summaryrefslogtreecommitdiffstats
path: root/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/no-aArgs.js
blob: 19a4da64728aee07fc4049e71f365d594706d0c5 (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 warns against using hungarian notation in function arguments
 * (i.e. aArg).
 *
 * 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 isPrefixed(name) {
  return name.length >= 2 && /^a[A-Z]/.test(name);
}

function deHungarianize(name) {
  return name.substring(1, 2).toLowerCase() + name.substring(2, name.length);
}

module.exports = {
  meta: {
    docs: {
      url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/no-aArgs.html",
    },
    messages: {
      dontUseHungarian:
        "Parameter '{{name}}' uses Hungarian Notation, consider using '{{suggestion}}' instead.",
    },
    schema: [],
    type: "layout",
  },

  create(context) {
    function checkFunction(node) {
      for (var i = 0; i < node.params.length; i++) {
        var param = node.params[i];
        if (param.name && isPrefixed(param.name)) {
          var errorObj = {
            name: param.name,
            suggestion: deHungarianize(param.name),
          };
          context.report({
            node: param,
            messageId: "dontUseHungarian",
            data: errorObj,
          });
        }
      }
    }

    return {
      FunctionDeclaration: checkFunction,
      ArrowFunctionExpression: checkFunction,
      FunctionExpression: checkFunction,
    };
  },
};