Blame view

node_modules/eslint/lib/rules/camelcase.js 3.57 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
  /**
   * @fileoverview Rule to flag non-camelcased identifiers
   * @author Nicholas C. Zakas
   * @copyright 2015 Dieter Oberkofler. All rights reserved.
   */
  
  "use strict";
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
  
      //--------------------------------------------------------------------------
      // Helpers
      //--------------------------------------------------------------------------
  
      /**
       * Checks if a string contains an underscore and isn't all upper-case
       * @param {String} name The string to check.
       * @returns {boolean} if the string is underscored
       * @private
       */
      function isUnderscored(name) {
  
          // if there's an underscore, it might be A_CONSTANT, which is okay
          return name.indexOf("_") > -1 && name !== name.toUpperCase();
      }
  
      /**
       * 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}}' is not in camel case.", { name: node.name });
      }
  
      var options = context.options[0] || {},
          properties = options.properties || "";
  
      if (properties !== "always" && properties !== "never") {
          properties = "always";
      }
  
      return {
  
          "Identifier": function(node) {
  
              // Leading and trailing underscores are commonly used to flag private/protected identifiers, strip them
              var name = node.name.replace(/^_+|_+$/g, ""),
                  effectiveParent = (node.parent.type === "MemberExpression") ? node.parent.parent : node.parent;
  
              // MemberExpressions get special rules
              if (node.parent.type === "MemberExpression") {
  
                  // "never" check properties
                  if (properties === "never") {
                      return;
                  }
  
                  // Always report underscored object names
                  if (node.parent.object.type === "Identifier" &&
                          node.parent.object.name === node.name &&
                          isUnderscored(name)) {
                      report(node);
  
                  // Report AssignmentExpressions only if they are the left side of the assignment
                  } else if (effectiveParent.type === "AssignmentExpression" &&
                          isUnderscored(name) &&
                          (effectiveParent.right.type !== "MemberExpression" ||
                          effectiveParent.left.type === "MemberExpression" &&
                          effectiveParent.left.property.name === node.name)) {
                      report(node);
                  }
  
              // Properties have their own rules
              } else if (node.parent.type === "Property") {
  
                  // "never" check properties
                  if (properties === "never") {
                      return;
                  }
  
                  if (isUnderscored(name) && effectiveParent.type !== "CallExpression") {
                      report(node);
                  }
  
              // Report anything that is underscored that isn't a CallExpression
              } else if (isUnderscored(name) && effectiveParent.type !== "CallExpression") {
                  report(node);
              }
          }
  
      };
  
  };
  
  module.exports.schema = [
      {
          "type": "object",
          "properties": {
              "properties": {
                  "enum": ["always", "never"]
              }
          },
          "additionalProperties": false
      }
  ];