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
@@ -16,9 +16,12 @@ const astUtils = require("./utils/ast-utils");
16
16
  // Helpers
17
17
  //------------------------------------------------------------------------------
18
18
 
19
- const PATTERN_TYPE = /^(?:.+?Pattern|RestElement|SpreadProperty|ExperimentalRestProperty|Property)$/u;
20
- const DECLARATION_HOST_TYPE = /^(?:Program|BlockStatement|StaticBlock|SwitchCase)$/u;
21
- const DESTRUCTURING_HOST_TYPE = /^(?:VariableDeclarator|AssignmentExpression)$/u;
19
+ const PATTERN_TYPE =
20
+ /^(?:.+?Pattern|RestElement|SpreadProperty|ExperimentalRestProperty|Property)$/u;
21
+ const DECLARATION_HOST_TYPE =
22
+ /^(?:Program|BlockStatement|StaticBlock|SwitchCase)$/u;
23
+ const DESTRUCTURING_HOST_TYPE =
24
+ /^(?:VariableDeclarator|AssignmentExpression)$/u;
22
25
 
23
26
  /**
24
27
  * Checks whether a given node is located at `ForStatement.init` or not.
@@ -26,7 +29,7 @@ const DESTRUCTURING_HOST_TYPE = /^(?:VariableDeclarator|AssignmentExpression)$/u
26
29
  * @returns {boolean} `true` if the node is located at `ForStatement.init`.
27
30
  */
28
31
  function isInitOfForStatement(node) {
29
- return node.parent.type === "ForStatement" && node.parent.init === node;
32
+ return node.parent.type === "ForStatement" && node.parent.init === node;
30
33
  }
31
34
 
32
35
  /**
@@ -35,20 +38,18 @@ function isInitOfForStatement(node) {
35
38
  * @returns {boolean} `true` if the node can become a VariableDeclaration.
36
39
  */
37
40
  function canBecomeVariableDeclaration(identifier) {
38
- let node = identifier.parent;
39
-
40
- while (PATTERN_TYPE.test(node.type)) {
41
- node = node.parent;
42
- }
43
-
44
- return (
45
- node.type === "VariableDeclarator" ||
46
- (
47
- node.type === "AssignmentExpression" &&
48
- node.parent.type === "ExpressionStatement" &&
49
- DECLARATION_HOST_TYPE.test(node.parent.parent.type)
50
- )
51
- );
41
+ let node = identifier.parent;
42
+
43
+ while (PATTERN_TYPE.test(node.type)) {
44
+ node = node.parent;
45
+ }
46
+
47
+ return (
48
+ node.type === "VariableDeclarator" ||
49
+ (node.type === "AssignmentExpression" &&
50
+ node.parent.type === "ExpressionStatement" &&
51
+ DECLARATION_HOST_TYPE.test(node.parent.parent.type))
52
+ );
52
53
  }
53
54
 
54
55
  /**
@@ -59,18 +60,21 @@ function canBecomeVariableDeclaration(identifier) {
59
60
  * @returns {boolean} Indicates if the variable is from outer scope or function parameters.
60
61
  */
61
62
  function isOuterVariableInDestructing(name, initScope) {
63
+ if (
64
+ initScope.through.some(
65
+ ref => ref.resolved && ref.resolved.name === name,
66
+ )
67
+ ) {
68
+ return true;
69
+ }
62
70
 
63
- if (initScope.through.some(ref => ref.resolved && ref.resolved.name === name)) {
64
- return true;
65
- }
71
+ const variable = astUtils.getVariableByName(initScope, name);
66
72
 
67
- const variable = astUtils.getVariableByName(initScope, name);
73
+ if (variable !== null) {
74
+ return variable.defs.some(def => def.type === "Parameter");
75
+ }
68
76
 
69
- if (variable !== null) {
70
- return variable.defs.some(def => def.type === "Parameter");
71
- }
72
-
73
- return false;
77
+ return false;
74
78
  }
75
79
 
76
80
  /**
@@ -83,19 +87,19 @@ function isOuterVariableInDestructing(name, initScope) {
83
87
  * null.
84
88
  */
85
89
  function getDestructuringHost(reference) {
86
- if (!reference.isWrite()) {
87
- return null;
88
- }
89
- let node = reference.identifier.parent;
90
-
91
- while (PATTERN_TYPE.test(node.type)) {
92
- node = node.parent;
93
- }
94
-
95
- if (!DESTRUCTURING_HOST_TYPE.test(node.type)) {
96
- return null;
97
- }
98
- return node;
90
+ if (!reference.isWrite()) {
91
+ return null;
92
+ }
93
+ let node = reference.identifier.parent;
94
+
95
+ while (PATTERN_TYPE.test(node.type)) {
96
+ node = node.parent;
97
+ }
98
+
99
+ if (!DESTRUCTURING_HOST_TYPE.test(node.type)) {
100
+ return null;
101
+ }
102
+ return node;
99
103
  }
100
104
 
101
105
  /**
@@ -108,42 +112,43 @@ function getDestructuringHost(reference) {
108
112
  * a MemberExpression, false if not.
109
113
  */
110
114
  function hasMemberExpressionAssignment(node) {
111
- switch (node.type) {
112
- case "ObjectPattern":
113
- return node.properties.some(prop => {
114
- if (prop) {
115
-
116
- /*
117
- * Spread elements have an argument property while
118
- * others have a value property. Because different
119
- * parsers use different node types for spread elements,
120
- * we just check if there is an argument property.
121
- */
122
- return hasMemberExpressionAssignment(prop.argument || prop.value);
123
- }
124
-
125
- return false;
126
- });
127
-
128
- case "ArrayPattern":
129
- return node.elements.some(element => {
130
- if (element) {
131
- return hasMemberExpressionAssignment(element);
132
- }
133
-
134
- return false;
135
- });
136
-
137
- case "AssignmentPattern":
138
- return hasMemberExpressionAssignment(node.left);
139
-
140
- case "MemberExpression":
141
- return true;
142
-
143
- // no default
144
- }
145
-
146
- return false;
115
+ switch (node.type) {
116
+ case "ObjectPattern":
117
+ return node.properties.some(prop => {
118
+ if (prop) {
119
+ /*
120
+ * Spread elements have an argument property while
121
+ * others have a value property. Because different
122
+ * parsers use different node types for spread elements,
123
+ * we just check if there is an argument property.
124
+ */
125
+ return hasMemberExpressionAssignment(
126
+ prop.argument || prop.value,
127
+ );
128
+ }
129
+
130
+ return false;
131
+ });
132
+
133
+ case "ArrayPattern":
134
+ return node.elements.some(element => {
135
+ if (element) {
136
+ return hasMemberExpressionAssignment(element);
137
+ }
138
+
139
+ return false;
140
+ });
141
+
142
+ case "AssignmentPattern":
143
+ return hasMemberExpressionAssignment(node.left);
144
+
145
+ case "MemberExpression":
146
+ return true;
147
+
148
+ // no default
149
+ }
150
+
151
+ return false;
147
152
  }
148
153
 
149
154
  /**
@@ -171,90 +176,91 @@ function hasMemberExpressionAssignment(node) {
171
176
  * Otherwise, null.
172
177
  */
173
178
  function getIdentifierIfShouldBeConst(variable, ignoreReadBeforeAssign) {
174
- if (variable.eslintUsed && variable.scope.type === "global") {
175
- return null;
176
- }
177
-
178
- // Finds the unique WriteReference.
179
- let writer = null;
180
- let isReadBeforeInit = false;
181
- const references = variable.references;
182
-
183
- for (let i = 0; i < references.length; ++i) {
184
- const reference = references[i];
185
-
186
- if (reference.isWrite()) {
187
- const isReassigned = (
188
- writer !== null &&
189
- writer.identifier !== reference.identifier
190
- );
191
-
192
- if (isReassigned) {
193
- return null;
194
- }
195
-
196
- const destructuringHost = getDestructuringHost(reference);
197
-
198
- if (destructuringHost !== null && destructuringHost.left !== void 0) {
199
- const leftNode = destructuringHost.left;
200
- let hasOuterVariables = false,
201
- hasNonIdentifiers = false;
202
-
203
- if (leftNode.type === "ObjectPattern") {
204
- const properties = leftNode.properties;
205
-
206
- hasOuterVariables = properties
207
- .filter(prop => prop.value)
208
- .map(prop => prop.value.name)
209
- .some(name => isOuterVariableInDestructing(name, variable.scope));
210
-
211
- hasNonIdentifiers = hasMemberExpressionAssignment(leftNode);
212
-
213
- } else if (leftNode.type === "ArrayPattern") {
214
- const elements = leftNode.elements;
215
-
216
- hasOuterVariables = elements
217
- .map(element => element && element.name)
218
- .some(name => isOuterVariableInDestructing(name, variable.scope));
219
-
220
- hasNonIdentifiers = hasMemberExpressionAssignment(leftNode);
221
- }
222
-
223
- if (hasOuterVariables || hasNonIdentifiers) {
224
- return null;
225
- }
226
-
227
- }
228
-
229
- writer = reference;
230
-
231
- } else if (reference.isRead() && writer === null) {
232
- if (ignoreReadBeforeAssign) {
233
- return null;
234
- }
235
- isReadBeforeInit = true;
236
- }
237
- }
238
-
239
- /*
240
- * If the assignment is from a different scope, ignore it.
241
- * If the assignment cannot change to a declaration, ignore it.
242
- */
243
- const shouldBeConst = (
244
- writer !== null &&
245
- writer.from === variable.scope &&
246
- canBecomeVariableDeclaration(writer.identifier)
247
- );
248
-
249
- if (!shouldBeConst) {
250
- return null;
251
- }
252
-
253
- if (isReadBeforeInit) {
254
- return variable.defs[0].name;
255
- }
256
-
257
- return writer.identifier;
179
+ if (variable.eslintUsed && variable.scope.type === "global") {
180
+ return null;
181
+ }
182
+
183
+ // Finds the unique WriteReference.
184
+ let writer = null;
185
+ let isReadBeforeInit = false;
186
+ const references = variable.references;
187
+
188
+ for (let i = 0; i < references.length; ++i) {
189
+ const reference = references[i];
190
+
191
+ if (reference.isWrite()) {
192
+ const isReassigned =
193
+ writer !== null && writer.identifier !== reference.identifier;
194
+
195
+ if (isReassigned) {
196
+ return null;
197
+ }
198
+
199
+ const destructuringHost = getDestructuringHost(reference);
200
+
201
+ if (
202
+ destructuringHost !== null &&
203
+ destructuringHost.left !== void 0
204
+ ) {
205
+ const leftNode = destructuringHost.left;
206
+ let hasOuterVariables = false,
207
+ hasNonIdentifiers = false;
208
+
209
+ if (leftNode.type === "ObjectPattern") {
210
+ const properties = leftNode.properties;
211
+
212
+ hasOuterVariables = properties
213
+ .filter(prop => prop.value)
214
+ .map(prop => prop.value.name)
215
+ .some(name =>
216
+ isOuterVariableInDestructing(name, variable.scope),
217
+ );
218
+
219
+ hasNonIdentifiers = hasMemberExpressionAssignment(leftNode);
220
+ } else if (leftNode.type === "ArrayPattern") {
221
+ const elements = leftNode.elements;
222
+
223
+ hasOuterVariables = elements
224
+ .map(element => element && element.name)
225
+ .some(name =>
226
+ isOuterVariableInDestructing(name, variable.scope),
227
+ );
228
+
229
+ hasNonIdentifiers = hasMemberExpressionAssignment(leftNode);
230
+ }
231
+
232
+ if (hasOuterVariables || hasNonIdentifiers) {
233
+ return null;
234
+ }
235
+ }
236
+
237
+ writer = reference;
238
+ } else if (reference.isRead() && writer === null) {
239
+ if (ignoreReadBeforeAssign) {
240
+ return null;
241
+ }
242
+ isReadBeforeInit = true;
243
+ }
244
+ }
245
+
246
+ /*
247
+ * If the assignment is from a different scope, ignore it.
248
+ * If the assignment cannot change to a declaration, ignore it.
249
+ */
250
+ const shouldBeConst =
251
+ writer !== null &&
252
+ writer.from === variable.scope &&
253
+ canBecomeVariableDeclaration(writer.identifier);
254
+
255
+ if (!shouldBeConst) {
256
+ return null;
257
+ }
258
+
259
+ if (isReadBeforeInit) {
260
+ return variable.defs[0].name;
261
+ }
262
+
263
+ return writer.identifier;
258
264
  }
259
265
 
260
266
  /**
@@ -268,41 +274,44 @@ function getIdentifierIfShouldBeConst(variable, ignoreReadBeforeAssign) {
268
274
  * @returns {Map<ASTNode, ASTNode[]>} Grouped identifier nodes.
269
275
  */
270
276
  function groupByDestructuring(variables, ignoreReadBeforeAssign) {
271
- const identifierMap = new Map();
272
-
273
- for (let i = 0; i < variables.length; ++i) {
274
- const variable = variables[i];
275
- const references = variable.references;
276
- const identifier = getIdentifierIfShouldBeConst(variable, ignoreReadBeforeAssign);
277
- let prevId = null;
278
-
279
- for (let j = 0; j < references.length; ++j) {
280
- const reference = references[j];
281
- const id = reference.identifier;
282
-
283
- /*
284
- * Avoid counting a reference twice or more for default values of
285
- * destructuring.
286
- */
287
- if (id === prevId) {
288
- continue;
289
- }
290
- prevId = id;
291
-
292
- // Add the identifier node into the destructuring group.
293
- const group = getDestructuringHost(reference);
294
-
295
- if (group) {
296
- if (identifierMap.has(group)) {
297
- identifierMap.get(group).push(identifier);
298
- } else {
299
- identifierMap.set(group, [identifier]);
300
- }
301
- }
302
- }
303
- }
304
-
305
- return identifierMap;
277
+ const identifierMap = new Map();
278
+
279
+ for (let i = 0; i < variables.length; ++i) {
280
+ const variable = variables[i];
281
+ const references = variable.references;
282
+ const identifier = getIdentifierIfShouldBeConst(
283
+ variable,
284
+ ignoreReadBeforeAssign,
285
+ );
286
+ let prevId = null;
287
+
288
+ for (let j = 0; j < references.length; ++j) {
289
+ const reference = references[j];
290
+ const id = reference.identifier;
291
+
292
+ /*
293
+ * Avoid counting a reference twice or more for default values of
294
+ * destructuring.
295
+ */
296
+ if (id === prevId) {
297
+ continue;
298
+ }
299
+ prevId = id;
300
+
301
+ // Add the identifier node into the destructuring group.
302
+ const group = getDestructuringHost(reference);
303
+
304
+ if (group) {
305
+ if (identifierMap.has(group)) {
306
+ identifierMap.get(group).push(identifier);
307
+ } else {
308
+ identifierMap.set(group, [identifier]);
309
+ }
310
+ }
311
+ }
312
+ }
313
+
314
+ return identifierMap;
306
315
  }
307
316
 
308
317
  /**
@@ -313,193 +322,225 @@ function groupByDestructuring(variables, ignoreReadBeforeAssign) {
313
322
  * @returns {ASTNode} The closest ancestor with the specified type; null if no such ancestor exists.
314
323
  */
315
324
  function findUp(node, type, shouldStop) {
316
- if (!node || shouldStop(node)) {
317
- return null;
318
- }
319
- if (node.type === type) {
320
- return node;
321
- }
322
- return findUp(node.parent, type, shouldStop);
325
+ if (!node || shouldStop(node)) {
326
+ return null;
327
+ }
328
+ if (node.type === type) {
329
+ return node;
330
+ }
331
+ return findUp(node.parent, type, shouldStop);
323
332
  }
324
333
 
325
334
  //------------------------------------------------------------------------------
326
335
  // Rule Definition
327
336
  //------------------------------------------------------------------------------
328
337
 
329
- /** @type {import('../shared/types').Rule} */
338
+ /** @type {import('../types').Rule.RuleModule} */
330
339
  module.exports = {
331
- meta: {
332
- type: "suggestion",
333
-
334
- defaultOptions: [{
335
- destructuring: "any",
336
- ignoreReadBeforeAssign: false
337
- }],
338
-
339
- docs: {
340
- description: "Require `const` declarations for variables that are never reassigned after declared",
341
- recommended: false,
342
- url: "https://eslint.org/docs/latest/rules/prefer-const"
343
- },
344
-
345
- fixable: "code",
346
-
347
- schema: [
348
- {
349
- type: "object",
350
- properties: {
351
- destructuring: { enum: ["any", "all"] },
352
- ignoreReadBeforeAssign: { type: "boolean" }
353
- },
354
- additionalProperties: false
355
- }
356
- ],
357
- messages: {
358
- useConst: "'{{name}}' is never reassigned. Use 'const' instead."
359
- }
360
- },
361
-
362
- create(context) {
363
- const [{ destructuring, ignoreReadBeforeAssign }] = context.options;
364
- const shouldMatchAnyDestructuredVariable = destructuring !== "all";
365
- const sourceCode = context.sourceCode;
366
- const variables = [];
367
- let reportCount = 0;
368
- let checkedId = null;
369
- let checkedName = "";
370
-
371
-
372
- /**
373
- * Reports given identifier nodes if all of the nodes should be declared
374
- * as const.
375
- *
376
- * The argument 'nodes' is an array of Identifier nodes.
377
- * This node is the result of 'getIdentifierIfShouldBeConst()', so it's
378
- * nullable. In simple declaration or assignment cases, the length of
379
- * the array is 1. In destructuring cases, the length of the array can
380
- * be 2 or more.
381
- * @param {(eslint-scope.Reference|null)[]} nodes
382
- * References which are grouped by destructuring to report.
383
- * @returns {void}
384
- */
385
- function checkGroup(nodes) {
386
- const nodesToReport = nodes.filter(Boolean);
387
-
388
- if (nodes.length && (shouldMatchAnyDestructuredVariable || nodesToReport.length === nodes.length)) {
389
- const varDeclParent = findUp(nodes[0], "VariableDeclaration", parentNode => parentNode.type.endsWith("Statement"));
390
- const isVarDecParentNull = varDeclParent === null;
391
-
392
- if (!isVarDecParentNull && varDeclParent.declarations.length > 0) {
393
- const firstDeclaration = varDeclParent.declarations[0];
394
-
395
- if (firstDeclaration.init) {
396
- const firstDecParent = firstDeclaration.init.parent;
397
-
398
- /*
399
- * First we check the declaration type and then depending on
400
- * if the type is a "VariableDeclarator" or its an "ObjectPattern"
401
- * we compare the name and id from the first identifier, if the names are different
402
- * we assign the new name, id and reset the count of reportCount and nodeCount in
403
- * order to check each block for the number of reported errors and base our fix
404
- * based on comparing nodes.length and nodesToReport.length.
405
- */
406
-
407
- if (firstDecParent.type === "VariableDeclarator") {
408
-
409
- if (firstDecParent.id.name !== checkedName) {
410
- checkedName = firstDecParent.id.name;
411
- reportCount = 0;
412
- }
413
-
414
- if (firstDecParent.id.type === "ObjectPattern") {
415
- if (firstDecParent.init.name !== checkedName) {
416
- checkedName = firstDecParent.init.name;
417
- reportCount = 0;
418
- }
419
- }
420
-
421
- if (firstDecParent.id !== checkedId) {
422
- checkedId = firstDecParent.id;
423
- reportCount = 0;
424
- }
425
- }
426
- }
427
- }
428
-
429
- let shouldFix = varDeclParent &&
430
-
431
- // Don't do a fix unless all variables in the declarations are initialized (or it's in a for-in or for-of loop)
432
- (varDeclParent.parent.type === "ForInStatement" || varDeclParent.parent.type === "ForOfStatement" ||
433
- varDeclParent.declarations.every(declaration => declaration.init)) &&
434
-
435
- /*
436
- * If options.destructuring is "all", then this warning will not occur unless
437
- * every assignment in the destructuring should be const. In that case, it's safe
438
- * to apply the fix.
439
- */
440
- nodesToReport.length === nodes.length;
441
-
442
- if (!isVarDecParentNull && varDeclParent.declarations && varDeclParent.declarations.length !== 1) {
443
-
444
- if (varDeclParent && varDeclParent.declarations && varDeclParent.declarations.length >= 1) {
445
-
446
- /*
447
- * Add nodesToReport.length to a count, then comparing the count to the length
448
- * of the declarations in the current block.
449
- */
450
-
451
- reportCount += nodesToReport.length;
452
-
453
- let totalDeclarationsCount = 0;
454
-
455
- varDeclParent.declarations.forEach(declaration => {
456
- if (declaration.id.type === "ObjectPattern") {
457
- totalDeclarationsCount += declaration.id.properties.length;
458
- } else if (declaration.id.type === "ArrayPattern") {
459
- totalDeclarationsCount += declaration.id.elements.length;
460
- } else {
461
- totalDeclarationsCount += 1;
462
- }
463
- });
464
-
465
- shouldFix = shouldFix && (reportCount === totalDeclarationsCount);
466
- }
467
- }
468
-
469
- nodesToReport.forEach(node => {
470
- context.report({
471
- node,
472
- messageId: "useConst",
473
- data: node,
474
- fix: shouldFix
475
- ? fixer => {
476
- const letKeywordToken = sourceCode.getFirstToken(varDeclParent, t => t.value === varDeclParent.kind);
477
-
478
- /**
479
- * Extend the replacement range to the whole declaration,
480
- * in order to prevent other fixes in the same pass
481
- * https://github.com/eslint/eslint/issues/13899
482
- */
483
- return new FixTracker(fixer, sourceCode)
484
- .retainRange(varDeclParent.range)
485
- .replaceTextRange(letKeywordToken.range, "const");
486
- }
487
- : null
488
- });
489
- });
490
- }
491
- }
492
-
493
- return {
494
- "Program:exit"() {
495
- groupByDestructuring(variables, ignoreReadBeforeAssign).forEach(checkGroup);
496
- },
497
-
498
- VariableDeclaration(node) {
499
- if (node.kind === "let" && !isInitOfForStatement(node)) {
500
- variables.push(...sourceCode.getDeclaredVariables(node));
501
- }
502
- }
503
- };
504
- }
340
+ meta: {
341
+ type: "suggestion",
342
+
343
+ defaultOptions: [
344
+ {
345
+ destructuring: "any",
346
+ ignoreReadBeforeAssign: false,
347
+ },
348
+ ],
349
+
350
+ docs: {
351
+ description:
352
+ "Require `const` declarations for variables that are never reassigned after declared",
353
+ recommended: false,
354
+ url: "https://eslint.org/docs/latest/rules/prefer-const",
355
+ },
356
+
357
+ fixable: "code",
358
+
359
+ schema: [
360
+ {
361
+ type: "object",
362
+ properties: {
363
+ destructuring: { enum: ["any", "all"] },
364
+ ignoreReadBeforeAssign: { type: "boolean" },
365
+ },
366
+ additionalProperties: false,
367
+ },
368
+ ],
369
+ messages: {
370
+ useConst: "'{{name}}' is never reassigned. Use 'const' instead.",
371
+ },
372
+ },
373
+
374
+ create(context) {
375
+ const [{ destructuring, ignoreReadBeforeAssign }] = context.options;
376
+ const shouldMatchAnyDestructuredVariable = destructuring !== "all";
377
+ const sourceCode = context.sourceCode;
378
+ const variables = [];
379
+ let reportCount = 0;
380
+ let checkedId = null;
381
+ let checkedName = "";
382
+
383
+ /**
384
+ * Reports given identifier nodes if all of the nodes should be declared
385
+ * as const.
386
+ *
387
+ * The argument 'nodes' is an array of Identifier nodes.
388
+ * This node is the result of 'getIdentifierIfShouldBeConst()', so it's
389
+ * nullable. In simple declaration or assignment cases, the length of
390
+ * the array is 1. In destructuring cases, the length of the array can
391
+ * be 2 or more.
392
+ * @param {(eslint-scope.Reference|null)[]} nodes
393
+ * References which are grouped by destructuring to report.
394
+ * @returns {void}
395
+ */
396
+ function checkGroup(nodes) {
397
+ const nodesToReport = nodes.filter(Boolean);
398
+
399
+ if (
400
+ nodes.length &&
401
+ (shouldMatchAnyDestructuredVariable ||
402
+ nodesToReport.length === nodes.length)
403
+ ) {
404
+ const varDeclParent = findUp(
405
+ nodes[0],
406
+ "VariableDeclaration",
407
+ parentNode => parentNode.type.endsWith("Statement"),
408
+ );
409
+ const isVarDecParentNull = varDeclParent === null;
410
+
411
+ if (
412
+ !isVarDecParentNull &&
413
+ varDeclParent.declarations.length > 0
414
+ ) {
415
+ const firstDeclaration = varDeclParent.declarations[0];
416
+
417
+ if (firstDeclaration.init) {
418
+ const firstDecParent = firstDeclaration.init.parent;
419
+
420
+ /*
421
+ * First we check the declaration type and then depending on
422
+ * if the type is a "VariableDeclarator" or its an "ObjectPattern"
423
+ * we compare the name and id from the first identifier, if the names are different
424
+ * we assign the new name, id and reset the count of reportCount and nodeCount in
425
+ * order to check each block for the number of reported errors and base our fix
426
+ * based on comparing nodes.length and nodesToReport.length.
427
+ */
428
+
429
+ if (firstDecParent.type === "VariableDeclarator") {
430
+ if (firstDecParent.id.name !== checkedName) {
431
+ checkedName = firstDecParent.id.name;
432
+ reportCount = 0;
433
+ }
434
+
435
+ if (firstDecParent.id.type === "ObjectPattern") {
436
+ if (firstDecParent.init.name !== checkedName) {
437
+ checkedName = firstDecParent.init.name;
438
+ reportCount = 0;
439
+ }
440
+ }
441
+
442
+ if (firstDecParent.id !== checkedId) {
443
+ checkedId = firstDecParent.id;
444
+ reportCount = 0;
445
+ }
446
+ }
447
+ }
448
+ }
449
+
450
+ let shouldFix =
451
+ varDeclParent &&
452
+ // Don't do a fix unless all variables in the declarations are initialized (or it's in a for-in or for-of loop)
453
+ (varDeclParent.parent.type === "ForInStatement" ||
454
+ varDeclParent.parent.type === "ForOfStatement" ||
455
+ varDeclParent.declarations.every(
456
+ declaration => declaration.init,
457
+ )) &&
458
+ /*
459
+ * If options.destructuring is "all", then this warning will not occur unless
460
+ * every assignment in the destructuring should be const. In that case, it's safe
461
+ * to apply the fix.
462
+ */
463
+ nodesToReport.length === nodes.length;
464
+
465
+ if (
466
+ !isVarDecParentNull &&
467
+ varDeclParent.declarations &&
468
+ varDeclParent.declarations.length !== 1
469
+ ) {
470
+ if (
471
+ varDeclParent &&
472
+ varDeclParent.declarations &&
473
+ varDeclParent.declarations.length >= 1
474
+ ) {
475
+ /*
476
+ * Add nodesToReport.length to a count, then comparing the count to the length
477
+ * of the declarations in the current block.
478
+ */
479
+
480
+ reportCount += nodesToReport.length;
481
+
482
+ let totalDeclarationsCount = 0;
483
+
484
+ varDeclParent.declarations.forEach(declaration => {
485
+ if (declaration.id.type === "ObjectPattern") {
486
+ totalDeclarationsCount +=
487
+ declaration.id.properties.length;
488
+ } else if (declaration.id.type === "ArrayPattern") {
489
+ totalDeclarationsCount +=
490
+ declaration.id.elements.length;
491
+ } else {
492
+ totalDeclarationsCount += 1;
493
+ }
494
+ });
495
+
496
+ shouldFix =
497
+ shouldFix && reportCount === totalDeclarationsCount;
498
+ }
499
+ }
500
+
501
+ nodesToReport.forEach(node => {
502
+ context.report({
503
+ node,
504
+ messageId: "useConst",
505
+ data: node,
506
+ fix: shouldFix
507
+ ? fixer => {
508
+ const letKeywordToken =
509
+ sourceCode.getFirstToken(
510
+ varDeclParent,
511
+ t => t.value === varDeclParent.kind,
512
+ );
513
+
514
+ /**
515
+ * Extend the replacement range to the whole declaration,
516
+ * in order to prevent other fixes in the same pass
517
+ * https://github.com/eslint/eslint/issues/13899
518
+ */
519
+ return new FixTracker(fixer, sourceCode)
520
+ .retainRange(varDeclParent.range)
521
+ .replaceTextRange(
522
+ letKeywordToken.range,
523
+ "const",
524
+ );
525
+ }
526
+ : null,
527
+ });
528
+ });
529
+ }
530
+ }
531
+
532
+ return {
533
+ "Program:exit"() {
534
+ groupByDestructuring(variables, ignoreReadBeforeAssign).forEach(
535
+ checkGroup,
536
+ );
537
+ },
538
+
539
+ VariableDeclaration(node) {
540
+ if (node.kind === "let" && !isInitOfForStatement(node)) {
541
+ variables.push(...sourceCode.getDeclaredVariables(node));
542
+ }
543
+ },
544
+ };
545
+ },
505
546
  };