Blame view

node_modules/eslint/lib/rules/id-match.js 3.97 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
  /**
   * @fileoverview Rule to flag non-matching identifiers
   * @author Matthieu Larcher
   * @copyright 2015 Matthieu Larcher. All rights reserved.
   * See LICENSE in root directory for full license.
   */
  
  "use strict";
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
  
      //--------------------------------------------------------------------------
      // Helpers
      //--------------------------------------------------------------------------
  
      var pattern = context.options[0] || "^.+$",
          regexp = new RegExp(pattern);
  
      var options = context.options[1] || {},
          properties = options.properties;
  
      // cast to boolean and default to false
      properties = !!properties;
  
  
      /**
       * Checks if a string matches the provided pattern
       * @param {String} name The string to check.
       * @returns {boolean} if the string is a match
       * @private
       */
      function isInvalid(name) {
          return !regexp.test(name);
      }
  
      /**
       * Verifies if we should report an error or not based on the effective
       * parent node and the identifier name.
       * @param {ASTNode} effectiveParent The effective parent node of the node to be reported
       * @param {String} name The identifier name of the identifier node
       * @returns {boolean} whether an error should be reported or not
       */
      function shouldReport(effectiveParent, name) {
          return effectiveParent.type !== "CallExpression"
              && effectiveParent.type !== "NewExpression" &&
              isInvalid(name);
      }
  
      /**
       * Reports an AST node as a rule violation.
       * @param {ASTNode} node The node to report.
       * @returns {void}
       * @private
       */
      function report(node) {
          context.report(node, "Identifier '{{name}}' does not match the pattern '{{pattern}}'.", {
              name: node.name,
              pattern: pattern
          });
      }
  
      return {
  
          "Identifier": function(node) {
              var name = node.name,
                  effectiveParent = (node.parent.type === "MemberExpression") ? node.parent.parent : node.parent;
  
              // MemberExpressions get special rules
              if (node.parent.type === "MemberExpression") {
                  // return early if properties is false
                  if (!properties) {
                      return;
                  }
  
                  // Always check object names
                  if (node.parent.object.type === "Identifier" &&
                      node.parent.object.name === node.name) {
                      if (isInvalid(name)) {
                          report(node);
                      }
  
                      // Report AssignmentExpressions only if they are the left side of the assignment
                  } else if (effectiveParent.type === "AssignmentExpression" &&
                      (effectiveParent.right.type !== "MemberExpression" ||
                      effectiveParent.left.type === "MemberExpression" &&
                      effectiveParent.left.property.name === node.name)) {
                      if (isInvalid(name)) {
                          report(node);
                      }
                  }
  
              // Properties have their own rules
              } else if (node.parent.type === "Property") {
                  // return early if properties is false
                  if (!properties) {
                      return;
                  }
  
                  if (shouldReport(effectiveParent, name)) {
                      report(node);
                  }
  
              // Report anything that is a match and not a CallExpression
              } else if (shouldReport(effectiveParent, name)) {
                  report(node);
              }
          }
  
      };
  
  };
  
  module.exports.schema = [
      {
          "type": "string"
      },
      {
          "type": "object",
          "properties": {
              "properties": {
                  "type": "boolean"
              }
          }
      }
  ];