eslint 8.57.1 → 9.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (458) hide show
  1. package/README.md +165 -115
  2. package/bin/eslint.js +112 -89
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +16 -0
  5. package/conf/globals.js +109 -94
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +89 -26
  8. package/lib/api.js +16 -20
  9. package/lib/cli-engine/cli-engine.js +841 -810
  10. package/lib/cli-engine/file-enumerator.js +384 -390
  11. package/lib/cli-engine/formatters/formatters-meta.json +17 -45
  12. package/lib/cli-engine/formatters/html.js +110 -102
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +97 -76
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +165 -148
  19. package/lib/cli-engine/load-rules.js +17 -17
  20. package/lib/cli.js +481 -399
  21. package/lib/config/config-loader.js +816 -0
  22. package/lib/config/config.js +674 -0
  23. package/lib/config/default-config.js +57 -46
  24. package/lib/config/flat-config-array.js +170 -333
  25. package/lib/config/flat-config-schema.js +389 -389
  26. package/lib/config-api.js +12 -0
  27. package/lib/eslint/eslint-helpers.js +1196 -663
  28. package/lib/eslint/eslint.js +1262 -607
  29. package/lib/eslint/index.js +3 -3
  30. package/lib/eslint/legacy-eslint.js +786 -0
  31. package/lib/eslint/worker.js +173 -0
  32. package/lib/languages/js/index.js +336 -0
  33. package/lib/languages/js/source-code/index.js +7 -0
  34. package/lib/languages/js/source-code/source-code.js +1364 -0
  35. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +61 -0
  36. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +57 -0
  37. package/lib/{source-code → languages/js/source-code}/token-store/cursor.js +36 -36
  38. package/lib/languages/js/source-code/token-store/cursors.js +120 -0
  39. package/lib/{source-code → languages/js/source-code}/token-store/decorative-cursor.js +17 -18
  40. package/lib/{source-code → languages/js/source-code}/token-store/filter-cursor.js +19 -20
  41. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +65 -0
  42. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +62 -0
  43. package/lib/languages/js/source-code/token-store/index.js +721 -0
  44. package/lib/{source-code → languages/js/source-code}/token-store/limit-cursor.js +17 -18
  45. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +45 -0
  46. package/lib/{source-code → languages/js/source-code}/token-store/skip-cursor.js +19 -20
  47. package/lib/languages/js/source-code/token-store/utils.js +110 -0
  48. package/lib/languages/js/validate-language-options.js +196 -0
  49. package/lib/linter/apply-disable-directives.js +490 -371
  50. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -674
  51. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  52. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  53. package/lib/linter/code-path-analysis/code-path.js +307 -317
  54. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  55. package/lib/linter/code-path-analysis/fork-context.js +297 -272
  56. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  57. package/lib/linter/esquery.js +332 -0
  58. package/lib/linter/file-context.js +144 -0
  59. package/lib/linter/file-report.js +608 -0
  60. package/lib/linter/index.js +3 -5
  61. package/lib/linter/interpolate.js +38 -16
  62. package/lib/linter/linter.js +2328 -1785
  63. package/lib/linter/rule-fixer.js +136 -107
  64. package/lib/linter/rules.js +37 -46
  65. package/lib/linter/source-code-fixer.js +96 -94
  66. package/lib/linter/source-code-traverser.js +333 -0
  67. package/lib/linter/source-code-visitor.js +81 -0
  68. package/lib/linter/timing.js +145 -97
  69. package/lib/linter/vfile.js +115 -0
  70. package/lib/options.js +464 -326
  71. package/lib/rule-tester/index.js +3 -1
  72. package/lib/rule-tester/rule-tester.js +1371 -998
  73. package/lib/rules/accessor-pairs.js +333 -259
  74. package/lib/rules/array-bracket-newline.js +250 -220
  75. package/lib/rules/array-bracket-spacing.js +286 -229
  76. package/lib/rules/array-callback-return.js +401 -354
  77. package/lib/rules/array-element-newline.js +358 -295
  78. package/lib/rules/arrow-body-style.js +400 -278
  79. package/lib/rules/arrow-parens.js +206 -155
  80. package/lib/rules/arrow-spacing.js +169 -145
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -158
  83. package/lib/rules/brace-style.js +262 -181
  84. package/lib/rules/callback-return.js +203 -174
  85. package/lib/rules/camelcase.js +403 -380
  86. package/lib/rules/capitalized-comments.js +253 -228
  87. package/lib/rules/class-methods-use-this.js +231 -168
  88. package/lib/rules/comma-dangle.js +379 -328
  89. package/lib/rules/comma-spacing.js +193 -177
  90. package/lib/rules/comma-style.js +375 -298
  91. package/lib/rules/complexity.js +180 -144
  92. package/lib/rules/computed-property-spacing.js +236 -193
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -141
  95. package/lib/rules/constructor-super.js +418 -411
  96. package/lib/rules/curly.js +407 -468
  97. package/lib/rules/default-case-last.js +39 -32
  98. package/lib/rules/default-case.js +89 -83
  99. package/lib/rules/default-param-last.js +69 -53
  100. package/lib/rules/dot-location.js +122 -92
  101. package/lib/rules/dot-notation.js +193 -153
  102. package/lib/rules/eol-last.js +122 -102
  103. package/lib/rules/eqeqeq.js +191 -155
  104. package/lib/rules/for-direction.js +150 -122
  105. package/lib/rules/func-call-spacing.js +261 -213
  106. package/lib/rules/func-name-matching.js +294 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +209 -86
  109. package/lib/rules/function-call-argument-newline.js +152 -111
  110. package/lib/rules/function-paren-newline.js +349 -273
  111. package/lib/rules/generator-star-spacing.js +229 -192
  112. package/lib/rules/getter-return.js +208 -170
  113. package/lib/rules/global-require.js +85 -58
  114. package/lib/rules/grouped-accessor-pairs.js +201 -148
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -87
  117. package/lib/rules/id-blacklist.js +182 -187
  118. package/lib/rules/id-denylist.js +174 -179
  119. package/lib/rules/id-length.js +197 -157
  120. package/lib/rules/id-match.js +350 -286
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -61
  122. package/lib/rules/indent-legacy.js +1345 -1102
  123. package/lib/rules/indent.js +2272 -1741
  124. package/lib/rules/index.js +320 -294
  125. package/lib/rules/init-declarations.js +139 -106
  126. package/lib/rules/jsx-quotes.js +94 -64
  127. package/lib/rules/key-spacing.js +750 -615
  128. package/lib/rules/keyword-spacing.js +648 -587
  129. package/lib/rules/line-comment-position.js +143 -108
  130. package/lib/rules/linebreak-style.js +115 -88
  131. package/lib/rules/lines-around-comment.js +540 -430
  132. package/lib/rules/lines-around-directive.js +233 -185
  133. package/lib/rules/lines-between-class-members.js +305 -216
  134. package/lib/rules/logical-assignment-operators.js +582 -398
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -416
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +102 -75
  142. package/lib/rules/max-statements-per-line.js +205 -180
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +638 -460
  145. package/lib/rules/multiline-ternary.js +241 -158
  146. package/lib/rules/new-cap.js +233 -232
  147. package/lib/rules/new-parens.js +88 -61
  148. package/lib/rules/newline-after-var.js +287 -233
  149. package/lib/rules/newline-before-return.js +229 -204
  150. package/lib/rules/newline-per-chained-call.js +142 -109
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +175 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +79 -70
  155. package/lib/rules/no-bitwise.js +113 -87
  156. package/lib/rules/no-buffer-constructor.js +61 -37
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -45
  159. package/lib/rules/no-catch-shadow.js +76 -62
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -63
  164. package/lib/rules/no-console.js +202 -188
  165. package/lib/rules/no-const-assign.js +58 -41
  166. package/lib/rules/no-constant-binary-expression.js +501 -407
  167. package/lib/rules/no-constant-condition.js +158 -131
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -26
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -40
  174. package/lib/rules/no-dupe-args.js +79 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +266 -188
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +197 -128
  183. package/lib/rules/no-empty-pattern.js +63 -56
  184. package/lib/rules/no-empty-static-block.js +61 -35
  185. package/lib/rules/no-empty.js +135 -85
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +258 -249
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -160
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -295
  192. package/lib/rules/no-extra-label.js +150 -130
  193. package/lib/rules/no-extra-parens.js +1654 -1307
  194. package/lib/rules/no-extra-semi.js +146 -126
  195. package/lib/rules/no-fallthrough.js +200 -136
  196. package/lib/rules/no-floating-decimal.js +74 -48
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -72
  199. package/lib/rules/no-implicit-coercion.js +350 -262
  200. package/lib/rules/no-implicit-globals.js +174 -133
  201. package/lib/rules/no-implied-eval.js +150 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -96
  204. package/lib/rules/no-inner-declarations.js +115 -78
  205. package/lib/rules/no-invalid-regexp.js +223 -174
  206. package/lib/rules/no-invalid-this.js +145 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -250
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -61
  210. package/lib/rules/no-labels.js +138 -131
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +105 -67
  213. package/lib/rules/no-loop-func.js +245 -184
  214. package/lib/rules/no-loss-of-precision.js +236 -201
  215. package/lib/rules/no-magic-numbers.js +339 -217
  216. package/lib/rules/no-misleading-character-class.js +548 -253
  217. package/lib/rules/no-mixed-operators.js +188 -164
  218. package/lib/rules/no-mixed-requires.js +253 -224
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +135 -103
  220. package/lib/rules/no-multi-assign.js +46 -47
  221. package/lib/rules/no-multi-spaces.js +163 -125
  222. package/lib/rules/no-multi-str.js +42 -40
  223. package/lib/rules/no-multiple-empty-lines.js +196 -140
  224. package/lib/rules/no-native-reassign.js +90 -74
  225. package/lib/rules/no-negated-condition.js +79 -74
  226. package/lib/rules/no-negated-in-lhs.js +45 -32
  227. package/lib/rules/no-nested-ternary.js +33 -31
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -39
  231. package/lib/rules/no-new-require.js +48 -31
  232. package/lib/rules/no-new-symbol.js +61 -43
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +149 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +29 -32
  240. package/lib/rules/no-param-reassign.js +236 -218
  241. package/lib/rules/no-path-concat.js +66 -51
  242. package/lib/rules/no-plusplus.js +60 -63
  243. package/lib/rules/no-process-env.js +49 -32
  244. package/lib/rules/no-process-exit.js +48 -28
  245. package/lib/rules/no-promise-executor-return.js +205 -204
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -155
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -174
  251. package/lib/rules/no-restricted-globals.js +254 -112
  252. package/lib/rules/no-restricted-imports.js +824 -384
  253. package/lib/rules/no-restricted-modules.js +222 -186
  254. package/lib/rules/no-restricted-properties.js +218 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +56 -49
  257. package/lib/rules/no-return-await.js +147 -120
  258. package/lib/rules/no-script-url.js +53 -46
  259. package/lib/rules/no-self-assign.js +148 -145
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -115
  262. package/lib/rules/no-setter-return.js +176 -178
  263. package/lib/rules/no-shadow-restricted-names.js +84 -36
  264. package/lib/rules/no-shadow.js +598 -310
  265. package/lib/rules/no-spaced-func.js +82 -60
  266. package/lib/rules/no-sparse-arrays.js +46 -28
  267. package/lib/rules/no-sync.js +61 -44
  268. package/lib/rules/no-tabs.js +83 -54
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -28
  271. package/lib/rules/no-this-before-super.js +332 -298
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +208 -174
  274. package/lib/rules/no-unassigned-vars.js +80 -0
  275. package/lib/rules/no-undef-init.js +86 -60
  276. package/lib/rules/no-undef.js +52 -47
  277. package/lib/rules/no-undefined.js +73 -74
  278. package/lib/rules/no-underscore-dangle.js +370 -322
  279. package/lib/rules/no-unexpected-multiline.js +112 -102
  280. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  281. package/lib/rules/no-unneeded-ternary.js +212 -146
  282. package/lib/rules/no-unreachable-loop.js +145 -140
  283. package/lib/rules/no-unreachable.js +255 -248
  284. package/lib/rules/no-unsafe-finally.js +93 -85
  285. package/lib/rules/no-unsafe-negation.js +105 -81
  286. package/lib/rules/no-unsafe-optional-chaining.js +193 -177
  287. package/lib/rules/no-unused-expressions.js +199 -158
  288. package/lib/rules/no-unused-labels.js +139 -124
  289. package/lib/rules/no-unused-private-class-members.js +206 -182
  290. package/lib/rules/no-unused-vars.js +1708 -687
  291. package/lib/rules/no-use-before-define.js +327 -229
  292. package/lib/rules/no-useless-assignment.js +654 -0
  293. package/lib/rules/no-useless-backreference.js +212 -143
  294. package/lib/rules/no-useless-call.js +58 -53
  295. package/lib/rules/no-useless-catch.js +40 -40
  296. package/lib/rules/no-useless-computed-key.js +144 -108
  297. package/lib/rules/no-useless-concat.js +65 -59
  298. package/lib/rules/no-useless-constructor.js +160 -97
  299. package/lib/rules/no-useless-escape.js +364 -291
  300. package/lib/rules/no-useless-rename.js +183 -153
  301. package/lib/rules/no-useless-return.js +344 -307
  302. package/lib/rules/no-var.js +245 -212
  303. package/lib/rules/no-void.js +51 -46
  304. package/lib/rules/no-warning-comments.js +191 -183
  305. package/lib/rules/no-whitespace-before-property.js +131 -97
  306. package/lib/rules/no-with.js +24 -26
  307. package/lib/rules/nonblock-statement-body-position.js +149 -112
  308. package/lib/rules/object-curly-newline.js +306 -247
  309. package/lib/rules/object-curly-spacing.js +360 -296
  310. package/lib/rules/object-property-newline.js +137 -88
  311. package/lib/rules/object-shorthand.js +632 -500
  312. package/lib/rules/one-var-declaration-per-line.js +104 -82
  313. package/lib/rules/one-var.js +686 -536
  314. package/lib/rules/operator-assignment.js +219 -158
  315. package/lib/rules/operator-linebreak.js +295 -233
  316. package/lib/rules/padded-blocks.js +346 -290
  317. package/lib/rules/padding-line-between-statements.js +443 -421
  318. package/lib/rules/prefer-arrow-callback.js +371 -315
  319. package/lib/rules/prefer-const.js +418 -373
  320. package/lib/rules/prefer-destructuring.js +309 -278
  321. package/lib/rules/prefer-exponentiation-operator.js +176 -132
  322. package/lib/rules/prefer-named-capture-group.js +160 -141
  323. package/lib/rules/prefer-numeric-literals.js +121 -112
  324. package/lib/rules/prefer-object-has-own.js +116 -82
  325. package/lib/rules/prefer-object-spread.js +214 -193
  326. package/lib/rules/prefer-promise-reject-errors.js +140 -118
  327. package/lib/rules/prefer-reflect.js +126 -103
  328. package/lib/rules/prefer-regex-literals.js +561 -463
  329. package/lib/rules/prefer-rest-params.js +79 -80
  330. package/lib/rules/prefer-spread.js +47 -43
  331. package/lib/rules/prefer-template.js +266 -194
  332. package/lib/rules/preserve-caught-error.js +535 -0
  333. package/lib/rules/quote-props.js +373 -289
  334. package/lib/rules/quotes.js +374 -308
  335. package/lib/rules/radix.js +152 -134
  336. package/lib/rules/require-atomic-updates.js +316 -282
  337. package/lib/rules/require-await.js +153 -82
  338. package/lib/rules/require-unicode-regexp.js +296 -108
  339. package/lib/rules/require-yield.js +53 -54
  340. package/lib/rules/rest-spread-spacing.js +128 -98
  341. package/lib/rules/semi-spacing.js +281 -232
  342. package/lib/rules/semi-style.js +176 -116
  343. package/lib/rules/semi.js +456 -418
  344. package/lib/rules/sort-imports.js +307 -229
  345. package/lib/rules/sort-keys.js +219 -181
  346. package/lib/rules/sort-vars.js +127 -91
  347. package/lib/rules/space-before-blocks.js +199 -171
  348. package/lib/rules/space-before-function-paren.js +186 -148
  349. package/lib/rules/space-in-parens.js +359 -270
  350. package/lib/rules/space-infix-ops.js +237 -183
  351. package/lib/rules/space-unary-ops.js +356 -280
  352. package/lib/rules/spaced-comment.js +363 -301
  353. package/lib/rules/strict.js +266 -229
  354. package/lib/rules/switch-colon-spacing.js +130 -104
  355. package/lib/rules/symbol-description.js +45 -48
  356. package/lib/rules/template-curly-spacing.js +148 -124
  357. package/lib/rules/template-tag-spacing.js +98 -70
  358. package/lib/rules/unicode-bom.js +54 -54
  359. package/lib/rules/use-isnan.js +237 -110
  360. package/lib/rules/utils/ast-utils.js +2139 -1688
  361. package/lib/rules/utils/char-source.js +247 -0
  362. package/lib/rules/utils/fix-tracker.js +99 -88
  363. package/lib/rules/utils/keywords.js +59 -59
  364. package/lib/rules/utils/lazy-loading-rule-map.js +81 -78
  365. package/lib/rules/utils/regular-expressions.js +35 -19
  366. package/lib/rules/utils/unicode/index.js +9 -4
  367. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  368. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  369. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  370. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  371. package/lib/rules/valid-typeof.js +153 -109
  372. package/lib/rules/vars-on-top.js +152 -144
  373. package/lib/rules/wrap-iife.js +204 -173
  374. package/lib/rules/wrap-regex.js +77 -47
  375. package/lib/rules/yield-star-spacing.js +145 -116
  376. package/lib/rules/yoda.js +283 -274
  377. package/lib/services/parser-service.js +65 -0
  378. package/lib/services/processor-service.js +101 -0
  379. package/lib/services/suppressions-service.js +302 -0
  380. package/lib/services/warning-service.js +98 -0
  381. package/lib/shared/ajv.js +14 -14
  382. package/lib/shared/assert.js +21 -0
  383. package/lib/shared/ast-utils.js +7 -6
  384. package/lib/shared/deep-merge-arrays.js +62 -0
  385. package/lib/shared/directives.js +3 -2
  386. package/lib/shared/flags.js +108 -0
  387. package/lib/shared/logging.js +24 -16
  388. package/lib/shared/naming.js +109 -0
  389. package/lib/shared/option-utils.js +63 -0
  390. package/lib/shared/relative-module-resolver.js +18 -40
  391. package/lib/shared/runtime-info.js +138 -128
  392. package/lib/shared/serialization.js +78 -0
  393. package/lib/shared/severity.js +22 -22
  394. package/lib/shared/stats.js +30 -0
  395. package/lib/shared/string-utils.js +19 -21
  396. package/lib/shared/text-table.js +68 -0
  397. package/lib/shared/translate-cli-options.js +281 -0
  398. package/lib/shared/traverser.js +153 -146
  399. package/lib/types/config-api.d.ts +12 -0
  400. package/lib/types/index.d.ts +1473 -0
  401. package/lib/types/rules.d.ts +5589 -0
  402. package/lib/types/universal.d.ts +6 -0
  403. package/lib/types/use-at-your-own-risk.d.ts +87 -0
  404. package/lib/universal.js +10 -0
  405. package/lib/unsupported-api.js +8 -9
  406. package/messages/all-files-ignored.js +3 -3
  407. package/messages/all-matched-files-ignored.js +21 -0
  408. package/messages/config-file-missing.js +16 -0
  409. package/messages/config-plugin-missing.js +14 -0
  410. package/messages/config-serialize-function.js +30 -0
  411. package/messages/eslintrc-incompat.js +35 -16
  412. package/messages/eslintrc-plugins.js +8 -5
  413. package/messages/extend-config-missing.js +3 -3
  414. package/messages/failed-to-read-json.js +3 -3
  415. package/messages/file-not-found.js +3 -3
  416. package/messages/invalid-rule-options.js +2 -2
  417. package/messages/invalid-rule-severity.js +2 -2
  418. package/messages/no-config-found.js +4 -4
  419. package/messages/plugin-conflict.js +9 -9
  420. package/messages/plugin-invalid.js +4 -4
  421. package/messages/plugin-missing.js +4 -4
  422. package/messages/print-config-with-directory-path.js +2 -2
  423. package/messages/shared.js +6 -1
  424. package/messages/whitespace-found.js +3 -3
  425. package/package.json +105 -60
  426. package/conf/config-schema.js +0 -93
  427. package/lib/cli-engine/formatters/checkstyle.js +0 -60
  428. package/lib/cli-engine/formatters/compact.js +0 -60
  429. package/lib/cli-engine/formatters/jslint-xml.js +0 -41
  430. package/lib/cli-engine/formatters/junit.js +0 -82
  431. package/lib/cli-engine/formatters/tap.js +0 -95
  432. package/lib/cli-engine/formatters/unix.js +0 -58
  433. package/lib/cli-engine/formatters/visualstudio.js +0 -63
  434. package/lib/cli-engine/xml-escape.js +0 -34
  435. package/lib/config/flat-config-helpers.js +0 -111
  436. package/lib/config/rule-validator.js +0 -158
  437. package/lib/eslint/flat-eslint.js +0 -1159
  438. package/lib/linter/config-comment-parser.js +0 -185
  439. package/lib/linter/node-event-generator.js +0 -354
  440. package/lib/linter/report-translator.js +0 -369
  441. package/lib/linter/safe-emitter.js +0 -52
  442. package/lib/rule-tester/flat-rule-tester.js +0 -1131
  443. package/lib/rules/require-jsdoc.js +0 -122
  444. package/lib/rules/utils/patterns/letters.js +0 -36
  445. package/lib/rules/valid-jsdoc.js +0 -516
  446. package/lib/shared/config-validator.js +0 -347
  447. package/lib/shared/deprecation-warnings.js +0 -58
  448. package/lib/shared/types.js +0 -216
  449. package/lib/source-code/index.js +0 -5
  450. package/lib/source-code/source-code.js +0 -1055
  451. package/lib/source-code/token-store/backward-token-comment-cursor.js +0 -57
  452. package/lib/source-code/token-store/backward-token-cursor.js +0 -58
  453. package/lib/source-code/token-store/cursors.js +0 -90
  454. package/lib/source-code/token-store/forward-token-comment-cursor.js +0 -57
  455. package/lib/source-code/token-store/forward-token-cursor.js +0 -63
  456. package/lib/source-code/token-store/index.js +0 -627
  457. package/lib/source-code/token-store/padded-token-cursor.js +0 -38
  458. package/lib/source-code/token-store/utils.js +0 -107
@@ -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,189 +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
- docs: {
335
- description: "Require `const` declarations for variables that are never reassigned after declared",
336
- recommended: false,
337
- url: "https://eslint.org/docs/latest/rules/prefer-const"
338
- },
339
-
340
- fixable: "code",
341
-
342
- schema: [
343
- {
344
- type: "object",
345
- properties: {
346
- destructuring: { enum: ["any", "all"], default: "any" },
347
- ignoreReadBeforeAssign: { type: "boolean", default: false }
348
- },
349
- additionalProperties: false
350
- }
351
- ],
352
- messages: {
353
- useConst: "'{{name}}' is never reassigned. Use 'const' instead."
354
- }
355
- },
356
-
357
- create(context) {
358
- const options = context.options[0] || {};
359
- const sourceCode = context.sourceCode;
360
- const shouldMatchAnyDestructuredVariable = options.destructuring !== "all";
361
- const ignoreReadBeforeAssign = options.ignoreReadBeforeAssign === true;
362
- const variables = [];
363
- let reportCount = 0;
364
- let checkedId = null;
365
- let checkedName = "";
366
-
367
-
368
- /**
369
- * Reports given identifier nodes if all of the nodes should be declared
370
- * as const.
371
- *
372
- * The argument 'nodes' is an array of Identifier nodes.
373
- * This node is the result of 'getIdentifierIfShouldBeConst()', so it's
374
- * nullable. In simple declaration or assignment cases, the length of
375
- * the array is 1. In destructuring cases, the length of the array can
376
- * be 2 or more.
377
- * @param {(eslint-scope.Reference|null)[]} nodes
378
- * References which are grouped by destructuring to report.
379
- * @returns {void}
380
- */
381
- function checkGroup(nodes) {
382
- const nodesToReport = nodes.filter(Boolean);
383
-
384
- if (nodes.length && (shouldMatchAnyDestructuredVariable || nodesToReport.length === nodes.length)) {
385
- const varDeclParent = findUp(nodes[0], "VariableDeclaration", parentNode => parentNode.type.endsWith("Statement"));
386
- const isVarDecParentNull = varDeclParent === null;
387
-
388
- if (!isVarDecParentNull && varDeclParent.declarations.length > 0) {
389
- const firstDeclaration = varDeclParent.declarations[0];
390
-
391
- if (firstDeclaration.init) {
392
- const firstDecParent = firstDeclaration.init.parent;
393
-
394
- /*
395
- * First we check the declaration type and then depending on
396
- * if the type is a "VariableDeclarator" or its an "ObjectPattern"
397
- * we compare the name and id from the first identifier, if the names are different
398
- * we assign the new name, id and reset the count of reportCount and nodeCount in
399
- * order to check each block for the number of reported errors and base our fix
400
- * based on comparing nodes.length and nodesToReport.length.
401
- */
402
-
403
- if (firstDecParent.type === "VariableDeclarator") {
404
-
405
- if (firstDecParent.id.name !== checkedName) {
406
- checkedName = firstDecParent.id.name;
407
- reportCount = 0;
408
- }
409
-
410
- if (firstDecParent.id.type === "ObjectPattern") {
411
- if (firstDecParent.init.name !== checkedName) {
412
- checkedName = firstDecParent.init.name;
413
- reportCount = 0;
414
- }
415
- }
416
-
417
- if (firstDecParent.id !== checkedId) {
418
- checkedId = firstDecParent.id;
419
- reportCount = 0;
420
- }
421
- }
422
- }
423
- }
424
-
425
- let shouldFix = varDeclParent &&
426
-
427
- // Don't do a fix unless all variables in the declarations are initialized (or it's in a for-in or for-of loop)
428
- (varDeclParent.parent.type === "ForInStatement" || varDeclParent.parent.type === "ForOfStatement" ||
429
- varDeclParent.declarations.every(declaration => declaration.init)) &&
430
-
431
- /*
432
- * If options.destructuring is "all", then this warning will not occur unless
433
- * every assignment in the destructuring should be const. In that case, it's safe
434
- * to apply the fix.
435
- */
436
- nodesToReport.length === nodes.length;
437
-
438
- if (!isVarDecParentNull && varDeclParent.declarations && varDeclParent.declarations.length !== 1) {
439
-
440
- if (varDeclParent && varDeclParent.declarations && varDeclParent.declarations.length >= 1) {
441
-
442
- /*
443
- * Add nodesToReport.length to a count, then comparing the count to the length
444
- * of the declarations in the current block.
445
- */
446
-
447
- reportCount += nodesToReport.length;
448
-
449
- let totalDeclarationsCount = 0;
450
-
451
- varDeclParent.declarations.forEach(declaration => {
452
- if (declaration.id.type === "ObjectPattern") {
453
- totalDeclarationsCount += declaration.id.properties.length;
454
- } else if (declaration.id.type === "ArrayPattern") {
455
- totalDeclarationsCount += declaration.id.elements.length;
456
- } else {
457
- totalDeclarationsCount += 1;
458
- }
459
- });
460
-
461
- shouldFix = shouldFix && (reportCount === totalDeclarationsCount);
462
- }
463
- }
464
-
465
- nodesToReport.forEach(node => {
466
- context.report({
467
- node,
468
- messageId: "useConst",
469
- data: node,
470
- fix: shouldFix
471
- ? fixer => {
472
- const letKeywordToken = sourceCode.getFirstToken(varDeclParent, t => t.value === varDeclParent.kind);
473
-
474
- /**
475
- * Extend the replacement range to the whole declaration,
476
- * in order to prevent other fixes in the same pass
477
- * https://github.com/eslint/eslint/issues/13899
478
- */
479
- return new FixTracker(fixer, sourceCode)
480
- .retainRange(varDeclParent.range)
481
- .replaceTextRange(letKeywordToken.range, "const");
482
- }
483
- : null
484
- });
485
- });
486
- }
487
- }
488
-
489
- return {
490
- "Program:exit"() {
491
- groupByDestructuring(variables, ignoreReadBeforeAssign).forEach(checkGroup);
492
- },
493
-
494
- VariableDeclaration(node) {
495
- if (node.kind === "let" && !isInitOfForStatement(node)) {
496
- variables.push(...sourceCode.getDeclaredVariables(node));
497
- }
498
- }
499
- };
500
- }
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
+ },
501
546
  };