Sign upLogin

andreoliwa/nitpick

View on GitHub
Star
docs/library.rst

Summary

Maintainability
Test Coverage
.. include:: targets.rst

.. _library:

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.

.. auto-generated-from-here

any
~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/any/codeclimate <src/nitpick/resources/any/codeclimate.toml>`
     - `CodeClimate <https://codeclimate.com/>`_
   * - :gitref:`py://nitpick/resources/any/commitizen <src/nitpick/resources/any/commitizen.toml>`
     - `Commitizen (Python) <https://github.com/commitizen-tools/commitizen>`_
   * - :gitref:`py://nitpick/resources/any/commitlint <src/nitpick/resources/any/commitlint.toml>`
     - `commitlint <https://github.com/conventional-changelog/commitlint>`_
   * - :gitref:`py://nitpick/resources/any/editorconfig <src/nitpick/resources/any/editorconfig.toml>`
     - `EditorConfig <https://editorconfig.org/>`_
   * - :gitref:`py://nitpick/resources/any/git-legal <src/nitpick/resources/any/git-legal.toml>`
     - `Git.legal - CodeClimate Community Edition <https://github.com/kmewhort/git.legal-codeclimate>`_
   * - :gitref:`py://nitpick/resources/any/pre-commit-hooks <src/nitpick/resources/any/pre-commit-hooks.toml>`
     - `pre-commit hooks for any project <https://github.com/pre-commit/pre-commit-hooks>`_
   * - :gitref:`py://nitpick/resources/any/prettier <src/nitpick/resources/any/prettier.toml>`
     - `Prettier <https://github.com/prettier/prettier>`_

javascript
~~~~~~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/javascript/package-json <src/nitpick/resources/javascript/package-json.toml>`
     - `package.json <https://github.com/yarnpkg/website/blob/master/lang/en/docs/package-json.md>`_

kotlin
~~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/kotlin/ktlint <src/nitpick/resources/kotlin/ktlint.toml>`
     - `ktlint <https://github.com/pinterest/ktlint>`_

markdown
~~~~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/markdown/markdownlint <src/nitpick/resources/markdown/markdownlint.toml>`
     - `Markdown lint <https://github.com/markdownlint/markdownlint>`_

presets
~~~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/presets/nitpick <src/nitpick/resources/presets/nitpick.toml>`
     - `Default style file for Nitpick <https://nitpick.rtfd.io/>`_

proto
~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/proto/protolint <src/nitpick/resources/proto/protolint.toml>`
     - `protolint (Protobuf linter) <https://github.com/yoheimuta/protolint>`_

python
~~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/python/310 <src/nitpick/resources/python/310.toml>`
     - Python 3.10
   * - :gitref:`py://nitpick/resources/python/311 <src/nitpick/resources/python/311.toml>`
     - Python 3.11
   * - :gitref:`py://nitpick/resources/python/312 <src/nitpick/resources/python/312.toml>`
     - Python 3.12
   * - :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 <https://github.com/myint/autoflake>`_
   * - :gitref:`py://nitpick/resources/python/bandit <src/nitpick/resources/python/bandit.toml>`
     - `Bandit <https://github.com/PyCQA/bandit>`_
   * - :gitref:`py://nitpick/resources/python/black <src/nitpick/resources/python/black.toml>`
     - `Black <https://github.com/psf/black>`_
   * - :gitref:`py://nitpick/resources/python/flake8 <src/nitpick/resources/python/flake8.toml>`
     - `Flake8 <https://github.com/PyCQA/flake8>`_
   * - :gitref:`py://nitpick/resources/python/github-workflow <src/nitpick/resources/python/github-workflow.toml>`
     - `GitHub Workflow for Python <https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions>`_
   * - :gitref:`py://nitpick/resources/python/ipython <src/nitpick/resources/python/ipython.toml>`
     - `IPython <https://github.com/ipython/ipython>`_
   * - :gitref:`py://nitpick/resources/python/isort <src/nitpick/resources/python/isort.toml>`
     - `isort <https://github.com/PyCQA/isort>`_
   * - :gitref:`py://nitpick/resources/python/mypy <src/nitpick/resources/python/mypy.toml>`
     - `Mypy <https://github.com/python/mypy>`_
   * - :gitref:`py://nitpick/resources/python/poetry-editable <src/nitpick/resources/python/poetry-editable.toml>`
     - `Poetry (editable projects; PEP 600 support) <https://github.com/python-poetry/poetry>`_
   * - :gitref:`py://nitpick/resources/python/poetry-venv <src/nitpick/resources/python/poetry-venv.toml>`
     - `Poetry (virtualenv in project) <https://github.com/python-poetry/poetry>`_
   * - :gitref:`py://nitpick/resources/python/poetry <src/nitpick/resources/python/poetry.toml>`
     - `Poetry <https://github.com/python-poetry/poetry>`_
   * - :gitref:`py://nitpick/resources/python/pre-commit-hooks <src/nitpick/resources/python/pre-commit-hooks.toml>`
     - `pre-commit hooks for Python projects <https://pre-commit.com/hooks>`_
   * - :gitref:`py://nitpick/resources/python/pylint <src/nitpick/resources/python/pylint.toml>`
     - `Pylint <https://github.com/PyCQA/pylint>`_
   * - :gitref:`py://nitpick/resources/python/radon <src/nitpick/resources/python/radon.toml>`
     - `Radon <https://github.com/rubik/radon>`_
   * - :gitref:`py://nitpick/resources/python/readthedocs <src/nitpick/resources/python/readthedocs.toml>`
     - `Read the Docs <https://github.com/readthedocs/readthedocs.org>`_
   * - :gitref:`py://nitpick/resources/python/sonar-python <src/nitpick/resources/python/sonar-python.toml>`
     - `SonarQube Python plugin <https://github.com/SonarSource/sonar-python>`_
   * - :gitref:`py://nitpick/resources/python/tox <src/nitpick/resources/python/tox.toml>`
     - `tox <https://github.com/tox-dev/tox>`_

shell
~~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/shell/bashate <src/nitpick/resources/shell/bashate.toml>`
     - `bashate (code style for Bash) <https://github.com/openstack/bashate>`_
   * - :gitref:`py://nitpick/resources/shell/shellcheck <src/nitpick/resources/shell/shellcheck.toml>`
     - `ShellCheck (static analysis for shell scripts) <https://github.com/koalaman/shellcheck>`_
   * - :gitref:`py://nitpick/resources/shell/shfmt <src/nitpick/resources/shell/shfmt.toml>`
     - `shfmt (shell script formatter) <https://github.com/mvdan/sh>`_

toml
~~~~

.. list-table::
   :header-rows: 1

   * - Style URL
     - Description
   * - :gitref:`py://nitpick/resources/toml/toml-sort <src/nitpick/resources/toml/toml-sort.toml>`
     - `TOML sort <https://github.com/pappasam/toml-sort>`_