/* 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"; const path = require("path"); const xpcshellTestConfig = require("eslint-plugin-mozilla/lib/configs/xpcshell-test.js"); const browserTestConfig = require("eslint-plugin-mozilla/lib/configs/browser-test.js"); const fs = require("fs"); /** * Some configurations have overrides, which can't be specified within overrides, * so we need to remove them. */ function removeOverrides(config) { config = { ...config }; delete config.overrides; return config; } function readFile(path) { return fs .readFileSync(path, { encoding: "utf-8" }) .split("\n") .filter(p => p && !p.startsWith("#")) .map(p => p.replace(/^comm\//, "")); } const ignorePatterns = [ ...readFile(path.join(__dirname, "tools", "lint", "ThirdPartyPaths.txt")), ...readFile(path.join(__dirname, "tools", "lint", "Generated.txt")), ]; const xpcshellTestPaths = [ "**/test*/unit*/", "**/test*/xpcshell/", "chat/**/test*/", ]; const browserTestPaths = [ "**/test*/**/browser/", "mail/base/test/performance/", "mail/base/test/webextensions/", "mail/base/test/widgets/", "mail/test/static/", ]; module.exports = { settings: { "import/extensions": [".mjs"], // 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. "html/xml-extensions": [".xhtml"], }, // Ignore eslint configurations in parent directories. root: true, ignorePatterns, // We would like the same base rules as provided by // mozilla/tools/lint/eslint/eslint-plugin-mozilla/lib/configs/recommended.js extends: ["plugin:mozilla/recommended"], // When adding items to this file please check for effects on sub-directories. plugins: ["mozilla", "import"], rules: { complexity: ["error", 80], "func-names": ["error", "never"], "mozilla/prefer-boolean-length-check": "off", // Enforce using `let` only when variables are reassigned. "prefer-const": ["error", { destructuring: "all" }], }, overrides: [ { files: [".eslintrc.js"], env: { node: true, browser: false, }, }, { files: ["*.mjs"], rules: { "import/default": "error", "import/export": "error", "import/named": "error", "import/namespace": "error", "import/newline-after-import": "error", "import/no-duplicates": "error", "import/no-absolute-path": "error", "import/no-named-default": "error", "import/no-named-as-default": "error", "import/no-named-as-default-member": "error", "import/no-self-import": "error", "import/no-unassigned-import": "error", "import/no-unresolved": [ "error", // Bug 1773473 - Ignore resolver URLs for chrome and resource as we // do not yet have a resolver for them. { ignore: ["chrome://", "resource://"] }, ], "import/no-useless-path-segments": "error", }, }, { files: ["mail/components/storybook/**"], rules: { "import/no-unresolved": "off", }, }, { ...removeOverrides(xpcshellTestConfig), files: xpcshellTestPaths.map(path => `${path}**`), rules: { ...xpcshellTestConfig.rules, "func-names": "off", }, }, { // If it is a test 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: [ ...browserTestPaths.map(path => `${path}head*.js`), ...xpcshellTestPaths.map(path => `${path}head*.js`), ], rules: { "no-unused-vars": [ "error", { argsIgnorePattern: "^_", vars: "local", }, ], }, }, { ...browserTestConfig, files: browserTestPaths.map(path => `${path}**`), rules: { ...browserTestConfig.rules, "func-names": "off", }, }, { files: [ "calendar/base/calendar.js", "calendar/base/content/calendar-base-view.js", "calendar/base/content/calendar-multiday-view.js", "calendar/base/content/calendar-task-tree-view.js", "calendar/base/content/dialogs/calendar-event-dialog-attendees.js", "calendar/base/content/dialogs/calendar-event-dialog-recurrence.js", "calendar/base/content/dialogs/calendar-ics-file-dialog.js", "calendar/base/content/item-editing/calendar-item-editing.js", "calendar/base/content/widgets/calendar-filter.js", "calendar/base/content/widgets/calendar-invitation-panel.js", "calendar/base/content/widgets/calendar-notifications-setting.js", "calendar/base/content/widgets/datetimepickers.js", "calendar/base/modules/calUtils.sys.mjs", "calendar/base/modules/utils/calDateTimeFormatter.sys.mjs", "calendar/base/modules/utils/calIteratorUtils.sys.mjs", "calendar/base/src/CalMetronome.sys.mjs", ], excludedFiles: [".eslintrc.js"], extends: ["plugin:mozilla/valid-jsdoc"], }, { files: ["**/test/**", "**/tests/**"], extends: ["plugin:mozilla/general-test"], }, ], };