eslint 9.22.0 → 9.24.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 (417) hide show
  1. package/README.md +48 -46
  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 +830 -810
  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 +638 -457
  21. package/lib/config/config-loader.js +726 -622
  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 +72 -72
  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 +756 -681
  30. package/lib/eslint/eslint.js +934 -912
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +577 -533
  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 +2403 -2045
  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 +36 -36
  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 +404 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1308 -1046
  73. package/lib/rules/accessor-pairs.js +298 -263
  74. package/lib/rules/array-bracket-newline.js +250 -238
  75. package/lib/rules/array-bracket-spacing.js +263 -224
  76. package/lib/rules/array-callback-return.js +402 -356
  77. package/lib/rules/array-element-newline.js +358 -313
  78. package/lib/rules/arrow-body-style.js +400 -281
  79. package/lib/rules/arrow-parens.js +206 -173
  80. package/lib/rules/arrow-spacing.js +169 -163
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -176
  83. package/lib/rules/brace-style.js +262 -199
  84. package/lib/rules/callback-return.js +203 -190
  85. package/lib/rules/camelcase.js +403 -392
  86. package/lib/rules/capitalized-comments.js +253 -232
  87. package/lib/rules/class-methods-use-this.js +224 -172
  88. package/lib/rules/comma-dangle.js +379 -346
  89. package/lib/rules/comma-spacing.js +193 -195
  90. package/lib/rules/comma-style.js +375 -316
  91. package/lib/rules/complexity.js +173 -169
  92. package/lib/rules/computed-property-spacing.js +236 -211
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -147
  95. package/lib/rules/constructor-super.js +412 -404
  96. package/lib/rules/curly.js +407 -332
  97. package/lib/rules/default-case-last.js +38 -31
  98. package/lib/rules/default-case.js +89 -85
  99. package/lib/rules/default-param-last.js +69 -54
  100. package/lib/rules/dot-location.js +122 -110
  101. package/lib/rules/dot-notation.js +192 -156
  102. package/lib/rules/eol-last.js +122 -120
  103. package/lib/rules/eqeqeq.js +168 -155
  104. package/lib/rules/for-direction.js +146 -121
  105. package/lib/rules/func-call-spacing.js +261 -231
  106. package/lib/rules/func-name-matching.js +293 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +159 -127
  109. package/lib/rules/function-call-argument-newline.js +152 -129
  110. package/lib/rules/function-paren-newline.js +349 -291
  111. package/lib/rules/generator-star-spacing.js +229 -210
  112. package/lib/rules/getter-return.js +208 -172
  113. package/lib/rules/global-require.js +85 -74
  114. package/lib/rules/grouped-accessor-pairs.js +170 -150
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -103
  117. package/lib/rules/id-blacklist.js +182 -199
  118. package/lib/rules/id-denylist.js +168 -187
  119. package/lib/rules/id-length.js +197 -171
  120. package/lib/rules/id-match.js +344 -289
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -79
  122. package/lib/rules/indent-legacy.js +1344 -1118
  123. package/lib/rules/indent.js +2272 -1759
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +137 -107
  126. package/lib/rules/jsx-quotes.js +94 -82
  127. package/lib/rules/key-spacing.js +750 -633
  128. package/lib/rules/keyword-spacing.js +648 -605
  129. package/lib/rules/line-comment-position.js +142 -128
  130. package/lib/rules/linebreak-style.js +107 -106
  131. package/lib/rules/lines-around-comment.js +540 -448
  132. package/lib/rules/lines-around-directive.js +233 -203
  133. package/lib/rules/lines-between-class-members.js +305 -234
  134. package/lib/rules/logical-assignment-operators.js +582 -399
  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 -434
  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 +78 -76
  142. package/lib/rules/max-statements-per-line.js +205 -198
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +637 -479
  145. package/lib/rules/multiline-ternary.js +241 -176
  146. package/lib/rules/new-cap.js +233 -213
  147. package/lib/rules/new-parens.js +88 -79
  148. package/lib/rules/newline-after-var.js +287 -250
  149. package/lib/rules/newline-before-return.js +229 -222
  150. package/lib/rules/newline-per-chained-call.js +142 -127
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +125 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +69 -71
  155. package/lib/rules/no-bitwise.js +124 -100
  156. package/lib/rules/no-buffer-constructor.js +55 -47
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -57
  159. package/lib/rules/no-catch-shadow.js +76 -73
  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 -81
  164. package/lib/rules/no-console.js +202 -199
  165. package/lib/rules/no-const-assign.js +47 -41
  166. package/lib/rules/no-constant-binary-expression.js +500 -405
  167. package/lib/rules/no-constant-condition.js +158 -143
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -27
  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 -41
  174. package/lib/rules/no-dupe-args.js +68 -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 +179 -176
  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 +127 -128
  183. package/lib/rules/no-empty-pattern.js +63 -58
  184. package/lib/rules/no-empty-static-block.js +37 -35
  185. package/lib/rules/no-empty.js +98 -86
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +256 -250
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -159
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -348
  192. package/lib/rules/no-extra-label.js +150 -131
  193. package/lib/rules/no-extra-parens.js +1654 -1325
  194. package/lib/rules/no-extra-semi.js +146 -144
  195. package/lib/rules/no-fallthrough.js +199 -157
  196. package/lib/rules/no-floating-decimal.js +74 -66
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -73
  199. package/lib/rules/no-implicit-coercion.js +349 -293
  200. package/lib/rules/no-implicit-globals.js +158 -135
  201. package/lib/rules/no-implied-eval.js +140 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -95
  204. package/lib/rules/no-inner-declarations.js +115 -101
  205. package/lib/rules/no-invalid-regexp.js +222 -190
  206. package/lib/rules/no-invalid-this.js +123 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -252
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -62
  210. package/lib/rules/no-labels.js +138 -133
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +108 -77
  213. package/lib/rules/no-loop-func.js +238 -213
  214. package/lib/rules/no-loss-of-precision.js +218 -201
  215. package/lib/rules/no-magic-numbers.js +246 -218
  216. package/lib/rules/no-misleading-character-class.js +499 -446
  217. package/lib/rules/no-mixed-operators.js +188 -182
  218. package/lib/rules/no-mixed-requires.js +253 -240
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +134 -121
  220. package/lib/rules/no-multi-assign.js +46 -44
  221. package/lib/rules/no-multi-spaces.js +163 -143
  222. package/lib/rules/no-multi-str.js +42 -41
  223. package/lib/rules/no-multiple-empty-lines.js +196 -158
  224. package/lib/rules/no-native-reassign.js +90 -85
  225. package/lib/rules/no-negated-condition.js +79 -75
  226. package/lib/rules/no-negated-in-lhs.js +45 -43
  227. package/lib/rules/no-nested-ternary.js +33 -32
  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 -48
  231. package/lib/rules/no-new-require.js +48 -47
  232. package/lib/rules/no-new-symbol.js +52 -50
  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 +141 -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 +32 -32
  240. package/lib/rules/no-param-reassign.js +235 -217
  241. package/lib/rules/no-path-concat.js +66 -67
  242. package/lib/rules/no-plusplus.js +60 -61
  243. package/lib/rules/no-process-env.js +49 -48
  244. package/lib/rules/no-process-exit.js +54 -50
  245. package/lib/rules/no-promise-executor-return.js +214 -182
  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 -152
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -185
  251. package/lib/rules/no-restricted-globals.js +111 -112
  252. package/lib/rules/no-restricted-imports.js +657 -537
  253. package/lib/rules/no-restricted-modules.js +222 -202
  254. package/lib/rules/no-restricted-properties.js +181 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +55 -50
  257. package/lib/rules/no-return-await.js +148 -124
  258. package/lib/rules/no-script-url.js +52 -45
  259. package/lib/rules/no-self-assign.js +148 -146
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -116
  262. package/lib/rules/no-setter-return.js +185 -152
  263. package/lib/rules/no-shadow-restricted-names.js +61 -46
  264. package/lib/rules/no-shadow.js +342 -316
  265. package/lib/rules/no-spaced-func.js +82 -77
  266. package/lib/rules/no-sparse-arrays.js +54 -59
  267. package/lib/rules/no-sync.js +61 -60
  268. package/lib/rules/no-tabs.js +83 -72
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -29
  271. package/lib/rules/no-this-before-super.js +321 -319
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +199 -191
  274. package/lib/rules/no-undef-init.js +76 -61
  275. package/lib/rules/no-undef.js +51 -48
  276. package/lib/rules/no-undefined.js +73 -75
  277. package/lib/rules/no-underscore-dangle.js +370 -327
  278. package/lib/rules/no-unexpected-multiline.js +112 -102
  279. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  280. package/lib/rules/no-unneeded-ternary.js +212 -147
  281. package/lib/rules/no-unreachable-loop.js +145 -142
  282. package/lib/rules/no-unreachable.js +255 -248
  283. package/lib/rules/no-unsafe-finally.js +93 -85
  284. package/lib/rules/no-unsafe-negation.js +105 -83
  285. package/lib/rules/no-unsafe-optional-chaining.js +192 -178
  286. package/lib/rules/no-unused-expressions.js +178 -162
  287. package/lib/rules/no-unused-labels.js +139 -124
  288. package/lib/rules/no-unused-private-class-members.js +206 -182
  289. package/lib/rules/no-unused-vars.js +1669 -1449
  290. package/lib/rules/no-use-before-define.js +229 -231
  291. package/lib/rules/no-useless-assignment.js +590 -511
  292. package/lib/rules/no-useless-backreference.js +212 -193
  293. package/lib/rules/no-useless-call.js +58 -53
  294. package/lib/rules/no-useless-catch.js +40 -40
  295. package/lib/rules/no-useless-computed-key.js +144 -115
  296. package/lib/rules/no-useless-concat.js +65 -60
  297. package/lib/rules/no-useless-constructor.js +158 -111
  298. package/lib/rules/no-useless-escape.js +342 -291
  299. package/lib/rules/no-useless-rename.js +183 -156
  300. package/lib/rules/no-useless-return.js +344 -312
  301. package/lib/rules/no-var.js +233 -212
  302. package/lib/rules/no-void.js +50 -48
  303. package/lib/rules/no-warning-comments.js +191 -186
  304. package/lib/rules/no-whitespace-before-property.js +131 -115
  305. package/lib/rules/no-with.js +24 -26
  306. package/lib/rules/nonblock-statement-body-position.js +149 -130
  307. package/lib/rules/object-curly-newline.js +306 -265
  308. package/lib/rules/object-curly-spacing.js +360 -314
  309. package/lib/rules/object-property-newline.js +137 -106
  310. package/lib/rules/object-shorthand.js +607 -502
  311. package/lib/rules/one-var-declaration-per-line.js +104 -100
  312. package/lib/rules/one-var.js +653 -537
  313. package/lib/rules/operator-assignment.js +219 -161
  314. package/lib/rules/operator-linebreak.js +295 -251
  315. package/lib/rules/padded-blocks.js +346 -308
  316. package/lib/rules/padding-line-between-statements.js +443 -439
  317. package/lib/rules/prefer-arrow-callback.js +362 -313
  318. package/lib/rules/prefer-const.js +418 -377
  319. package/lib/rules/prefer-destructuring.js +301 -279
  320. package/lib/rules/prefer-exponentiation-operator.js +176 -133
  321. package/lib/rules/prefer-named-capture-group.js +153 -140
  322. package/lib/rules/prefer-numeric-literals.js +121 -113
  323. package/lib/rules/prefer-object-has-own.js +116 -82
  324. package/lib/rules/prefer-object-spread.js +213 -193
  325. package/lib/rules/prefer-promise-reject-errors.js +140 -122
  326. package/lib/rules/prefer-reflect.js +127 -107
  327. package/lib/rules/prefer-regex-literals.js +578 -466
  328. package/lib/rules/prefer-rest-params.js +79 -80
  329. package/lib/rules/prefer-spread.js +47 -44
  330. package/lib/rules/prefer-template.js +266 -195
  331. package/lib/rules/quote-props.js +373 -307
  332. package/lib/rules/quotes.js +374 -326
  333. package/lib/rules/radix.js +152 -136
  334. package/lib/rules/require-atomic-updates.js +316 -285
  335. package/lib/rules/require-await.js +144 -116
  336. package/lib/rules/require-unicode-regexp.js +282 -177
  337. package/lib/rules/require-yield.js +53 -54
  338. package/lib/rules/rest-spread-spacing.js +128 -116
  339. package/lib/rules/semi-spacing.js +281 -250
  340. package/lib/rules/semi-style.js +176 -134
  341. package/lib/rules/semi.js +456 -436
  342. package/lib/rules/sort-imports.js +306 -233
  343. package/lib/rules/sort-keys.js +219 -188
  344. package/lib/rules/sort-vars.js +127 -93
  345. package/lib/rules/space-before-blocks.js +199 -189
  346. package/lib/rules/space-before-function-paren.js +186 -166
  347. package/lib/rules/space-in-parens.js +359 -288
  348. package/lib/rules/space-infix-ops.js +237 -201
  349. package/lib/rules/space-unary-ops.js +356 -298
  350. package/lib/rules/spaced-comment.js +363 -319
  351. package/lib/rules/strict.js +265 -230
  352. package/lib/rules/switch-colon-spacing.js +130 -122
  353. package/lib/rules/symbol-description.js +45 -48
  354. package/lib/rules/template-curly-spacing.js +148 -142
  355. package/lib/rules/template-tag-spacing.js +98 -88
  356. package/lib/rules/unicode-bom.js +54 -56
  357. package/lib/rules/use-isnan.js +237 -206
  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 +153 -111
  370. package/lib/rules/vars-on-top.js +152 -145
  371. package/lib/rules/wrap-iife.js +204 -191
  372. package/lib/rules/wrap-regex.js +70 -58
  373. package/lib/rules/yield-star-spacing.js +145 -134
  374. package/lib/rules/yoda.js +283 -272
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/services/suppressions-service.js +289 -0
  378. package/lib/shared/ajv.js +14 -14
  379. package/lib/shared/assert.js +3 -4
  380. package/lib/shared/ast-utils.js +7 -6
  381. package/lib/shared/deep-merge-arrays.js +24 -22
  382. package/lib/shared/directives.js +3 -2
  383. package/lib/shared/flags.js +50 -17
  384. package/lib/shared/logging.js +24 -25
  385. package/lib/shared/option-utils.js +43 -36
  386. package/lib/shared/runtime-info.js +136 -127
  387. package/lib/shared/serialization.js +27 -27
  388. package/lib/shared/severity.js +22 -22
  389. package/lib/shared/stats.js +5 -5
  390. package/lib/shared/string-utils.js +16 -16
  391. package/lib/shared/text-table.js +28 -27
  392. package/lib/shared/traverser.js +153 -146
  393. package/lib/shared/types.js +4 -27
  394. package/lib/types/index.d.ts +2010 -1559
  395. package/lib/types/rules.d.ts +5253 -5140
  396. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  397. package/lib/unsupported-api.js +5 -5
  398. package/messages/all-files-ignored.js +3 -3
  399. package/messages/all-matched-files-ignored.js +3 -3
  400. package/messages/config-file-missing.js +2 -2
  401. package/messages/config-plugin-missing.js +3 -3
  402. package/messages/config-serialize-function.js +9 -7
  403. package/messages/eslintrc-incompat.js +13 -15
  404. package/messages/eslintrc-plugins.js +3 -4
  405. package/messages/extend-config-missing.js +3 -3
  406. package/messages/failed-to-read-json.js +3 -3
  407. package/messages/file-not-found.js +3 -3
  408. package/messages/invalid-rule-options.js +2 -2
  409. package/messages/invalid-rule-severity.js +2 -2
  410. package/messages/no-config-found.js +3 -3
  411. package/messages/plugin-conflict.js +8 -8
  412. package/messages/plugin-invalid.js +3 -3
  413. package/messages/plugin-missing.js +3 -3
  414. package/messages/print-config-with-directory-path.js +2 -2
  415. package/messages/shared.js +6 -1
  416. package/messages/whitespace-found.js +3 -3
  417. package/package.json +14 -20
@@ -10,8 +10,17 @@
10
10
  //------------------------------------------------------------------------------
11
11
 
12
12
  const astUtils = require("./utils/ast-utils");
13
- const { CALL, CONSTRUCT, ReferenceTracker, findVariable } = require("@eslint-community/eslint-utils");
14
- const { RegExpValidator, visitRegExpAST, RegExpParser } = require("@eslint-community/regexpp");
13
+ const {
14
+ CALL,
15
+ CONSTRUCT,
16
+ ReferenceTracker,
17
+ findVariable,
18
+ } = require("@eslint-community/eslint-utils");
19
+ const {
20
+ RegExpValidator,
21
+ visitRegExpAST,
22
+ RegExpParser,
23
+ } = require("@eslint-community/regexpp");
15
24
  const { canTokensBeAdjacent } = require("./utils/ast-utils");
16
25
  const { REGEXPP_LATEST_ECMA_VERSION } = require("./utils/regular-expressions");
17
26
 
@@ -25,7 +34,7 @@ const { REGEXPP_LATEST_ECMA_VERSION } = require("./utils/regular-expressions");
25
34
  * @returns {boolean} True if the node is a string literal.
26
35
  */
27
36
  function isStringLiteral(node) {
28
- return node.type === "Literal" && typeof node.value === "string";
37
+ return node.type === "Literal" && typeof node.value === "string";
29
38
  }
30
39
 
31
40
  /**
@@ -34,477 +43,580 @@ function isStringLiteral(node) {
34
43
  * @returns {boolean} True if the node is a regex literal.
35
44
  */
36
45
  function isRegexLiteral(node) {
37
- return node.type === "Literal" && Object.hasOwn(node, "regex");
46
+ return node.type === "Literal" && Object.hasOwn(node, "regex");
38
47
  }
39
48
 
40
49
  const validPrecedingTokens = new Set([
41
- "(",
42
- ";",
43
- "[",
44
- ",",
45
- "=",
46
- "+",
47
- "*",
48
- "-",
49
- "?",
50
- "~",
51
- "%",
52
- "**",
53
- "!",
54
- "typeof",
55
- "instanceof",
56
- "&&",
57
- "||",
58
- "??",
59
- "return",
60
- "...",
61
- "delete",
62
- "void",
63
- "in",
64
- "<",
65
- ">",
66
- "<=",
67
- ">=",
68
- "==",
69
- "===",
70
- "!=",
71
- "!==",
72
- "<<",
73
- ">>",
74
- ">>>",
75
- "&",
76
- "|",
77
- "^",
78
- ":",
79
- "{",
80
- "=>",
81
- "*=",
82
- "<<=",
83
- ">>=",
84
- ">>>=",
85
- "^=",
86
- "|=",
87
- "&=",
88
- "??=",
89
- "||=",
90
- "&&=",
91
- "**=",
92
- "+=",
93
- "-=",
94
- "/=",
95
- "%=",
96
- "/",
97
- "do",
98
- "break",
99
- "continue",
100
- "debugger",
101
- "case",
102
- "throw"
50
+ "(",
51
+ ";",
52
+ "[",
53
+ ",",
54
+ "=",
55
+ "+",
56
+ "*",
57
+ "-",
58
+ "?",
59
+ "~",
60
+ "%",
61
+ "**",
62
+ "!",
63
+ "typeof",
64
+ "instanceof",
65
+ "&&",
66
+ "||",
67
+ "??",
68
+ "return",
69
+ "...",
70
+ "delete",
71
+ "void",
72
+ "in",
73
+ "<",
74
+ ">",
75
+ "<=",
76
+ ">=",
77
+ "==",
78
+ "===",
79
+ "!=",
80
+ "!==",
81
+ "<<",
82
+ ">>",
83
+ ">>>",
84
+ "&",
85
+ "|",
86
+ "^",
87
+ ":",
88
+ "{",
89
+ "=>",
90
+ "*=",
91
+ "<<=",
92
+ ">>=",
93
+ ">>>=",
94
+ "^=",
95
+ "|=",
96
+ "&=",
97
+ "??=",
98
+ "||=",
99
+ "&&=",
100
+ "**=",
101
+ "+=",
102
+ "-=",
103
+ "/=",
104
+ "%=",
105
+ "/",
106
+ "do",
107
+ "break",
108
+ "continue",
109
+ "debugger",
110
+ "case",
111
+ "throw",
103
112
  ]);
104
113
 
105
-
106
114
  //------------------------------------------------------------------------------
107
115
  // Rule Definition
108
116
  //------------------------------------------------------------------------------
109
117
 
110
- /** @type {import('../shared/types').Rule} */
118
+ /** @type {import('../types').Rule.RuleModule} */
111
119
  module.exports = {
112
- meta: {
113
- type: "suggestion",
114
-
115
- defaultOptions: [{
116
- disallowRedundantWrapping: false
117
- }],
118
-
119
- docs: {
120
- description: "Disallow use of the `RegExp` constructor in favor of regular expression literals",
121
- recommended: false,
122
- url: "https://eslint.org/docs/latest/rules/prefer-regex-literals"
123
- },
124
-
125
- hasSuggestions: true,
126
-
127
- schema: [
128
- {
129
- type: "object",
130
- properties: {
131
- disallowRedundantWrapping: {
132
- type: "boolean"
133
- }
134
- },
135
- additionalProperties: false
136
- }
137
- ],
138
-
139
- messages: {
140
- unexpectedRegExp: "Use a regular expression literal instead of the 'RegExp' constructor.",
141
- replaceWithLiteral: "Replace with an equivalent regular expression literal.",
142
- replaceWithLiteralAndFlags: "Replace with an equivalent regular expression literal with flags '{{ flags }}'.",
143
- replaceWithIntendedLiteralAndFlags: "Replace with a regular expression literal with flags '{{ flags }}'.",
144
- unexpectedRedundantRegExp: "Regular expression literal is unnecessarily wrapped within a 'RegExp' constructor.",
145
- unexpectedRedundantRegExpWithFlags: "Use regular expression literal with flags instead of the 'RegExp' constructor."
146
- }
147
- },
148
-
149
- create(context) {
150
- const [{ disallowRedundantWrapping }] = context.options;
151
- const sourceCode = context.sourceCode;
152
-
153
- /**
154
- * Determines whether the given identifier node is a reference to a global variable.
155
- * @param {ASTNode} node `Identifier` node to check.
156
- * @returns {boolean} True if the identifier is a reference to a global variable.
157
- */
158
- function isGlobalReference(node) {
159
- const scope = sourceCode.getScope(node);
160
- const variable = findVariable(scope, node);
161
-
162
- return variable !== null && variable.scope.type === "global" && variable.defs.length === 0;
163
- }
164
-
165
- /**
166
- * Determines whether the given node is a String.raw`` tagged template expression
167
- * with a static template literal.
168
- * @param {ASTNode} node Node to check.
169
- * @returns {boolean} True if the node is String.raw`` with a static template.
170
- */
171
- function isStringRawTaggedStaticTemplateLiteral(node) {
172
- return node.type === "TaggedTemplateExpression" &&
173
- astUtils.isSpecificMemberAccess(node.tag, "String", "raw") &&
174
- isGlobalReference(astUtils.skipChainExpression(node.tag).object) &&
175
- astUtils.isStaticTemplateLiteral(node.quasi);
176
- }
177
-
178
- /**
179
- * Gets the value of a string
180
- * @param {ASTNode} node The node to get the string of.
181
- * @returns {string|null} The value of the node.
182
- */
183
- function getStringValue(node) {
184
- if (isStringLiteral(node)) {
185
- return node.value;
186
- }
187
-
188
- if (astUtils.isStaticTemplateLiteral(node)) {
189
- return node.quasis[0].value.cooked;
190
- }
191
-
192
- if (isStringRawTaggedStaticTemplateLiteral(node)) {
193
- return node.quasi.quasis[0].value.raw;
194
- }
195
-
196
- return null;
197
- }
198
-
199
- /**
200
- * Determines whether the given node is considered to be a static string by the logic of this rule.
201
- * @param {ASTNode} node Node to check.
202
- * @returns {boolean} True if the node is a static string.
203
- */
204
- function isStaticString(node) {
205
- return isStringLiteral(node) ||
206
- astUtils.isStaticTemplateLiteral(node) ||
207
- isStringRawTaggedStaticTemplateLiteral(node);
208
- }
209
-
210
- /**
211
- * Determines whether the relevant arguments of the given are all static string literals.
212
- * @param {ASTNode} node Node to check.
213
- * @returns {boolean} True if all arguments are static strings.
214
- */
215
- function hasOnlyStaticStringArguments(node) {
216
- const args = node.arguments;
217
-
218
- if ((args.length === 1 || args.length === 2) && args.every(isStaticString)) {
219
- return true;
220
- }
221
-
222
- return false;
223
- }
224
-
225
- /**
226
- * Determines whether the arguments of the given node indicate that a regex literal is unnecessarily wrapped.
227
- * @param {ASTNode} node Node to check.
228
- * @returns {boolean} True if the node already contains a regex literal argument.
229
- */
230
- function isUnnecessarilyWrappedRegexLiteral(node) {
231
- const args = node.arguments;
232
-
233
- if (args.length === 1 && isRegexLiteral(args[0])) {
234
- return true;
235
- }
236
-
237
- if (args.length === 2 && isRegexLiteral(args[0]) && isStaticString(args[1])) {
238
- return true;
239
- }
240
-
241
- return false;
242
- }
243
-
244
- /**
245
- * Returns a ecmaVersion compatible for regexpp.
246
- * @param {number} ecmaVersion The ecmaVersion to convert.
247
- * @returns {import("@eslint-community/regexpp/ecma-versions").EcmaVersion} The resulting ecmaVersion compatible for regexpp.
248
- */
249
- function getRegexppEcmaVersion(ecmaVersion) {
250
- if (ecmaVersion <= 5) {
251
- return 5;
252
- }
253
- return Math.min(ecmaVersion, REGEXPP_LATEST_ECMA_VERSION);
254
- }
255
-
256
- const regexppEcmaVersion = getRegexppEcmaVersion(context.languageOptions.ecmaVersion);
257
-
258
- /**
259
- * Makes a character escaped or else returns null.
260
- * @param {string} character The character to escape.
261
- * @returns {string} The resulting escaped character.
262
- */
263
- function resolveEscapes(character) {
264
- switch (character) {
265
- case "\n":
266
- case "\\\n":
267
- return "\\n";
268
-
269
- case "\r":
270
- case "\\\r":
271
- return "\\r";
272
-
273
- case "\t":
274
- case "\\\t":
275
- return "\\t";
276
-
277
- case "\v":
278
- case "\\\v":
279
- return "\\v";
280
-
281
- case "\f":
282
- case "\\\f":
283
- return "\\f";
284
-
285
- case "/":
286
- return "\\/";
287
-
288
- default:
289
- return null;
290
- }
291
- }
292
-
293
- /**
294
- * Checks whether the given regex and flags are valid for the ecma version or not.
295
- * @param {string} pattern The regex pattern to check.
296
- * @param {string | undefined} flags The regex flags to check.
297
- * @returns {boolean} True if the given regex pattern and flags are valid for the ecma version.
298
- */
299
- function isValidRegexForEcmaVersion(pattern, flags) {
300
- const validator = new RegExpValidator({ ecmaVersion: regexppEcmaVersion });
301
-
302
- try {
303
- validator.validatePattern(pattern, 0, pattern.length, {
304
- unicode: flags ? flags.includes("u") : false,
305
- unicodeSets: flags ? flags.includes("v") : false
306
- });
307
- if (flags) {
308
- validator.validateFlags(flags);
309
- }
310
- return true;
311
- } catch {
312
- return false;
313
- }
314
- }
315
-
316
- /**
317
- * Checks whether two given regex flags contain the same flags or not.
318
- * @param {string} flagsA The regex flags.
319
- * @param {string} flagsB The regex flags.
320
- * @returns {boolean} True if two regex flags contain same flags.
321
- */
322
- function areFlagsEqual(flagsA, flagsB) {
323
- return [...flagsA].sort().join("") === [...flagsB].sort().join("");
324
- }
325
-
326
-
327
- /**
328
- * Merges two regex flags.
329
- * @param {string} flagsA The regex flags.
330
- * @param {string} flagsB The regex flags.
331
- * @returns {string} The merged regex flags.
332
- */
333
- function mergeRegexFlags(flagsA, flagsB) {
334
- const flagsSet = new Set([
335
- ...flagsA,
336
- ...flagsB
337
- ]);
338
-
339
- return [...flagsSet].join("");
340
- }
341
-
342
- /**
343
- * Checks whether a give node can be fixed to the given regex pattern and flags.
344
- * @param {ASTNode} node The node to check.
345
- * @param {string} pattern The regex pattern to check.
346
- * @param {string} flags The regex flags
347
- * @returns {boolean} True if a node can be fixed to the given regex pattern and flags.
348
- */
349
- function canFixTo(node, pattern, flags) {
350
- const tokenBefore = sourceCode.getTokenBefore(node);
351
-
352
- return sourceCode.getCommentsInside(node).length === 0 &&
353
- (!tokenBefore || validPrecedingTokens.has(tokenBefore.value)) &&
354
- isValidRegexForEcmaVersion(pattern, flags);
355
- }
356
-
357
- /**
358
- * Returns a safe output code considering the before and after tokens.
359
- * @param {ASTNode} node The regex node.
360
- * @param {string} newRegExpValue The new regex expression value.
361
- * @returns {string} The output code.
362
- */
363
- function getSafeOutput(node, newRegExpValue) {
364
- const tokenBefore = sourceCode.getTokenBefore(node);
365
- const tokenAfter = sourceCode.getTokenAfter(node);
366
-
367
- return (tokenBefore && !canTokensBeAdjacent(tokenBefore, newRegExpValue) && tokenBefore.range[1] === node.range[0] ? " " : "") +
368
- newRegExpValue +
369
- (tokenAfter && !canTokensBeAdjacent(newRegExpValue, tokenAfter) && node.range[1] === tokenAfter.range[0] ? " " : "");
370
-
371
- }
372
-
373
- return {
374
- Program(node) {
375
- const scope = sourceCode.getScope(node);
376
- const tracker = new ReferenceTracker(scope);
377
- const traceMap = {
378
- RegExp: {
379
- [CALL]: true,
380
- [CONSTRUCT]: true
381
- }
382
- };
383
-
384
- for (const { node: refNode } of tracker.iterateGlobalReferences(traceMap)) {
385
- if (disallowRedundantWrapping && isUnnecessarilyWrappedRegexLiteral(refNode)) {
386
- const regexNode = refNode.arguments[0];
387
-
388
- if (refNode.arguments.length === 2) {
389
- const suggests = [];
390
-
391
- const argFlags = getStringValue(refNode.arguments[1]) || "";
392
-
393
- if (canFixTo(refNode, regexNode.regex.pattern, argFlags)) {
394
- suggests.push({
395
- messageId: "replaceWithLiteralAndFlags",
396
- pattern: regexNode.regex.pattern,
397
- flags: argFlags
398
- });
399
- }
400
-
401
- const literalFlags = regexNode.regex.flags || "";
402
- const mergedFlags = mergeRegexFlags(literalFlags, argFlags);
403
-
404
- if (
405
- !areFlagsEqual(mergedFlags, argFlags) &&
406
- canFixTo(refNode, regexNode.regex.pattern, mergedFlags)
407
- ) {
408
- suggests.push({
409
- messageId: "replaceWithIntendedLiteralAndFlags",
410
- pattern: regexNode.regex.pattern,
411
- flags: mergedFlags
412
- });
413
- }
414
-
415
- context.report({
416
- node: refNode,
417
- messageId: "unexpectedRedundantRegExpWithFlags",
418
- suggest: suggests.map(({ flags, pattern, messageId }) => ({
419
- messageId,
420
- data: {
421
- flags
422
- },
423
- fix(fixer) {
424
- return fixer.replaceText(refNode, getSafeOutput(refNode, `/${pattern}/${flags}`));
425
- }
426
- }))
427
- });
428
- } else {
429
- const outputs = [];
430
-
431
- if (canFixTo(refNode, regexNode.regex.pattern, regexNode.regex.flags)) {
432
- outputs.push(sourceCode.getText(regexNode));
433
- }
434
-
435
-
436
- context.report({
437
- node: refNode,
438
- messageId: "unexpectedRedundantRegExp",
439
- suggest: outputs.map(output => ({
440
- messageId: "replaceWithLiteral",
441
- fix(fixer) {
442
- return fixer.replaceText(
443
- refNode,
444
- getSafeOutput(refNode, output)
445
- );
446
- }
447
- }))
448
- });
449
- }
450
- } else if (hasOnlyStaticStringArguments(refNode)) {
451
- let regexContent = getStringValue(refNode.arguments[0]);
452
- let noFix = false;
453
- let flags;
454
-
455
- if (refNode.arguments[1]) {
456
- flags = getStringValue(refNode.arguments[1]);
457
- }
458
-
459
- if (!canFixTo(refNode, regexContent, flags)) {
460
- noFix = true;
461
- }
462
-
463
- if (!/^[-a-zA-Z0-9\\[\](){} \t\r\n\v\f!@#$%^&*+^_=/~`.><?,'"|:;]*$/u.test(regexContent)) {
464
- noFix = true;
465
- }
466
-
467
- if (regexContent && !noFix) {
468
- let charIncrease = 0;
469
-
470
- const ast = new RegExpParser({ ecmaVersion: regexppEcmaVersion }).parsePattern(regexContent, 0, regexContent.length, {
471
- unicode: flags ? flags.includes("u") : false,
472
- unicodeSets: flags ? flags.includes("v") : false
473
- });
474
-
475
- visitRegExpAST(ast, {
476
- onCharacterEnter(characterNode) {
477
- const escaped = resolveEscapes(characterNode.raw);
478
-
479
- if (escaped) {
480
- regexContent =
481
- regexContent.slice(0, characterNode.start + charIncrease) +
482
- escaped +
483
- regexContent.slice(characterNode.end + charIncrease);
484
-
485
- if (characterNode.raw.length === 1) {
486
- charIncrease += 1;
487
- }
488
- }
489
- }
490
- });
491
- }
492
-
493
- const newRegExpValue = `/${regexContent || "(?:)"}/${flags || ""}`;
494
-
495
- context.report({
496
- node: refNode,
497
- messageId: "unexpectedRegExp",
498
- suggest: noFix ? [] : [{
499
- messageId: "replaceWithLiteral",
500
- fix(fixer) {
501
- return fixer.replaceText(refNode, getSafeOutput(refNode, newRegExpValue));
502
- }
503
- }]
504
- });
505
- }
506
- }
507
- }
508
- };
509
- }
120
+ meta: {
121
+ type: "suggestion",
122
+
123
+ defaultOptions: [
124
+ {
125
+ disallowRedundantWrapping: false,
126
+ },
127
+ ],
128
+
129
+ docs: {
130
+ description:
131
+ "Disallow use of the `RegExp` constructor in favor of regular expression literals",
132
+ recommended: false,
133
+ url: "https://eslint.org/docs/latest/rules/prefer-regex-literals",
134
+ },
135
+
136
+ hasSuggestions: true,
137
+
138
+ schema: [
139
+ {
140
+ type: "object",
141
+ properties: {
142
+ disallowRedundantWrapping: {
143
+ type: "boolean",
144
+ },
145
+ },
146
+ additionalProperties: false,
147
+ },
148
+ ],
149
+
150
+ messages: {
151
+ unexpectedRegExp:
152
+ "Use a regular expression literal instead of the 'RegExp' constructor.",
153
+ replaceWithLiteral:
154
+ "Replace with an equivalent regular expression literal.",
155
+ replaceWithLiteralAndFlags:
156
+ "Replace with an equivalent regular expression literal with flags '{{ flags }}'.",
157
+ replaceWithIntendedLiteralAndFlags:
158
+ "Replace with a regular expression literal with flags '{{ flags }}'.",
159
+ unexpectedRedundantRegExp:
160
+ "Regular expression literal is unnecessarily wrapped within a 'RegExp' constructor.",
161
+ unexpectedRedundantRegExpWithFlags:
162
+ "Use regular expression literal with flags instead of the 'RegExp' constructor.",
163
+ },
164
+ },
165
+
166
+ create(context) {
167
+ const [{ disallowRedundantWrapping }] = context.options;
168
+ const sourceCode = context.sourceCode;
169
+
170
+ /**
171
+ * Determines whether the given identifier node is a reference to a global variable.
172
+ * @param {ASTNode} node `Identifier` node to check.
173
+ * @returns {boolean} True if the identifier is a reference to a global variable.
174
+ */
175
+ function isGlobalReference(node) {
176
+ const scope = sourceCode.getScope(node);
177
+ const variable = findVariable(scope, node);
178
+
179
+ return (
180
+ variable !== null &&
181
+ variable.scope.type === "global" &&
182
+ variable.defs.length === 0
183
+ );
184
+ }
185
+
186
+ /**
187
+ * Determines whether the given node is a String.raw`` tagged template expression
188
+ * with a static template literal.
189
+ * @param {ASTNode} node Node to check.
190
+ * @returns {boolean} True if the node is String.raw`` with a static template.
191
+ */
192
+ function isStringRawTaggedStaticTemplateLiteral(node) {
193
+ return (
194
+ node.type === "TaggedTemplateExpression" &&
195
+ astUtils.isSpecificMemberAccess(node.tag, "String", "raw") &&
196
+ isGlobalReference(
197
+ astUtils.skipChainExpression(node.tag).object,
198
+ ) &&
199
+ astUtils.isStaticTemplateLiteral(node.quasi)
200
+ );
201
+ }
202
+
203
+ /**
204
+ * Gets the value of a string
205
+ * @param {ASTNode} node The node to get the string of.
206
+ * @returns {string|null} The value of the node.
207
+ */
208
+ function getStringValue(node) {
209
+ if (isStringLiteral(node)) {
210
+ return node.value;
211
+ }
212
+
213
+ if (astUtils.isStaticTemplateLiteral(node)) {
214
+ return node.quasis[0].value.cooked;
215
+ }
216
+
217
+ if (isStringRawTaggedStaticTemplateLiteral(node)) {
218
+ return node.quasi.quasis[0].value.raw;
219
+ }
220
+
221
+ return null;
222
+ }
223
+
224
+ /**
225
+ * Determines whether the given node is considered to be a static string by the logic of this rule.
226
+ * @param {ASTNode} node Node to check.
227
+ * @returns {boolean} True if the node is a static string.
228
+ */
229
+ function isStaticString(node) {
230
+ return (
231
+ isStringLiteral(node) ||
232
+ astUtils.isStaticTemplateLiteral(node) ||
233
+ isStringRawTaggedStaticTemplateLiteral(node)
234
+ );
235
+ }
236
+
237
+ /**
238
+ * Determines whether the relevant arguments of the given are all static string literals.
239
+ * @param {ASTNode} node Node to check.
240
+ * @returns {boolean} True if all arguments are static strings.
241
+ */
242
+ function hasOnlyStaticStringArguments(node) {
243
+ const args = node.arguments;
244
+
245
+ if (
246
+ (args.length === 1 || args.length === 2) &&
247
+ args.every(isStaticString)
248
+ ) {
249
+ return true;
250
+ }
251
+
252
+ return false;
253
+ }
254
+
255
+ /**
256
+ * Determines whether the arguments of the given node indicate that a regex literal is unnecessarily wrapped.
257
+ * @param {ASTNode} node Node to check.
258
+ * @returns {boolean} True if the node already contains a regex literal argument.
259
+ */
260
+ function isUnnecessarilyWrappedRegexLiteral(node) {
261
+ const args = node.arguments;
262
+
263
+ if (args.length === 1 && isRegexLiteral(args[0])) {
264
+ return true;
265
+ }
266
+
267
+ if (
268
+ args.length === 2 &&
269
+ isRegexLiteral(args[0]) &&
270
+ isStaticString(args[1])
271
+ ) {
272
+ return true;
273
+ }
274
+
275
+ return false;
276
+ }
277
+
278
+ /**
279
+ * Returns a ecmaVersion compatible for regexpp.
280
+ * @param {number} ecmaVersion The ecmaVersion to convert.
281
+ * @returns {import("@eslint-community/regexpp/ecma-versions").EcmaVersion} The resulting ecmaVersion compatible for regexpp.
282
+ */
283
+ function getRegexppEcmaVersion(ecmaVersion) {
284
+ if (ecmaVersion <= 5) {
285
+ return 5;
286
+ }
287
+ return Math.min(ecmaVersion, REGEXPP_LATEST_ECMA_VERSION);
288
+ }
289
+
290
+ const regexppEcmaVersion = getRegexppEcmaVersion(
291
+ context.languageOptions.ecmaVersion,
292
+ );
293
+
294
+ /**
295
+ * Makes a character escaped or else returns null.
296
+ * @param {string} character The character to escape.
297
+ * @returns {string} The resulting escaped character.
298
+ */
299
+ function resolveEscapes(character) {
300
+ switch (character) {
301
+ case "\n":
302
+ case "\\\n":
303
+ return "\\n";
304
+
305
+ case "\r":
306
+ case "\\\r":
307
+ return "\\r";
308
+
309
+ case "\t":
310
+ case "\\\t":
311
+ return "\\t";
312
+
313
+ case "\v":
314
+ case "\\\v":
315
+ return "\\v";
316
+
317
+ case "\f":
318
+ case "\\\f":
319
+ return "\\f";
320
+
321
+ case "/":
322
+ return "\\/";
323
+
324
+ default:
325
+ return null;
326
+ }
327
+ }
328
+
329
+ /**
330
+ * Checks whether the given regex and flags are valid for the ecma version or not.
331
+ * @param {string} pattern The regex pattern to check.
332
+ * @param {string | undefined} flags The regex flags to check.
333
+ * @returns {boolean} True if the given regex pattern and flags are valid for the ecma version.
334
+ */
335
+ function isValidRegexForEcmaVersion(pattern, flags) {
336
+ const validator = new RegExpValidator({
337
+ ecmaVersion: regexppEcmaVersion,
338
+ });
339
+
340
+ try {
341
+ validator.validatePattern(pattern, 0, pattern.length, {
342
+ unicode: flags ? flags.includes("u") : false,
343
+ unicodeSets: flags ? flags.includes("v") : false,
344
+ });
345
+ if (flags) {
346
+ validator.validateFlags(flags);
347
+ }
348
+ return true;
349
+ } catch {
350
+ return false;
351
+ }
352
+ }
353
+
354
+ /**
355
+ * Checks whether two given regex flags contain the same flags or not.
356
+ * @param {string} flagsA The regex flags.
357
+ * @param {string} flagsB The regex flags.
358
+ * @returns {boolean} True if two regex flags contain same flags.
359
+ */
360
+ function areFlagsEqual(flagsA, flagsB) {
361
+ return [...flagsA].sort().join("") === [...flagsB].sort().join("");
362
+ }
363
+
364
+ /**
365
+ * Merges two regex flags.
366
+ * @param {string} flagsA The regex flags.
367
+ * @param {string} flagsB The regex flags.
368
+ * @returns {string} The merged regex flags.
369
+ */
370
+ function mergeRegexFlags(flagsA, flagsB) {
371
+ const flagsSet = new Set([...flagsA, ...flagsB]);
372
+
373
+ return [...flagsSet].join("");
374
+ }
375
+
376
+ /**
377
+ * Checks whether a give node can be fixed to the given regex pattern and flags.
378
+ * @param {ASTNode} node The node to check.
379
+ * @param {string} pattern The regex pattern to check.
380
+ * @param {string} flags The regex flags
381
+ * @returns {boolean} True if a node can be fixed to the given regex pattern and flags.
382
+ */
383
+ function canFixTo(node, pattern, flags) {
384
+ const tokenBefore = sourceCode.getTokenBefore(node);
385
+
386
+ return (
387
+ sourceCode.getCommentsInside(node).length === 0 &&
388
+ (!tokenBefore || validPrecedingTokens.has(tokenBefore.value)) &&
389
+ isValidRegexForEcmaVersion(pattern, flags)
390
+ );
391
+ }
392
+
393
+ /**
394
+ * Returns a safe output code considering the before and after tokens.
395
+ * @param {ASTNode} node The regex node.
396
+ * @param {string} newRegExpValue The new regex expression value.
397
+ * @returns {string} The output code.
398
+ */
399
+ function getSafeOutput(node, newRegExpValue) {
400
+ const tokenBefore = sourceCode.getTokenBefore(node);
401
+ const tokenAfter = sourceCode.getTokenAfter(node);
402
+
403
+ return (
404
+ (tokenBefore &&
405
+ !canTokensBeAdjacent(tokenBefore, newRegExpValue) &&
406
+ tokenBefore.range[1] === node.range[0]
407
+ ? " "
408
+ : "") +
409
+ newRegExpValue +
410
+ (tokenAfter &&
411
+ !canTokensBeAdjacent(newRegExpValue, tokenAfter) &&
412
+ node.range[1] === tokenAfter.range[0]
413
+ ? " "
414
+ : "")
415
+ );
416
+ }
417
+
418
+ return {
419
+ Program(node) {
420
+ const scope = sourceCode.getScope(node);
421
+ const tracker = new ReferenceTracker(scope);
422
+ const traceMap = {
423
+ RegExp: {
424
+ [CALL]: true,
425
+ [CONSTRUCT]: true,
426
+ },
427
+ };
428
+
429
+ for (const { node: refNode } of tracker.iterateGlobalReferences(
430
+ traceMap,
431
+ )) {
432
+ if (
433
+ disallowRedundantWrapping &&
434
+ isUnnecessarilyWrappedRegexLiteral(refNode)
435
+ ) {
436
+ const regexNode = refNode.arguments[0];
437
+
438
+ if (refNode.arguments.length === 2) {
439
+ const suggests = [];
440
+
441
+ const argFlags =
442
+ getStringValue(refNode.arguments[1]) || "";
443
+
444
+ if (
445
+ canFixTo(
446
+ refNode,
447
+ regexNode.regex.pattern,
448
+ argFlags,
449
+ )
450
+ ) {
451
+ suggests.push({
452
+ messageId: "replaceWithLiteralAndFlags",
453
+ pattern: regexNode.regex.pattern,
454
+ flags: argFlags,
455
+ });
456
+ }
457
+
458
+ const literalFlags = regexNode.regex.flags || "";
459
+ const mergedFlags = mergeRegexFlags(
460
+ literalFlags,
461
+ argFlags,
462
+ );
463
+
464
+ if (
465
+ !areFlagsEqual(mergedFlags, argFlags) &&
466
+ canFixTo(
467
+ refNode,
468
+ regexNode.regex.pattern,
469
+ mergedFlags,
470
+ )
471
+ ) {
472
+ suggests.push({
473
+ messageId:
474
+ "replaceWithIntendedLiteralAndFlags",
475
+ pattern: regexNode.regex.pattern,
476
+ flags: mergedFlags,
477
+ });
478
+ }
479
+
480
+ context.report({
481
+ node: refNode,
482
+ messageId: "unexpectedRedundantRegExpWithFlags",
483
+ suggest: suggests.map(
484
+ ({ flags, pattern, messageId }) => ({
485
+ messageId,
486
+ data: {
487
+ flags,
488
+ },
489
+ fix(fixer) {
490
+ return fixer.replaceText(
491
+ refNode,
492
+ getSafeOutput(
493
+ refNode,
494
+ `/${pattern}/${flags}`,
495
+ ),
496
+ );
497
+ },
498
+ }),
499
+ ),
500
+ });
501
+ } else {
502
+ const outputs = [];
503
+
504
+ if (
505
+ canFixTo(
506
+ refNode,
507
+ regexNode.regex.pattern,
508
+ regexNode.regex.flags,
509
+ )
510
+ ) {
511
+ outputs.push(sourceCode.getText(regexNode));
512
+ }
513
+
514
+ context.report({
515
+ node: refNode,
516
+ messageId: "unexpectedRedundantRegExp",
517
+ suggest: outputs.map(output => ({
518
+ messageId: "replaceWithLiteral",
519
+ fix(fixer) {
520
+ return fixer.replaceText(
521
+ refNode,
522
+ getSafeOutput(refNode, output),
523
+ );
524
+ },
525
+ })),
526
+ });
527
+ }
528
+ } else if (hasOnlyStaticStringArguments(refNode)) {
529
+ let regexContent = getStringValue(refNode.arguments[0]);
530
+ let noFix = false;
531
+ let flags;
532
+
533
+ if (refNode.arguments[1]) {
534
+ flags = getStringValue(refNode.arguments[1]);
535
+ }
536
+
537
+ if (!canFixTo(refNode, regexContent, flags)) {
538
+ noFix = true;
539
+ }
540
+
541
+ if (
542
+ !/^[-a-zA-Z0-9\\[\](){} \t\r\n\v\f!@#$%^&*+^_=/~`.><?,'"|:;]*$/u.test(
543
+ regexContent,
544
+ )
545
+ ) {
546
+ noFix = true;
547
+ }
548
+
549
+ if (regexContent && !noFix) {
550
+ let charIncrease = 0;
551
+
552
+ const ast = new RegExpParser({
553
+ ecmaVersion: regexppEcmaVersion,
554
+ }).parsePattern(
555
+ regexContent,
556
+ 0,
557
+ regexContent.length,
558
+ {
559
+ unicode: flags
560
+ ? flags.includes("u")
561
+ : false,
562
+ unicodeSets: flags
563
+ ? flags.includes("v")
564
+ : false,
565
+ },
566
+ );
567
+
568
+ visitRegExpAST(ast, {
569
+ onCharacterEnter(characterNode) {
570
+ const escaped = resolveEscapes(
571
+ characterNode.raw,
572
+ );
573
+
574
+ if (escaped) {
575
+ regexContent =
576
+ regexContent.slice(
577
+ 0,
578
+ characterNode.start +
579
+ charIncrease,
580
+ ) +
581
+ escaped +
582
+ regexContent.slice(
583
+ characterNode.end +
584
+ charIncrease,
585
+ );
586
+
587
+ if (characterNode.raw.length === 1) {
588
+ charIncrease += 1;
589
+ }
590
+ }
591
+ },
592
+ });
593
+ }
594
+
595
+ const newRegExpValue = `/${regexContent || "(?:)"}/${flags || ""}`;
596
+
597
+ context.report({
598
+ node: refNode,
599
+ messageId: "unexpectedRegExp",
600
+ suggest: noFix
601
+ ? []
602
+ : [
603
+ {
604
+ messageId: "replaceWithLiteral",
605
+ fix(fixer) {
606
+ return fixer.replaceText(
607
+ refNode,
608
+ getSafeOutput(
609
+ refNode,
610
+ newRegExpValue,
611
+ ),
612
+ );
613
+ },
614
+ },
615
+ ],
616
+ });
617
+ }
618
+ }
619
+ },
620
+ };
621
+ },
510
622
  };