devtools/.eslintrc.js

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 "use strict";
   6
   7 module.exports = {
   8   plugins: ["react"],
   9   globals: {
  10     exports: true,
  11     isWorker: true,
  12     loader: true,
  13     module: true,
  14     require: true,
  15     DebuggerNotificationObserver: true,
  16   },
  17   overrides: [
  18     {
  19       files: ["client/framework/**"],
  20       rules: {
  21         "no-return-assign": "off",
  22       },
  23     },
  24     {
  25       files: [
  26         // Allow non-camelcase so that run_test doesn't produce a warning.
  27         "**/test*/**/*",
  28       ],
  29       rules: {
  30         camelcase: "off",
  31       },
  32     },
  33     {
  34       files: ["client/framework/**"],
  35       rules: {
  36         "max-nested-callbacks": "off",
  37       },
  38     },
  39     {
  40       files: ["client/framework/**", "shared/webconsole/test/chrome/*.html"],
  41       rules: {
  42         "mozilla/no-aArgs": "off",
  43       },
  44     },
  45     {
  46       files: ["client/framework/test/**"],
  47       rules: {
  48         "mozilla/var-only-at-top-level": "off",
  49       },
  50     },
  51     {
  52       files: ["client/framework/**"],
  53       rules: {
  54         "no-shadow": "off",
  55       },
  56     },
  57     {
  58       files: ["client/framework/**"],
  59       rules: {
  60         strict: "off",
  61       },
  62     },
  63     {
  64       // For all head*.js files, turn off no-unused-vars at a global level
  65       files: ["**/head*.js"],
  66       rules: {
  67         "no-unused-vars": ["error", { args: "none", vars: "local" }],
  68       },
  69     },
  70     {
  71       // For all server and shared files, prevent requiring devtools/client
  72       // modules.
  73       files: ["server/**", "shared/**"],
  74       rules: {
  75         "mozilla/reject-some-requires": [
  76           "error",
  77           "^(resource://)?devtools/client",
  78         ],
  79       },
  80       excludedFiles: [
  81         // Tests can always import anything.
  82         "**/test*/**/*",
  83       ],
  84     },
  85     {
  86       // Cu, Cc etc... are not available in most devtools modules loaded by require.
  87       files: ["**"],
  88       excludedFiles: [
  89         // Enable the rule on JSM, test head files and some specific files.
  90         "**/*.jsm",
  91         "**/*.sjs",
  92         "**/test/**/head.js",
  93         "**/test/**/shared-head.js",
  94         "client/debugger/test/mochitest/code_frame-script.js",
  95         "client/responsive.html/browser/content.js",
  96         "server/startup/content-process.js",
  97         "server/startup/frame.js",
  98         "shared/loader/base-loader.sys.mjs",
  99         "shared/loader/browser-loader.js",
 100         "shared/loader/worker-loader.js",
 101         "startup/aboutdebugging-registration.js",
 102         "startup/aboutdevtoolstoolbox-registration.js",
 103         "startup/devtools-startup.js",
 104       ],
 105       rules: {
 106         "mozilla/no-define-cc-etc": "off",
 107       },
 108     },
 109     {
 110       // All DevTools files should avoid relative paths.
 111       files: ["**"],
 112       excludedFiles: [
 113         // Debugger modules have a custom bundling logic which relies on relative
 114         // paths.
 115         "client/debugger/src/**",
 116         // `client/shared/build` contains node helpers to build the debugger and
 117         // not devtools modules.
 118         "client/shared/build/**",
 119       ],
 120       rules: {
 121         "mozilla/reject-relative-requires": "error",
 122       },
 123     },
 124     {
 125       // These tests use old React. We should accept deprecated API usages
 126       files: [
 127         "client/inspector/markup/test/doc_markup_events_react_development_15.4.1.html",
 128         "client/inspector/markup/test/doc_markup_events_react_development_15.4.1_jsx.html",
 129         "client/inspector/markup/test/doc_markup_events_react_production_15.3.1.html",
 130         "client/inspector/markup/test/doc_markup_events_react_production_15.3.1_jsx.html",
 131       ],
 132       rules: {
 133         "react/no-deprecated": "off",
 134       },
 135     },
 136     {
 137       // These files are used in both browser and node environments,
 138       files: [
 139         "shared/compatibility/constants.js",
 140         "shared/compatibility/helpers.js",
 141       ],
 142       env: {
 143         browser: false,
 144         "mozilla/privileged": false,
 145         "mozilla/specific": false,
 146       },
 147     },
 148     {
 149       // This file is only used in node environment.
 150       files: ["shared/compatibility/bin/update.js"],
 151       env: {
 152         browser: false,
 153         node: true,
 154         "mozilla/privileged": false,
 155         "mozilla/specific": false,
 156       },
 157     },
 158   ],
 159   rules: {
 160     // These are the rules that have been configured so far to match the
 161     // devtools coding style.
 162
 163     // Rules from the mozilla plugin
 164     "mozilla/balanced-observers": "error",
 165     "mozilla/no-aArgs": "error",
 166     // See bug 1224289.
 167     "mozilla/reject-importGlobalProperties": ["error", "everything"],
 168     "mozilla/var-only-at-top-level": "error",
 169
 170     // Rules from the React plugin
 171     "react/display-name": "error",
 172     "react/no-danger": "error",
 173     "react/no-deprecated": "error",
 174     "react/no-did-mount-set-state": "error",
 175     "react/no-did-update-set-state": "error",
 176     "react/no-direct-mutation-state": "error",
 177     "react/no-unknown-property": "error",
 178     "react/prefer-es6-class": ["off", "always"],
 179     "react/prop-types": "error",
 180     "react/sort-comp": [
 181       "error",
 182       {
 183         order: ["static-methods", "lifecycle", "everything-else", "render"],
 184         groups: {
 185           lifecycle: [
 186             "displayName",
 187             "propTypes",
 188             "contextTypes",
 189             "childContextTypes",
 190             "mixins",
 191             "statics",
 192             "defaultProps",
 193             "constructor",
 194             "getDefaultProps",
 195             "getInitialState",
 196             "state",
 197             "getChildContext",
 198             "UNSAFE_componentWillMount",
 199             "componentDidMount",
 200             "UNSAFE_componentWillReceiveProps",
 201             "shouldComponentUpdate",
 202             "UNSAFE_componentWillUpdate",
 203             "componentDidUpdate",
 204             "componentWillUnmount",
 205           ],
 206         },
 207       },
 208     ],
 209
 210     // Disallow using variables outside the blocks they are defined (especially
 211     // since only let and const are used, see "no-var").
 212     "block-scoped-var": "error",
 213     // Require camel case names
 214     camelcase: ["error", { properties: "never" }],
 215     // Warn about cyclomatic complexity in functions.
 216     // 20 is ESLint's default, and we want to keep it this way to prevent new highly
 217     // complex functions from being introduced. However, because Mozilla's eslintrc has
 218     // some other value defined, we need to override it here. See bug 1553449 for more
 219     // information on complex DevTools functions that are currently excluded.
 220     complexity: ["error", 20],
 221     // componentDidUnmount is not a real lifecycle method, use componentWillUnmount.
 222     "id-denylist": ["error", "componentDidUnmount"],
 223     // Maximum depth callbacks can be nested.
 224     "max-nested-callbacks": ["error", 3],
 225     // Require a capital letter for constructors, only check if all new
 226     // operators are followed by a capital letter. Don't warn when capitalized
 227     // functions are used without the new operator.
 228     "new-cap": ["error", { capIsNew: false }],
 229     // Disallow empty statements. This will report an error for:
 230     // try { something(); } catch (e) {}
 231     // but will not report it for:
 232     // try { something(); } catch (e) { /* Silencing the error because ...*/ }
 233     // which is a valid use case.
 234     "no-empty": "error",
 235     // Disallow adding to native types
 236     "no-extend-native": "error",
 237     // Disallow fallthrough of case statements, except if there is a comment.
 238     "no-fallthrough": "error",
 239     // Disallow use of multiline strings (use template strings instead).
 240     "no-multi-str": "error",
 241     // Disallow usage of __proto__ property.
 242     "no-proto": "error",
 243     // Disallow use of assignment in return statement. It is preferable for a
 244     // single line of code to have only one easily predictable effect.
 245     "no-return-assign": "error",
 246     // Warn about declaration of variables already declared in the outer scope.
 247     // This isn't an error because it sometimes is useful to use the same name
 248     // in a small helper function rather than having to come up with another
 249     // random name.
 250     // Still, making this a warning can help people avoid being confused.
 251     "no-shadow": "error",
 252     // Disallow global and local variables that aren't used, but allow unused
 253     // function arguments.
 254     "no-unused-vars": ["error", { args: "none", vars: "all" }],
 255     // Enforce using `let` only when variables are reassigned.
 256     "prefer-const": ["error", { destructuring: "all" }],
 257     // Require use of the second argument for parseInt().
 258     radix: "error",
 259     // Require "use strict" to be defined globally in the script.
 260     strict: ["error", "global"],
 261     // Disallow Yoda conditions (where literal value comes first).
 262     yoda: "error",
 263
 264     // And these are the rules that haven't been discussed so far, and that are
 265     // disabled for now until we introduce them, one at a time.
 266
 267     // disallow overwriting functions written as function declarations
 268     "no-func-assign": "off",
 269     // disallow unnecessary nested blocks
 270     "no-lone-blocks": "off",
 271     // disallow unnecessary concatenation of literals or template literals
 272     "no-useless-concat": "off",
 273     // This rule will match any function starting with `use` which aren't
 274     // necessarily in a React component. Also DevTools aren't using React hooks
 275     // so this sounds unecessary.
 276     "react-hooks/rules-of-hooks": "off",
 277   },
 278   settings: {
 279     react: {
 280       version: "16.8",
 281     },
 282   },
 283 };