Linting Issues

How to lint issues
Categories:

Issu can lint issue files to ensure the frontmatter labels are correct and consistent.

Performing Linting

You can lint all files under the Config > issuesPath using issu lint. Lint will scan all files, check their labels against Config > labels, and exit 1 if there are any issues with them:

$ issu lint

ERROR Linting errors found

/candiddev/engineering/issues/159.md:
    value does not match values for label: difficulty: 5 - Heroic

For Continuous Delivery/Continuous Integration Usage, it’s highly recommended to run linting for every Config > issuesPath change.

Custom Linting Rules

You can configure custom linting rules using Config > lintRules. These rules will be evaluated against all issue labels and fail linting for any issue that returns true.

Fixing Linting Issues

If the linting issue is due to a missing label, and that label has a default, Issu can automatically fix the problem by Organizing the Labelsissu org. This command will reorganize and relabel issues, potentially fixing linting problems.