eslint 0.22.0 → 0.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +111 -95
  3. package/bin/eslint.js +41 -41
  4. package/conf/environments.js +87 -81
  5. package/conf/eslint.json +186 -179
  6. package/lib/api.js +13 -12
  7. package/lib/cli-engine.js +441 -451
  8. package/lib/cli.js +196 -196
  9. package/lib/config-initializer.js +145 -145
  10. package/lib/config-validator.js +110 -110
  11. package/lib/config.js +428 -416
  12. package/lib/eslint.js +1072 -1073
  13. package/lib/file-finder.js +167 -167
  14. package/lib/formatters/checkstyle.js +68 -68
  15. package/lib/formatters/compact.js +53 -53
  16. package/lib/formatters/jslint-xml.js +40 -40
  17. package/lib/formatters/junit.js +63 -63
  18. package/lib/formatters/stylish.js +90 -90
  19. package/lib/formatters/tap.js +86 -86
  20. package/lib/ignored-paths.js +137 -137
  21. package/lib/load-rules.js +39 -39
  22. package/lib/options.js +132 -126
  23. package/lib/rule-context.js +107 -107
  24. package/lib/rules/accessor-pairs.js +65 -65
  25. package/lib/rules/array-bracket-spacing.js +180 -0
  26. package/lib/rules/block-scoped-var.js +339 -320
  27. package/lib/rules/brace-style.js +228 -228
  28. package/lib/rules/camelcase.js +111 -111
  29. package/lib/rules/comma-dangle.js +67 -64
  30. package/lib/rules/comma-spacing.js +191 -191
  31. package/lib/rules/comma-style.js +195 -195
  32. package/lib/rules/complexity.js +94 -94
  33. package/lib/rules/computed-property-spacing.js +144 -0
  34. package/lib/rules/consistent-return.js +75 -75
  35. package/lib/rules/consistent-this.js +119 -119
  36. package/lib/rules/constructor-super.js +108 -0
  37. package/lib/rules/curly.js +109 -109
  38. package/lib/rules/default-case.js +66 -66
  39. package/lib/rules/dot-location.js +63 -63
  40. package/lib/rules/dot-notation.js +119 -119
  41. package/lib/rules/eol-last.js +38 -38
  42. package/lib/rules/eqeqeq.js +96 -96
  43. package/lib/rules/func-names.js +45 -45
  44. package/lib/rules/func-style.js +49 -49
  45. package/lib/rules/generator-star-spacing.js +104 -87
  46. package/lib/rules/generator-star.js +76 -76
  47. package/lib/rules/global-strict.js +49 -49
  48. package/lib/rules/guard-for-in.js +32 -32
  49. package/lib/rules/handle-callback-err.js +81 -124
  50. package/lib/rules/indent.js +486 -486
  51. package/lib/rules/key-spacing.js +325 -325
  52. package/lib/rules/linebreak-style.js +44 -44
  53. package/lib/rules/lines-around-comment.js +228 -160
  54. package/lib/rules/max-depth.js +89 -89
  55. package/lib/rules/max-len.js +76 -76
  56. package/lib/rules/max-nested-callbacks.js +73 -73
  57. package/lib/rules/max-params.js +45 -45
  58. package/lib/rules/max-statements.js +61 -61
  59. package/lib/rules/new-cap.js +224 -224
  60. package/lib/rules/new-parens.js +29 -29
  61. package/lib/rules/newline-after-var.js +127 -127
  62. package/lib/rules/no-alert.js +153 -153
  63. package/lib/rules/no-array-constructor.js +31 -31
  64. package/lib/rules/no-bitwise.js +57 -57
  65. package/lib/rules/no-caller.js +29 -29
  66. package/lib/rules/no-catch-shadow.js +52 -52
  67. package/lib/rules/no-comma-dangle.js +45 -45
  68. package/lib/rules/no-cond-assign.js +123 -123
  69. package/lib/rules/no-console.js +27 -27
  70. package/lib/rules/no-constant-condition.js +73 -73
  71. package/lib/rules/no-continue.js +23 -23
  72. package/lib/rules/no-control-regex.js +58 -58
  73. package/lib/rules/no-debugger.js +22 -22
  74. package/lib/rules/no-delete-var.js +25 -25
  75. package/lib/rules/no-div-regex.js +27 -27
  76. package/lib/rules/no-dupe-args.js +89 -85
  77. package/lib/rules/no-dupe-keys.js +43 -43
  78. package/lib/rules/no-duplicate-case.js +67 -67
  79. package/lib/rules/no-else-return.js +125 -125
  80. package/lib/rules/no-empty-character-class.js +43 -43
  81. package/lib/rules/no-empty-class.js +45 -45
  82. package/lib/rules/no-empty-label.js +27 -27
  83. package/lib/rules/no-empty.js +49 -49
  84. package/lib/rules/no-eq-null.js +29 -29
  85. package/lib/rules/no-eval.js +26 -26
  86. package/lib/rules/no-ex-assign.js +42 -42
  87. package/lib/rules/no-extend-native.js +103 -103
  88. package/lib/rules/no-extra-bind.js +81 -81
  89. package/lib/rules/no-extra-boolean-cast.js +71 -71
  90. package/lib/rules/no-extra-parens.js +368 -355
  91. package/lib/rules/no-extra-semi.js +70 -23
  92. package/lib/rules/no-extra-strict.js +86 -86
  93. package/lib/rules/no-fallthrough.js +97 -97
  94. package/lib/rules/no-floating-decimal.js +30 -30
  95. package/lib/rules/no-func-assign.js +83 -83
  96. package/lib/rules/no-implied-eval.js +76 -76
  97. package/lib/rules/no-inline-comments.js +49 -49
  98. package/lib/rules/no-inner-declarations.js +78 -78
  99. package/lib/rules/no-invalid-regexp.js +53 -53
  100. package/lib/rules/no-irregular-whitespace.js +135 -135
  101. package/lib/rules/no-iterator.js +28 -28
  102. package/lib/rules/no-label-var.js +64 -64
  103. package/lib/rules/no-labels.js +44 -44
  104. package/lib/rules/no-lone-blocks.js +106 -27
  105. package/lib/rules/no-lonely-if.js +30 -30
  106. package/lib/rules/no-loop-func.js +58 -58
  107. package/lib/rules/no-mixed-requires.js +165 -165
  108. package/lib/rules/no-mixed-spaces-and-tabs.js +74 -74
  109. package/lib/rules/no-multi-spaces.js +119 -119
  110. package/lib/rules/no-multi-str.js +43 -43
  111. package/lib/rules/no-multiple-empty-lines.js +98 -98
  112. package/lib/rules/no-native-reassign.js +62 -62
  113. package/lib/rules/no-negated-in-lhs.js +25 -25
  114. package/lib/rules/no-nested-ternary.js +24 -24
  115. package/lib/rules/no-new-func.js +25 -25
  116. package/lib/rules/no-new-object.js +25 -25
  117. package/lib/rules/no-new-require.js +25 -25
  118. package/lib/rules/no-new-wrappers.js +26 -26
  119. package/lib/rules/no-new.js +27 -27
  120. package/lib/rules/no-obj-calls.js +28 -28
  121. package/lib/rules/no-octal-escape.js +39 -39
  122. package/lib/rules/no-octal.js +25 -25
  123. package/lib/rules/no-param-reassign.js +87 -87
  124. package/lib/rules/no-path-concat.js +39 -39
  125. package/lib/rules/no-plusplus.js +24 -24
  126. package/lib/rules/no-process-env.js +30 -30
  127. package/lib/rules/no-process-exit.js +33 -33
  128. package/lib/rules/no-proto.js +28 -28
  129. package/lib/rules/no-redeclare.js +68 -68
  130. package/lib/rules/no-regex-spaces.js +35 -35
  131. package/lib/rules/no-reserved-keys.js +56 -56
  132. package/lib/rules/no-restricted-modules.js +85 -85
  133. package/lib/rules/no-return-assign.js +53 -24
  134. package/lib/rules/no-script-url.js +34 -34
  135. package/lib/rules/no-self-compare.js +29 -29
  136. package/lib/rules/no-sequences.js +94 -94
  137. package/lib/rules/no-shadow-restricted-names.js +51 -51
  138. package/lib/rules/no-shadow.js +181 -136
  139. package/lib/rules/no-space-before-semi.js +98 -98
  140. package/lib/rules/no-spaced-func.js +37 -37
  141. package/lib/rules/no-sparse-arrays.js +33 -33
  142. package/lib/rules/no-sync.js +30 -30
  143. package/lib/rules/no-ternary.js +24 -24
  144. package/lib/rules/no-this-before-super.js +144 -0
  145. package/lib/rules/no-throw-literal.js +33 -33
  146. package/lib/rules/no-trailing-spaces.js +74 -63
  147. package/lib/rules/no-undef-init.js +28 -28
  148. package/lib/rules/no-undef.js +92 -92
  149. package/lib/rules/no-undefined.js +27 -27
  150. package/lib/rules/no-underscore-dangle.js +73 -73
  151. package/lib/rules/no-unexpected-multiline.js +58 -0
  152. package/lib/rules/no-unneeded-ternary.js +48 -48
  153. package/lib/rules/no-unreachable.js +98 -98
  154. package/lib/rules/no-unused-expressions.js +76 -76
  155. package/lib/rules/no-unused-vars.js +252 -250
  156. package/lib/rules/no-use-before-define.js +105 -105
  157. package/lib/rules/no-var.js +26 -26
  158. package/lib/rules/no-void.js +28 -28
  159. package/lib/rules/no-warning-comments.js +102 -102
  160. package/lib/rules/no-with.js +22 -22
  161. package/lib/rules/no-wrap-func.js +65 -65
  162. package/lib/rules/object-curly-spacing.js +231 -206
  163. package/lib/rules/object-shorthand.js +74 -73
  164. package/lib/rules/one-var.js +311 -304
  165. package/lib/rules/operator-assignment.js +118 -118
  166. package/lib/rules/operator-linebreak.js +114 -114
  167. package/lib/rules/padded-blocks.js +98 -98
  168. package/lib/rules/prefer-const.js +91 -0
  169. package/lib/rules/quote-props.js +72 -72
  170. package/lib/rules/quotes.js +92 -92
  171. package/lib/rules/radix.js +41 -41
  172. package/lib/rules/semi-spacing.js +167 -167
  173. package/lib/rules/semi.js +136 -136
  174. package/lib/rules/sort-vars.js +49 -49
  175. package/lib/rules/space-after-function-name.js +49 -49
  176. package/lib/rules/space-after-keywords.js +82 -82
  177. package/lib/rules/space-before-blocks.js +91 -91
  178. package/lib/rules/space-before-function-paren.js +139 -139
  179. package/lib/rules/space-before-function-parentheses.js +139 -139
  180. package/lib/rules/space-in-brackets.js +305 -305
  181. package/lib/rules/space-in-parens.js +281 -281
  182. package/lib/rules/space-infix-ops.js +106 -106
  183. package/lib/rules/space-return-throw-case.js +38 -38
  184. package/lib/rules/space-unary-ops.js +124 -133
  185. package/lib/rules/spaced-comment.js +143 -0
  186. package/lib/rules/spaced-line-comment.js +89 -89
  187. package/lib/rules/strict.js +242 -242
  188. package/lib/rules/use-isnan.js +26 -26
  189. package/lib/rules/valid-jsdoc.js +215 -215
  190. package/lib/rules/valid-typeof.js +42 -42
  191. package/lib/rules/vars-on-top.js +115 -115
  192. package/lib/rules/wrap-iife.js +48 -48
  193. package/lib/rules/wrap-regex.js +38 -38
  194. package/lib/rules/yoda.js +242 -225
  195. package/lib/rules.js +88 -88
  196. package/lib/timing.js +109 -109
  197. package/lib/token-store.js +201 -201
  198. package/lib/util/traverse.js +105 -105
  199. package/lib/util.js +125 -85
  200. package/package.json +6 -6
  201. package/CHANGELOG.md +0 -1638
package/lib/timing.js CHANGED
@@ -1,109 +1,109 @@
1
- /**
2
- * @fileoverview Tracks performance of individual rules.
3
- * @author Brandon Mills
4
- * @copyright 2014 Brandon Mills. All rights reserved.
5
- */
6
-
7
- "use strict";
8
-
9
- //------------------------------------------------------------------------------
10
- // Helpers
11
- //------------------------------------------------------------------------------
12
-
13
- /* istanbul ignore next */
14
- function alignLeft(str, len, ch) {
15
- return str + new Array(len - str.length + 1).join(ch || " ");
16
- }
17
-
18
- /* istanbul ignore next */
19
- function alignRight(str, len, ch) {
20
- return new Array(len - str.length + 1).join(ch || " ") + str;
21
- }
22
-
23
- //------------------------------------------------------------------------------
24
- // Module definition
25
- //------------------------------------------------------------------------------
26
-
27
- var enabled = !!process.env.TIMING;
28
-
29
- var HEADERS = ["Rule", "Time (ms)", "Relative"];
30
- var ALIGN = [alignLeft, alignRight, alignRight];
31
-
32
- /* istanbul ignore next */
33
- function display(data) {
34
- var total = 0;
35
- var rows = Object.keys(data)
36
- .map(function(key) {
37
- var time = data[key];
38
- total += time;
39
- return [key, time];
40
- })
41
- .sort(function(a, b) {
42
- return b[1] - a[1];
43
- })
44
- .slice(0, 10);
45
-
46
- rows.forEach(function(row) {
47
- row.push((row[1] * 100 / total).toFixed(1) + "%");
48
- row[1] = row[1].toFixed(3);
49
- });
50
-
51
- rows.unshift(HEADERS);
52
-
53
- var widths = [];
54
- rows.forEach(function(row) {
55
- var len = row.length, i, n;
56
- for (i = 0; i < len; i++) {
57
- n = row[i].length;
58
- if (!widths[i] || n > widths[i]) {
59
- widths[i] = n;
60
- }
61
- }
62
- });
63
-
64
- var table = rows.map(function(row) {
65
- return row.map(function(cell, index) {
66
- return ALIGN[index](cell, widths[index]);
67
- }).join(" | ");
68
- });
69
- table.splice(1, 0, widths.map(function(w, index) {
70
- if (index !== 0 && index !== widths.length - 1) {
71
- w++;
72
- }
73
-
74
- return ALIGN[index](":", w + 1, "-");
75
- }).join("|"));
76
-
77
- console.log(table.join("\n"));
78
- }
79
-
80
- /* istanbul ignore next */
81
- module.exports = (function() {
82
-
83
- var data = Object.create(null);
84
-
85
- function time(key, fn) {
86
- if (typeof data[key] === "undefined") {
87
- data[key] = 0;
88
- }
89
-
90
- return function() {
91
- var t = process.hrtime();
92
- fn.apply(null, Array.prototype.slice.call(arguments));
93
- t = process.hrtime(t);
94
- data[key] += t[0] * 1e3 + t[1] / 1e6;
95
- };
96
- }
97
-
98
- if (enabled) {
99
- process.on("exit", function() {
100
- display(data);
101
- });
102
- }
103
-
104
- return {
105
- time: time,
106
- enabled: enabled
107
- };
108
-
109
- }());
1
+ /**
2
+ * @fileoverview Tracks performance of individual rules.
3
+ * @author Brandon Mills
4
+ * @copyright 2014 Brandon Mills. All rights reserved.
5
+ */
6
+
7
+ "use strict";
8
+
9
+ //------------------------------------------------------------------------------
10
+ // Helpers
11
+ //------------------------------------------------------------------------------
12
+
13
+ /* istanbul ignore next */
14
+ function alignLeft(str, len, ch) {
15
+ return str + new Array(len - str.length + 1).join(ch || " ");
16
+ }
17
+
18
+ /* istanbul ignore next */
19
+ function alignRight(str, len, ch) {
20
+ return new Array(len - str.length + 1).join(ch || " ") + str;
21
+ }
22
+
23
+ //------------------------------------------------------------------------------
24
+ // Module definition
25
+ //------------------------------------------------------------------------------
26
+
27
+ var enabled = !!process.env.TIMING;
28
+
29
+ var HEADERS = ["Rule", "Time (ms)", "Relative"];
30
+ var ALIGN = [alignLeft, alignRight, alignRight];
31
+
32
+ /* istanbul ignore next */
33
+ function display(data) {
34
+ var total = 0;
35
+ var rows = Object.keys(data)
36
+ .map(function(key) {
37
+ var time = data[key];
38
+ total += time;
39
+ return [key, time];
40
+ })
41
+ .sort(function(a, b) {
42
+ return b[1] - a[1];
43
+ })
44
+ .slice(0, 10);
45
+
46
+ rows.forEach(function(row) {
47
+ row.push((row[1] * 100 / total).toFixed(1) + "%");
48
+ row[1] = row[1].toFixed(3);
49
+ });
50
+
51
+ rows.unshift(HEADERS);
52
+
53
+ var widths = [];
54
+ rows.forEach(function(row) {
55
+ var len = row.length, i, n;
56
+ for (i = 0; i < len; i++) {
57
+ n = row[i].length;
58
+ if (!widths[i] || n > widths[i]) {
59
+ widths[i] = n;
60
+ }
61
+ }
62
+ });
63
+
64
+ var table = rows.map(function(row) {
65
+ return row.map(function(cell, index) {
66
+ return ALIGN[index](cell, widths[index]);
67
+ }).join(" | ");
68
+ });
69
+ table.splice(1, 0, widths.map(function(w, index) {
70
+ if (index !== 0 && index !== widths.length - 1) {
71
+ w++;
72
+ }
73
+
74
+ return ALIGN[index](":", w + 1, "-");
75
+ }).join("|"));
76
+
77
+ console.log(table.join("\n"));
78
+ }
79
+
80
+ /* istanbul ignore next */
81
+ module.exports = (function() {
82
+
83
+ var data = Object.create(null);
84
+
85
+ function time(key, fn) {
86
+ if (typeof data[key] === "undefined") {
87
+ data[key] = 0;
88
+ }
89
+
90
+ return function() {
91
+ var t = process.hrtime();
92
+ fn.apply(null, Array.prototype.slice.call(arguments));
93
+ t = process.hrtime(t);
94
+ data[key] += t[0] * 1e3 + t[1] / 1e6;
95
+ };
96
+ }
97
+
98
+ if (enabled) {
99
+ process.on("exit", function() {
100
+ display(data);
101
+ });
102
+ }
103
+
104
+ return {
105
+ time: time,
106
+ enabled: enabled
107
+ };
108
+
109
+ }());
@@ -1,201 +1,201 @@
1
- /**
2
- * @fileoverview Object to handle access and retrieval of tokens.
3
- * @author Brandon Mills
4
- * @copyright 2014 Nicholas C. Zakas. All rights reserved.
5
- * @copyright 2014 Brandon Mills. All rights reserved.
6
- */
7
- "use strict";
8
-
9
- //------------------------------------------------------------------------------
10
- // Implementation
11
- //------------------------------------------------------------------------------
12
-
13
- module.exports = function(tokens) {
14
- var api = {},
15
- starts = Object.create(null),
16
- ends = Object.create(null),
17
- index, length, range;
18
-
19
- /**
20
- * Gets tokens in a given interval.
21
- * @param {int} start Inclusive index of the first token. 0 if negative.
22
- * @param {int} end Exclusive index of the last token.
23
- * @returns {Token[]} Tokens in the interval.
24
- */
25
- function get(start, end) {
26
- var result = [],
27
- i;
28
-
29
- for (i = Math.max(0, start); i < end && i < length; i++) {
30
- result.push(tokens[i]);
31
- }
32
-
33
- return result;
34
- }
35
-
36
- /**
37
- * Gets the index in the tokens array of the last token belonging to a node.
38
- * Usually a node ends exactly at a token, but due to ASI, sometimes a
39
- * node's range extends beyond its last token.
40
- * @param {ASTNode} node The node for which to find the last token's index.
41
- * @returns {int} Index in the tokens array of the node's last token.
42
- */
43
- function lastTokenIndex(node) {
44
- var end = node.range[1],
45
- cursor = ends[end];
46
-
47
- // If the node extends beyond its last token, get the token before the
48
- // next token
49
- if (typeof cursor === "undefined") {
50
- cursor = starts[end] - 1;
51
- }
52
-
53
- // If there isn't a next token, the desired token is the last one in the
54
- // array
55
- if (isNaN(cursor)) {
56
- cursor = length - 1;
57
- }
58
-
59
- return cursor;
60
- }
61
-
62
- // Map tokens' start and end range to the index in the tokens array
63
- for (index = 0, length = tokens.length; index < length; index++) {
64
- range = tokens[index].range;
65
- starts[range[0]] = index;
66
- ends[range[1]] = index;
67
- }
68
-
69
- /**
70
- * Gets a number of tokens that precede a given node or token in the token
71
- * stream.
72
- * @param {(ASTNode|Token)} node The AST node or token.
73
- * @param {int} [beforeCount=0] The number of tokens before the node or
74
- * token to retrieve.
75
- * @returns {Token[]} Array of objects representing tokens.
76
- */
77
- api.getTokensBefore = function(node, beforeCount) {
78
- var first = starts[node.range[0]];
79
- return get(first - (beforeCount || 0), first);
80
- };
81
-
82
- /**
83
- * Gets the token that precedes a given node or token in the token stream.
84
- * @param {(ASTNode|Token)} node The AST node or token.
85
- * @param {int} [skip=0] A number of tokens to skip before the given node or
86
- * token.
87
- * @returns {Token} An object representing the token.
88
- */
89
- api.getTokenBefore = function(node, skip) {
90
- return tokens[starts[node.range[0]] - (skip || 0) - 1];
91
- };
92
-
93
- /**
94
- * Gets a number of tokens that follow a given node or token in the token
95
- * stream.
96
- * @param {(ASTNode|Token)} node The AST node or token.
97
- * @param {int} [afterCount=0] The number of tokens after the node or token
98
- * to retrieve.
99
- * @returns {Token[]} Array of objects representing tokens.
100
- */
101
- api.getTokensAfter = function(node, afterCount) {
102
- var start = lastTokenIndex(node) + 1;
103
- return get(start, start + (afterCount || 0));
104
- };
105
-
106
- /**
107
- * Gets the token that follows a given node or token in the token stream.
108
- * @param {(ASTNode|Token)} node The AST node or token.
109
- * @param {int} [skip=0] A number of tokens to skip after the given node or
110
- * token.
111
- * @returns {Token} An object representing the token.
112
- */
113
- api.getTokenAfter = function(node, skip) {
114
- return tokens[lastTokenIndex(node) + (skip || 0) + 1];
115
- };
116
-
117
- /**
118
- * Gets all tokens that are related to the given node.
119
- * @param {ASTNode} node The AST node.
120
- * @param {int} [beforeCount=0] The number of tokens before the node to retrieve.
121
- * @param {int} [afterCount=0] The number of tokens after the node to retrieve.
122
- * @returns {Token[]} Array of objects representing tokens.
123
- */
124
- api.getTokens = function(node, beforeCount, afterCount) {
125
- return get(
126
- starts[node.range[0]] - (beforeCount || 0),
127
- lastTokenIndex(node) + (afterCount || 0) + 1
128
- );
129
- };
130
-
131
- /**
132
- * Gets the first `count` tokens of the given node's token stream.
133
- * @param {ASTNode} node The AST node.
134
- * @param {int} [count=0] The number of tokens of the node to retrieve.
135
- * @returns {Token[]} Array of objects representing tokens.
136
- */
137
- api.getFirstTokens = function(node, count) {
138
- var first = starts[node.range[0]];
139
- return get(
140
- first,
141
- Math.min(lastTokenIndex(node) + 1, first + (count || 0))
142
- );
143
- };
144
-
145
- /**
146
- * Gets the first token of the given node's token stream.
147
- * @param {ASTNode} node The AST node.
148
- * @param {int} [skip=0] A number of tokens to skip.
149
- * @returns {Token} An object representing the token.
150
- */
151
- api.getFirstToken = function(node, skip) {
152
- return tokens[starts[node.range[0]] + (skip || 0)];
153
- };
154
-
155
- /**
156
- * Gets the last `count` tokens of the given node.
157
- * @param {ASTNode} node The AST node.
158
- * @param {int} [count=0] The number of tokens of the node to retrieve.
159
- * @returns {Token[]} Array of objects representing tokens.
160
- */
161
- api.getLastTokens = function(node, count) {
162
- var last = lastTokenIndex(node) + 1;
163
- return get(Math.max(starts[node.range[0]], last - (count || 0)), last);
164
- };
165
-
166
- /**
167
- * Gets the last token of the given node's token stream.
168
- * @param {ASTNode} node The AST node.
169
- * @param {int} [skip=0] A number of tokens to skip.
170
- * @returns {Token} An object representing the token.
171
- */
172
- api.getLastToken = function(node, skip) {
173
- return tokens[lastTokenIndex(node) - (skip || 0)];
174
- };
175
-
176
- /**
177
- * Gets all of the tokens between two non-overlapping nodes.
178
- * @param {ASTNode} left Node before the desired token range.
179
- * @param {ASTNode} right Node after the desired token range.
180
- * @param {int} [padding=0] Number of extra tokens on either side of center.
181
- * @returns {Token[]} Tokens between left and right plus padding.
182
- */
183
- api.getTokensBetween = function(left, right, padding) {
184
- padding = padding || 0;
185
- return get(
186
- lastTokenIndex(left) + 1 - padding,
187
- starts[right.range[0]] + padding
188
- );
189
- };
190
-
191
- /**
192
- * Gets the token starting at the specified index.
193
- * @param {int} startIndex Index of the start of the token's range.
194
- * @returns {Token} The token starting at index, or null if no such token.
195
- */
196
- api.getTokenByRangeStart = function(startIndex) {
197
- return (tokens[starts[startIndex]] || null);
198
- };
199
-
200
- return api;
201
- };
1
+ /**
2
+ * @fileoverview Object to handle access and retrieval of tokens.
3
+ * @author Brandon Mills
4
+ * @copyright 2014 Nicholas C. Zakas. All rights reserved.
5
+ * @copyright 2014 Brandon Mills. All rights reserved.
6
+ */
7
+ "use strict";
8
+
9
+ //------------------------------------------------------------------------------
10
+ // Implementation
11
+ //------------------------------------------------------------------------------
12
+
13
+ module.exports = function(tokens) {
14
+ var api = {},
15
+ starts = Object.create(null),
16
+ ends = Object.create(null),
17
+ index, length, range;
18
+
19
+ /**
20
+ * Gets tokens in a given interval.
21
+ * @param {int} start Inclusive index of the first token. 0 if negative.
22
+ * @param {int} end Exclusive index of the last token.
23
+ * @returns {Token[]} Tokens in the interval.
24
+ */
25
+ function get(start, end) {
26
+ var result = [],
27
+ i;
28
+
29
+ for (i = Math.max(0, start); i < end && i < length; i++) {
30
+ result.push(tokens[i]);
31
+ }
32
+
33
+ return result;
34
+ }
35
+
36
+ /**
37
+ * Gets the index in the tokens array of the last token belonging to a node.
38
+ * Usually a node ends exactly at a token, but due to ASI, sometimes a
39
+ * node's range extends beyond its last token.
40
+ * @param {ASTNode} node The node for which to find the last token's index.
41
+ * @returns {int} Index in the tokens array of the node's last token.
42
+ */
43
+ function lastTokenIndex(node) {
44
+ var end = node.range[1],
45
+ cursor = ends[end];
46
+
47
+ // If the node extends beyond its last token, get the token before the
48
+ // next token
49
+ if (typeof cursor === "undefined") {
50
+ cursor = starts[end] - 1;
51
+ }
52
+
53
+ // If there isn't a next token, the desired token is the last one in the
54
+ // array
55
+ if (isNaN(cursor)) {
56
+ cursor = length - 1;
57
+ }
58
+
59
+ return cursor;
60
+ }
61
+
62
+ // Map tokens' start and end range to the index in the tokens array
63
+ for (index = 0, length = tokens.length; index < length; index++) {
64
+ range = tokens[index].range;
65
+ starts[range[0]] = index;
66
+ ends[range[1]] = index;
67
+ }
68
+
69
+ /**
70
+ * Gets a number of tokens that precede a given node or token in the token
71
+ * stream.
72
+ * @param {(ASTNode|Token)} node The AST node or token.
73
+ * @param {int} [beforeCount=0] The number of tokens before the node or
74
+ * token to retrieve.
75
+ * @returns {Token[]} Array of objects representing tokens.
76
+ */
77
+ api.getTokensBefore = function(node, beforeCount) {
78
+ var first = starts[node.range[0]];
79
+ return get(first - (beforeCount || 0), first);
80
+ };
81
+
82
+ /**
83
+ * Gets the token that precedes a given node or token in the token stream.
84
+ * @param {(ASTNode|Token)} node The AST node or token.
85
+ * @param {int} [skip=0] A number of tokens to skip before the given node or
86
+ * token.
87
+ * @returns {Token} An object representing the token.
88
+ */
89
+ api.getTokenBefore = function(node, skip) {
90
+ return tokens[starts[node.range[0]] - (skip || 0) - 1];
91
+ };
92
+
93
+ /**
94
+ * Gets a number of tokens that follow a given node or token in the token
95
+ * stream.
96
+ * @param {(ASTNode|Token)} node The AST node or token.
97
+ * @param {int} [afterCount=0] The number of tokens after the node or token
98
+ * to retrieve.
99
+ * @returns {Token[]} Array of objects representing tokens.
100
+ */
101
+ api.getTokensAfter = function(node, afterCount) {
102
+ var start = lastTokenIndex(node) + 1;
103
+ return get(start, start + (afterCount || 0));
104
+ };
105
+
106
+ /**
107
+ * Gets the token that follows a given node or token in the token stream.
108
+ * @param {(ASTNode|Token)} node The AST node or token.
109
+ * @param {int} [skip=0] A number of tokens to skip after the given node or
110
+ * token.
111
+ * @returns {Token} An object representing the token.
112
+ */
113
+ api.getTokenAfter = function(node, skip) {
114
+ return tokens[lastTokenIndex(node) + (skip || 0) + 1];
115
+ };
116
+
117
+ /**
118
+ * Gets all tokens that are related to the given node.
119
+ * @param {ASTNode} node The AST node.
120
+ * @param {int} [beforeCount=0] The number of tokens before the node to retrieve.
121
+ * @param {int} [afterCount=0] The number of tokens after the node to retrieve.
122
+ * @returns {Token[]} Array of objects representing tokens.
123
+ */
124
+ api.getTokens = function(node, beforeCount, afterCount) {
125
+ return get(
126
+ starts[node.range[0]] - (beforeCount || 0),
127
+ lastTokenIndex(node) + (afterCount || 0) + 1
128
+ );
129
+ };
130
+
131
+ /**
132
+ * Gets the first `count` tokens of the given node's token stream.
133
+ * @param {ASTNode} node The AST node.
134
+ * @param {int} [count=0] The number of tokens of the node to retrieve.
135
+ * @returns {Token[]} Array of objects representing tokens.
136
+ */
137
+ api.getFirstTokens = function(node, count) {
138
+ var first = starts[node.range[0]];
139
+ return get(
140
+ first,
141
+ Math.min(lastTokenIndex(node) + 1, first + (count || 0))
142
+ );
143
+ };
144
+
145
+ /**
146
+ * Gets the first token of the given node's token stream.
147
+ * @param {ASTNode} node The AST node.
148
+ * @param {int} [skip=0] A number of tokens to skip.
149
+ * @returns {Token} An object representing the token.
150
+ */
151
+ api.getFirstToken = function(node, skip) {
152
+ return tokens[starts[node.range[0]] + (skip || 0)];
153
+ };
154
+
155
+ /**
156
+ * Gets the last `count` tokens of the given node.
157
+ * @param {ASTNode} node The AST node.
158
+ * @param {int} [count=0] The number of tokens of the node to retrieve.
159
+ * @returns {Token[]} Array of objects representing tokens.
160
+ */
161
+ api.getLastTokens = function(node, count) {
162
+ var last = lastTokenIndex(node) + 1;
163
+ return get(Math.max(starts[node.range[0]], last - (count || 0)), last);
164
+ };
165
+
166
+ /**
167
+ * Gets the last token of the given node's token stream.
168
+ * @param {ASTNode} node The AST node.
169
+ * @param {int} [skip=0] A number of tokens to skip.
170
+ * @returns {Token} An object representing the token.
171
+ */
172
+ api.getLastToken = function(node, skip) {
173
+ return tokens[lastTokenIndex(node) - (skip || 0)];
174
+ };
175
+
176
+ /**
177
+ * Gets all of the tokens between two non-overlapping nodes.
178
+ * @param {ASTNode} left Node before the desired token range.
179
+ * @param {ASTNode} right Node after the desired token range.
180
+ * @param {int} [padding=0] Number of extra tokens on either side of center.
181
+ * @returns {Token[]} Tokens between left and right plus padding.
182
+ */
183
+ api.getTokensBetween = function(left, right, padding) {
184
+ padding = padding || 0;
185
+ return get(
186
+ lastTokenIndex(left) + 1 - padding,
187
+ starts[right.range[0]] + padding
188
+ );
189
+ };
190
+
191
+ /**
192
+ * Gets the token starting at the specified index.
193
+ * @param {int} startIndex Index of the start of the token's range.
194
+ * @returns {Token} The token starting at index, or null if no such token.
195
+ */
196
+ api.getTokenByRangeStart = function(startIndex) {
197
+ return (tokens[starts[startIndex]] || null);
198
+ };
199
+
200
+ return api;
201
+ };