File: ignorefile.rst

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (44 lines) | stat: -rw-r--r-- 1,053 bytes parent folder | download | duplicates (7) 
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
39
40
41
42
43
44
 
Ignorefile Lint
===============

Ignorefile lint is a linter for ``.gitignore`` and ``.hgignore`` files,
to verify those files have equivalent entries.

Each pattern is roughly compared, ignoring punctuation, to absorb the
syntax difference.

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

The mozlint integration of ignorefile linter can be run using mach:

.. parsed-literal::

    $ mach lint --linter ignorefile


Special syntax
--------------

The following special comment can be used to ignore the pattern in the next line.

.. parsed-literal::

    # lint-ignore-next-line: git-only

The next line exists only in ``.gitignore``.

.. parsed-literal::
    # lint-ignore-next-line: syntax-difference

The next line's pattern needs to be represented differently between
``.gitignore`` and ``.hgignore``.
This can be used when the ``.hgignore`` uses complex pattern which cannot be
represented in single pattern in ``.gitignore``.


Sources
-------

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