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