summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/rejected-words.rst
blob: c952b420da9288683156ceadcaa3380c5b42fa17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Rejected words
==============

Reject some words we don't want to use in the code base for various reasons.

Run Locally
-----------

The mozlint integration of codespell can be run using mach:

.. parsed-literal::

    $ mach lint --linter rejected-words <file paths>


Configuration
-------------

This linter is enabled on the whole code base. Issues existing in the code base are listed in the exclude list in
 the `rejected-words.yml <https://searchfox.org/mozilla-central/source/tools/lint/rejected-words.yml>`_ file.

New words can be added in the `payload` section.

Sources
-------

* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/rejected-words.yml>`_