summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/prefer-formatValues.js
blob: 29daca3c7c53d6f3a8f24fc64a629007178fcae2 (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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/**
 * @fileoverview Reject multiple calls to document.l10n.formatValue in the same
 * code block.
 *
 * 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;
}

/**
 * As we enter blocks new sets are pushed onto this stack and then popped when
 * we exit the block.
 */
const BlockStack = [];

module.exports = {
  meta: {
    docs: {
      description: "disallow multiple document.l10n.formatValue calls",
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/prefer-formatValues.html",
    },
    messages: {
      outsideCallBlock: "call expression found outside of known block",
      useSingleCall:
        "prefer to use a single document.l10n.formatValues call instead " +
        "of multiple calls to document.l10n.formatValue or document.l10n.formatValues",
    },
    schema: [],
    type: "problem",
  },

  create(context) {
    function enterBlock() {
      BlockStack.push(new Set());
    }

    function exitBlock() {
      let calls = BlockStack.pop();
      if (calls.size > 1) {
        for (let callNode of calls) {
          context.report({
            node: callNode,
            messageId: "useSingleCall",
          });
        }
      }
    }

    return {
      Program: enterBlock,
      "Program:exit": exitBlock,
      BlockStatement: enterBlock,
      "BlockStatement:exit": exitBlock,

      CallExpression(node) {
        if (!BlockStack.length) {
          context.report({
            node,
            messageId: "outsideCallBlock",
          });
        }

        let callee = node.callee;
        if (callee.type !== "MemberExpression") {
          return;
        }

        if (
          !isIdentifier(callee.property, "formatValue") &&
          !isIdentifier(callee.property, "formatValues")
        ) {
          return;
        }

        if (callee.object.type !== "MemberExpression") {
          return;
        }

        if (
          !isIdentifier(callee.object.object, "document") ||
          !isIdentifier(callee.object.property, "l10n")
        ) {
          return;
        }

        let calls = BlockStack[BlockStack.length - 1];
        calls.add(node);
      },
    };
  },
};