=====================
Mozilla ESLint Plugin
=====================

This is the documentation of Mozilla ESLint PLugin.

Environments
============

The plugin implements the following environments:


.. toctree::
   :maxdepth: 2

   eslint-plugin-mozilla/environment

Rules
=====

The plugin implements the following rules:

.. toctree::
   :maxdepth: 1

   eslint-plugin-mozilla/avoid-Date-timing
   eslint-plugin-mozilla/avoid-removeChild
   eslint-plugin-mozilla/balanced-listeners
   eslint-plugin-mozilla/balanced-observers
   eslint-plugin-mozilla/consistent-if-bracing
   eslint-plugin-mozilla/import-browser-window-globals
   eslint-plugin-mozilla/import-content-task-globals
   eslint-plugin-mozilla/import-globals
   eslint-plugin-mozilla/import-globals-from
   eslint-plugin-mozilla/import-headjs-globals
   eslint-plugin-mozilla/lazy-getter-object-name
   eslint-plugin-mozilla/mark-exported-symbols-as-used
   eslint-plugin-mozilla/mark-test-function-used
   eslint-plugin-mozilla/no-aArgs
   eslint-plugin-mozilla/no-addtask-setup
   eslint-plugin-mozilla/no-arbitrary-setTimeout
   eslint-plugin-mozilla/no-compare-against-boolean-literals
   eslint-plugin-mozilla/no-cu-reportError
   eslint-plugin-mozilla/no-define-cc-etc
   eslint-plugin-mozilla/no-redeclare-with-import-autofix
   eslint-plugin-mozilla/no-throw-cr-literal
   eslint-plugin-mozilla/no-useless-parameters
   eslint-plugin-mozilla/no-useless-removeEventListener
   eslint-plugin-mozilla/no-useless-run-test
   eslint-plugin-mozilla/prefer-boolean-length-check
   eslint-plugin-mozilla/prefer-formatValues
   eslint-plugin-mozilla/reject-addtask-only
   eslint-plugin-mozilla/reject-chromeutils-import
   eslint-plugin-mozilla/reject-chromeutils-import-params
   eslint-plugin-mozilla/reject-eager-module-in-lazy-getter
   eslint-plugin-mozilla/reject-global-this
   eslint-plugin-mozilla/reject-globalThis-modification
   eslint-plugin-mozilla/reject-importGlobalProperties
   eslint-plugin-mozilla/reject-lazy-imports-into-globals
   eslint-plugin-mozilla/reject-mixing-eager-and-lazy
   eslint-plugin-mozilla/reject-multiple-getters-calls
   eslint-plugin-mozilla/reject-relative-requires
   eslint-plugin-mozilla/reject-requires-await
   eslint-plugin-mozilla/reject-scriptableunicodeconverter
   eslint-plugin-mozilla/reject-some-requires
   eslint-plugin-mozilla/reject-top-level-await
   eslint-plugin-mozilla/reject-import-system-module-from-non-system
   eslint-plugin-mozilla/use-cc-etc
   eslint-plugin-mozilla/use-chromeutils-generateqi
   eslint-plugin-mozilla/use-chromeutils-import
   eslint-plugin-mozilla/use-default-preference-values
   eslint-plugin-mozilla/use-includes-instead-of-indexOf
   eslint-plugin-mozilla/use-isInstance
   eslint-plugin-mozilla/use-ownerGlobal
   eslint-plugin-mozilla/use-returnValue
   eslint-plugin-mozilla/use-services
   eslint-plugin-mozilla/use-static-import
   eslint-plugin-mozilla/valid-ci-uses
   eslint-plugin-mozilla/valid-lazy
   eslint-plugin-mozilla/valid-services
   eslint-plugin-mozilla/valid-services-property
   eslint-plugin-mozilla/var-only-at-top-level

Tests
=====

The tests for eslint-plugin-mozilla are run via `mochajs`_ on top of node. Most
of the tests use the `ESLint Rule Unit Test framework`_.

.. _mochajs: https://mochajs.org/
.. _ESLint Rule Unit Test Framework: http://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests

Running Tests
-------------

The tests for eslint-plugin-mozilla are run via `mochajs`_ on top of node. Most
of the tests use the `ESLint Rule Unit Test framework`_.

The rules have some self tests, these can be run via:

.. code-block:: shell

   $ cd tools/lint/eslint/eslint-plugin-mozilla
   $ npm install
   $ npm run test

Disabling tests
---------------

In the unlikely event of needing to disable a test, currently the only way is
by commenting-out. Please file a bug if you have to do this. Bugs should be filed
in the *Testing* product under *Lint*.

.. _mochajs: https://mochajs.org/
.. _ESLint Rule Unit Test Framework: http://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests
