Auto-Enable
Last updated
Last updated
Simply defining a linter does not enable it. Trunk needs to know when to auto-enable the linter for certain projects (ex: all python projects) or if certain files are already present (ex: .eslintrc
).
The direct_configs
property contains a list of config files that the underlying linter uses. The suggest_if
property determines when trunk check
should suggest this linter. If suggest_if
is set to config_present
, then trunk will search for the listed config files. If found, the linter will be enabled automatically when the user does trunk init
or trunk update
.
For example: in the following yaml, the flake8 linter sets suggest_if
to config_preset
and sets direct_configs
to [.flake8]
. If any *.flake8
files are found, then trunk check will automatically enable flake8.
Flake8 linter definition.
The suggest_if field can be one of the following:
config_present
will auto-enable a linter if Trunk sees any direct_config
for it .
files_present
will auto-enable a linter if Trunk sees any file type that it operates on.
never
will never auto-enable this linter.
Setting the lint.definitions[*].enabled
property to true will force the linter to be enabled. Setting the lint.definitions[*].disabled
property to true will force the linter to never be enabled, even if the enabled
property is true, and will never suggest this linter, even if suggest_if
says it should.
Trunk curates the values of suggest_if
for all linters in the repo.
For additional information on the properties of Linters, see the .