summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/rejected-words.rst
blob: 9afe7df27e44cddba124c6cff48d692f83027844 (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
28
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 :searchfox:`rejected-words.yml
<tools/lint/rejected-words.yml>` file.

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

Sources
-------

* :searchfox:`Configuration (YAML) <tools/lint/rejected-words.yml>`