Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andreoliwa/nitpick

Enforce the same settings on multiple projects
https://github.com/andreoliwa/nitpick

flake8 flake8-plugin isort linter mypy pylint python python3 styleguide

Last synced: 7 days ago
JSON representation

Enforce the same settings on multiple projects

Host: GitHub
URL: https://github.com/andreoliwa/nitpick
Owner: andreoliwa
License: mit
Created: 2018-03-23T14:25:24.000Z (over 6 years ago)
Default Branch: develop
Last Pushed: 2024-11-11T21:31:53.000Z (about 1 month ago)
Last Synced: 2024-11-16T09:20:34.642Z (26 days ago)
Topics: flake8, flake8-plugin, isort, linter, mypy, pylint, python, python3, styleguide
Language: Python
Homepage: https://nitpick.readthedocs.io/
Size: 2.6 MB
Stars: 399
Watchers: 5
Forks: 25
Open Issues: 51
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS.rst

Awesome Lists containing this project

awesome-flake8-extensions - nitpick - Enforce the same lint configuration (flake8, isort, mypy, pylint) across multiple Python projects. (Tools)
best-of-python-dev - GitHub - 38% open · ⏱️ 28.05.2024): (Linters & Style Checkers)
awesome-codemods - **nitpick** - Apply the same pre-defined settings across all your projects (Fix aggregators / Debian)

README

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 the `CLI docs for more
info `_.

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

The style file
--------------

A "Nitpick code style" is a `TOML `_
file with the settings that should be present in config files from other
tools.

Example of a style:

.. code-block:: toml

["pyproject.toml".tool.black]
line-length = 120

["pyproject.toml".tool.poetry.dev-dependencies]
pylint = "*"

["setup.cfg".flake8]
ignore = "D107,D202,D203,D401"
max-line-length = 120
inline-quotes = "double"

["setup.cfg".isort]
line_length = 120
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
combine_as_imports = true

This style will assert that:

- ... `black `_,
`isort `_ and
`flake8 `_ have a line length of
120;
- ... `flake8 `_ and
`isort `_ are configured as above in
``setup.cfg``;
- ... `Pylint `__ is present as a
`Poetry `_ dev dependency
in ``pyproject.toml``.

Supported file types
--------------------

These are the file types currently handled by Nitpick.

- Some files are only being checked and have to be modified manually;
- Some files can already be fixed automatically (with the
``nitpick fix`` command);
- Others are still under construction; the ticket numbers are shown in
the table (upvote the ticket with 👍🏻 if you would like to prioritise
development).

Implemented
~~~~~~~~~~~

.. auto-generated-start-implemented
.. list-table::
:header-rows: 1

* - File type
- ``nitpick check``
- ``nitpick fix``
* - `Any INI file `_
- ✅
- ✅
* - `Any JSON file `_
- ✅
- ✅
* - `Any plain text file `_
- ✅
- ❌
* - `Any TOML file `_
- ✅
- ✅
* - `Any YAML file `_
- ✅
- ✅
* - `.editorconfig `_
- ✅
- ✅
* - `.pylintrc `_
- ✅
- ✅
* - `setup.cfg `_
- ✅
- ✅
.. auto-generated-end-implemented

Planned
~~~~~~~

.. auto-generated-start-planned
.. list-table::
:header-rows: 1

* - File type
- ``nitpick check``
- ``nitpick fix``
* - Any Markdown file
- `#280 `_ 🚧
- ❓
* - Any Terraform file
- `#318 `_ 🚧
- ❓
* - Dockerfile
- `#272 `_ 🚧
- `#272 `_ 🚧
* - .dockerignore
- `#8 `_ 🚧
- `#8 `_ 🚧
* - .gitignore
- `#8 `_ 🚧
- `#8 `_ 🚧
* - Jenkinsfile
- `#278 `_ 🚧
- ❓
* - Makefile
- `#277 `_ 🚧
- ❓
.. auto-generated-end-planned

Style Library (Presets)
-----------------------

Nitpick has a builtin library of style presets, shipped as `Python resources `_.

This library contains building blocks for your your custom style.
Just choose styles from the table below and create your own style, like LEGO.

Read how to:

- `...add multiple styles to the configuration file `_;
- `...include styles inside a style `_.

.. auto-generated-start-style-library

any
~~~