Skip to content

docs: give varar lint a reference on the site #63

Description

@aslakhellesoy

Split out from #57 (§8, varar lint sub-item).

varar lint is documented only in varar --help, not anywhere on varar.dev.

The expectation-gap note the issue asked for now exists: both Run your existing .feature files and Varar for Cucumber users explain that a sentence matching nothing is prose by design, so varar lint will not produce the "undefined step" list a Cucumber user expects — that regression is caught by drift detection instead.

What is still missing is a reference for the command itself: what varar lint actually checks, what it reports, its exit code, and when you'd run it. Right now it's only ever mentioned in passing to explain what it does not do.

Suggested change

A short section or reference page covering varar lint:

  • what it validates (e.g. config resolves, step files load, expressions compile, ambiguous matches);
  • what it does not flag (unmatched sentences — by design), linking the drift-detection explanation already written;
  • exit code / CI usage.

Small; likely folds into the configuration or examples reference, or a brief CLI reference section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions