Nitpick

Command-line tool and flake8 plugin to enforce the same settings across multiple language-independent projects.

Useful if you maintain multiple projects and are tired of copying/pasting the same INI/TOML/YAML/JSON keys and values over and over, in all of them.

The CLI now has a nitpick fix command that modifies configuration files directly (pretty much like black and isort do with Python files). See Command-line interface for more info.

Many more features are planned for the future, check the roadmap.

Note

This project is still a work in progress, so the API is not fully defined:

• The style file syntax might have changes before the 1.0 stable release;

• The numbers in the NIP* error codes might change; don’t fully rely on them;

• See also Breaking changes.

Contents:

• Quickstart
  • Install
  • Run
  • Run as a pre-commit hook
  • Modify files directly
• Styles
  • The style file
  • Configure your own style
  • Default search order for a style
  • Style file syntax
  • Special configurations
    • Comparing elements on lists
  • Breaking changes
    • missing_message key was removed
• Configuration
  • Remote style
  • Style inside Python package
  • Cache
    • Expiring after a predefined time
    • Forever
    • Never
    • Clearing
  • Local style
  • Multiple styles
  • Override a remote style
• Examples
  • codeclimate
  • commitizen
  • commitlint
  • EditorConfig
  • git-legal
  • pre-commit hooks for any language
  • markdownlint
  • Prettier
  • package.json
  • Python 3.10
  • Python 3.7
  • Python 3.8
  • Python 3.9
  • Absent files
  • autoflake
  • bandit
  • black
  • flake8
  • GitHub Workflow (Python)
  • pre-commit hooks for Python
  • IPython
  • isort
  • mypy
  • Poetry
  • Pylint
  • radon
  • ReadTheDocs
  • sonar-python
  • Python (stable version)
  • tox
  • bashate
  • shellcheck
• The [nitpick] section
  • Minimum version
  • [nitpick.files]
    • Files that should exist
    • Files that should be deleted
    • Comma separated values
  • [nitpick.styles]
• Command-line interface
  • Main options
  • fix: Modify files directly
  • check: Don’t modify, just print the differences
  • ls: List configures files
  • init: Initialise a configuration file
• Flake8 plugin
  • Pre-commit hook and flake8
    • Why always_run: true?
  • Root dir of the project
  • Main Python file
• Plugins
  • INI files
  • JSON files
  • Text files
  • TOML files
  • YAML files
• Troubleshooting
  • Crash on multi-threading
  • ModuleNotFoundError: No module named ‘nitpick.plugins.XXX’
  • Executable .tox/lint/bin/pylint not found
• Contributing
  • Bug reports or feature requests
  • Documentation improvements
  • Development
    • Commit convention
    • Pull Request Guidelines
• Authors

API Reference:

• nitpick

Indices and tables

• Index

• Module Index

• Search Page

To Do List