File: lintpref.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 (32 lines) | stat: -rw-r--r-- 889 bytes parent folder | download | duplicates (15) 
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
 
Lintpref
========

The lintpref linter is a simple linter for libpref files to check for duplicate
entries between :searchfox:`modules/libpref/init/all.js` and
:searchfox:`modules/libpref/init/StaticPrefList.yaml`. If a duplicate is found,
lintpref will raise an error and emit the ``all.js`` line where you can find
the duplicate entry.


Running Locally
---------------

The linter can be run using mach:

 .. parsed-literal::

     $ mach lint --linter lintpref


Fixing Lintpref Errors
----------------------

In most cases, duplicate entries should be avoided and the duplicate removed
from ``all.js``. If for any reason a pref should exist in both files, the pref
should be added to ``IGNORE_PREFS`` in :searchfox:`tools/lint/libpref/__init__.py`.

Sources
-------

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