Configuration files

Below are the currently supported configuration files.

pyproject.toml

Checker for pyproject.toml.

See also PEP 518.

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

setup.cfg

Checker for the setup.cfg config file.

Example: flake8 configuration.

.pre-commit-config.yaml

Checker for the .pre-commit-config.yaml file.

Example: the default pre-commit hooks.

JSON files

Checker for any JSON file.

First, configure the list of files to be checked in the [nitpick.JSONFile] section.

Then add the configuration for the file name you just declared. Example: the default config for package.json.

If a JSON file is configured on [nitpick.JSONFile] file_names, then a configuration for it should exist. Otherwise, a style validation error will be raised.