Definitions
Last updated
Last updated
The definition of a particular linter is put under lint.definitions. The following properties define the settings of a particular linter, not for all linters. For global linter settings, see .
affects_cacheaffects_cache: The list of files that affect the cache results of this linter. .
allow_empty_filesallow_empty_files: optional boolean. Indicates to skip linting empty files for this linter.
batchbatch: optional boolean. Combine multiple files into the same execution.
commandscommands: The list of commands exposed by this linter. See .
deprecateddeprecated: string. Indicates the linter is deprecated and should not be used.
direct_configsdisableddisabled: optional boolean: Whether linter is actively disabled (and will not be recommended) and will not run (overrides enabled).
downloadenabledenabled: optional boolean. Whether this linter is enabled.
environmentextra_packagesformatterformatter: boolean. Indicates whether this is a formatter and should be included in trunk fmt.
good_without_confighold_the_lineinclude_lfsinclude_scanner_typeinclude_scanner_type: which include scanner to use, if any.
issue_url_formatissue_url_format: string, a format string that accepts issue codes for links to issues docs.
known_good_versionknown_good_version: string. A version to be used when Trunk cannot query the latest version. Currently, Trunk can query the latest version for all package managers and downloads hosted on GitHub.
known_bad_versionsknown_bad_versions: string list. Versions of a linter that are known to be broken and should not be run with Trunk. We will fall back to a known_good_version if init or upgrade chooses something in this set.
main_toolmain_tool, string. If your linter depends on more than a single tool, and none of the tools has the same name as the linter, then you will need to specify which is the main tool here. It will be used to version the tool from the linter's enabled version.
namename required string. The name of the linter. This property will be used to refer to the linter in other parts of the config, for example, in the list of enabled linters.
packagepath_formatpath_format, Whether to use the platform-specific paths or generic "/". Default native.
plugin_urlplugin_url: string, a plugin url for reporting issues.
prepare_commandprepare_command. A command that is run once per session before linting any number of files using this linter. ex. [tflint, --init].
query_compile_commandsquery_compile_commands, optional boolean.
runtimerun_timeoutsuggest_ifsupported_platformstoolsversion_commandversion_command: Version check commands.
verbatim_messageverbatim_message: Do not try to truncate or reflow the output of this linter.
direct_configs: string list. Indicates config files used to auto-enable the linter. See .
download: string. The download URL. You must provide either runtime + packages or download, not both. Using runtimes is preferred. See .
environment: a list of runtime variables used when running the linter. See .
extra_packages: list of strings, Extra packages to install, versions are optional. See .
good_without_config: optional boolean. Indicates whether this linter is recommended without the user tuning its configuration. Prefer .
hold_the_line: optional boolean. Whether be done for this linter or not.
include_lfs: boolean. Allow this linter to operate on files tracked using .
package: string, What primary package to install, if using a package manager runtime. The enabled version of the runtime for this linter will apply to this package. See .
runtime: RuntimeType, Which package manager runtime, if any, to require to be setup for this linter. Ex: node, ruby, python. See .
run_timeout: duration string. Describes how long a linter can run before timing out. .
How to determine if this linter should be auto-enabled/recommended. Possible values are never, config_present, and files_present. for more details.
Platform constraint. If incompatible, renders a notice. See also .
tools, string list. The list of tools used by this linter. See .