summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/reject-chromeutils-import-null.js
blob: b7fd1593b81f5777b311bc97d25868e7a6e72b78 (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
/**
 * @fileoverview Reject calls to ChromeUtils.import(..., null). This allows to
 * retrieve the global object for the JSM, instead we should rely on explicitly
 * exported symbols.
 *
 * 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";

// -----------------------------------------------------------------------------
// Rule Definition
// -----------------------------------------------------------------------------

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

module.exports = function(context) {
  // ---------------------------------------------------------------------------
  // Public
  //  --------------------------------------------------------------------------

  return {
    CallExpression(node) {
      let { callee } = node;
      if (
        isIdentifier(callee.object, "ChromeUtils") &&
        isIdentifier(callee.property, "import") &&
        node.arguments.length >= 2 &&
        node.arguments[1].type == "Literal" &&
        node.arguments[1].raw == "null"
      ) {
        context.report(
          node,
          "ChromeUtils.import should not be called with (..., null) to " +
            "retrieve the JSM global object. Rely on explicit exports instead."
        );
      }
    },
  };
};