Skip to main content
Checks issue YAML files under modules and packages. It reports file-integrity, YAML, schema, state, branch, pull request, dependency, and cross-file diagnostics, then exits non-zero when errors are present.

​
Usage

​
Examples

Check every issue file:
Check issues owned by one module or package:
Check specific issue ids:
Fail on warnings as well as errors:
Print diagnostics as JSON:

​
Options

​
Discovery

The command scans modules/ and packages/ for directories that own an issues/ directory. It loads the whole project before filtering so duplicate ids, duplicate branches, and dependency cycles remain visible when you filter the report. Only <ID>.yml files are issue files. Hidden files are ignored. Nested directories and non-.yml files inside a selected issues/ directory are reported as errors.

​
Rules

The checker validates issue file integrity before parsing YAML. It rejects unreadable, too-large, non-UTF-8, empty, malformed, non-mapping, and duplicate-key files. It also reports line-ending, indentation, control-character, trailing-whitespace, and missing-trailing-newline problems. Parsed issues are checked against the known top-level fields, states, priorities, labels, required planned sections, checkbox formats, dependencies, branch format, pull request format, comments, spec, and resources.

​
Output

The human report prints diagnostics grouped by file as ERROR or WARN, including a line number when available. With --json, the report contains file and module counts, error and warning counts, and a diagnostics array. If no issue matches a requested filter, the command exits non-zero. If there are no issue files and no filter, it prints No issue files found and exits successfully.

​
Exit codes

The command exits non-zero when any error is reported. With --strict, warnings also make the command exit non-zero.