Blame view

node_modules/eslint/lib/rules/id-length.js 3.51 KB
c39994410   Ryan Glover   wip converting to...
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
98
99
100
101
102
103
104
105
106
  /**
   * @fileoverview Rule that warns when identifier names are shorter or longer
   *               than the values provided in configuration.
   * @author Burak Yigit Kaya aka BYK
   * @copyright 2015 Burak Yigit Kaya. All rights reserved.
   * @copyright 2015 Mathieu M-Gosselin. All rights reserved.
   */
  
  "use strict";
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
      var options = context.options[0] || {};
      var minLength = typeof options.min !== "undefined" ? options.min : 2;
      var maxLength = typeof options.max !== "undefined" ? options.max : Infinity;
      var properties = options.properties !== "never";
      var exceptions = (options.exceptions ? options.exceptions : [])
          .reduce(function(obj, item) {
              obj[item] = true;
  
              return obj;
          }, {});
  
      var SUPPORTED_EXPRESSIONS = {
          "MemberExpression": properties && function(parent) {
              return !parent.computed && (
                  // regular property assignment
                  parent.parent.left === parent || (
                      // or the last identifier in an ObjectPattern destructuring
                      parent.parent.type === "Property" && parent.parent.value === parent &&
                      parent.parent.parent.type === "ObjectPattern" && parent.parent.parent.parent.left === parent.parent.parent
                  )
              );
          },
          "AssignmentPattern": function(parent, node) {
              return parent.left === node;
          },
          "VariableDeclarator": function(parent, node) {
              return parent.id === node;
          },
          "Property": properties && function(parent, node) {
              return parent.key === node;
          },
          "ImportDefaultSpecifier": true,
          "RestElement": true,
          "FunctionExpression": true,
          "ArrowFunctionExpression": true,
          "ClassDeclaration": true,
          "FunctionDeclaration": true,
          "MethodDefinition": true,
          "CatchClause": true
      };
  
      return {
          Identifier: function(node) {
              var name = node.name;
              var parent = node.parent;
  
              var isShort = name.length < minLength;
              var isLong = name.length > maxLength;
              if (!(isShort || isLong) || exceptions[name]) {
                  return;  // Nothing to report
              }
  
              var isValidExpression = SUPPORTED_EXPRESSIONS[parent.type];
  
              if (isValidExpression && (isValidExpression === true || isValidExpression(parent, node))) {
                  context.report(
                      node,
                      isShort ?
                          "Identifier name '{{name}}' is too short. (< {{min}})" :
                          "Identifier name '{{name}}' is too long. (> {{max}})",
                      { name: name, min: minLength, max: maxLength }
                  );
              }
          }
      };
  };
  
  module.exports.schema = [
      {
          "type": "object",
          "properties": {
              "min": {
                  "type": "number"
              },
              "max": {
                  "type": "number"
              },
              "exceptions": {
                  "type": "array",
                  "uniqueItems": true,
                  "items": {
                      "type": "string"
                  }
              },
              "properties": {
                  "enum": ["always", "never"]
              }
          },
          "additionalProperties": false
      }
  ];