Plugins — Qlty Docs

Qlty integrates with linters, auto-formatters, security scanners, and other static analysis tools as plugins.

Each plugin consists of two components:

A plugin definition in a TOML configuration file
A results parser implemented in Rust

Here is a simplified example plugin definition for Ruff:

plugin.toml for ruff

1 config_version = "0"
2 
3 [plugins.definitions.ruff]
4 runtime = "python"
5 package = "ruff"
6 file_types = ["python"]
7 version_command = "ruff version"
8 config_files = ["ruff.toml"]
9 issue_url_format = "https://docs.astral.sh/ruff/rules/${rule}"
10 
11 [plugins.definitions.ruff.drivers.lint]
12 script = "ruff check --exit-zero --output-format sarif --output-file ${tmpfile}  ${target}"
13 success_codes = [0]
14 output = "tmpfile"
15 output_format = "sarif"
16 batch = true

Gitleaks supports outputting results in the SARIF standard format, so a custom results parser is not needed. For tools which do not support SARIF, a results parser is implemented within the Qlty CLI and referenced by name.

Auto-Formatters

Auto-formatters are a special type of plugin because they rewrite files rather than outputting findings. Therefore, they do not require results parsers.

Here is an example of a plugin definition for the shfmt auto-formatter:

plugin.toml for shfmt

1 config_version = "0"
2 
3 [plugins.definitions.shfmt]
4 package = "mvdan.cc/sh/v${major_version}/cmd/shfmt"
5 runtime = "go"
6 file_types = ["shell"]
7 version_command = "shfmt --version"
8 affects_cache = [".editorconfig"]
9 
10 [plugins.definitions.shfmt.drivers.format]
11 script = "shfmt -w -s ${target}"
12 success_codes = [0, 1]
13 output = "rewrite"
14 cache_results = true
15 batch = true
16 driver_type = "formatter"

Note the specification of output = "rewrite" and driver_type = "formatter".

1	config_version = "0"
2
3	[plugins.definitions.ruff]
4	runtime = "python"
5	package = "ruff"
6	file_types = ["python"]
7	version_command = "ruff version"
8	config_files = ["ruff.toml"]
9	issue_url_format = "https://docs.astral.sh/ruff/rules/${rule}"
10
11	[plugins.definitions.ruff.drivers.lint]
12	script = "ruff check --exit-zero --output-format sarif --output-file ${tmpfile} ${target}"
13	success_codes = [0]
14	output = "tmpfile"
15	output_format = "sarif"
16	batch = true

1	config_version = "0"
2
3	[plugins.definitions.shfmt]
4	package = "mvdan.cc/sh/v${major_version}/cmd/shfmt"
5	runtime = "go"
6	file_types = ["shell"]
7	version_command = "shfmt --version"
8	affects_cache = [".editorconfig"]
9
10	[plugins.definitions.shfmt.drivers.format]
11	script = "shfmt -w -s ${target}"
12	success_codes = [0, 1]
13	output = "rewrite"
14	cache_results = true
15	batch = true
16	driver_type = "formatter"