devtools/.eslintrc.js

   1 "use strict";
   2
   3 module.exports = {
   4   "plugins": [
   5     "react"
   6   ],
   7   "globals": {
   8     "exports": true,
   9     "isWorker": true,
  10     "isReplaying": true,
  11     "loader": true,
  12     "module": true,
  13     "reportError": true,
  14     "require": true,
  15   },
  16   "overrides": [{
  17     "files": [
  18       "client/framework/**",
  19     ],
  20     "rules": {
  21       "no-return-assign": "off",
  22     }
  23   }, {
  24     "files": [
  25       "client/scratchpad/scratchpad-manager.jsm",
  26       "client/scratchpad/scratchpad.js",
  27       "client/shared/*.jsm",
  28     ],
  29     "rules": {
  30       "camelcase": "off",
  31     }
  32   }, {
  33     "files": [
  34       "client/framework/**",
  35       "client/scratchpad/**",
  36       "client/shared/*.jsm",
  37       "client/shared/widgets/*.jsm",
  38       "client/webide/**",
  39     ],
  40     "rules": {
  41       "consistent-return": "off",
  42     }
  43   }, {
  44     "files": [
  45       "client/framework/**",
  46       "client/scratchpad/**",
  47       "client/webide/**",
  48     ],
  49     "rules": {
  50       "max-nested-callbacks": "off",
  51     }
  52   }, {
  53     "files": [
  54       "client/scratchpad/test/browser_scratchpad_inspect.js",
  55       "client/scratchpad/test/browser_scratchpad_inspect_primitives.js",
  56     ],
  57     "rules": {
  58       "no-labels": "off",
  59     }
  60   }, {
  61     "files": [
  62       "client/framework/**",
  63       "client/scratchpad/**",
  64       "client/shared/*.jsm",
  65       "client/shared/widgets/*.jsm",
  66       "client/webide/**",
  67     ],
  68     "rules": {
  69       "mozilla/no-aArgs": "off",
  70     }
  71   }, {
  72     "files": [
  73       "client/framework/test/**",
  74       "client/scratchpad/**",
  75     ],
  76     "rules": {
  77       "mozilla/var-only-at-top-level": "off",
  78     }
  79   }, {
  80     "files": [
  81       "client/framework/**",
  82       "client/scratchpad/**",
  83       "client/shared/widgets/*.jsm",
  84       "client/webide/**",
  85     ],
  86     "rules": {
  87       "no-shadow": "off",
  88     }
  89   }, {
  90     "files": [
  91       "client/framework/**",
  92       "client/scratchpad/**",
  93       "client/webide/**",
  94     ],
  95     "rules": {
  96       "strict": "off",
  97     }
  98   }, {
  99     // For all head*.js files, turn off no-unused-vars at a global level
 100     "files": [
 101       "**/head*.js",
 102     ],
 103     "rules": {
 104       "no-unused-vars": ["error", {"args": "none", "vars": "local"}],
 105     }
 106   }, {
 107     // Cu, Cc etc... are not available in most devtools modules loaded by require.
 108     "files": [
 109       "**"
 110     ],
 111     "excludedFiles": [
 112       // Enable the rule on JSM, test head files and some specific files.
 113       "**/*.jsm",
 114       "**/test/**/head.js",
 115       "**/test/**/shared-head.js",
 116       "client/debugger/test/mochitest/code_frame-script.js",
 117       "client/inspector/animation-old/test/doc_frame_script.js",
 118       "client/inspector/animation/test/doc_frame_script.js",
 119       "client/inspector/rules/test/doc_frame_script.js",
 120       "client/inspector/shared/test/doc_frame_script.js",
 121       "client/jsonview/converter-observer.js",
 122       "client/jsonview/test/doc_frame_script.js",
 123       "client/responsive.html/browser/content.js",
 124       "client/shared/browser-loader.js",
 125       "server/actors/webconsole/content-process-forward.js",
 126       "server/actors/worker/service-worker-process.js",
 127       "server/startup/content-process.js",
 128       "server/startup/frame.js",
 129       "shared/base-loader.js",
 130       "shared/worker/loader.js",
 131       "startup/aboutdebugging-registration.js",
 132       "startup/aboutdevtools/aboutdevtools-registration.js",
 133       "startup/aboutdevtoolstoolbox-registration.js",
 134       "startup/devtools-startup.js",
 135     ],
 136     "rules": {
 137       "mozilla/no-define-cc-etc": "off",
 138     }
 139   }, ],
 140   "rules": {
 141     // These are the rules that have been configured so far to match the
 142     // devtools coding style.
 143
 144     // Rules from the mozilla plugin
 145     "mozilla/no-aArgs": "error",
 146     // See bug 1224289.
 147     "mozilla/reject-importGlobalProperties": ["error", "everything"],
 148     // devtools/shared/platform is special; see the README.md in that
 149     // directory for details.  We reject requires using explicit
 150     // subdirectories of this directory.
 151     "mozilla/reject-some-requires": ["error", "^devtools/shared/platform/(chome|content)/"],
 152     "mozilla/var-only-at-top-level": "error",
 153     "mozilla/use-chromeutils-import": ["error", {allowCu: true}],
 154
 155     // Rules from the React plugin
 156     "react/display-name": "error",
 157     "react/no-danger": "error",
 158     "react/no-did-mount-set-state": "error",
 159     "react/no-did-update-set-state": "error",
 160     "react/no-direct-mutation-state": "error",
 161     "react/no-unknown-property": "error",
 162     "react/prefer-es6-class": ["off", "always"],
 163     "react/prop-types": "error",
 164     "react/sort-comp": ["error", {
 165       order: [
 166         "static-methods",
 167         "lifecycle",
 168         "everything-else",
 169         "render"
 170       ],
 171       groups: {
 172         lifecycle: [
 173           "displayName",
 174           "propTypes",
 175           "contextTypes",
 176           "childContextTypes",
 177           "mixins",
 178           "statics",
 179           "defaultProps",
 180           "constructor",
 181           "getDefaultProps",
 182           "getInitialState",
 183           "state",
 184           "getChildContext",
 185           "componentWillMount",
 186           "componentDidMount",
 187           "componentWillReceiveProps",
 188           "shouldComponentUpdate",
 189           "componentWillUpdate",
 190           "componentDidUpdate",
 191           "componentWillUnmount"
 192         ]
 193       }
 194     }],
 195
 196     // Disallow using variables outside the blocks they are defined (especially
 197     // since only let and const are used, see "no-var").
 198     "block-scoped-var": "error",
 199     // Require camel case names
 200     "camelcase": ["error", { "properties": "never" }],
 201     // Warn about cyclomatic complexity in functions.
 202     // 20 is ESLint's default, and we want to keep it this way to prevent new highly
 203     // complex functions from being introduced. However, because Mozilla's eslintrc has
 204     // some other value defined, we need to override it here. See bug 1553449 for more
 205     // information on complex DevTools functions that are currently excluded.
 206     "complexity": ["error", 20],
 207     // Don't warn for inconsistent naming when capturing this (not so important
 208     // with auto-binding fat arrow functions).
 209     "consistent-this": "off",
 210     // Don't require a default case in switch statements. Avoid being forced to
 211     // add a bogus default when you know all possible cases are handled.
 212     "default-case": "off",
 213     // Allow using == instead of ===, in the interest of landing something since
 214     // the devtools codebase is split on convention here.
 215     "eqeqeq": "off",
 216     // Don't require function expressions to have a name.
 217     // This makes the code more verbose and hard to read. Our engine already
 218     // does a fantastic job assigning a name to the function, which includes
 219     // the enclosing function name, and worst case you have a line number that
 220     // you can just look up.
 221     "func-names": "off",
 222     // Allow use of function declarations and expressions.
 223     "func-style": "off",
 224     // Only useful in a node environment.
 225     "handle-callback-err": "off",
 226     // Maximum depth callbacks can be nested.
 227     "max-nested-callbacks": ["error", 3],
 228     // Don't limit the number of parameters that can be used in a function.
 229     "max-params": "off",
 230     // Don't limit the maximum number of statement allowed in a function. We
 231     // already have the complexity rule that's a better measurement.
 232     "max-statements": "off",
 233     // Require a capital letter for constructors, only check if all new
 234     // operators are followed by a capital letter. Don't warn when capitalized
 235     // functions are used without the new operator.
 236     "new-cap": ["error", {"capIsNew": false}],
 237     // Allow use of bitwise operators.
 238     "no-bitwise": "off",
 239     // Allow using the console API.
 240     "no-console": "off",
 241     // Allow using constant expressions in conditions like while (true)
 242     "no-constant-condition": "off",
 243     // Allow use of the continue statement.
 244     "no-continue": "off",
 245     // Allow division operators explicitly at beginning of regular expression.
 246     "no-div-regex": "off",
 247     // Disallow empty statements. This will report an error for:
 248     // try { something(); } catch (e) {}
 249     // but will not report it for:
 250     // try { something(); } catch (e) { /* Silencing the error because ...*/ }
 251     // which is a valid use case.
 252     "no-empty": "error",
 253     // Disallow adding to native types
 254     "no-extend-native": "error",
 255     // Disallow fallthrough of case statements, except if there is a comment.
 256     "no-fallthrough": "error",
 257     // Allow comments inline after code.
 258     "no-inline-comments": "off",
 259     // Allow mixing regular variable and require declarations (not a node env).
 260     "no-mixed-requires": "off",
 261     // Disallow use of multiline strings (use template strings instead).
 262     "no-multi-str": "error",
 263     // Allow use of new operator with the require function.
 264     "no-new-require": "off",
 265     // Allow reassignment of function parameters.
 266     "no-param-reassign": "off",
 267     // Allow string concatenation with __dirname and __filename (not a node env).
 268     "no-path-concat": "off",
 269     // Allow use of unary operators, ++ and --.
 270     "no-plusplus": "off",
 271     // Allow using process.env (not a node environment).
 272     "no-process-env": "off",
 273     // Allow using process.exit (not a node environment).
 274     "no-process-exit": "off",
 275     // Disallow usage of __proto__ property.
 276     "no-proto": "error",
 277     // Disallow multiple spaces in a regular expression literal.
 278     "no-regex-spaces": "off",
 279     // Don't restrict usage of specified node modules (not a node environment).
 280     "no-restricted-modules": "off",
 281     // Prevent using some properties
 282     "no-restricted-properties": ["error", {
 283       "property": "setupInParent",
 284       "message": "avoid child/parent communication with setupInParent"
 285     }],
 286     // Disallow use of assignment in return statement. It is preferable for a
 287     // single line of code to have only one easily predictable effect.
 288     "no-return-assign": "error",
 289     // Allow use of javascript: urls.
 290     "no-script-url": "off",
 291     // Warn about declaration of variables already declared in the outer scope.
 292     // This isn't an error because it sometimes is useful to use the same name
 293     // in a small helper function rather than having to come up with another
 294     // random name.
 295     // Still, making this a warning can help people avoid being confused.
 296     "no-shadow": "error",
 297     // Allow use of synchronous methods (not a node environment).
 298     "no-sync": "off",
 299     // Allow the use of ternary operators.
 300     "no-ternary": "off",
 301     // Allow dangling underscores in identifiers (for privates).
 302     "no-underscore-dangle": "off",
 303     // Allow use of undefined variable.
 304     "no-undefined": "off",
 305     // Disallow global and local variables that aren't used, but allow unused
 306     // function arguments.
 307     "no-unused-vars": ["error", {"args": "none", "vars": "all"}],
 308     // Allow using variables before they are defined.
 309     "no-use-before-define": "off",
 310     // We use var-only-at-top-level instead of no-var as we allow top level
 311     // vars.
 312     "no-var": "off",
 313     // Allow using TODO/FIXME comments.
 314     "no-warning-comments": "off",
 315     // Don't require method and property shorthand syntax for object literals.
 316     // We use this in the code a lot, but not consistently, and this seems more
 317     // like something to check at code review time.
 318     "object-shorthand": "off",
 319     // Allow more than one variable declaration per function.
 320     "one-var": "off",
 321     // Enforce using `let` only when variables are reassigned.
 322     "prefer-const": ["error", { "destructuring": "all" }],
 323     // Require use of the second argument for parseInt().
 324     "radix": "error",
 325     // Don't require to sort variables within the same declaration block.
 326     // Anyway, one-var is disabled.
 327     "sort-vars": "off",
 328     // Require "use strict" to be defined globally in the script.
 329     "strict": ["error", "global"],
 330     // Warn about invalid JSDoc comments.
 331     // Disabled for now because of https://github.com/eslint/eslint/issues/2270
 332     // The rule fails on some jsdoc comments like in:
 333     // devtools/client/webconsole/old/console-output.js
 334     "valid-jsdoc": "off",
 335     // Allow vars to be declared anywhere in the scope.
 336     "vars-on-top": "off",
 337     // Disallow Yoda conditions (where literal value comes first).
 338     "yoda": "error",
 339
 340     // And these are the rules that haven't been discussed so far, and that are
 341     // disabled for now until we introduce them, one at a time.
 342
 343     // Require for-in loops to have an if statement.
 344     "guard-for-in": "off",
 345     // disallow the use of alert, confirm, and prompt
 346     "no-alert": "off",
 347     // disallow comparisons to null without a type-checking operator
 348     "no-eq-null": "off",
 349     // disallow overwriting functions written as function declarations
 350     "no-func-assign": "off",
 351     // disallow function or variable declarations in nested blocks
 352     "no-inner-declarations": "off",
 353     // disallow invalid regular expression strings in the RegExp constructor
 354     "no-invalid-regexp": "off",
 355     // disallow irregular whitespace outside of strings and comments
 356     "no-irregular-whitespace": "off",
 357     // disallow usage of __iterator__ property
 358     "no-iterator": "off",
 359     // disallow labels that share a name with a variable
 360     "no-label-var": "off",
 361     // disallow unnecessary nested blocks
 362     "no-lone-blocks": "off",
 363     // disallow creation of functions within loops
 364     "no-loop-func": "off",
 365     // disallow use of new operator when not part of the assignment or
 366     // comparison
 367     "no-new": "off",
 368     // disallow use of new operator for Function object
 369     "no-new-func": "off",
 370     // disallow use of the Object constructor
 371     "no-new-object": "off",
 372     // disallows creating new instances of String,Number, and Boolean
 373     "no-new-wrappers": "off",
 374     // disallow the use of object properties of the global object (Math and
 375     // JSON) as functions
 376     "no-obj-calls": "off",
 377     // disallow use of octal escape sequences in string literals, such as
 378     // var foo = "Copyright \251";
 379     "no-octal-escape": "off",
 380     // disallow use of undefined when initializing variables
 381     "no-undef-init": "off",
 382     // disallow usage of expressions in statement position
 383     "no-unused-expressions": "off",
 384     // disallow unnecessary concatenation of literals or template literals
 385     "no-useless-concat": "off",
 386     // disallow use of void operator
 387     "no-void": "off",
 388     // require assignment operator shorthand where possible or prohibit it
 389     // entirely
 390     "operator-assignment": "off",
 391   }
 392 };