Plugins

Nitpick uses plugins to handle configuration files.

There are plans to add plugins that handle certain file types, specific files, and user plugins. Check the roadmap.

Below are the currently included plugins.

setup.cfg

Enforce config on setup.cfg.

Example: flake8 configuration.

pyproject.toml

Enforce config on pyproject.toml.

See also PEP 518.

Example: the Python 3.7 default. There are many other examples in Defaults.

.pre-commit-config.yaml

Enforce configuration for .pre-commit-config.yaml.

Example: the default pre-commit hooks.

JSON files

Enforce configurations for any JSON file.

Add the configurations for the file name you wish to check. Example: the default config for package.json.

Text files

Enforce configuration on text files.

To check if some.txt file contains the lines abc and def (in any order):

[["some.txt".contains]]
line = "abc"

[["some.txt".contains]]
line = "def"