Skip to content

Latest commit

 

History

History
151 lines (124 loc) · 6.89 KB

library.rst

File metadata and controls

151 lines (124 loc) · 6.89 KB

Library (Presets)

If you want to :ref:`configure your own style <configure-your-own-style>`, those are the some styles you can reuse.

Many TOML_ configs below are used in the :gitref:`default style file <nitpick-style.toml>`.

You can use these examples directly with their py:// URL (see :ref:`multiple_styles`), or copy/paste the TOML into your own style file.

any

Style URL Description
:gitref:`py://nitpick/resources/any/codeclimate <src/nitpick/resources/any/codeclimate.toml>` CodeClimate
:gitref:`py://nitpick/resources/any/commitizen <src/nitpick/resources/any/commitizen.toml>` Commitizen (Python)
:gitref:`py://nitpick/resources/any/commitlint <src/nitpick/resources/any/commitlint.toml>` commitlint
:gitref:`py://nitpick/resources/any/editorconfig <src/nitpick/resources/any/editorconfig.toml>` EditorConfig
:gitref:`py://nitpick/resources/any/git-legal <src/nitpick/resources/any/git-legal.toml>` Git.legal - CodeClimate Community Edition
:gitref:`py://nitpick/resources/any/markdownlint <src/nitpick/resources/any/markdownlint.toml>` Markdown lint
:gitref:`py://nitpick/resources/any/pre-commit-hooks <src/nitpick/resources/any/pre-commit-hooks.toml>` pre-commit hooks for any project
:gitref:`py://nitpick/resources/any/prettier <src/nitpick/resources/any/prettier.toml>` Prettier

javascript

Style URL Description
:gitref:`py://nitpick/resources/javascript/package-json <src/nitpick/resources/javascript/package-json.toml>` package.json

kotlin

Style URL Description
:gitref:`py://nitpick/resources/kotlin/ktlint <src/nitpick/resources/kotlin/ktlint.toml>` ktlint

presets

Style URL Description
:gitref:`py://nitpick/resources/presets/nitpick <src/nitpick/resources/presets/nitpick.toml>` Default style file for Nitpick

proto

Style URL Description
:gitref:`py://nitpick/resources/proto/protolint <src/nitpick/resources/proto/protolint.toml>` protolint (Protobuf linter)

python

Style URL Description
:gitref:`py://nitpick/resources/python/310 <src/nitpick/resources/python/310.toml>` Python 3.10
:gitref:`py://nitpick/resources/python/37 <src/nitpick/resources/python/37.toml>` Python 3.7
:gitref:`py://nitpick/resources/python/38 <src/nitpick/resources/python/38.toml>` Python 3.8
:gitref:`py://nitpick/resources/python/39 <src/nitpick/resources/python/39.toml>` Python 3.9
:gitref:`py://nitpick/resources/python/absent <src/nitpick/resources/python/absent.toml>` Files that should not exist
:gitref:`py://nitpick/resources/python/autoflake <src/nitpick/resources/python/autoflake.toml>` autoflake
:gitref:`py://nitpick/resources/python/bandit <src/nitpick/resources/python/bandit.toml>` Bandit
:gitref:`py://nitpick/resources/python/black <src/nitpick/resources/python/black.toml>` Black
:gitref:`py://nitpick/resources/python/flake8 <src/nitpick/resources/python/flake8.toml>` Flake8
:gitref:`py://nitpick/resources/python/github-workflow <src/nitpick/resources/python/github-workflow.toml>` GitHub Workflow for Python
:gitref:`py://nitpick/resources/python/ipython <src/nitpick/resources/python/ipython.toml>` IPython
:gitref:`py://nitpick/resources/python/isort <src/nitpick/resources/python/isort.toml>` isort
:gitref:`py://nitpick/resources/python/mypy <src/nitpick/resources/python/mypy.toml>` Mypy
:gitref:`py://nitpick/resources/python/poetry-editable <src/nitpick/resources/python/poetry-editable.toml>` Poetry (editable projects; PEP 600 support)
:gitref:`py://nitpick/resources/python/poetry <src/nitpick/resources/python/poetry.toml>` Poetry
:gitref:`py://nitpick/resources/python/pre-commit-hooks <src/nitpick/resources/python/pre-commit-hooks.toml>` pre-commit hooks for Python projects
:gitref:`py://nitpick/resources/python/pylint <src/nitpick/resources/python/pylint.toml>` Pylint
:gitref:`py://nitpick/resources/python/radon <src/nitpick/resources/python/radon.toml>` Radon
:gitref:`py://nitpick/resources/python/readthedocs <src/nitpick/resources/python/readthedocs.toml>` Read the Docs
:gitref:`py://nitpick/resources/python/sonar-python <src/nitpick/resources/python/sonar-python.toml>` SonarQube Python plugin
:gitref:`py://nitpick/resources/python/stable <src/nitpick/resources/python/stable.toml>` Current stable Python version
:gitref:`py://nitpick/resources/python/tox <src/nitpick/resources/python/tox.toml>` tox

shell

Style URL Description
:gitref:`py://nitpick/resources/shell/bashate <src/nitpick/resources/shell/bashate.toml>` bashate (code style for Bash)
:gitref:`py://nitpick/resources/shell/shellcheck <src/nitpick/resources/shell/shellcheck.toml>` ShellCheck (static analysis for shell scripts)
:gitref:`py://nitpick/resources/shell/shfmt <src/nitpick/resources/shell/shfmt.toml>` shfmt (shell script formatter)