Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qlty.sh/llms.txt

Use this file to discover all available pages before exploring further.

To fine tune your analysis results, you can ignore issues within your source code or through rules in your qlty.toml project configuration file.

​
Mute comments

Qlty CLI supports using mute comments in your source code files to ignore issues on a line, within a block of code, or for an entire file.
This documentation is coming soon. In the meantime, please contact us and we can help!

​
Adding [[exclude]] rules in qlty.toml

Qlty CLI also allows a simple way to exclude certain plugins from running on a set of files in your project configuration file (.qlty/qlty.toml). Each [[exclude]] block can specify conditions by plugins and file patterns. Qlty will avoid running the given plugins on files that match the given patterns or ignore any issues matching the plugins and file patterns. Examples: 
# Exclude eslint from running on files in remix/app/components/ui/
[[exclude]]
plugins = ["eslint"]
file_patterns = ["remix/app/components/ui/**"]

​
Adding [[triage]] rules in qlty.toml

Qlty CLI also allows a highly flexible way to suppress issues in your project configuration file (.qlty/qlty.toml). Each [[triage]] block can specify match conditions by plugins, rules, file globs, and levels. If an issue matches all the specified conditions, it will be ignored. Examples: 
# Ignore the eslint react/prop-types check only in remix/app/components/ui/
[[triage]]
match.rules = ["eslint:react/prop-types"]
match.file_patterns = ["remix/app/components/ui/**"]
set.ignored = true

# Ignore all rubocop issues at "low" level
[[triage]]
match.plugins = ["rubocop"]
match.levels = ["low"]
set.ignored = true

​
Reviewing ignored issues

Issues that have been ignored in the project configuration file (.qlty/qlty.toml) are surpressed at generation time and cannot be viewed in the Qlty web application.

​
See Also