.eslintrc.js

/* 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(filePath) {
  return fs
    .readFileSync(filePath, { 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" }],
    "mozilla/reject-chromeutils-import": "error",
    "no-redeclare": "off",
    "no-shadow": "off",
  },

  overrides: [
    {
      files: [".eslintrc.js"],
      env: {
        node: true,
        browser: false,
      },
    },
    {
      files: ["**/test/**", "**/tests/**"],
      extends: ["plugin:mozilla/general-test"],
    },
    {
      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(filePath => `${filePath}**`),
      rules: {
        ...xpcshellTestConfig.rules,
        "func-names": "off",
      },
      excludedFiles: ["**/*.mjs", "**/*.sjs"],
    },
    {
      // 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(filePath => `${filePath}head*.js`),
        ...xpcshellTestPaths.map(filePath => `${filePath}head*.js`),
      ],
      rules: {
        "no-unused-vars": [
          "error",
          {
            argsIgnorePattern: "^_",
            vars: "local",
          },
        ],
      },
    },
    {
      ...browserTestConfig,
      files: browserTestPaths.map(filePath => `${filePath}**`),
      rules: {
        ...browserTestConfig.rules,
        "func-names": "off",
      },
      excludedFiles: ["**/*.mjs", "**/*.sjs"],
    },
    {
      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/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",

        "chat/modules/imContentSink.sys.mjs",

        "mail/components/inappnotifications/**",

        "mail/modules/QuickFilterManager.sys.mjs",
      ],
      excludedFiles: [".eslintrc.js"],
      extends: ["plugin:mozilla/valid-jsdoc"],
    },

    {
      // Files that have been fixed to work with rules
      // no-redeclare and no-shadow
      files: [
        ".eslintrc.js",
        "mail/test/browser/composition/browser_redirect.js",
        "mail/test/browser/composition/browser_replySelection.js",
        "mail/test/browser/composition/browser_sendButton.js",
        "mail/test/browser/content-policy/browser_dnsPrefetch.js",
        "mail/test/browser/content-policy/browser_exposedInContentTabs.js",
        "mail/test/browser/content-policy/browser_generalContentPolicy.js",
        "mail/test/browser/folder-display/browser_displayName.js",
        "mail/test/browser/folder-display/browser_messageCommands.js",
        "mail/test/browser/folder-display/browser_summarization.js",
        "mail/test/browser/import/browser_exportProfile.js",
        "mail/test/browser/import/browser_importProfile.js",
        "mail/test/browser/import/browser_importTabChange.js",
        "mail/test/browser/session-store/browser_sessionStore.js",
        "mail/test/browser/shared-modules/ComposeHelpers.sys.mjs",
        "mail/test/browser/shared-modules/ContentTabHelpers.sys.mjs",
        "mail/test/browser/shared-modules/EventUtils.sys.mjs",
        "mail/test/browser/shared-modules/FolderDisplayHelpers.sys.mjs",
        "mail/test/browser/shared-modules/NNTPHelpers.sys.mjs",
        "mail/test/browser/shared-modules/OpenPGPTestUtils.sys.mjs",
        "mail/test/browser/shared-modules/SubscribeWindowHelpers.sys.mjs",
        "mail/test/browser/shared-modules/WindowHelpers.sys.mjs",
        "mailnews/addrbook/modules/AddrBookManager.sys.mjs",
        "mailnews/addrbook/modules/CardDAVDirectory.sys.mjs",
        "mailnews/addrbook/modules/CardDAVUtils.sys.mjs",
        "mailnews/addrbook/modules/LDAPMessage.sys.mjs",
        "mailnews/addrbook/src/AbAutoCompleteSearch.sys.mjs",
        "mailnews/base/prefs/content/AccountManager.js",
        "mailnews/base/prefs/content/removeAccount.js",
        "mailnews/base/src/MailNotificationService.sys.mjs",
        "mailnews/base/src/MsgIncomingServer.sys.mjs",
        "mailnews/base/src/MsgProtocolInfo.sys.mjs",
        "mailnews/base/src/OAuth2.sys.mjs",
        "mailnews/base/src/mailstoreConverter.sys.mjs",
        "mailnews/compose/src/MessageSend.sys.mjs",
        "mailnews/db/gloda/modules/Gloda.sys.mjs",
        "mailnews/db/gloda/modules/GlodaDatabind.sys.mjs",
        "mailnews/db/gloda/modules/GlodaDatastore.sys.mjs",
        "mailnews/db/gloda/modules/GlodaFundAttr.sys.mjs",
        "mailnews/db/gloda/modules/IndexMsg.sys.mjs",
        "mailnews/db/gloda/modules/MimeMessage.sys.mjs",
        "mailnews/db/gloda/test/unit/resources/GlodaQueryHelper.sys.mjs",
        "mailnews/extensions/newsblog/FeedParser.sys.mjs",
        "mailnews/extensions/newsblog/FeedUtils.sys.mjs",
        "mailnews/extensions/newsblog/feed-subscriptions.js",
        "mailnews/extensions/newsblog/newsblogOverlay.js",
        "mailnews/extensions/newsblog/test/browser/browser_feedDisplay.js",
        "mailnews/imap/src/ImapChannel.sys.mjs",
        "mailnews/imap/src/ImapClient.sys.mjs",
        "mailnews/import/content/csv-field-map.js",
        "mailnews/jsaccount/modules/JSAccountUtils.sys.mjs",
        "mailnews/local/src/Pop3Client.sys.mjs",
        "mailnews/news/src/NntpMessageService.sys.mjs",
        "mailnews/search/content/FilterEditor.js",
        "mailnews/test/fakeserver/Binaryd.sys.mjs",
        "mailnews/test/fakeserver/Imapd.sys.mjs",
        "mailnews/test/fakeserver/Maild.sys.mjs",
        "mailnews/test/resources/MailTestUtils.sys.mjs",
        "mail/extensions/am-e2e/am-e2e.js",
        "mail/extensions/openpgp/content/modules/armor.sys.mjs",
        "mail/extensions/openpgp/content/modules/filters.sys.mjs",
        "mail/extensions/openpgp/content/modules/mimeVerify.sys.mjs",
        "mail/extensions/openpgp/content/ui/keyDetailsDlg.js",
      ],
      rules: {
        "no-redeclare": ["error", { builtinGlobals: true }],
        "no-shadow": "error",
      },
    },
  ],
};