summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/lint/linters/file-whitespace.rst
blob: fd134b32ef43423cf943b1f29b91d38a15ab94b5 (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
29
30
31
32
33
34
35
36
37
38
Trailing whitespaces
====================

This linter verifies if a file has:

* unnecessary trailing whitespaces,
* Windows carriage return,
* empty lines at the end of file,
* if file ends with a newline or not


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

This mozlint linter can be run using mach:

.. parsed-literal::

    $ mach lint --linter file-whitespace <file paths>


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

This linter is enabled on most of the code base.

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

Autofix
-------

This linter provides a ``--fix`` option. The python script is doing the change itself.

Sources
-------

* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/file-whitespace.yml>`_
* `Source <https://searchfox.org/mozilla-central/source/tools/lint/file-whitespace/__init__.py>`_