eslint-plugin-mozilla.rst (1255B)
1 ===================== 2 Mozilla ESLint Plugin 3 ===================== 4 5 This is the documentation of Mozilla ESLint PLugin. 6 7 Rules 8 ===== 9 10 The plugin implements the following rules: 11 12 .. toctree:: 13 :maxdepth: 1 14 :glob: 15 16 eslint-plugin-mozilla/rules/* 17 18 Tests 19 ===== 20 21 The tests for eslint-plugin-mozilla are run via `mochajs`_ on top of node. Most 22 of the tests use the `ESLint Rule Unit Test framework`_. 23 24 .. _mochajs: https://mochajs.org/ 25 .. _ESLint Rule Unit Test Framework: http://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests 26 27 Running Tests 28 ------------- 29 30 The tests for eslint-plugin-mozilla are run via `mochajs`_ on top of node. Most 31 of the tests use the `ESLint Rule Unit Test framework`_. 32 33 The rules have some self tests, these can be run via: 34 35 .. code-block:: shell 36 37 $ cd tools/lint/eslint/eslint-plugin-mozilla 38 $ npm install 39 $ npm run test 40 41 Disabling tests 42 --------------- 43 44 In the unlikely event of needing to disable a test, currently the only way is 45 by commenting-out. Please file a bug if you have to do this. Bugs should be filed 46 in the *Testing* product under *Lint*. 47 48 .. _mochajs: https://mochajs.org/ 49 .. _ESLint Rule Unit Test Framework: http://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests