File: codespell.rst

package info (click to toggle)
firefox 147.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,484 kB
  • sloc: cpp: 7,607,246; javascript: 6,533,185; ansic: 3,775,227; python: 1,415,393; xml: 634,561; asm: 438,951; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (36 lines) | stat: -rw-r--r-- 929 bytes parent folder | download | duplicates (18) 
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
29
30
31
32
33
34
35
36
 
Codespell
=========

`codespell <https://github.com/codespell-project/codespell/>`__ is a popular tool to look for typical typos in the source code.

It is enabled mostly for the documentation and English locale files.

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

The mozlint integration of codespell can be run using mach:

.. parsed-literal::

    $ mach lint --linter codespell <file paths>


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

To enable codespell on new directory, add the path to the include
section in the :searchfox:`codespell.yml <tools/lint/codespell.yml>` file.

This job is configured as `tier 2 <https://wiki.mozilla.org/Sheriffing/Job_Visibility_Policy#Overview_of_the_Job_Visibility_Tiers>`_.

Autofix
-------

Codespell provides a ``--fix`` option. It is based on the ``-w`` option provided by upstream.


Sources
-------

* :searchfox:`Configuration (YAML) <tools/lint/codespell.yml>`
* :searchfox:`Source <tools/lint/spell/__init__.py>`