4c68ca682b
This for a few reasons: * The summary becomes the landing page for code quality: https://firefox-source-docs.mozilla.org/tools/static-analysis/summary.html * I don't think we need a full code quality category * Closer to the source-code-doc * All the files at the same place Differential Revision: https://phabricator.services.mozilla.com/D61767
32 lines
932 B
ReStructuredText
32 lines
932 B
ReStructuredText
Lintpref
|
|
========
|
|
|
|
The lintpref linter is a simple linter for libpref files to check for duplicate
|
|
entries between ``modules/libpref/init/all.js`` and ``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 ``tools/lint/libpref/__init__.py``.
|
|
|
|
Sources
|
|
-------
|
|
|
|
* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/lintpref.yml>`_
|
|
* `Source <https://searchfox.org/mozilla-central/source/tools/lint/libpref/__init__.py>`_
|