diff options
Diffstat (limited to 'docs/code-quality/lint/linters/black.rst')
| -rw-r--r-- | docs/code-quality/lint/linters/black.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/code-quality/lint/linters/black.rst b/docs/code-quality/lint/linters/black.rst new file mode 100644 index 0000000000..da4c1a52a2 --- /dev/null +++ b/docs/code-quality/lint/linters/black.rst @@ -0,0 +1,36 @@ +Black +===== + +`Black <https://black.readthedocs.io/en/stable/>`__ is a opinionated python code formatter. + + +Run Locally +----------- + +The mozlint integration of black can be run using mach: + +.. parsed-literal:: + + $ mach lint --linter black <file paths> + +Alternatively, omit the ``--linter black`` and run all configured linters, which will include +black. + + +Configuration +------------- + +To enable black on new directory, add the path to the include +section in the `black.yml <https://searchfox.org/mozilla-central/source/tools/lint/black.yml>`_ file. + +Autofix +------- + +The black linter provides a ``--fix`` option. + + +Sources +------- + +* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/black.yml>`_ +* `Source <https://searchfox.org/mozilla-central/source/tools/lint/python/black.py>`_ |