From 2aa4a82499d4becd2284cdb482213d541b8804dd Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 28 Apr 2024 16:29:10 +0200 Subject: Adding upstream version 86.0.1. Signed-off-by: Daniel Baumann --- docs/code-quality/lint/linters/eslint.rst | 60 +++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/code-quality/lint/linters/eslint.rst (limited to 'docs/code-quality/lint/linters/eslint.rst') diff --git a/docs/code-quality/lint/linters/eslint.rst b/docs/code-quality/lint/linters/eslint.rst new file mode 100644 index 0000000000..5803163751 --- /dev/null +++ b/docs/code-quality/lint/linters/eslint.rst @@ -0,0 +1,60 @@ +ESLint +====== + +`ESLint `__ is a popular linter for JavaScript. + +Run Locally +----------- + +The mozlint integration of `ESLint `__ can be run using mach: + +.. parsed-literal:: + + $ mach lint --linter eslint + +Alternatively, omit the ``--linter eslint`` and run all configured linters, which will include +ESLint. + + +Configuration +------------- + +The ESLint mozilla-central integration uses a skip list to exclude certain directories from being +linted. This lives in ``topsrcdir/.eslintignore``. If you don't wish your directory to be linted, it +must be added here. + +The global configuration file lives in ``topsrcdir/.eslintrc``. This global configuration can be +overridden by including an ``.eslintrc`` in the appropriate subdirectory. For an overview of the +supported configuration, see `ESLint's documentation `__. + + +Autofix +------- + +The eslint linter provides a ``--fix`` option. It is based on the upstream option. + +Sources +------- + +* `Configuration (YAML) `_ +* `Source `_ + + +ESLint Plugin Mozilla +--------------------- + +In addition to default ESLint rules, there are several Mozilla-specific rules that are defined in +the :doc:`Mozilla ESLint Plugin `. + +ESLint Plugin SpiderMonkey JS +----------------------------- + +In addition to default ESLint rules, there is an extra processor for SpiderMonkey +code :doc:`Mozilla ESLint SpiderMonkey JS `. + + +.. toctree:: + :hidden: + + eslint-plugin-mozilla + eslint-plugin-spidermonkey-js -- cgit v1.2.3