summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/no-define-cc-etc.js
blob: aeee3170ccace21acc210ec303dc8285bac669ac (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
/**
 * @fileoverview Reject defining Cc/Ci/Cr/Cu.
 *
 * 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 componentsBlacklist = ["Cc", "Ci", "Cr", "Cu"];

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/no-define-cc-etc.html",
    },
    messages: {
      noSeparateDefinition:
        "{{name}} is now defined in global scope, a separate definition is no longer necessary.",
    },
    schema: [],
    type: "suggestion",
  },

  create(context) {
    return {
      VariableDeclarator(node) {
        if (
          node.id.type == "Identifier" &&
          componentsBlacklist.includes(node.id.name)
        ) {
          context.report({
            node,
            messageId: "noSeparateDefinition",
            data: { name: node.id.name },
          });
        }

        if (node.id.type == "ObjectPattern") {
          for (let property of node.id.properties) {
            if (
              property.type == "Property" &&
              componentsBlacklist.includes(property.value.name)
            ) {
              context.report({
                node,
                messageId: "noSeparateDefinition",
                data: { name: property.value.name },
              });
            }
          }
        }
      },
    };
  },
};