Skip to content

Improve onboarding: validate command and error messages #34

@ldraney

Description

@ldraney

Context

New users currently have to understand the sop.json schema by reading docs. The two biggest onboarding gaps:

  1. validate command (Add JSON schema validation for sop.json #21 tracks the schema, this is about UX): Run npx dev-sop-engine validate and get clear, actionable error messages — not just "invalid JSON" but "rule 'no-env' references validator 'validators/check.sh' which doesn't exist".
  2. Generator error messages: When generation fails (missing files, bad paths, invalid config), the errors should point to the exact problem and suggest a fix.

Relates to

What good looks like

$ npx dev-sop-engine validate
✗ rules.no-env-writes.validator: file "validators/check-env.sh" not found
  → Expected at: ./sop/validators/check-env.sh
✗ skills.workflow.content_file: file "./skills/workflow.md" not found
✓ logging configuration valid
✓ mcp configuration valid

2 errors found. Fix them and run again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestneeds reviewNeeds review before implementation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions