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
@@ -32,35 +32,36 @@ const { findVariable } = require("@eslint-community/eslint-utils");
32
32
  * @param {Pattern} pattern The pattern node to extract identifier
33
33
  * @returns {Iterable<Identifier>} The extracted identifier
34
34
  */
35
- function *extractIdentifiersFromPattern(pattern) {
36
- switch (pattern.type) {
37
- case "Identifier":
38
- yield pattern;
39
- return;
40
- case "ObjectPattern":
41
- for (const property of pattern.properties) {
42
- yield* extractIdentifiersFromPattern(property.type === "Property" ? property.value : property);
43
- }
44
- return;
45
- case "ArrayPattern":
46
- for (const element of pattern.elements) {
47
- if (!element) {
48
- continue;
49
- }
50
- yield* extractIdentifiersFromPattern(element);
51
- }
52
- return;
53
- case "RestElement":
54
- yield* extractIdentifiersFromPattern(pattern.argument);
55
- return;
56
- case "AssignmentPattern":
57
- yield* extractIdentifiersFromPattern(pattern.left);
58
-
59
- // no default
60
- }
35
+ function* extractIdentifiersFromPattern(pattern) {
36
+ switch (pattern.type) {
37
+ case "Identifier":
38
+ yield pattern;
39
+ return;
40
+ case "ObjectPattern":
41
+ for (const property of pattern.properties) {
42
+ yield* extractIdentifiersFromPattern(
43
+ property.type === "Property" ? property.value : property,
44
+ );
45
+ }
46
+ return;
47
+ case "ArrayPattern":
48
+ for (const element of pattern.elements) {
49
+ if (!element) {
50
+ continue;
51
+ }
52
+ yield* extractIdentifiersFromPattern(element);
53
+ }
54
+ return;
55
+ case "RestElement":
56
+ yield* extractIdentifiersFromPattern(pattern.argument);
57
+ return;
58
+ case "AssignmentPattern":
59
+ yield* extractIdentifiersFromPattern(pattern.left);
60
+
61
+ // no default
62
+ }
61
63
  }
62
64
 
63
-
64
65
  /**
65
66
  * Checks whether the given identifier node is evaluated after the assignment identifier.
66
67
  * @param {AssignmentInfo} assignment The assignment info.
@@ -68,34 +69,33 @@ function *extractIdentifiersFromPattern(pattern) {
68
69
  * @returns {boolean} `true` if the given identifier node is evaluated after the assignment identifier.
69
70
  */
70
71
  function isIdentifierEvaluatedAfterAssignment(assignment, identifier) {
71
- if (identifier.range[0] < assignment.identifier.range[1]) {
72
- return false;
73
- }
74
- if (
75
- assignment.expression &&
76
- assignment.expression.range[0] <= identifier.range[0] &&
77
- identifier.range[1] <= assignment.expression.range[1]
78
- ) {
79
-
80
- /*
81
- * The identifier node is in an expression that is evaluated before the assignment.
82
- * e.g. x = id;
83
- * ^^ identifier to check
84
- * ^ assignment identifier
85
- */
86
- return false;
87
- }
88
-
89
- /*
90
- * e.g.
91
- * x = 42; id;
92
- * ^^ identifier to check
93
- * ^ assignment identifier
94
- * let { x, y = id } = obj;
95
- * ^^ identifier to check
96
- * ^ assignment identifier
97
- */
98
- return true;
72
+ if (identifier.range[0] < assignment.identifier.range[1]) {
73
+ return false;
74
+ }
75
+ if (
76
+ assignment.expression &&
77
+ assignment.expression.range[0] <= identifier.range[0] &&
78
+ identifier.range[1] <= assignment.expression.range[1]
79
+ ) {
80
+ /*
81
+ * The identifier node is in an expression that is evaluated before the assignment.
82
+ * e.g. x = id;
83
+ * ^^ identifier to check
84
+ * ^ assignment identifier
85
+ */
86
+ return false;
87
+ }
88
+
89
+ /*
90
+ * e.g.
91
+ * x = 42; id;
92
+ * ^^ identifier to check
93
+ * ^ assignment identifier
94
+ * let { x, y = id } = obj;
95
+ * ^^ identifier to check
96
+ * ^ assignment identifier
97
+ */
98
+ return true;
99
99
  }
100
100
 
101
101
  /**
@@ -109,467 +109,546 @@ function isIdentifierEvaluatedAfterAssignment(assignment, identifier) {
109
109
  * @returns {boolean} `true` if the given identifier node is used between the assigned identifier and the equal sign.
110
110
  */
111
111
  function isIdentifierUsedBetweenAssignedAndEqualSign(assignment, identifier) {
112
- if (!assignment.expression) {
113
- return false;
114
- }
115
- return (
116
- assignment.identifier.range[1] <= identifier.range[0] &&
117
- identifier.range[1] <= assignment.expression.range[0]
118
- );
112
+ if (!assignment.expression) {
113
+ return false;
114
+ }
115
+ return (
116
+ assignment.identifier.range[1] <= identifier.range[0] &&
117
+ identifier.range[1] <= assignment.expression.range[0]
118
+ );
119
119
  }
120
120
 
121
121
  //------------------------------------------------------------------------------
122
122
  // Rule Definition
123
123
  //------------------------------------------------------------------------------
124
124
 
125
- /** @type {import('../shared/types').Rule} */
125
+ /** @type {import('../types').Rule.RuleModule} */
126
126
  module.exports = {
127
- meta: {
128
- type: "problem",
129
-
130
- docs: {
131
- description: "Disallow variable assignments when the value is not used",
132
- recommended: false,
133
- url: "https://eslint.org/docs/latest/rules/no-useless-assignment"
134
- },
135
-
136
- schema: [],
137
-
138
- messages: {
139
- unnecessaryAssignment: "This assigned value is not used in subsequent statements."
140
- }
141
- },
142
-
143
- create(context) {
144
- const sourceCode = context.sourceCode;
145
-
146
- /**
147
- * @typedef {Object} ScopeStack
148
- * @property {CodePath} codePath The code path of this scope stack.
149
- * @property {Scope} scope The scope of this scope stack.
150
- * @property {ScopeStack} upper The upper scope stack.
151
- * @property {Record<string, ScopeStackSegmentInfo>} segments The map of ScopeStackSegmentInfo.
152
- * @property {Set<CodePathSegment>} currentSegments The current CodePathSegments.
153
- * @property {Map<Variable, AssignmentInfo[]>} assignments The map of list of AssignmentInfo for each variable.
154
- */
155
- /**
156
- * @typedef {Object} ScopeStackSegmentInfo
157
- * @property {CodePathSegment} segment The code path segment.
158
- * @property {Identifier|null} first The first identifier that appears within the segment.
159
- * @property {Identifier|null} last The last identifier that appears within the segment.
160
- * `first` and `last` are used to determine whether an identifier exists within the segment position range.
161
- * Since it is used as a range of segments, we should originally hold all nodes, not just identifiers,
162
- * but since the only nodes to be judged are identifiers, it is sufficient to have a range of identifiers.
163
- */
164
- /**
165
- * @typedef {Object} AssignmentInfo
166
- * @property {Variable} variable The variable that is assigned.
167
- * @property {Identifier} identifier The identifier that is assigned.
168
- * @property {VariableDeclarator|AssignmentExpression|UpdateExpression} node The node where the variable was updated.
169
- * @property {Expression|null} expression The expression that is evaluated before the assignment.
170
- * @property {CodePathSegment[]} segments The code path segments where the assignment was made.
171
- */
172
-
173
- /** @type {ScopeStack} */
174
- let scopeStack = null;
175
-
176
- /** @type {Set<Scope>} */
177
- const codePathStartScopes = new Set();
178
-
179
- /**
180
- * Gets the scope of code path start from given scope
181
- * @param {Scope} scope The initial scope
182
- * @returns {Scope} The scope of code path start
183
- * @throws {Error} Unexpected error
184
- */
185
- function getCodePathStartScope(scope) {
186
- let target = scope;
187
-
188
- while (target) {
189
- if (codePathStartScopes.has(target)) {
190
- return target;
191
- }
192
- target = target.upper;
193
- }
194
-
195
- // Should be unreachable
196
- return null;
197
- }
198
-
199
- /**
200
- * Verify the given scope stack.
201
- * @param {ScopeStack} target The scope stack to verify.
202
- * @returns {void}
203
- */
204
- function verify(target) {
205
-
206
- /**
207
- * Checks whether the given identifier is used in the segment.
208
- * @param {CodePathSegment} segment The code path segment.
209
- * @param {Identifier} identifier The identifier to check.
210
- * @returns {boolean} `true` if the identifier is used in the segment.
211
- */
212
- function isIdentifierUsedInSegment(segment, identifier) {
213
- const segmentInfo = target.segments[segment.id];
214
-
215
- return (
216
- segmentInfo.first &&
217
- segmentInfo.last &&
218
- segmentInfo.first.range[0] <= identifier.range[0] &&
219
- identifier.range[1] <= segmentInfo.last.range[1]
220
- );
221
- }
222
-
223
- /**
224
- * Verifies whether the given assignment info is an used assignment.
225
- * Report if it is an unused assignment.
226
- * @param {AssignmentInfo} targetAssignment The assignment info to verify.
227
- * @param {AssignmentInfo[]} allAssignments The list of all assignment info for variables.
228
- * @returns {void}
229
- */
230
- function verifyAssignmentIsUsed(targetAssignment, allAssignments) {
231
-
232
- /**
233
- * @typedef {Object} SubsequentSegmentData
234
- * @property {CodePathSegment} segment The code path segment
235
- * @property {AssignmentInfo} [assignment] The first occurrence of the assignment within the segment.
236
- * There is no need to check if the variable is used after this assignment,
237
- * as the value it was assigned will be used.
238
- */
239
-
240
- /**
241
- * Information used in `getSubsequentSegments()`.
242
- * To avoid unnecessary iterations, cache information that has already been iterated over,
243
- * and if additional iterations are needed, start iterating from the retained position.
244
- */
245
- const subsequentSegmentData = {
246
-
247
- /**
248
- * Cache of subsequent segment information list that have already been iterated.
249
- * @type {SubsequentSegmentData[]}
250
- */
251
- results: [],
252
-
253
- /**
254
- * Subsequent segments that have already been iterated on. Used to avoid infinite loops.
255
- * @type {Set<CodePathSegment>}
256
- */
257
- subsequentSegments: new Set(),
258
-
259
- /**
260
- * Unexplored code path segment.
261
- * If additional iterations are needed, consume this information and iterate.
262
- * @type {CodePathSegment[]}
263
- */
264
- queueSegments: targetAssignment.segments.flatMap(segment => segment.nextSegments)
265
- };
266
-
267
-
268
- /**
269
- * Gets the subsequent segments from the segment of
270
- * the assignment currently being validated (targetAssignment).
271
- * @returns {Iterable<SubsequentSegmentData>} the subsequent segments
272
- */
273
- function *getSubsequentSegments() {
274
- yield* subsequentSegmentData.results;
275
-
276
- while (subsequentSegmentData.queueSegments.length > 0) {
277
- const nextSegment = subsequentSegmentData.queueSegments.shift();
278
-
279
- if (subsequentSegmentData.subsequentSegments.has(nextSegment)) {
280
- continue;
281
- }
282
- subsequentSegmentData.subsequentSegments.add(nextSegment);
283
-
284
- const assignmentInSegment = allAssignments
285
- .find(otherAssignment => (
286
- otherAssignment.segments.includes(nextSegment) &&
287
- !isIdentifierUsedBetweenAssignedAndEqualSign(otherAssignment, targetAssignment.identifier)
288
- ));
289
-
290
- if (!assignmentInSegment) {
291
-
292
- /*
293
- * Stores the next segment to explore.
294
- * If `assignmentInSegment` exists,
295
- * we are guarding it because we don't need to explore the next segment.
296
- */
297
- subsequentSegmentData.queueSegments.push(...nextSegment.nextSegments);
298
- }
299
-
300
- /** @type {SubsequentSegmentData} */
301
- const result = {
302
- segment: nextSegment,
303
- assignment: assignmentInSegment
304
- };
305
-
306
- subsequentSegmentData.results.push(result);
307
- yield result;
308
- }
309
- }
310
-
311
-
312
- if (targetAssignment.variable.references.some(ref => ref.identifier.type !== "Identifier")) {
313
-
314
- /**
315
- * Skip checking for a variable that has at least one non-identifier reference.
316
- * It's generated by plugins and cannot be handled reliably in the core rule.
317
- */
318
- return;
319
- }
320
-
321
- const readReferences = targetAssignment.variable.references.filter(reference => reference.isRead());
322
-
323
- if (!readReferences.length) {
324
-
325
- /*
326
- * It is not just an unnecessary assignment, but an unnecessary (unused) variable
327
- * and thus should not be reported by this rule because it is reported by `no-unused-vars`.
328
- */
329
- return;
330
- }
331
-
332
- /**
333
- * Other assignment on the current segment and after current assignment.
334
- */
335
- const otherAssignmentAfterTargetAssignment = allAssignments
336
- .find(assignment => {
337
- if (
338
- assignment === targetAssignment ||
339
- assignment.segments.length && assignment.segments.every(segment => !targetAssignment.segments.includes(segment))
340
- ) {
341
- return false;
342
- }
343
- if (isIdentifierEvaluatedAfterAssignment(targetAssignment, assignment.identifier)) {
344
- return true;
345
- }
346
- if (
347
- assignment.expression &&
348
- assignment.expression.range[0] <= targetAssignment.identifier.range[0] &&
349
- targetAssignment.identifier.range[1] <= assignment.expression.range[1]
350
- ) {
351
-
352
- /*
353
- * The target assignment is in an expression that is evaluated before the assignment.
354
- * e.g. x=(x=1);
355
- * ^^^ targetAssignment
356
- * ^^^^^^^ assignment
357
- */
358
- return true;
359
- }
360
-
361
- return false;
362
- });
363
-
364
- for (const reference of readReferences) {
365
-
366
- /*
367
- * If the scope of the reference is outside the current code path scope,
368
- * we cannot track whether this assignment is not used.
369
- * For example, it can also be called asynchronously.
370
- */
371
- if (target.scope !== getCodePathStartScope(reference.from)) {
372
- return;
373
- }
374
-
375
- // Checks if it is used in the same segment as the target assignment.
376
- if (
377
- isIdentifierEvaluatedAfterAssignment(targetAssignment, reference.identifier) &&
378
- (
379
- isIdentifierUsedBetweenAssignedAndEqualSign(targetAssignment, reference.identifier) ||
380
- targetAssignment.segments.some(segment => isIdentifierUsedInSegment(segment, reference.identifier))
381
- )
382
- ) {
383
-
384
- if (
385
- otherAssignmentAfterTargetAssignment &&
386
- isIdentifierEvaluatedAfterAssignment(otherAssignmentAfterTargetAssignment, reference.identifier)
387
- ) {
388
-
389
- // There was another assignment before the reference. Therefore, it has not been used yet.
390
- continue;
391
- }
392
-
393
- // Uses in statements after the written identifier.
394
- return;
395
- }
396
-
397
- if (otherAssignmentAfterTargetAssignment) {
398
-
399
- /*
400
- * The assignment was followed by another assignment in the same segment.
401
- * Therefore, there is no need to check the next segment.
402
- */
403
- continue;
404
- }
405
-
406
- // Check subsequent segments.
407
- for (const subsequentSegment of getSubsequentSegments()) {
408
- if (isIdentifierUsedInSegment(subsequentSegment.segment, reference.identifier)) {
409
- if (
410
- subsequentSegment.assignment &&
411
- isIdentifierEvaluatedAfterAssignment(subsequentSegment.assignment, reference.identifier)
412
- ) {
413
-
414
- // There was another assignment before the reference. Therefore, it has not been used yet.
415
- continue;
416
- }
417
-
418
- // It is used
419
- return;
420
- }
421
- }
422
- }
423
- context.report({
424
- node: targetAssignment.identifier,
425
- messageId: "unnecessaryAssignment"
426
- });
427
- }
428
-
429
- // Verify that each assignment in the code path is used.
430
- for (const assignments of target.assignments.values()) {
431
- assignments.sort((a, b) => a.identifier.range[0] - b.identifier.range[0]);
432
- for (const assignment of assignments) {
433
- verifyAssignmentIsUsed(assignment, assignments);
434
- }
435
- }
436
- }
437
-
438
- return {
439
- onCodePathStart(codePath, node) {
440
- const scope = sourceCode.getScope(node);
441
-
442
- scopeStack = {
443
- upper: scopeStack,
444
- codePath,
445
- scope,
446
- segments: Object.create(null),
447
- currentSegments: new Set(),
448
- assignments: new Map()
449
- };
450
- codePathStartScopes.add(scopeStack.scope);
451
- },
452
- onCodePathEnd() {
453
- verify(scopeStack);
454
-
455
- scopeStack = scopeStack.upper;
456
- },
457
- onCodePathSegmentStart(segment) {
458
- const segmentInfo = { segment, first: null, last: null };
459
-
460
- scopeStack.segments[segment.id] = segmentInfo;
461
- scopeStack.currentSegments.add(segment);
462
- },
463
- onCodePathSegmentEnd(segment) {
464
- scopeStack.currentSegments.delete(segment);
465
- },
466
- Identifier(node) {
467
- for (const segment of scopeStack.currentSegments) {
468
- const segmentInfo = scopeStack.segments[segment.id];
469
-
470
- if (!segmentInfo.first) {
471
- segmentInfo.first = node;
472
- }
473
- segmentInfo.last = node;
474
- }
475
- },
476
- ":matches(VariableDeclarator[init!=null], AssignmentExpression, UpdateExpression):exit"(node) {
477
- if (scopeStack.currentSegments.size === 0) {
478
-
479
- // Ignore unreachable segments
480
- return;
481
- }
482
-
483
- const assignments = scopeStack.assignments;
484
-
485
- let pattern;
486
- let expression = null;
487
-
488
- if (node.type === "VariableDeclarator") {
489
- pattern = node.id;
490
- expression = node.init;
491
- } else if (node.type === "AssignmentExpression") {
492
- pattern = node.left;
493
- expression = node.right;
494
- } else { // UpdateExpression
495
- pattern = node.argument;
496
- }
497
-
498
- for (const identifier of extractIdentifiersFromPattern(pattern)) {
499
- const scope = sourceCode.getScope(identifier);
500
-
501
- /** @type {Variable} */
502
- const variable = findVariable(scope, identifier);
503
-
504
- if (!variable) {
505
- continue;
506
- }
507
-
508
- // We don't know where global variables are used.
509
- if (variable.scope.type === "global" && variable.defs.length === 0) {
510
- continue;
511
- }
512
-
513
- /*
514
- * If the scope of the variable is outside the current code path scope,
515
- * we cannot track whether this assignment is not used.
516
- */
517
- if (scopeStack.scope !== getCodePathStartScope(variable.scope)) {
518
- continue;
519
- }
520
-
521
- // Variables marked by `markVariableAsUsed()` or
522
- // exported by "exported" block comment.
523
- if (variable.eslintUsed) {
524
- continue;
525
- }
526
-
527
- // Variables exported by ESM export syntax
528
- if (variable.scope.type === "module") {
529
- if (
530
- variable.defs
531
- .some(def => (
532
- (def.type === "Variable" && def.parent.parent.type === "ExportNamedDeclaration") ||
533
- (
534
- def.type === "FunctionName" &&
535
- (
536
- def.node.parent.type === "ExportNamedDeclaration" ||
537
- def.node.parent.type === "ExportDefaultDeclaration"
538
- )
539
- ) ||
540
- (
541
- def.type === "ClassName" &&
542
- (
543
- def.node.parent.type === "ExportNamedDeclaration" ||
544
- def.node.parent.type === "ExportDefaultDeclaration"
545
- )
546
- )
547
- ))
548
- ) {
549
- continue;
550
- }
551
- if (variable.references.some(reference => reference.identifier.parent.type === "ExportSpecifier")) {
552
-
553
- // It have `export { ... }` reference.
554
- continue;
555
- }
556
- }
557
-
558
- let list = assignments.get(variable);
559
-
560
- if (!list) {
561
- list = [];
562
- assignments.set(variable, list);
563
- }
564
- list.push({
565
- variable,
566
- identifier,
567
- node,
568
- expression,
569
- segments: [...scopeStack.currentSegments]
570
- });
571
- }
572
- }
573
- };
574
- }
127
+ meta: {
128
+ type: "problem",
129
+
130
+ docs: {
131
+ description:
132
+ "Disallow variable assignments when the value is not used",
133
+ recommended: false,
134
+ url: "https://eslint.org/docs/latest/rules/no-useless-assignment",
135
+ },
136
+
137
+ schema: [],
138
+
139
+ messages: {
140
+ unnecessaryAssignment:
141
+ "This assigned value is not used in subsequent statements.",
142
+ },
143
+ },
144
+
145
+ create(context) {
146
+ const sourceCode = context.sourceCode;
147
+
148
+ /**
149
+ * @typedef {Object} ScopeStack
150
+ * @property {CodePath} codePath The code path of this scope stack.
151
+ * @property {Scope} scope The scope of this scope stack.
152
+ * @property {ScopeStack} upper The upper scope stack.
153
+ * @property {Record<string, ScopeStackSegmentInfo>} segments The map of ScopeStackSegmentInfo.
154
+ * @property {Set<CodePathSegment>} currentSegments The current CodePathSegments.
155
+ * @property {Map<Variable, AssignmentInfo[]>} assignments The map of list of AssignmentInfo for each variable.
156
+ * @property {Array} tryStatementBlocks The array of TryStatement block nodes in this scope stack.
157
+ */
158
+ /**
159
+ * @typedef {Object} ScopeStackSegmentInfo
160
+ * @property {CodePathSegment} segment The code path segment.
161
+ * @property {Identifier|null} first The first identifier that appears within the segment.
162
+ * @property {Identifier|null} last The last identifier that appears within the segment.
163
+ * `first` and `last` are used to determine whether an identifier exists within the segment position range.
164
+ * Since it is used as a range of segments, we should originally hold all nodes, not just identifiers,
165
+ * but since the only nodes to be judged are identifiers, it is sufficient to have a range of identifiers.
166
+ */
167
+ /**
168
+ * @typedef {Object} AssignmentInfo
169
+ * @property {Variable} variable The variable that is assigned.
170
+ * @property {Identifier} identifier The identifier that is assigned.
171
+ * @property {VariableDeclarator|AssignmentExpression|UpdateExpression} node The node where the variable was updated.
172
+ * @property {Expression|null} expression The expression that is evaluated before the assignment.
173
+ * @property {CodePathSegment[]} segments The code path segments where the assignment was made.
174
+ */
175
+
176
+ /** @type {ScopeStack} */
177
+ let scopeStack = null;
178
+
179
+ /** @type {Set<Scope>} */
180
+ const codePathStartScopes = new Set();
181
+
182
+ /**
183
+ * Gets the scope of code path start from given scope
184
+ * @param {Scope} scope The initial scope
185
+ * @returns {Scope} The scope of code path start
186
+ * @throws {Error} Unexpected error
187
+ */
188
+ function getCodePathStartScope(scope) {
189
+ let target = scope;
190
+
191
+ while (target) {
192
+ if (codePathStartScopes.has(target)) {
193
+ return target;
194
+ }
195
+ target = target.upper;
196
+ }
197
+
198
+ // Should be unreachable
199
+ return null;
200
+ }
201
+
202
+ /**
203
+ * Verify the given scope stack.
204
+ * @param {ScopeStack} target The scope stack to verify.
205
+ * @returns {void}
206
+ */
207
+ function verify(target) {
208
+ /**
209
+ * Checks whether the given identifier is used in the segment.
210
+ * @param {CodePathSegment} segment The code path segment.
211
+ * @param {Identifier} identifier The identifier to check.
212
+ * @returns {boolean} `true` if the identifier is used in the segment.
213
+ */
214
+ function isIdentifierUsedInSegment(segment, identifier) {
215
+ const segmentInfo = target.segments[segment.id];
216
+
217
+ return (
218
+ segmentInfo.first &&
219
+ segmentInfo.last &&
220
+ segmentInfo.first.range[0] <= identifier.range[0] &&
221
+ identifier.range[1] <= segmentInfo.last.range[1]
222
+ );
223
+ }
224
+
225
+ /**
226
+ * Verifies whether the given assignment info is an used assignment.
227
+ * Report if it is an unused assignment.
228
+ * @param {AssignmentInfo} targetAssignment The assignment info to verify.
229
+ * @param {AssignmentInfo[]} allAssignments The list of all assignment info for variables.
230
+ * @returns {void}
231
+ */
232
+ function verifyAssignmentIsUsed(targetAssignment, allAssignments) {
233
+ // Skip assignment if it is in a try block.
234
+ const isAssignmentInTryBlock = target.tryStatementBlocks.some(
235
+ tryBlock =>
236
+ tryBlock.range[0] <=
237
+ targetAssignment.identifier.range[0] &&
238
+ targetAssignment.identifier.range[1] <=
239
+ tryBlock.range[1],
240
+ );
241
+
242
+ if (isAssignmentInTryBlock) {
243
+ return;
244
+ }
245
+
246
+ /**
247
+ * @typedef {Object} SubsequentSegmentData
248
+ * @property {CodePathSegment} segment The code path segment
249
+ * @property {AssignmentInfo} [assignment] The first occurrence of the assignment within the segment.
250
+ * There is no need to check if the variable is used after this assignment,
251
+ * as the value it was assigned will be used.
252
+ */
253
+
254
+ /**
255
+ * Information used in `getSubsequentSegments()`.
256
+ * To avoid unnecessary iterations, cache information that has already been iterated over,
257
+ * and if additional iterations are needed, start iterating from the retained position.
258
+ */
259
+ const subsequentSegmentData = {
260
+ /**
261
+ * Cache of subsequent segment information list that have already been iterated.
262
+ * @type {SubsequentSegmentData[]}
263
+ */
264
+ results: [],
265
+
266
+ /**
267
+ * Subsequent segments that have already been iterated on. Used to avoid infinite loops.
268
+ * @type {Set<CodePathSegment>}
269
+ */
270
+ subsequentSegments: new Set(),
271
+
272
+ /**
273
+ * Unexplored code path segment.
274
+ * If additional iterations are needed, consume this information and iterate.
275
+ * @type {CodePathSegment[]}
276
+ */
277
+ queueSegments: targetAssignment.segments.flatMap(
278
+ segment => segment.nextSegments,
279
+ ),
280
+ };
281
+
282
+ /**
283
+ * Gets the subsequent segments from the segment of
284
+ * the assignment currently being validated (targetAssignment).
285
+ * @returns {Iterable<SubsequentSegmentData>} the subsequent segments
286
+ */
287
+ function* getSubsequentSegments() {
288
+ yield* subsequentSegmentData.results;
289
+
290
+ while (subsequentSegmentData.queueSegments.length > 0) {
291
+ const nextSegment =
292
+ subsequentSegmentData.queueSegments.shift();
293
+
294
+ if (
295
+ subsequentSegmentData.subsequentSegments.has(
296
+ nextSegment,
297
+ )
298
+ ) {
299
+ continue;
300
+ }
301
+ subsequentSegmentData.subsequentSegments.add(
302
+ nextSegment,
303
+ );
304
+
305
+ const assignmentInSegment = allAssignments.find(
306
+ otherAssignment =>
307
+ otherAssignment.segments.includes(
308
+ nextSegment,
309
+ ) &&
310
+ !isIdentifierUsedBetweenAssignedAndEqualSign(
311
+ otherAssignment,
312
+ targetAssignment.identifier,
313
+ ),
314
+ );
315
+
316
+ if (!assignmentInSegment) {
317
+ /*
318
+ * Stores the next segment to explore.
319
+ * If `assignmentInSegment` exists,
320
+ * we are guarding it because we don't need to explore the next segment.
321
+ */
322
+ subsequentSegmentData.queueSegments.push(
323
+ ...nextSegment.nextSegments,
324
+ );
325
+ }
326
+
327
+ /** @type {SubsequentSegmentData} */
328
+ const result = {
329
+ segment: nextSegment,
330
+ assignment: assignmentInSegment,
331
+ };
332
+
333
+ subsequentSegmentData.results.push(result);
334
+ yield result;
335
+ }
336
+ }
337
+
338
+ if (
339
+ targetAssignment.variable.references.some(
340
+ ref => ref.identifier.type !== "Identifier",
341
+ )
342
+ ) {
343
+ /**
344
+ * Skip checking for a variable that has at least one non-identifier reference.
345
+ * It's generated by plugins and cannot be handled reliably in the core rule.
346
+ */
347
+ return;
348
+ }
349
+
350
+ const readReferences =
351
+ targetAssignment.variable.references.filter(reference =>
352
+ reference.isRead(),
353
+ );
354
+
355
+ if (!readReferences.length) {
356
+ /*
357
+ * It is not just an unnecessary assignment, but an unnecessary (unused) variable
358
+ * and thus should not be reported by this rule because it is reported by `no-unused-vars`.
359
+ */
360
+ return;
361
+ }
362
+
363
+ /**
364
+ * Other assignment on the current segment and after current assignment.
365
+ */
366
+ const otherAssignmentAfterTargetAssignment =
367
+ allAssignments.find(assignment => {
368
+ if (
369
+ assignment === targetAssignment ||
370
+ (assignment.segments.length &&
371
+ assignment.segments.every(
372
+ segment =>
373
+ !targetAssignment.segments.includes(
374
+ segment,
375
+ ),
376
+ ))
377
+ ) {
378
+ return false;
379
+ }
380
+ if (
381
+ isIdentifierEvaluatedAfterAssignment(
382
+ targetAssignment,
383
+ assignment.identifier,
384
+ )
385
+ ) {
386
+ return true;
387
+ }
388
+ if (
389
+ assignment.expression &&
390
+ assignment.expression.range[0] <=
391
+ targetAssignment.identifier.range[0] &&
392
+ targetAssignment.identifier.range[1] <=
393
+ assignment.expression.range[1]
394
+ ) {
395
+ /*
396
+ * The target assignment is in an expression that is evaluated before the assignment.
397
+ * e.g. x=(x=1);
398
+ * ^^^ targetAssignment
399
+ * ^^^^^^^ assignment
400
+ */
401
+ return true;
402
+ }
403
+
404
+ return false;
405
+ });
406
+
407
+ for (const reference of readReferences) {
408
+ /*
409
+ * If the scope of the reference is outside the current code path scope,
410
+ * we cannot track whether this assignment is not used.
411
+ * For example, it can also be called asynchronously.
412
+ */
413
+ if (
414
+ target.scope !== getCodePathStartScope(reference.from)
415
+ ) {
416
+ return;
417
+ }
418
+
419
+ // Checks if it is used in the same segment as the target assignment.
420
+ if (
421
+ isIdentifierEvaluatedAfterAssignment(
422
+ targetAssignment,
423
+ reference.identifier,
424
+ ) &&
425
+ (isIdentifierUsedBetweenAssignedAndEqualSign(
426
+ targetAssignment,
427
+ reference.identifier,
428
+ ) ||
429
+ targetAssignment.segments.some(segment =>
430
+ isIdentifierUsedInSegment(
431
+ segment,
432
+ reference.identifier,
433
+ ),
434
+ ))
435
+ ) {
436
+ if (
437
+ otherAssignmentAfterTargetAssignment &&
438
+ isIdentifierEvaluatedAfterAssignment(
439
+ otherAssignmentAfterTargetAssignment,
440
+ reference.identifier,
441
+ )
442
+ ) {
443
+ // There was another assignment before the reference. Therefore, it has not been used yet.
444
+ continue;
445
+ }
446
+
447
+ // Uses in statements after the written identifier.
448
+ return;
449
+ }
450
+
451
+ if (otherAssignmentAfterTargetAssignment) {
452
+ /*
453
+ * The assignment was followed by another assignment in the same segment.
454
+ * Therefore, there is no need to check the next segment.
455
+ */
456
+ continue;
457
+ }
458
+
459
+ // Check subsequent segments.
460
+ for (const subsequentSegment of getSubsequentSegments()) {
461
+ if (
462
+ isIdentifierUsedInSegment(
463
+ subsequentSegment.segment,
464
+ reference.identifier,
465
+ )
466
+ ) {
467
+ if (
468
+ subsequentSegment.assignment &&
469
+ isIdentifierEvaluatedAfterAssignment(
470
+ subsequentSegment.assignment,
471
+ reference.identifier,
472
+ )
473
+ ) {
474
+ // There was another assignment before the reference. Therefore, it has not been used yet.
475
+ continue;
476
+ }
477
+
478
+ // It is used
479
+ return;
480
+ }
481
+ }
482
+ }
483
+ context.report({
484
+ node: targetAssignment.identifier,
485
+ messageId: "unnecessaryAssignment",
486
+ });
487
+ }
488
+
489
+ // Verify that each assignment in the code path is used.
490
+ for (const assignments of target.assignments.values()) {
491
+ assignments.sort(
492
+ (a, b) => a.identifier.range[0] - b.identifier.range[0],
493
+ );
494
+ for (const assignment of assignments) {
495
+ verifyAssignmentIsUsed(assignment, assignments);
496
+ }
497
+ }
498
+ }
499
+
500
+ return {
501
+ onCodePathStart(codePath, node) {
502
+ const scope = sourceCode.getScope(node);
503
+
504
+ scopeStack = {
505
+ upper: scopeStack,
506
+ codePath,
507
+ scope,
508
+ segments: Object.create(null),
509
+ currentSegments: new Set(),
510
+ assignments: new Map(),
511
+ tryStatementBlocks: [],
512
+ };
513
+ codePathStartScopes.add(scopeStack.scope);
514
+ },
515
+ onCodePathEnd() {
516
+ verify(scopeStack);
517
+
518
+ scopeStack = scopeStack.upper;
519
+ },
520
+ onCodePathSegmentStart(segment) {
521
+ const segmentInfo = { segment, first: null, last: null };
522
+
523
+ scopeStack.segments[segment.id] = segmentInfo;
524
+ scopeStack.currentSegments.add(segment);
525
+ },
526
+ onCodePathSegmentEnd(segment) {
527
+ scopeStack.currentSegments.delete(segment);
528
+ },
529
+ TryStatement(node) {
530
+ scopeStack.tryStatementBlocks.push(node.block);
531
+ },
532
+ Identifier(node) {
533
+ for (const segment of scopeStack.currentSegments) {
534
+ const segmentInfo = scopeStack.segments[segment.id];
535
+
536
+ if (!segmentInfo.first) {
537
+ segmentInfo.first = node;
538
+ }
539
+ segmentInfo.last = node;
540
+ }
541
+ },
542
+ ":matches(VariableDeclarator[init!=null], AssignmentExpression, UpdateExpression):exit"(
543
+ node,
544
+ ) {
545
+ if (scopeStack.currentSegments.size === 0) {
546
+ // Ignore unreachable segments
547
+ return;
548
+ }
549
+
550
+ const assignments = scopeStack.assignments;
551
+
552
+ let pattern;
553
+ let expression = null;
554
+
555
+ if (node.type === "VariableDeclarator") {
556
+ pattern = node.id;
557
+ expression = node.init;
558
+ } else if (node.type === "AssignmentExpression") {
559
+ pattern = node.left;
560
+ expression = node.right;
561
+ } else {
562
+ // UpdateExpression
563
+ pattern = node.argument;
564
+ }
565
+
566
+ for (const identifier of extractIdentifiersFromPattern(
567
+ pattern,
568
+ )) {
569
+ const scope = sourceCode.getScope(identifier);
570
+
571
+ /** @type {Variable} */
572
+ const variable = findVariable(scope, identifier);
573
+
574
+ if (!variable) {
575
+ continue;
576
+ }
577
+
578
+ // We don't know where global variables are used.
579
+ if (
580
+ variable.scope.type === "global" &&
581
+ variable.defs.length === 0
582
+ ) {
583
+ continue;
584
+ }
585
+
586
+ /*
587
+ * If the scope of the variable is outside the current code path scope,
588
+ * we cannot track whether this assignment is not used.
589
+ */
590
+ if (
591
+ scopeStack.scope !==
592
+ getCodePathStartScope(variable.scope)
593
+ ) {
594
+ continue;
595
+ }
596
+
597
+ // Variables marked by `markVariableAsUsed()` or
598
+ // exported by "exported" block comment.
599
+ if (variable.eslintUsed) {
600
+ continue;
601
+ }
602
+
603
+ // Variables exported by ESM export syntax
604
+ if (variable.scope.type === "module") {
605
+ if (
606
+ variable.defs.some(
607
+ def =>
608
+ (def.type === "Variable" &&
609
+ def.parent.parent.type ===
610
+ "ExportNamedDeclaration") ||
611
+ (def.type === "FunctionName" &&
612
+ (def.node.parent.type ===
613
+ "ExportNamedDeclaration" ||
614
+ def.node.parent.type ===
615
+ "ExportDefaultDeclaration")) ||
616
+ (def.type === "ClassName" &&
617
+ (def.node.parent.type ===
618
+ "ExportNamedDeclaration" ||
619
+ def.node.parent.type ===
620
+ "ExportDefaultDeclaration")),
621
+ )
622
+ ) {
623
+ continue;
624
+ }
625
+ if (
626
+ variable.references.some(
627
+ reference =>
628
+ reference.identifier.parent.type ===
629
+ "ExportSpecifier",
630
+ )
631
+ ) {
632
+ // It have `export { ... }` reference.
633
+ continue;
634
+ }
635
+ }
636
+
637
+ let list = assignments.get(variable);
638
+
639
+ if (!list) {
640
+ list = [];
641
+ assignments.set(variable, list);
642
+ }
643
+ list.push({
644
+ variable,
645
+ identifier,
646
+ node,
647
+ expression,
648
+ segments: [...scopeStack.currentSegments],
649
+ });
650
+ }
651
+ },
652
+ };
653
+ },
575
654
  };