At least one finding reaches it, or a fix was applied with --exit-non-zero-on-fix
2
Usage, configuration or internal error
When a directory holds nothing to lint (for example a folder of loose .py files without a project.json), iglint says so on standard error and exits with 0.
Lints files and directories (default: .). A directory is searched for Ignition projects and gateway resource collections; Python files are linted as Ignition scripts only inside them. A .py file named on the command line is linted on its own, as a standalone script. Whatever is linted, iglint analyses the whole workspace around it (see pre-commit).
text (default, or output-format from the configuration), concise, grouped, json, json-lines, sarif, github, azure, junit, pylint, gitlab. See Output formats
-o, --output-file <FILE>
Write the report to this file instead of standard output
--statistics
Show the number of findings per rule instead of the findings
--show-files
List the files that would be linted, then exit
--show-settings
Show the settings that apply to the first path, then exit
--timing
Print the time spent in each phase to standard error
Baseline file of known findings that do not fail the run (default: baseline from the configuration, or .iglint-baseline.json in the project root if it exists)
Writes a baseline of the current findings, so that only new findings fail. Same as iglint check --update-baseline, and accepts the same options as check. See Baseline.
Lists the rules with code, name, severity, fix availability, default and summary. --category takes a prefix such as SCR or a name such as scripts. --format json includes each rule's options with their types and defaults, its ign-lint equivalent and its documentation.
Shows the documentation of a rule, by code or name, as Markdown: the same text as the rule pages. --all shows every rule; --output-format json prints the rule's metadata as JSON.
Lints Perspective view.json files with the command-line interface and output format of ign-lint 0.6.4. The binary behaves the same when it is called through a link named ign-lint.
A command for iglint's own development, not listed in --help: writes the rule reference (docs/rules/*.md) from the rule metadata. --check only checks that the pages are up to date and exits with 1 when they are not; CI runs it. The rule pages of this site are copies of those files.
