summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-chromeutils-import.js
blob: 1f746db7304c307915f5447d9be0bc59097c8e15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/**
 * @fileoverview Reject use of Cu.import and ChromeUtils.import
 *               in favor of ChromeUtils.importESModule.
 *
 * 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";

function isIdentifier(node, id) {
  return node && node.type === "Identifier" && node.name === id;
}

function isMemberExpression(node, object, member) {
  return (
    node.type === "MemberExpression" &&
    isIdentifier(node.object, object) &&
    isIdentifier(node.property, member)
  );
}

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/rules/reject-chromeutils-import.html",
    },
    messages: {
      useImportESModule:
        "Please use ChromeUtils.importESModule instead of " +
        "ChromeUtils.import unless the module is not yet ESMified",
      useImportESModuleLazy:
        "Please use ChromeUtils.defineESModuleGetters instead of " +
        "ChromeUtils.defineModuleGetter " +
        "unless the module is not yet ESMified",
    },
    schema: [],
    type: "problem",
  },

  create(context) {
    return {
      CallExpression(node) {
        if (node.callee.type !== "MemberExpression") {
          return;
        }

        let { callee } = node;

        if (
          (isIdentifier(callee.object, "ChromeUtils") ||
            isMemberExpression(
              callee.object,
              "SpecialPowers",
              "ChromeUtils"
            )) &&
          isIdentifier(callee.property, "import")
        ) {
          context.report({
            node,
            messageId: "useImportESModule",
          });
        }

        if (
          (isMemberExpression(callee.object, "SpecialPowers", "ChromeUtils") &&
            isIdentifier(callee.property, "defineModuleGetter")) ||
          isMemberExpression(callee, "ChromeUtils", "defineModuleGetter") ||
          isMemberExpression(callee, "XPCOMUtils", "defineLazyModuleGetters")
        ) {
          context.report({
            node,
            messageId: "useImportESModuleLazy",
          });
        }
      },
    };
  },
};