eslint 9.22.0 → 9.23.0

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 (415) hide show
  1. package/README.md +47 -45
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +828 -808
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +541 -457
  21. package/lib/config/config-loader.js +648 -618
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +65 -68
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +709 -679
  30. package/lib/eslint/eslint.js +944 -886
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +576 -532
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2402 -2044
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +35 -35
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +375 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1307 -1045
  73. package/lib/rules/accessor-pairs.js +297 -262
  74. package/lib/rules/array-bracket-newline.js +249 -237
  75. package/lib/rules/array-bracket-spacing.js +262 -223
  76. package/lib/rules/array-callback-return.js +401 -355
  77. package/lib/rules/array-element-newline.js +357 -312
  78. package/lib/rules/arrow-body-style.js +399 -280
  79. package/lib/rules/arrow-parens.js +205 -172
  80. package/lib/rules/arrow-spacing.js +168 -162
  81. package/lib/rules/block-scoped-var.js +124 -122
  82. package/lib/rules/block-spacing.js +185 -175
  83. package/lib/rules/brace-style.js +261 -198
  84. package/lib/rules/callback-return.js +202 -189
  85. package/lib/rules/camelcase.js +402 -391
  86. package/lib/rules/capitalized-comments.js +252 -231
  87. package/lib/rules/class-methods-use-this.js +179 -171
  88. package/lib/rules/comma-dangle.js +378 -345
  89. package/lib/rules/comma-spacing.js +192 -194
  90. package/lib/rules/comma-style.js +374 -315
  91. package/lib/rules/complexity.js +172 -168
  92. package/lib/rules/computed-property-spacing.js +235 -210
  93. package/lib/rules/consistent-return.js +180 -169
  94. package/lib/rules/consistent-this.js +166 -146
  95. package/lib/rules/constructor-super.js +411 -403
  96. package/lib/rules/curly.js +406 -331
  97. package/lib/rules/default-case-last.js +37 -30
  98. package/lib/rules/default-case.js +88 -84
  99. package/lib/rules/default-param-last.js +68 -53
  100. package/lib/rules/dot-location.js +121 -109
  101. package/lib/rules/dot-notation.js +191 -155
  102. package/lib/rules/eol-last.js +121 -119
  103. package/lib/rules/eqeqeq.js +167 -154
  104. package/lib/rules/for-direction.js +145 -120
  105. package/lib/rules/func-call-spacing.js +260 -230
  106. package/lib/rules/func-name-matching.js +292 -208
  107. package/lib/rules/func-names.js +164 -163
  108. package/lib/rules/func-style.js +158 -126
  109. package/lib/rules/function-call-argument-newline.js +151 -128
  110. package/lib/rules/function-paren-newline.js +348 -290
  111. package/lib/rules/generator-star-spacing.js +228 -209
  112. package/lib/rules/getter-return.js +207 -171
  113. package/lib/rules/global-require.js +84 -73
  114. package/lib/rules/grouped-accessor-pairs.js +169 -149
  115. package/lib/rules/guard-for-in.js +71 -62
  116. package/lib/rules/handle-callback-err.js +107 -102
  117. package/lib/rules/id-blacklist.js +181 -198
  118. package/lib/rules/id-denylist.js +167 -186
  119. package/lib/rules/id-length.js +196 -170
  120. package/lib/rules/id-match.js +343 -288
  121. package/lib/rules/implicit-arrow-linebreak.js +101 -78
  122. package/lib/rules/indent-legacy.js +1343 -1117
  123. package/lib/rules/indent.js +2271 -1758
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +115 -106
  126. package/lib/rules/jsx-quotes.js +93 -81
  127. package/lib/rules/key-spacing.js +749 -632
  128. package/lib/rules/keyword-spacing.js +647 -604
  129. package/lib/rules/line-comment-position.js +141 -127
  130. package/lib/rules/linebreak-style.js +106 -105
  131. package/lib/rules/lines-around-comment.js +539 -447
  132. package/lib/rules/lines-around-directive.js +232 -202
  133. package/lib/rules/lines-between-class-members.js +304 -233
  134. package/lib/rules/logical-assignment-operators.js +581 -398
  135. package/lib/rules/max-classes-per-file.js +68 -67
  136. package/lib/rules/max-depth.js +145 -142
  137. package/lib/rules/max-len.js +472 -433
  138. package/lib/rules/max-lines-per-function.js +200 -175
  139. package/lib/rules/max-lines.js +157 -161
  140. package/lib/rules/max-nested-callbacks.js +101 -103
  141. package/lib/rules/max-params.js +77 -75
  142. package/lib/rules/max-statements-per-line.js +204 -197
  143. package/lib/rules/max-statements.js +167 -163
  144. package/lib/rules/multiline-comment-style.js +636 -478
  145. package/lib/rules/multiline-ternary.js +240 -175
  146. package/lib/rules/new-cap.js +232 -212
  147. package/lib/rules/new-parens.js +87 -78
  148. package/lib/rules/newline-after-var.js +286 -249
  149. package/lib/rules/newline-before-return.js +228 -221
  150. package/lib/rules/newline-per-chained-call.js +141 -126
  151. package/lib/rules/no-alert.js +89 -78
  152. package/lib/rules/no-array-constructor.js +121 -112
  153. package/lib/rules/no-async-promise-executor.js +29 -23
  154. package/lib/rules/no-await-in-loop.js +68 -70
  155. package/lib/rules/no-bitwise.js +123 -99
  156. package/lib/rules/no-buffer-constructor.js +54 -46
  157. package/lib/rules/no-caller.js +38 -32
  158. package/lib/rules/no-case-declarations.js +60 -56
  159. package/lib/rules/no-catch-shadow.js +75 -72
  160. package/lib/rules/no-class-assign.js +50 -47
  161. package/lib/rules/no-compare-neg-zero.js +61 -47
  162. package/lib/rules/no-cond-assign.js +147 -131
  163. package/lib/rules/no-confusing-arrow.js +97 -80
  164. package/lib/rules/no-console.js +201 -198
  165. package/lib/rules/no-const-assign.js +46 -40
  166. package/lib/rules/no-constant-binary-expression.js +499 -404
  167. package/lib/rules/no-constant-condition.js +157 -142
  168. package/lib/rules/no-constructor-return.js +48 -48
  169. package/lib/rules/no-continue.js +24 -26
  170. package/lib/rules/no-control-regex.js +124 -120
  171. package/lib/rules/no-debugger.js +27 -29
  172. package/lib/rules/no-delete-var.js +28 -28
  173. package/lib/rules/no-div-regex.js +46 -40
  174. package/lib/rules/no-dupe-args.js +67 -68
  175. package/lib/rules/no-dupe-class-members.js +92 -88
  176. package/lib/rules/no-dupe-else-if.js +99 -76
  177. package/lib/rules/no-dupe-keys.js +132 -109
  178. package/lib/rules/no-duplicate-case.js +49 -42
  179. package/lib/rules/no-duplicate-imports.js +178 -175
  180. package/lib/rules/no-else-return.js +429 -384
  181. package/lib/rules/no-empty-character-class.js +56 -49
  182. package/lib/rules/no-empty-function.js +126 -127
  183. package/lib/rules/no-empty-pattern.js +62 -57
  184. package/lib/rules/no-empty-static-block.js +36 -34
  185. package/lib/rules/no-empty.js +97 -85
  186. package/lib/rules/no-eq-null.js +36 -31
  187. package/lib/rules/no-eval.js +255 -249
  188. package/lib/rules/no-ex-assign.js +41 -38
  189. package/lib/rules/no-extend-native.js +160 -158
  190. package/lib/rules/no-extra-bind.js +200 -189
  191. package/lib/rules/no-extra-boolean-cast.js +397 -347
  192. package/lib/rules/no-extra-label.js +149 -130
  193. package/lib/rules/no-extra-parens.js +1653 -1324
  194. package/lib/rules/no-extra-semi.js +145 -143
  195. package/lib/rules/no-fallthrough.js +198 -156
  196. package/lib/rules/no-floating-decimal.js +73 -65
  197. package/lib/rules/no-func-assign.js +53 -54
  198. package/lib/rules/no-global-assign.js +77 -72
  199. package/lib/rules/no-implicit-coercion.js +348 -292
  200. package/lib/rules/no-implicit-globals.js +157 -134
  201. package/lib/rules/no-implied-eval.js +139 -111
  202. package/lib/rules/no-import-assign.js +144 -158
  203. package/lib/rules/no-inline-comments.js +100 -94
  204. package/lib/rules/no-inner-declarations.js +114 -100
  205. package/lib/rules/no-invalid-regexp.js +221 -189
  206. package/lib/rules/no-invalid-this.js +122 -116
  207. package/lib/rules/no-irregular-whitespace.js +265 -251
  208. package/lib/rules/no-iterator.js +28 -32
  209. package/lib/rules/no-label-var.js +58 -61
  210. package/lib/rules/no-labels.js +137 -132
  211. package/lib/rules/no-lone-blocks.js +126 -122
  212. package/lib/rules/no-lonely-if.js +107 -76
  213. package/lib/rules/no-loop-func.js +233 -212
  214. package/lib/rules/no-loss-of-precision.js +215 -200
  215. package/lib/rules/no-magic-numbers.js +245 -217
  216. package/lib/rules/no-misleading-character-class.js +498 -445
  217. package/lib/rules/no-mixed-operators.js +187 -181
  218. package/lib/rules/no-mixed-requires.js +252 -239
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +133 -120
  220. package/lib/rules/no-multi-assign.js +45 -43
  221. package/lib/rules/no-multi-spaces.js +162 -142
  222. package/lib/rules/no-multi-str.js +41 -40
  223. package/lib/rules/no-multiple-empty-lines.js +195 -157
  224. package/lib/rules/no-native-reassign.js +89 -84
  225. package/lib/rules/no-negated-condition.js +78 -74
  226. package/lib/rules/no-negated-in-lhs.js +44 -42
  227. package/lib/rules/no-nested-ternary.js +32 -31
  228. package/lib/rules/no-new-func.js +70 -61
  229. package/lib/rules/no-new-native-nonconstructor.js +42 -38
  230. package/lib/rules/no-new-object.js +47 -47
  231. package/lib/rules/no-new-require.js +47 -46
  232. package/lib/rules/no-new-symbol.js +51 -49
  233. package/lib/rules/no-new-wrappers.js +42 -40
  234. package/lib/rules/no-new.js +27 -28
  235. package/lib/rules/no-nonoctal-decimal-escape.js +140 -120
  236. package/lib/rules/no-obj-calls.js +65 -52
  237. package/lib/rules/no-object-constructor.js +103 -96
  238. package/lib/rules/no-octal-escape.js +39 -42
  239. package/lib/rules/no-octal.js +31 -31
  240. package/lib/rules/no-param-reassign.js +234 -216
  241. package/lib/rules/no-path-concat.js +65 -66
  242. package/lib/rules/no-plusplus.js +59 -60
  243. package/lib/rules/no-process-env.js +48 -47
  244. package/lib/rules/no-process-exit.js +53 -49
  245. package/lib/rules/no-promise-executor-return.js +213 -181
  246. package/lib/rules/no-proto.js +25 -28
  247. package/lib/rules/no-prototype-builtins.js +145 -123
  248. package/lib/rules/no-redeclare.js +153 -151
  249. package/lib/rules/no-regex-spaces.js +182 -160
  250. package/lib/rules/no-restricted-exports.js +207 -184
  251. package/lib/rules/no-restricted-globals.js +110 -111
  252. package/lib/rules/no-restricted-imports.js +656 -536
  253. package/lib/rules/no-restricted-modules.js +221 -201
  254. package/lib/rules/no-restricted-properties.js +180 -152
  255. package/lib/rules/no-restricted-syntax.js +55 -51
  256. package/lib/rules/no-return-assign.js +54 -49
  257. package/lib/rules/no-return-await.js +147 -123
  258. package/lib/rules/no-script-url.js +51 -44
  259. package/lib/rules/no-self-assign.js +147 -145
  260. package/lib/rules/no-self-compare.js +62 -45
  261. package/lib/rules/no-sequences.js +134 -115
  262. package/lib/rules/no-setter-return.js +184 -151
  263. package/lib/rules/no-shadow-restricted-names.js +60 -45
  264. package/lib/rules/no-shadow.js +341 -315
  265. package/lib/rules/no-spaced-func.js +81 -76
  266. package/lib/rules/no-sparse-arrays.js +53 -58
  267. package/lib/rules/no-sync.js +60 -59
  268. package/lib/rules/no-tabs.js +82 -71
  269. package/lib/rules/no-template-curly-in-string.js +32 -31
  270. package/lib/rules/no-ternary.js +24 -28
  271. package/lib/rules/no-this-before-super.js +320 -318
  272. package/lib/rules/no-throw-literal.js +30 -35
  273. package/lib/rules/no-trailing-spaces.js +198 -190
  274. package/lib/rules/no-undef-init.js +75 -60
  275. package/lib/rules/no-undef.js +50 -47
  276. package/lib/rules/no-undefined.js +72 -74
  277. package/lib/rules/no-underscore-dangle.js +369 -326
  278. package/lib/rules/no-unexpected-multiline.js +111 -101
  279. package/lib/rules/no-unmodified-loop-condition.js +253 -253
  280. package/lib/rules/no-unneeded-ternary.js +211 -146
  281. package/lib/rules/no-unreachable-loop.js +144 -141
  282. package/lib/rules/no-unreachable.js +254 -247
  283. package/lib/rules/no-unsafe-finally.js +92 -84
  284. package/lib/rules/no-unsafe-negation.js +104 -82
  285. package/lib/rules/no-unsafe-optional-chaining.js +191 -177
  286. package/lib/rules/no-unused-expressions.js +177 -161
  287. package/lib/rules/no-unused-labels.js +138 -123
  288. package/lib/rules/no-unused-private-class-members.js +205 -181
  289. package/lib/rules/no-unused-vars.js +1668 -1448
  290. package/lib/rules/no-use-before-define.js +228 -230
  291. package/lib/rules/no-useless-assignment.js +589 -510
  292. package/lib/rules/no-useless-backreference.js +211 -192
  293. package/lib/rules/no-useless-call.js +57 -52
  294. package/lib/rules/no-useless-catch.js +39 -39
  295. package/lib/rules/no-useless-computed-key.js +143 -114
  296. package/lib/rules/no-useless-concat.js +64 -59
  297. package/lib/rules/no-useless-constructor.js +157 -110
  298. package/lib/rules/no-useless-escape.js +341 -290
  299. package/lib/rules/no-useless-rename.js +182 -155
  300. package/lib/rules/no-useless-return.js +343 -311
  301. package/lib/rules/no-var.js +232 -211
  302. package/lib/rules/no-void.js +49 -47
  303. package/lib/rules/no-warning-comments.js +190 -185
  304. package/lib/rules/no-whitespace-before-property.js +130 -114
  305. package/lib/rules/no-with.js +23 -25
  306. package/lib/rules/nonblock-statement-body-position.js +148 -129
  307. package/lib/rules/object-curly-newline.js +305 -264
  308. package/lib/rules/object-curly-spacing.js +359 -313
  309. package/lib/rules/object-property-newline.js +136 -105
  310. package/lib/rules/object-shorthand.js +606 -501
  311. package/lib/rules/one-var-declaration-per-line.js +103 -99
  312. package/lib/rules/one-var.js +652 -536
  313. package/lib/rules/operator-assignment.js +218 -160
  314. package/lib/rules/operator-linebreak.js +294 -250
  315. package/lib/rules/padded-blocks.js +345 -307
  316. package/lib/rules/padding-line-between-statements.js +442 -438
  317. package/lib/rules/prefer-arrow-callback.js +361 -312
  318. package/lib/rules/prefer-const.js +417 -376
  319. package/lib/rules/prefer-destructuring.js +300 -278
  320. package/lib/rules/prefer-exponentiation-operator.js +175 -132
  321. package/lib/rules/prefer-named-capture-group.js +152 -139
  322. package/lib/rules/prefer-numeric-literals.js +120 -112
  323. package/lib/rules/prefer-object-has-own.js +115 -81
  324. package/lib/rules/prefer-object-spread.js +212 -192
  325. package/lib/rules/prefer-promise-reject-errors.js +139 -121
  326. package/lib/rules/prefer-reflect.js +126 -106
  327. package/lib/rules/prefer-regex-literals.js +577 -465
  328. package/lib/rules/prefer-rest-params.js +78 -79
  329. package/lib/rules/prefer-spread.js +46 -43
  330. package/lib/rules/prefer-template.js +265 -194
  331. package/lib/rules/quote-props.js +372 -306
  332. package/lib/rules/quotes.js +373 -325
  333. package/lib/rules/radix.js +151 -135
  334. package/lib/rules/require-atomic-updates.js +315 -284
  335. package/lib/rules/require-await.js +143 -115
  336. package/lib/rules/require-unicode-regexp.js +281 -176
  337. package/lib/rules/require-yield.js +52 -53
  338. package/lib/rules/rest-spread-spacing.js +127 -115
  339. package/lib/rules/semi-spacing.js +280 -249
  340. package/lib/rules/semi-style.js +175 -133
  341. package/lib/rules/semi.js +455 -435
  342. package/lib/rules/sort-imports.js +305 -232
  343. package/lib/rules/sort-keys.js +218 -187
  344. package/lib/rules/sort-vars.js +126 -92
  345. package/lib/rules/space-before-blocks.js +198 -188
  346. package/lib/rules/space-before-function-paren.js +185 -165
  347. package/lib/rules/space-in-parens.js +358 -287
  348. package/lib/rules/space-infix-ops.js +236 -200
  349. package/lib/rules/space-unary-ops.js +355 -297
  350. package/lib/rules/spaced-comment.js +362 -318
  351. package/lib/rules/strict.js +264 -229
  352. package/lib/rules/switch-colon-spacing.js +129 -121
  353. package/lib/rules/symbol-description.js +44 -47
  354. package/lib/rules/template-curly-spacing.js +147 -141
  355. package/lib/rules/template-tag-spacing.js +97 -87
  356. package/lib/rules/unicode-bom.js +53 -55
  357. package/lib/rules/use-isnan.js +236 -205
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +152 -110
  370. package/lib/rules/vars-on-top.js +151 -144
  371. package/lib/rules/wrap-iife.js +203 -190
  372. package/lib/rules/wrap-regex.js +69 -57
  373. package/lib/rules/yield-star-spacing.js +144 -133
  374. package/lib/rules/yoda.js +282 -271
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/shared/ajv.js +14 -14
  378. package/lib/shared/assert.js +3 -4
  379. package/lib/shared/ast-utils.js +7 -6
  380. package/lib/shared/deep-merge-arrays.js +24 -22
  381. package/lib/shared/directives.js +3 -2
  382. package/lib/shared/flags.js +46 -17
  383. package/lib/shared/logging.js +24 -25
  384. package/lib/shared/option-utils.js +43 -36
  385. package/lib/shared/runtime-info.js +136 -127
  386. package/lib/shared/serialization.js +27 -27
  387. package/lib/shared/severity.js +22 -22
  388. package/lib/shared/stats.js +5 -5
  389. package/lib/shared/string-utils.js +16 -16
  390. package/lib/shared/text-table.js +28 -27
  391. package/lib/shared/traverser.js +153 -146
  392. package/lib/types/index.d.ts +2010 -1559
  393. package/lib/types/rules.d.ts +5253 -5140
  394. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  395. package/lib/unsupported-api.js +5 -5
  396. package/messages/all-files-ignored.js +3 -3
  397. package/messages/all-matched-files-ignored.js +3 -3
  398. package/messages/config-file-missing.js +2 -2
  399. package/messages/config-plugin-missing.js +3 -3
  400. package/messages/config-serialize-function.js +9 -7
  401. package/messages/eslintrc-incompat.js +13 -15
  402. package/messages/eslintrc-plugins.js +3 -4
  403. package/messages/extend-config-missing.js +3 -3
  404. package/messages/failed-to-read-json.js +3 -3
  405. package/messages/file-not-found.js +3 -3
  406. package/messages/invalid-rule-options.js +2 -2
  407. package/messages/invalid-rule-severity.js +2 -2
  408. package/messages/no-config-found.js +3 -3
  409. package/messages/plugin-conflict.js +8 -8
  410. package/messages/plugin-invalid.js +3 -3
  411. package/messages/plugin-missing.js +3 -3
  412. package/messages/print-config-with-directory-path.js +2 -2
  413. package/messages/shared.js +6 -1
  414. package/messages/whitespace-found.js +3 -3
  415. package/package.json +11 -17
@@ -11,53 +11,53 @@
11
11
  //------------------------------------------------------------------------------
12
12
 
13
13
  const OPTIONS_SCHEMA = {
14
- type: "object",
15
- properties: {
16
- code: {
17
- type: "integer",
18
- minimum: 0
19
- },
20
- comments: {
21
- type: "integer",
22
- minimum: 0
23
- },
24
- tabWidth: {
25
- type: "integer",
26
- minimum: 0
27
- },
28
- ignorePattern: {
29
- type: "string"
30
- },
31
- ignoreComments: {
32
- type: "boolean"
33
- },
34
- ignoreStrings: {
35
- type: "boolean"
36
- },
37
- ignoreUrls: {
38
- type: "boolean"
39
- },
40
- ignoreTemplateLiterals: {
41
- type: "boolean"
42
- },
43
- ignoreRegExpLiterals: {
44
- type: "boolean"
45
- },
46
- ignoreTrailingComments: {
47
- type: "boolean"
48
- }
49
- },
50
- additionalProperties: false
14
+ type: "object",
15
+ properties: {
16
+ code: {
17
+ type: "integer",
18
+ minimum: 0,
19
+ },
20
+ comments: {
21
+ type: "integer",
22
+ minimum: 0,
23
+ },
24
+ tabWidth: {
25
+ type: "integer",
26
+ minimum: 0,
27
+ },
28
+ ignorePattern: {
29
+ type: "string",
30
+ },
31
+ ignoreComments: {
32
+ type: "boolean",
33
+ },
34
+ ignoreStrings: {
35
+ type: "boolean",
36
+ },
37
+ ignoreUrls: {
38
+ type: "boolean",
39
+ },
40
+ ignoreTemplateLiterals: {
41
+ type: "boolean",
42
+ },
43
+ ignoreRegExpLiterals: {
44
+ type: "boolean",
45
+ },
46
+ ignoreTrailingComments: {
47
+ type: "boolean",
48
+ },
49
+ },
50
+ additionalProperties: false,
51
51
  };
52
52
 
53
53
  const OPTIONS_OR_INTEGER_SCHEMA = {
54
- anyOf: [
55
- OPTIONS_SCHEMA,
56
- {
57
- type: "integer",
58
- minimum: 0
59
- }
60
- ]
54
+ anyOf: [
55
+ OPTIONS_SCHEMA,
56
+ {
57
+ type: "integer",
58
+ minimum: 0,
59
+ },
60
+ ],
61
61
  };
62
62
 
63
63
  //------------------------------------------------------------------------------
@@ -66,393 +66,432 @@ const OPTIONS_OR_INTEGER_SCHEMA = {
66
66
 
67
67
  /** @type {import('../shared/types').Rule} */
68
68
  module.exports = {
69
- meta: {
70
- deprecated: {
71
- message: "Formatting rules are being moved out of ESLint core.",
72
- url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
73
- deprecatedSince: "8.53.0",
74
- availableUntil: "10.0.0",
75
- replacedBy: [
76
- {
77
- message: "ESLint Stylistic now maintains deprecated stylistic core rules.",
78
- url: "https://eslint.style/guide/migration",
79
- plugin: {
80
- name: "@stylistic/eslint-plugin-js",
81
- url: "https://eslint.style/packages/js"
82
- },
83
- rule: {
84
- name: "max-len",
85
- url: "https://eslint.style/rules/js/max-len"
86
- }
87
- }
88
- ]
89
- },
90
- type: "layout",
91
-
92
- docs: {
93
- description: "Enforce a maximum line length",
94
- recommended: false,
95
- url: "https://eslint.org/docs/latest/rules/max-len"
96
- },
97
-
98
- schema: [
99
- OPTIONS_OR_INTEGER_SCHEMA,
100
- OPTIONS_OR_INTEGER_SCHEMA,
101
- OPTIONS_SCHEMA
102
- ],
103
- messages: {
104
- max: "This line has a length of {{lineLength}}. Maximum allowed is {{maxLength}}.",
105
- maxComment: "This line has a comment length of {{lineLength}}. Maximum allowed is {{maxCommentLength}}."
106
- }
107
- },
108
-
109
- create(context) {
110
-
111
- /*
112
- * Inspired by http://tools.ietf.org/html/rfc3986#appendix-B, however:
113
- * - They're matching an entire string that we know is a URI
114
- * - We're matching part of a string where we think there *might* be a URL
115
- * - We're only concerned about URLs, as picking out any URI would cause
116
- * too many false positives
117
- * - We don't care about matching the entire URL, any small segment is fine
118
- */
119
- const URL_REGEXP = /[^:/?#]:\/\/[^?#]/u;
120
-
121
- const sourceCode = context.sourceCode;
122
-
123
- /**
124
- * Computes the length of a line that may contain tabs. The width of each
125
- * tab will be the number of spaces to the next tab stop.
126
- * @param {string} line The line.
127
- * @param {int} tabWidth The width of each tab stop in spaces.
128
- * @returns {int} The computed line length.
129
- * @private
130
- */
131
- function computeLineLength(line, tabWidth) {
132
- let extraCharacterCount = 0;
133
-
134
- line.replace(/\t/gu, (match, offset) => {
135
- const totalOffset = offset + extraCharacterCount,
136
- previousTabStopOffset = tabWidth ? totalOffset % tabWidth : 0,
137
- spaceCount = tabWidth - previousTabStopOffset;
138
-
139
- extraCharacterCount += spaceCount - 1; // -1 for the replaced tab
140
- });
141
- return Array.from(line).length + extraCharacterCount;
142
- }
143
-
144
- // The options object must be the last option specified…
145
- const options = Object.assign({}, context.options.at(-1));
146
-
147
- // …but max code length
148
- if (typeof context.options[0] === "number") {
149
- options.code = context.options[0];
150
- }
151
-
152
- // …and tabWidth can be optionally specified directly as integers.
153
- if (typeof context.options[1] === "number") {
154
- options.tabWidth = context.options[1];
155
- }
156
-
157
- const maxLength = typeof options.code === "number" ? options.code : 80,
158
- tabWidth = typeof options.tabWidth === "number" ? options.tabWidth : 4,
159
- ignoreComments = !!options.ignoreComments,
160
- ignoreStrings = !!options.ignoreStrings,
161
- ignoreTemplateLiterals = !!options.ignoreTemplateLiterals,
162
- ignoreRegExpLiterals = !!options.ignoreRegExpLiterals,
163
- ignoreTrailingComments = !!options.ignoreTrailingComments || !!options.ignoreComments,
164
- ignoreUrls = !!options.ignoreUrls,
165
- maxCommentLength = options.comments;
166
- let ignorePattern = options.ignorePattern || null;
167
-
168
- if (ignorePattern) {
169
- ignorePattern = new RegExp(ignorePattern, "u");
170
- }
171
-
172
- //--------------------------------------------------------------------------
173
- // Helpers
174
- //--------------------------------------------------------------------------
175
-
176
- /**
177
- * Tells if a given comment is trailing: it starts on the current line and
178
- * extends to or past the end of the current line.
179
- * @param {string} line The source line we want to check for a trailing comment on
180
- * @param {number} lineNumber The one-indexed line number for line
181
- * @param {ASTNode} comment The comment to inspect
182
- * @returns {boolean} If the comment is trailing on the given line
183
- */
184
- function isTrailingComment(line, lineNumber, comment) {
185
- return comment &&
186
- (comment.loc.start.line === lineNumber && lineNumber <= comment.loc.end.line) &&
187
- (comment.loc.end.line > lineNumber || comment.loc.end.column === line.length);
188
- }
189
-
190
- /**
191
- * Tells if a comment encompasses the entire line.
192
- * @param {string} line The source line with a trailing comment
193
- * @param {number} lineNumber The one-indexed line number this is on
194
- * @param {ASTNode} comment The comment to remove
195
- * @returns {boolean} If the comment covers the entire line
196
- */
197
- function isFullLineComment(line, lineNumber, comment) {
198
- const start = comment.loc.start,
199
- end = comment.loc.end,
200
- isFirstTokenOnLine = !line.slice(0, comment.loc.start.column).trim();
201
-
202
- return comment &&
203
- (start.line < lineNumber || (start.line === lineNumber && isFirstTokenOnLine)) &&
204
- (end.line > lineNumber || (end.line === lineNumber && end.column === line.length));
205
- }
206
-
207
- /**
208
- * Check if a node is a JSXEmptyExpression contained in a single line JSXExpressionContainer.
209
- * @param {ASTNode} node A node to check.
210
- * @returns {boolean} True if the node is a JSXEmptyExpression contained in a single line JSXExpressionContainer.
211
- */
212
- function isJSXEmptyExpressionInSingleLineContainer(node) {
213
- if (!node || !node.parent || node.type !== "JSXEmptyExpression" || node.parent.type !== "JSXExpressionContainer") {
214
- return false;
215
- }
216
-
217
- const parent = node.parent;
218
-
219
- return parent.loc.start.line === parent.loc.end.line;
220
- }
221
-
222
- /**
223
- * Gets the line after the comment and any remaining trailing whitespace is
224
- * stripped.
225
- * @param {string} line The source line with a trailing comment
226
- * @param {ASTNode} comment The comment to remove
227
- * @returns {string} Line without comment and trailing whitespace
228
- */
229
- function stripTrailingComment(line, comment) {
230
-
231
- // loc.column is zero-indexed
232
- return line.slice(0, comment.loc.start.column).replace(/\s+$/u, "");
233
- }
234
-
235
- /**
236
- * Ensure that an array exists at [key] on `object`, and add `value` to it.
237
- * @param {Object} object the object to mutate
238
- * @param {string} key the object's key
239
- * @param {any} value the value to add
240
- * @returns {void}
241
- * @private
242
- */
243
- function ensureArrayAndPush(object, key, value) {
244
- if (!Array.isArray(object[key])) {
245
- object[key] = [];
246
- }
247
- object[key].push(value);
248
- }
249
-
250
- /**
251
- * Retrieves an array containing all strings (" or ') in the source code.
252
- * @returns {ASTNode[]} An array of string nodes.
253
- */
254
- function getAllStrings() {
255
- return sourceCode.ast.tokens.filter(token => (token.type === "String" ||
256
- (token.type === "JSXText" && sourceCode.getNodeByRangeIndex(token.range[0] - 1).type === "JSXAttribute")));
257
- }
258
-
259
- /**
260
- * Retrieves an array containing all template literals in the source code.
261
- * @returns {ASTNode[]} An array of template literal nodes.
262
- */
263
- function getAllTemplateLiterals() {
264
- return sourceCode.ast.tokens.filter(token => token.type === "Template");
265
- }
266
-
267
-
268
- /**
269
- * Retrieves an array containing all RegExp literals in the source code.
270
- * @returns {ASTNode[]} An array of RegExp literal nodes.
271
- */
272
- function getAllRegExpLiterals() {
273
- return sourceCode.ast.tokens.filter(token => token.type === "RegularExpression");
274
- }
275
-
276
- /**
277
- *
278
- * reduce an array of AST nodes by line number, both start and end.
279
- * @param {ASTNode[]} arr array of AST nodes
280
- * @returns {Object} accululated AST nodes
281
- */
282
- function groupArrayByLineNumber(arr) {
283
- const obj = {};
284
-
285
- for (let i = 0; i < arr.length; i++) {
286
- const node = arr[i];
287
-
288
- for (let j = node.loc.start.line; j <= node.loc.end.line; ++j) {
289
- ensureArrayAndPush(obj, j, node);
290
- }
291
- }
292
- return obj;
293
- }
294
-
295
- /**
296
- * Returns an array of all comments in the source code.
297
- * If the element in the array is a JSXEmptyExpression contained with a single line JSXExpressionContainer,
298
- * the element is changed with JSXExpressionContainer node.
299
- * @returns {ASTNode[]} An array of comment nodes
300
- */
301
- function getAllComments() {
302
- const comments = [];
303
-
304
- sourceCode.getAllComments()
305
- .forEach(commentNode => {
306
- const containingNode = sourceCode.getNodeByRangeIndex(commentNode.range[0]);
307
-
308
- if (isJSXEmptyExpressionInSingleLineContainer(containingNode)) {
309
-
310
- // push a unique node only
311
- if (comments.at(-1) !== containingNode.parent) {
312
- comments.push(containingNode.parent);
313
- }
314
- } else {
315
- comments.push(commentNode);
316
- }
317
- });
318
-
319
- return comments;
320
- }
321
-
322
- /**
323
- * Check the program for max length
324
- * @param {ASTNode} node Node to examine
325
- * @returns {void}
326
- * @private
327
- */
328
- function checkProgramForMaxLength(node) {
329
-
330
- // split (honors line-ending)
331
- const lines = sourceCode.lines,
332
-
333
- // list of comments to ignore
334
- comments = ignoreComments || maxCommentLength || ignoreTrailingComments ? getAllComments() : [];
335
-
336
- // we iterate over comments in parallel with the lines
337
- let commentsIndex = 0;
338
-
339
- const strings = getAllStrings();
340
- const stringsByLine = groupArrayByLineNumber(strings);
341
-
342
- const templateLiterals = getAllTemplateLiterals();
343
- const templateLiteralsByLine = groupArrayByLineNumber(templateLiterals);
344
-
345
- const regExpLiterals = getAllRegExpLiterals();
346
- const regExpLiteralsByLine = groupArrayByLineNumber(regExpLiterals);
347
-
348
- lines.forEach((line, i) => {
349
-
350
- // i is zero-indexed, line numbers are one-indexed
351
- const lineNumber = i + 1;
352
-
353
- /*
354
- * if we're checking comment length; we need to know whether this
355
- * line is a comment
356
- */
357
- let lineIsComment = false;
358
- let textToMeasure;
359
-
360
- /*
361
- * We can short-circuit the comment checks if we're already out of
362
- * comments to check.
363
- */
364
- if (commentsIndex < comments.length) {
365
- let comment;
366
-
367
- // iterate over comments until we find one past the current line
368
- do {
369
- comment = comments[++commentsIndex];
370
- } while (comment && comment.loc.start.line <= lineNumber);
371
-
372
- // and step back by one
373
- comment = comments[--commentsIndex];
374
-
375
- if (isFullLineComment(line, lineNumber, comment)) {
376
- lineIsComment = true;
377
- textToMeasure = line;
378
- } else if (ignoreTrailingComments && isTrailingComment(line, lineNumber, comment)) {
379
- textToMeasure = stripTrailingComment(line, comment);
380
-
381
- // ignore multiple trailing comments in the same line
382
- let lastIndex = commentsIndex;
383
-
384
- while (isTrailingComment(textToMeasure, lineNumber, comments[--lastIndex])) {
385
- textToMeasure = stripTrailingComment(textToMeasure, comments[lastIndex]);
386
- }
387
- } else {
388
- textToMeasure = line;
389
- }
390
- } else {
391
- textToMeasure = line;
392
- }
393
- if (ignorePattern && ignorePattern.test(textToMeasure) ||
394
- ignoreUrls && URL_REGEXP.test(textToMeasure) ||
395
- ignoreStrings && stringsByLine[lineNumber] ||
396
- ignoreTemplateLiterals && templateLiteralsByLine[lineNumber] ||
397
- ignoreRegExpLiterals && regExpLiteralsByLine[lineNumber]
398
- ) {
399
-
400
- // ignore this line
401
- return;
402
- }
403
-
404
- const lineLength = computeLineLength(textToMeasure, tabWidth);
405
- const commentLengthApplies = lineIsComment && maxCommentLength;
406
-
407
- if (lineIsComment && ignoreComments) {
408
- return;
409
- }
410
-
411
- const loc = {
412
- start: {
413
- line: lineNumber,
414
- column: 0
415
- },
416
- end: {
417
- line: lineNumber,
418
- column: textToMeasure.length
419
- }
420
- };
421
-
422
- if (commentLengthApplies) {
423
- if (lineLength > maxCommentLength) {
424
- context.report({
425
- node,
426
- loc,
427
- messageId: "maxComment",
428
- data: {
429
- lineLength,
430
- maxCommentLength
431
- }
432
- });
433
- }
434
- } else if (lineLength > maxLength) {
435
- context.report({
436
- node,
437
- loc,
438
- messageId: "max",
439
- data: {
440
- lineLength,
441
- maxLength
442
- }
443
- });
444
- }
445
- });
446
- }
447
-
448
-
449
- //--------------------------------------------------------------------------
450
- // Public API
451
- //--------------------------------------------------------------------------
452
-
453
- return {
454
- Program: checkProgramForMaxLength
455
- };
456
-
457
- }
69
+ meta: {
70
+ deprecated: {
71
+ message: "Formatting rules are being moved out of ESLint core.",
72
+ url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
73
+ deprecatedSince: "8.53.0",
74
+ availableUntil: "10.0.0",
75
+ replacedBy: [
76
+ {
77
+ message:
78
+ "ESLint Stylistic now maintains deprecated stylistic core rules.",
79
+ url: "https://eslint.style/guide/migration",
80
+ plugin: {
81
+ name: "@stylistic/eslint-plugin-js",
82
+ url: "https://eslint.style/packages/js",
83
+ },
84
+ rule: {
85
+ name: "max-len",
86
+ url: "https://eslint.style/rules/js/max-len",
87
+ },
88
+ },
89
+ ],
90
+ },
91
+ type: "layout",
92
+
93
+ docs: {
94
+ description: "Enforce a maximum line length",
95
+ recommended: false,
96
+ url: "https://eslint.org/docs/latest/rules/max-len",
97
+ },
98
+
99
+ schema: [
100
+ OPTIONS_OR_INTEGER_SCHEMA,
101
+ OPTIONS_OR_INTEGER_SCHEMA,
102
+ OPTIONS_SCHEMA,
103
+ ],
104
+ messages: {
105
+ max: "This line has a length of {{lineLength}}. Maximum allowed is {{maxLength}}.",
106
+ maxComment:
107
+ "This line has a comment length of {{lineLength}}. Maximum allowed is {{maxCommentLength}}.",
108
+ },
109
+ },
110
+
111
+ create(context) {
112
+ /*
113
+ * Inspired by http://tools.ietf.org/html/rfc3986#appendix-B, however:
114
+ * - They're matching an entire string that we know is a URI
115
+ * - We're matching part of a string where we think there *might* be a URL
116
+ * - We're only concerned about URLs, as picking out any URI would cause
117
+ * too many false positives
118
+ * - We don't care about matching the entire URL, any small segment is fine
119
+ */
120
+ const URL_REGEXP = /[^:/?#]:\/\/[^?#]/u;
121
+
122
+ const sourceCode = context.sourceCode;
123
+
124
+ /**
125
+ * Computes the length of a line that may contain tabs. The width of each
126
+ * tab will be the number of spaces to the next tab stop.
127
+ * @param {string} line The line.
128
+ * @param {int} tabWidth The width of each tab stop in spaces.
129
+ * @returns {int} The computed line length.
130
+ * @private
131
+ */
132
+ function computeLineLength(line, tabWidth) {
133
+ let extraCharacterCount = 0;
134
+
135
+ line.replace(/\t/gu, (match, offset) => {
136
+ const totalOffset = offset + extraCharacterCount,
137
+ previousTabStopOffset = tabWidth
138
+ ? totalOffset % tabWidth
139
+ : 0,
140
+ spaceCount = tabWidth - previousTabStopOffset;
141
+
142
+ extraCharacterCount += spaceCount - 1; // -1 for the replaced tab
143
+ });
144
+ return Array.from(line).length + extraCharacterCount;
145
+ }
146
+
147
+ // The options object must be the last option specified
148
+ const options = Object.assign({}, context.options.at(-1));
149
+
150
+ // …but max code length…
151
+ if (typeof context.options[0] === "number") {
152
+ options.code = context.options[0];
153
+ }
154
+
155
+ // …and tabWidth can be optionally specified directly as integers.
156
+ if (typeof context.options[1] === "number") {
157
+ options.tabWidth = context.options[1];
158
+ }
159
+
160
+ const maxLength = typeof options.code === "number" ? options.code : 80,
161
+ tabWidth =
162
+ typeof options.tabWidth === "number" ? options.tabWidth : 4,
163
+ ignoreComments = !!options.ignoreComments,
164
+ ignoreStrings = !!options.ignoreStrings,
165
+ ignoreTemplateLiterals = !!options.ignoreTemplateLiterals,
166
+ ignoreRegExpLiterals = !!options.ignoreRegExpLiterals,
167
+ ignoreTrailingComments =
168
+ !!options.ignoreTrailingComments || !!options.ignoreComments,
169
+ ignoreUrls = !!options.ignoreUrls,
170
+ maxCommentLength = options.comments;
171
+ let ignorePattern = options.ignorePattern || null;
172
+
173
+ if (ignorePattern) {
174
+ ignorePattern = new RegExp(ignorePattern, "u");
175
+ }
176
+
177
+ //--------------------------------------------------------------------------
178
+ // Helpers
179
+ //--------------------------------------------------------------------------
180
+
181
+ /**
182
+ * Tells if a given comment is trailing: it starts on the current line and
183
+ * extends to or past the end of the current line.
184
+ * @param {string} line The source line we want to check for a trailing comment on
185
+ * @param {number} lineNumber The one-indexed line number for line
186
+ * @param {ASTNode} comment The comment to inspect
187
+ * @returns {boolean} If the comment is trailing on the given line
188
+ */
189
+ function isTrailingComment(line, lineNumber, comment) {
190
+ return (
191
+ comment &&
192
+ comment.loc.start.line === lineNumber &&
193
+ lineNumber <= comment.loc.end.line &&
194
+ (comment.loc.end.line > lineNumber ||
195
+ comment.loc.end.column === line.length)
196
+ );
197
+ }
198
+
199
+ /**
200
+ * Tells if a comment encompasses the entire line.
201
+ * @param {string} line The source line with a trailing comment
202
+ * @param {number} lineNumber The one-indexed line number this is on
203
+ * @param {ASTNode} comment The comment to remove
204
+ * @returns {boolean} If the comment covers the entire line
205
+ */
206
+ function isFullLineComment(line, lineNumber, comment) {
207
+ const start = comment.loc.start,
208
+ end = comment.loc.end,
209
+ isFirstTokenOnLine = !line
210
+ .slice(0, comment.loc.start.column)
211
+ .trim();
212
+
213
+ return (
214
+ comment &&
215
+ (start.line < lineNumber ||
216
+ (start.line === lineNumber && isFirstTokenOnLine)) &&
217
+ (end.line > lineNumber ||
218
+ (end.line === lineNumber && end.column === line.length))
219
+ );
220
+ }
221
+
222
+ /**
223
+ * Check if a node is a JSXEmptyExpression contained in a single line JSXExpressionContainer.
224
+ * @param {ASTNode} node A node to check.
225
+ * @returns {boolean} True if the node is a JSXEmptyExpression contained in a single line JSXExpressionContainer.
226
+ */
227
+ function isJSXEmptyExpressionInSingleLineContainer(node) {
228
+ if (
229
+ !node ||
230
+ !node.parent ||
231
+ node.type !== "JSXEmptyExpression" ||
232
+ node.parent.type !== "JSXExpressionContainer"
233
+ ) {
234
+ return false;
235
+ }
236
+
237
+ const parent = node.parent;
238
+
239
+ return parent.loc.start.line === parent.loc.end.line;
240
+ }
241
+
242
+ /**
243
+ * Gets the line after the comment and any remaining trailing whitespace is
244
+ * stripped.
245
+ * @param {string} line The source line with a trailing comment
246
+ * @param {ASTNode} comment The comment to remove
247
+ * @returns {string} Line without comment and trailing whitespace
248
+ */
249
+ function stripTrailingComment(line, comment) {
250
+ // loc.column is zero-indexed
251
+ return line.slice(0, comment.loc.start.column).replace(/\s+$/u, "");
252
+ }
253
+
254
+ /**
255
+ * Ensure that an array exists at [key] on `object`, and add `value` to it.
256
+ * @param {Object} object the object to mutate
257
+ * @param {string} key the object's key
258
+ * @param {any} value the value to add
259
+ * @returns {void}
260
+ * @private
261
+ */
262
+ function ensureArrayAndPush(object, key, value) {
263
+ if (!Array.isArray(object[key])) {
264
+ object[key] = [];
265
+ }
266
+ object[key].push(value);
267
+ }
268
+
269
+ /**
270
+ * Retrieves an array containing all strings (" or ') in the source code.
271
+ * @returns {ASTNode[]} An array of string nodes.
272
+ */
273
+ function getAllStrings() {
274
+ return sourceCode.ast.tokens.filter(
275
+ token =>
276
+ token.type === "String" ||
277
+ (token.type === "JSXText" &&
278
+ sourceCode.getNodeByRangeIndex(token.range[0] - 1)
279
+ .type === "JSXAttribute"),
280
+ );
281
+ }
282
+
283
+ /**
284
+ * Retrieves an array containing all template literals in the source code.
285
+ * @returns {ASTNode[]} An array of template literal nodes.
286
+ */
287
+ function getAllTemplateLiterals() {
288
+ return sourceCode.ast.tokens.filter(
289
+ token => token.type === "Template",
290
+ );
291
+ }
292
+
293
+ /**
294
+ * Retrieves an array containing all RegExp literals in the source code.
295
+ * @returns {ASTNode[]} An array of RegExp literal nodes.
296
+ */
297
+ function getAllRegExpLiterals() {
298
+ return sourceCode.ast.tokens.filter(
299
+ token => token.type === "RegularExpression",
300
+ );
301
+ }
302
+
303
+ /**
304
+ *
305
+ * reduce an array of AST nodes by line number, both start and end.
306
+ * @param {ASTNode[]} arr array of AST nodes
307
+ * @returns {Object} accululated AST nodes
308
+ */
309
+ function groupArrayByLineNumber(arr) {
310
+ const obj = {};
311
+
312
+ for (let i = 0; i < arr.length; i++) {
313
+ const node = arr[i];
314
+
315
+ for (let j = node.loc.start.line; j <= node.loc.end.line; ++j) {
316
+ ensureArrayAndPush(obj, j, node);
317
+ }
318
+ }
319
+ return obj;
320
+ }
321
+
322
+ /**
323
+ * Returns an array of all comments in the source code.
324
+ * If the element in the array is a JSXEmptyExpression contained with a single line JSXExpressionContainer,
325
+ * the element is changed with JSXExpressionContainer node.
326
+ * @returns {ASTNode[]} An array of comment nodes
327
+ */
328
+ function getAllComments() {
329
+ const comments = [];
330
+
331
+ sourceCode.getAllComments().forEach(commentNode => {
332
+ const containingNode = sourceCode.getNodeByRangeIndex(
333
+ commentNode.range[0],
334
+ );
335
+
336
+ if (isJSXEmptyExpressionInSingleLineContainer(containingNode)) {
337
+ // push a unique node only
338
+ if (comments.at(-1) !== containingNode.parent) {
339
+ comments.push(containingNode.parent);
340
+ }
341
+ } else {
342
+ comments.push(commentNode);
343
+ }
344
+ });
345
+
346
+ return comments;
347
+ }
348
+
349
+ /**
350
+ * Check the program for max length
351
+ * @param {ASTNode} node Node to examine
352
+ * @returns {void}
353
+ * @private
354
+ */
355
+ function checkProgramForMaxLength(node) {
356
+ // split (honors line-ending)
357
+ const lines = sourceCode.lines,
358
+ // list of comments to ignore
359
+ comments =
360
+ ignoreComments || maxCommentLength || ignoreTrailingComments
361
+ ? getAllComments()
362
+ : [];
363
+
364
+ // we iterate over comments in parallel with the lines
365
+ let commentsIndex = 0;
366
+
367
+ const strings = getAllStrings();
368
+ const stringsByLine = groupArrayByLineNumber(strings);
369
+
370
+ const templateLiterals = getAllTemplateLiterals();
371
+ const templateLiteralsByLine =
372
+ groupArrayByLineNumber(templateLiterals);
373
+
374
+ const regExpLiterals = getAllRegExpLiterals();
375
+ const regExpLiteralsByLine = groupArrayByLineNumber(regExpLiterals);
376
+
377
+ lines.forEach((line, i) => {
378
+ // i is zero-indexed, line numbers are one-indexed
379
+ const lineNumber = i + 1;
380
+
381
+ /*
382
+ * if we're checking comment length; we need to know whether this
383
+ * line is a comment
384
+ */
385
+ let lineIsComment = false;
386
+ let textToMeasure;
387
+
388
+ /*
389
+ * We can short-circuit the comment checks if we're already out of
390
+ * comments to check.
391
+ */
392
+ if (commentsIndex < comments.length) {
393
+ let comment;
394
+
395
+ // iterate over comments until we find one past the current line
396
+ do {
397
+ comment = comments[++commentsIndex];
398
+ } while (comment && comment.loc.start.line <= lineNumber);
399
+
400
+ // and step back by one
401
+ comment = comments[--commentsIndex];
402
+
403
+ if (isFullLineComment(line, lineNumber, comment)) {
404
+ lineIsComment = true;
405
+ textToMeasure = line;
406
+ } else if (
407
+ ignoreTrailingComments &&
408
+ isTrailingComment(line, lineNumber, comment)
409
+ ) {
410
+ textToMeasure = stripTrailingComment(line, comment);
411
+
412
+ // ignore multiple trailing comments in the same line
413
+ let lastIndex = commentsIndex;
414
+
415
+ while (
416
+ isTrailingComment(
417
+ textToMeasure,
418
+ lineNumber,
419
+ comments[--lastIndex],
420
+ )
421
+ ) {
422
+ textToMeasure = stripTrailingComment(
423
+ textToMeasure,
424
+ comments[lastIndex],
425
+ );
426
+ }
427
+ } else {
428
+ textToMeasure = line;
429
+ }
430
+ } else {
431
+ textToMeasure = line;
432
+ }
433
+ if (
434
+ (ignorePattern && ignorePattern.test(textToMeasure)) ||
435
+ (ignoreUrls && URL_REGEXP.test(textToMeasure)) ||
436
+ (ignoreStrings && stringsByLine[lineNumber]) ||
437
+ (ignoreTemplateLiterals &&
438
+ templateLiteralsByLine[lineNumber]) ||
439
+ (ignoreRegExpLiterals && regExpLiteralsByLine[lineNumber])
440
+ ) {
441
+ // ignore this line
442
+ return;
443
+ }
444
+
445
+ const lineLength = computeLineLength(textToMeasure, tabWidth);
446
+ const commentLengthApplies = lineIsComment && maxCommentLength;
447
+
448
+ if (lineIsComment && ignoreComments) {
449
+ return;
450
+ }
451
+
452
+ const loc = {
453
+ start: {
454
+ line: lineNumber,
455
+ column: 0,
456
+ },
457
+ end: {
458
+ line: lineNumber,
459
+ column: textToMeasure.length,
460
+ },
461
+ };
462
+
463
+ if (commentLengthApplies) {
464
+ if (lineLength > maxCommentLength) {
465
+ context.report({
466
+ node,
467
+ loc,
468
+ messageId: "maxComment",
469
+ data: {
470
+ lineLength,
471
+ maxCommentLength,
472
+ },
473
+ });
474
+ }
475
+ } else if (lineLength > maxLength) {
476
+ context.report({
477
+ node,
478
+ loc,
479
+ messageId: "max",
480
+ data: {
481
+ lineLength,
482
+ maxLength,
483
+ },
484
+ });
485
+ }
486
+ });
487
+ }
488
+
489
+ //--------------------------------------------------------------------------
490
+ // Public API
491
+ //--------------------------------------------------------------------------
492
+
493
+ return {
494
+ Program: checkProgramForMaxLength,
495
+ };
496
+ },
458
497
  };