Agent skill

Create Rule Processor

Scaffold a new rule processor, implement the evaluation logic, and write tests.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/create-rule-carrot-foundation-methodology-rules-3

SKILL.md

  1. Scaffold the rule using the built-in script:

    bash
    pnpm create-rule <name> <scope> <description>
    
    • <name>: kebab-case rule name (e.g., vehicle-validation)
    • <scope>: processor group (mass-id, credit-order, or mass-id-certificate)
    • <description>: short description of what the rule validates

    This creates the standard file structure:

    {rule-name}/
    ├── {rule-name}.processor.ts
    ├── {rule-name}.lambda.ts
    ├── {rule-name}.processor.spec.ts
    ├── {rule-name}.lambda.e2e.spec.ts
    ├── {rule-name}.test-cases.ts
    ├── index.ts
    ├── project.json
    └── jest.config.ts
    
  2. Implement the processor: In {rule-name}.processor.ts, implement the evaluateResult() method. The processor extends ParentDocumentRuleProcessor<RuleSubject>.

  3. Write test cases: In {rule-name}.test-cases.ts, define shared test data using @faker-js/faker and zocker. Never use real data (no real company names, tax IDs, addresses, etc.).

  4. Write unit tests: In {rule-name}.processor.spec.ts, test the core evaluation logic using the shared test cases.

  5. Write e2e tests: In {rule-name}.lambda.e2e.spec.ts, test the Lambda handler end-to-end.

  6. Apply to a methodology (if needed):

    bash
    pnpm apply-methodology-rule <methodology> <rule> <scope>
    

    Example: pnpm apply-methodology-rule carbon-organic vehicle-validation mass-id

  7. Verify: Run pnpm lint:affected && pnpm ts:affected && pnpm test:affected to confirm everything passes.

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results