The [nitpick] section¶
The [nitpick] section in the style file contains global settings for the style.
Those are settings that either don’t belong to any specific config file, or can be applied to all config files.
Show an upgrade message to the developer if Nitpick’s version is below
[nitpick] minimum_version = "0.10.0"
Files that should exist¶
To enforce that certain files should exist in the project, you can add them to the style file as a dictionary of “file name” and “extra message”.
Use an empty string to not display any extra message.
[nitpick.files.present] ".editorconfig" = "" "CHANGELOG.md" = "A project should have a changelog"
Files that should be deleted¶
To enforce that certain files should not exist in the project, you can add them to the style file.
[nitpick.files.absent] "some_file.txt" = "This is an optional extra string to display after the warning" "another_file.env" = ""
Multiple files can be configured as above. The message is optional.
Comma separated values¶
setup.cfg, some keys are lists of multiple values separated by commas, like
On the style file, it’s possible to indicate which key/value pairs should be treated as multiple values instead of an exact string. Multiple keys can be added.
[nitpick.files."setup.cfg"] comma_separated_values = ["flake8.ignore", "isort.some_key", "another_section.another_key"]
Styles can include other styles. Just provide a list of styles to include:
[nitpick.styles] include = ["styles/python37", "styles/poetry"]
The styles will be merged following the sequence in the list.
If a key/value pair appears in more than one sub-style, it will be overridden; the last declared key/pair will prevail.