Skip to content

cli: make chock check say what to do next when it fails #133

Description

@jothimani-rajendran

chock check is the command a new adopter runs first, and its failure output currently names
what is wrong without naming the fix. For someone who has just installed chock, "compiled drift"
or "vendored-runtime-modified" is a diagnosis in a language they do not speak yet.

What to do: for each check that can fail, add the next action to the failure message — the
command that regenerates, the file to look at, or the doc section that explains it. The message
stays beside the condition that raises it; do not move diagnostics into a lookup table.

Constraints:

  • Do not weaken any check to make its message nicer, and do not make a failing check exit zero.
    This is about the text, not the verdict.
  • Do not suggest a fix that is wrong for the situation. "Run chock sync" is unhelpful if the
    drift came from an upstream version bump — say which case is which, or say nothing.

Good first issue for someone who wants to learn the codebase by reading its error paths, which is
usually the fastest way in. Sized to an afternoon. Files: src/chock/, wherever each check
raises.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions