Adding upstream version 86.0.1.upstream/86.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

6 files changed, 491 insertions, 0 deletions

diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/.eslintrc.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/.eslintrc.js
new file mode 100644
index 0000000000..76df4134f5
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/.eslintrc.js
@@ -0,0 +1,8 @@
+"use strict";
+
+module.exports = {
+  rules: {
+    // Require object keys to be sorted.
+    "sort-keys": "error",
+  },
+};
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/browser-test.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/browser-test.js
new file mode 100644
index 0000000000..596815c850
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/browser-test.js
@@ -0,0 +1,64 @@
+// Parent config file for all browser-chrome files.
+"use strict";
+
+module.exports = {
+  env: {
+    browser: true,
+    "mozilla/browser-window": true,
+    "mozilla/simpletest": true,
+    // "node": true
+  },
+
+  // All globals made available in the test environment.
+  globals: {
+    // `$` is defined in SimpleTest.js
+    $: false,
+    Assert: false,
+    BrowserTestUtils: false,
+    ContentTask: false,
+    ContentTaskUtils: false,
+    EventUtils: false,
+    PromiseDebugging: false,
+    SpecialPowers: false,
+    TestUtils: false,
+    XPCNativeWrapper: false,
+    addLoadEvent: false,
+    add_task: false,
+    content: false,
+    executeSoon: false,
+    expectUncaughtException: false,
+    export_assertions: false,
+    extractJarToTmp: false,
+    finish: false,
+    gTestPath: false,
+    getChromeDir: false,
+    getJar: false,
+    getResolvedURI: false,
+    getRootDirectory: false,
+    getTestFilePath: false,
+    ignoreAllUncaughtExceptions: false,
+    info: false,
+    is: false,
+    isnot: false,
+    ok: false,
+    record: false,
+    registerCleanupFunction: false,
+    requestLongerTimeout: false,
+    setExpectedFailuresForSelfTest: false,
+    todo: false,
+    todo_is: false,
+    todo_isnot: false,
+    waitForClipboard: false,
+    waitForExplicitFinish: false,
+    waitForFocus: false,
+  },
+
+  plugins: ["mozilla"],
+
+  rules: {
+    "mozilla/import-content-task-globals": "error",
+    "mozilla/import-headjs-globals": "error",
+    "mozilla/mark-test-function-used": "error",
+    "mozilla/no-arbitrary-setTimeout": "error",
+  },
+};
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/chrome-test.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/chrome-test.js
new file mode 100644
index 0000000000..d097f8ebdf
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/chrome-test.js
@@ -0,0 +1,40 @@
+// Parent config file for all mochitest files.
+"use strict";
+
+module.exports = {
+  env: {
+    browser: true,
+    "mozilla/browser-window": true,
+  },
+
+  // All globals made available in the test environment.
+  globals: {
+    // SpecialPowers is injected into the window object via SimpleTest.js
+    SpecialPowers: false,
+    extractJarToTmp: false,
+    getChromeDir: false,
+    getJar: false,
+    getResolvedURI: false,
+    getRootDirectory: false,
+  },
+
+  overrides: [
+    {
+      env: {
+        // Ideally we wouldn't be using the simpletest env here, but our uses of
+        // js files mean we pick up everything from the global scope, which could
+        // be any one of a number of html files. So we just allow the basics...
+        "mozilla/simpletest": true,
+      },
+      files: ["*.js"],
+    },
+  ],
+
+  plugins: ["mozilla"],
+
+  rules: {
+    "mozilla/import-content-task-globals": "error",
+    "mozilla/import-headjs-globals": "error",
+    "mozilla/mark-test-function-used": "error",
+  },
+};
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/mochitest-test.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/mochitest-test.js
new file mode 100644
index 0000000000..af71955a4b
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/mochitest-test.js
@@ -0,0 +1,39 @@
+// Parent config file for all mochitest files.
+"use strict";
+
+module.exports = {
+  env: {
+    browser: true,
+  },
+
+  // All globals made available in the test environment.
+  globals: {
+    // SpecialPowers is injected into the window object via SimpleTest.js
+    SpecialPowers: false,
+    XPCNativeWrapper: false,
+  },
+
+  overrides: [
+    {
+      env: {
+        // Ideally we wouldn't be using the simpletest env here, but our uses of
+        // js files mean we pick up everything from the global scope, which could
+        // be any one of a number of html files. So we just allow the basics...
+        "mozilla/simpletest": true,
+      },
+      files: ["*.js"],
+    },
+  ],
+
+  plugins: ["mozilla"],
+
+  rules: {
+    "mozilla/import-content-task-globals": "error",
+    "mozilla/import-headjs-globals": "error",
+    "mozilla/mark-test-function-used": "error",
+    // Turn off no-define-cc-etc for mochitests as these don't have Cc etc defined in the
+    // global scope.
+    "mozilla/no-define-cc-etc": "off",
+    "no-shadow": "error",
+  },
+};
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/recommended.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/recommended.js
new file mode 100644
index 0000000000..72023fd0b9
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/recommended.js
@@ -0,0 +1,305 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+/**
+ * The configuration is based on eslint:recommended config. The details for all
+ * the ESLint rules, and which ones are in the recommended configuration can
+ * be found here:
+ *
+ * https://eslint.org/docs/rules/
+ */
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    "mozilla/privileged": true,
+  },
+
+  extends: ["eslint:recommended", "plugin:prettier/recommended"],
+
+  globals: {
+    Cc: false,
+    // Specific to Firefox (Chrome code only).
+    ChromeUtils: false,
+    Ci: false,
+    Components: false,
+    Cr: false,
+    Cu: false,
+    Debugger: false,
+    InstallTrigger: false,
+    // Specific to Firefox
+    // https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/InternalError
+    InternalError: true,
+    Intl: false,
+    SharedArrayBuffer: false,
+    StopIteration: false,
+    dump: true,
+    // Override the "browser" env definition of "location" to allow writing as it
+    // is a writeable property.
+    // See https://bugzilla.mozilla.org/show_bug.cgi?id=1509270#c1 for more information.
+    location: true,
+    openDialog: false,
+    saveStack: false,
+    sizeToContent: false,
+    // Specific to Firefox
+    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/uneval
+    uneval: false,
+  },
+
+  overrides: [
+    {
+      // We don't have the general browser environment for jsm files, but we do
+      // have our own special environments for them.
+      env: {
+        browser: false,
+        "mozilla/jsm": true,
+      },
+      files: ["**/*.jsm", "**/*.jsm.js"],
+      rules: {
+        "mozilla/mark-exported-symbols-as-used": "error",
+        // TODO: Bug 1575506 turn `builtinGlobals` on here.
+        // We can enable builtinGlobals for jsms due to their scopes.
+        "no-redeclare": ["error", { builtinGlobals: false }],
+        // JSM modules are far easier to check for no-unused-vars on a global scope,
+        // than our content files. Hence we turn that on here.
+        "no-unused-vars": [
+          "error",
+          {
+            args: "none",
+            vars: "all",
+          },
+        ],
+      },
+    },
+  ],
+
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+
+  // When adding items to this file please check for effects on sub-directories.
+  plugins: ["html", "fetch-options", "no-unsanitized"],
+
+  // When adding items to this file please check for effects on all of toolkit
+  // and browser
+  rules: {
+    // Warn about cyclomatic complexity in functions.
+    // XXX Get this down to 20?
+    complexity: ["error", 34],
+
+    // Functions must always return something or nothing
+    "consistent-return": "error",
+
+    // XXX This rule line should be removed to enable it. See bug 1487642.
+    // Require super() calls in constructors
+    "constructor-super": "off",
+
+    // Require braces around blocks that start a new line
+    curly: ["error", "all"],
+
+    // Encourage the use of dot notation whenever possible.
+    "dot-notation": "error",
+
+    // XXX This rule should be enabled, see Bug 1557040
+    // No credentials submitted with fetch calls
+    "fetch-options/no-fetch-credentials": "off",
+
+    // XXX This rule line should be removed to enable it. See bug 1487642.
+    // Enforce return statements in getters
+    "getter-return": "off",
+
+    // Don't enforce the maximum depth that blocks can be nested. The complexity
+    // rule is a better rule to check this.
+    "max-depth": "off",
+
+    // Maximum depth callbacks can be nested.
+    "max-nested-callbacks": ["error", 10],
+
+    "mozilla/avoid-removeChild": "error",
+    "mozilla/consistent-if-bracing": "error",
+    "mozilla/import-browser-window-globals": "error",
+    "mozilla/import-globals": "error",
+    "mozilla/no-compare-against-boolean-literals": "error",
+    "mozilla/no-define-cc-etc": "error",
+    "mozilla/no-throw-cr-literal": "error",
+    "mozilla/no-useless-parameters": "error",
+    "mozilla/no-useless-removeEventListener": "error",
+    "mozilla/prefer-boolean-length-check": "error",
+    "mozilla/prefer-formatValues": "error",
+    "mozilla/reject-chromeutils-import-null": "error",
+    "mozilla/reject-importGlobalProperties": ["error", "allownonwebidl"],
+    "mozilla/rejects-requires-await": "error",
+    "mozilla/use-cc-etc": "error",
+    "mozilla/use-chromeutils-generateqi": "error",
+    "mozilla/use-chromeutils-import": "error",
+    "mozilla/use-default-preference-values": "error",
+    "mozilla/use-includes-instead-of-indexOf": "error",
+    "mozilla/use-ownerGlobal": "error",
+    "mozilla/use-returnValue": "error",
+    "mozilla/use-services": "error",
+
+    // Use [] instead of Array()
+    "no-array-constructor": "error",
+
+    // Disallow use of arguments.caller or arguments.callee.
+    "no-caller": "error",
+
+    // XXX Bug 1487642 - decide if we want to enable this or not.
+    // Disallow lexical declarations in case clauses
+    "no-case-declarations": "off",
+
+    // XXX Bug 1487642 - decide if we want to enable this or not.
+    // Disallow the use of console
+    "no-console": "off",
+
+    // XXX Bug 1487642 - decide if we want to enable this or not.
+    // Disallow constant expressions in conditions
+    "no-constant-condition": "off",
+
+    // No duplicate keys in object declarations
+    "no-dupe-keys": "error",
+
+    // If an if block ends with a return no need for an else block
+    "no-else-return": "error",
+
+    // No empty statements
+    "no-empty": ["error", { allowEmptyCatch: true }],
+
+    // Disallow eval and setInteral/setTimeout with strings
+    "no-eval": "error",
+
+    // Disallow unnecessary calls to .bind()
+    "no-extra-bind": "error",
+
+    // Disallow fallthrough of case statements
+    "no-fallthrough": [
+      "error",
+      {
+        // The eslint rule doesn't allow for case-insensitive regex option.
+        // The following pattern allows for a dash between "fall through" as
+        // well as alternate spelling of "fall thru". The pattern also allows
+        // for an optional "s" at the end of "fall" ("falls through").
+        commentPattern:
+          "[Ff][Aa][Ll][Ll][Ss]?[\\s-]?([Tt][Hh][Rr][Oo][Uu][Gg][Hh]|[Tt][Hh][Rr][Uu])",
+      },
+    ],
+
+    // Disallow assignments to native objects or read-only global variables
+    "no-global-assign": "error",
+
+    // Disallow eval and setInteral/setTimeout with strings
+    "no-implied-eval": "error",
+
+    // This has been superseded since we're using ES6.
+    // Disallow variable or function declarations in nested blocks
+    "no-inner-declarations": "off",
+
+    // Disallow the use of the __iterator__ property
+    "no-iterator": "error",
+
+    // No labels
+    "no-labels": "error",
+
+    // Disallow unnecessary nested blocks
+    "no-lone-blocks": "error",
+
+    // No single if block inside an else block
+    "no-lonely-if": "error",
+
+    // Nested ternary statements are confusing
+    "no-nested-ternary": "error",
+
+    // Use {} instead of new Object()
+    "no-new-object": "error",
+
+    // Disallow use of new wrappers
+    "no-new-wrappers": "error",
+
+    // We don't want this, see bug 1551829
+    "no-prototype-builtins": "off",
+
+    // Disable builtinGlobals for no-redeclare as this conflicts with our
+    // globals declarations especially for browser window.
+    "no-redeclare": ["error", { builtinGlobals: false }],
+
+    // Disallow use of event global.
+    "no-restricted-globals": ["error", "event"],
+
+    // Disallows unnecessary `return await ...`.
+    "no-return-await": "error",
+
+    // No unnecessary comparisons
+    "no-self-compare": "error",
+
+    // No comma sequenced statements
+    "no-sequences": "error",
+
+    // No declaring variables from an outer scope
+    // "no-shadow": "error",
+
+    // No declaring variables that hide things like arguments
+    "no-shadow-restricted-names": "error",
+
+    // Disallow throwing literals (eg. throw "error" instead of
+    // throw new Error("error")).
+    "no-throw-literal": "error",
+
+    // Disallow the use of Boolean literals in conditional expressions.
+    "no-unneeded-ternary": "error",
+
+    // No unsanitized use of innerHTML=, document.write() etc.
+    // cf. https://github.com/mozilla/eslint-plugin-no-unsanitized#rule-details
+    "no-unsanitized/method": "error",
+    "no-unsanitized/property": "error",
+
+    // No declaring variables that are never used
+    "no-unused-vars": [
+      "error",
+      {
+        args: "none",
+        vars: "local",
+      },
+    ],
+
+    // No using variables before defined
+    // "no-use-before-define": ["error", "nofunc"],
+
+    // Disallow unnecessary .call() and .apply()
+    "no-useless-call": "error",
+
+    // Don't concatenate string literals together (unless they span multiple
+    // lines)
+    "no-useless-concat": "error",
+
+    // XXX Bug 1487642 - decide if we want to enable this or not.
+    // Disallow unnecessary escape characters
+    "no-useless-escape": "off",
+
+    // Disallow redundant return statements
+    "no-useless-return": "error",
+
+    // No using with
+    "no-with": "error",
+
+    // Require object-literal shorthand with ES6 method syntax
+    "object-shorthand": ["error", "always", { avoidQuotes: true }],
+
+    // This generates too many false positives that are not easy to work around,
+    // and false positives seem to be inherent in the rule.
+    "require-atomic-updates": "off",
+
+    // XXX Bug 1487642 - decide if we want to enable this or not.
+    // Require generator functions to contain yield
+    "require-yield": "off",
+  },
+
+  // To avoid bad interactions of the html plugin with the xml preprocessor in
+  // eslint-plugin-mozilla, we turn off processing of the html plugin for .xml
+  // files.
+  settings: {
+    "html/xml-extensions": [".xhtml"],
+  },
+};
diff --git a/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/xpcshell-test.js b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/xpcshell-test.js
new file mode 100644
index 0000000000..4cff7fcdc3
--- /dev/null
+++ b/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/xpcshell-test.js
@@ -0,0 +1,35 @@
+// Parent config file for all xpcshell files.
+"use strict";
+
+module.exports = {
+  env: {
+    "mozilla/xpcshell": true,
+  },
+
+  overrides: [
+    {
+      // If it is a head file, we turn off global unused variable checks, as it
+      // would require searching the other test files to know if they are used or not.
+      // This would be expensive and slow, and it isn't worth it for head files.
+      // We could get developers to declare as exported, but that doesn't seem worth it.
+      files: "head*.js",
+      rules: {
+        "no-unused-vars": [
+          "error",
+          {
+            args: "none",
+            vars: "local",
+          },
+        ],
+      },
+    },
+  ],
+
+  rules: {
+    "mozilla/import-headjs-globals": "error",
+    "mozilla/mark-test-function-used": "error",
+    "mozilla/no-arbitrary-setTimeout": "error",
+    "mozilla/no-useless-run-test": "error",
+    "no-shadow": "error",
+  },
+};