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
@@ -21,547 +21,697 @@ const astUtils = require("./utils/ast-utils");
21
21
  * @returns {boolean} `true` if the given node is in a statement list
22
22
  */
23
23
  function isInStatementList(node) {
24
- return astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type);
24
+ return astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type);
25
25
  }
26
26
 
27
27
  //------------------------------------------------------------------------------
28
28
  // Rule Definition
29
29
  //------------------------------------------------------------------------------
30
30
 
31
- /** @type {import('../shared/types').Rule} */
31
+ /** @type {import('../types').Rule.RuleModule} */
32
32
  module.exports = {
33
- meta: {
34
- type: "suggestion",
35
-
36
- docs: {
37
- description: "Enforce variables to be declared either together or separately in functions",
38
- recommended: false,
39
- url: "https://eslint.org/docs/latest/rules/one-var"
40
- },
41
-
42
- fixable: "code",
43
-
44
- schema: [
45
- {
46
- oneOf: [
47
- {
48
- enum: ["always", "never", "consecutive"]
49
- },
50
- {
51
- type: "object",
52
- properties: {
53
- separateRequires: {
54
- type: "boolean"
55
- },
56
- var: {
57
- enum: ["always", "never", "consecutive"]
58
- },
59
- let: {
60
- enum: ["always", "never", "consecutive"]
61
- },
62
- const: {
63
- enum: ["always", "never", "consecutive"]
64
- }
65
- },
66
- additionalProperties: false
67
- },
68
- {
69
- type: "object",
70
- properties: {
71
- initialized: {
72
- enum: ["always", "never", "consecutive"]
73
- },
74
- uninitialized: {
75
- enum: ["always", "never", "consecutive"]
76
- }
77
- },
78
- additionalProperties: false
79
- }
80
- ]
81
- }
82
- ],
83
-
84
- messages: {
85
- combineUninitialized: "Combine this with the previous '{{type}}' statement with uninitialized variables.",
86
- combineInitialized: "Combine this with the previous '{{type}}' statement with initialized variables.",
87
- splitUninitialized: "Split uninitialized '{{type}}' declarations into multiple statements.",
88
- splitInitialized: "Split initialized '{{type}}' declarations into multiple statements.",
89
- splitRequires: "Split requires to be separated into a single block.",
90
- combine: "Combine this with the previous '{{type}}' statement.",
91
- split: "Split '{{type}}' declarations into multiple statements."
92
- }
93
- },
94
-
95
- create(context) {
96
- const MODE_ALWAYS = "always";
97
- const MODE_NEVER = "never";
98
- const MODE_CONSECUTIVE = "consecutive";
99
- const mode = context.options[0] || MODE_ALWAYS;
100
-
101
- const options = {};
102
-
103
- if (typeof mode === "string") { // simple options configuration with just a string
104
- options.var = { uninitialized: mode, initialized: mode };
105
- options.let = { uninitialized: mode, initialized: mode };
106
- options.const = { uninitialized: mode, initialized: mode };
107
- } else if (typeof mode === "object") { // options configuration is an object
108
- options.separateRequires = !!mode.separateRequires;
109
- options.var = { uninitialized: mode.var, initialized: mode.var };
110
- options.let = { uninitialized: mode.let, initialized: mode.let };
111
- options.const = { uninitialized: mode.const, initialized: mode.const };
112
- if (Object.prototype.hasOwnProperty.call(mode, "uninitialized")) {
113
- options.var.uninitialized = mode.uninitialized;
114
- options.let.uninitialized = mode.uninitialized;
115
- options.const.uninitialized = mode.uninitialized;
116
- }
117
- if (Object.prototype.hasOwnProperty.call(mode, "initialized")) {
118
- options.var.initialized = mode.initialized;
119
- options.let.initialized = mode.initialized;
120
- options.const.initialized = mode.initialized;
121
- }
122
- }
123
-
124
- const sourceCode = context.sourceCode;
125
-
126
- //--------------------------------------------------------------------------
127
- // Helpers
128
- //--------------------------------------------------------------------------
129
-
130
- const functionStack = [];
131
- const blockStack = [];
132
-
133
- /**
134
- * Increments the blockStack counter.
135
- * @returns {void}
136
- * @private
137
- */
138
- function startBlock() {
139
- blockStack.push({
140
- let: { initialized: false, uninitialized: false },
141
- const: { initialized: false, uninitialized: false }
142
- });
143
- }
144
-
145
- /**
146
- * Increments the functionStack counter.
147
- * @returns {void}
148
- * @private
149
- */
150
- function startFunction() {
151
- functionStack.push({ initialized: false, uninitialized: false });
152
- startBlock();
153
- }
154
-
155
- /**
156
- * Decrements the blockStack counter.
157
- * @returns {void}
158
- * @private
159
- */
160
- function endBlock() {
161
- blockStack.pop();
162
- }
163
-
164
- /**
165
- * Decrements the functionStack counter.
166
- * @returns {void}
167
- * @private
168
- */
169
- function endFunction() {
170
- functionStack.pop();
171
- endBlock();
172
- }
173
-
174
- /**
175
- * Check if a variable declaration is a require.
176
- * @param {ASTNode} decl variable declaration Node
177
- * @returns {bool} if decl is a require, return true; else return false.
178
- * @private
179
- */
180
- function isRequire(decl) {
181
- return decl.init && decl.init.type === "CallExpression" && decl.init.callee.name === "require";
182
- }
183
-
184
- /**
185
- * Records whether initialized/uninitialized/required variables are defined in current scope.
186
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
187
- * @param {ASTNode[]} declarations List of declarations
188
- * @param {Object} currentScope The scope being investigated
189
- * @returns {void}
190
- * @private
191
- */
192
- function recordTypes(statementType, declarations, currentScope) {
193
- for (let i = 0; i < declarations.length; i++) {
194
- if (declarations[i].init === null) {
195
- if (options[statementType] && options[statementType].uninitialized === MODE_ALWAYS) {
196
- currentScope.uninitialized = true;
197
- }
198
- } else {
199
- if (options[statementType] && options[statementType].initialized === MODE_ALWAYS) {
200
- if (options.separateRequires && isRequire(declarations[i])) {
201
- currentScope.required = true;
202
- } else {
203
- currentScope.initialized = true;
204
- }
205
- }
206
- }
207
- }
208
- }
209
-
210
- /**
211
- * Determines the current scope (function or block)
212
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
213
- * @returns {Object} The scope associated with statementType
214
- */
215
- function getCurrentScope(statementType) {
216
- let currentScope;
217
-
218
- if (statementType === "var") {
219
- currentScope = functionStack[functionStack.length - 1];
220
- } else if (statementType === "let") {
221
- currentScope = blockStack[blockStack.length - 1].let;
222
- } else if (statementType === "const") {
223
- currentScope = blockStack[blockStack.length - 1].const;
224
- }
225
- return currentScope;
226
- }
227
-
228
- /**
229
- * Counts the number of initialized and uninitialized declarations in a list of declarations
230
- * @param {ASTNode[]} declarations List of declarations
231
- * @returns {Object} Counts of 'uninitialized' and 'initialized' declarations
232
- * @private
233
- */
234
- function countDeclarations(declarations) {
235
- const counts = { uninitialized: 0, initialized: 0 };
236
-
237
- for (let i = 0; i < declarations.length; i++) {
238
- if (declarations[i].init === null) {
239
- counts.uninitialized++;
240
- } else {
241
- counts.initialized++;
242
- }
243
- }
244
- return counts;
245
- }
246
-
247
- /**
248
- * Determines if there is more than one var statement in the current scope.
249
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
250
- * @param {ASTNode[]} declarations List of declarations
251
- * @returns {boolean} Returns true if it is the first var declaration, false if not.
252
- * @private
253
- */
254
- function hasOnlyOneStatement(statementType, declarations) {
255
-
256
- const declarationCounts = countDeclarations(declarations);
257
- const currentOptions = options[statementType] || {};
258
- const currentScope = getCurrentScope(statementType);
259
- const hasRequires = declarations.some(isRequire);
260
-
261
- if (currentOptions.uninitialized === MODE_ALWAYS && currentOptions.initialized === MODE_ALWAYS) {
262
- if (currentScope.uninitialized || currentScope.initialized) {
263
- if (!hasRequires) {
264
- return false;
265
- }
266
- }
267
- }
268
-
269
- if (declarationCounts.uninitialized > 0) {
270
- if (currentOptions.uninitialized === MODE_ALWAYS && currentScope.uninitialized) {
271
- return false;
272
- }
273
- }
274
- if (declarationCounts.initialized > 0) {
275
- if (currentOptions.initialized === MODE_ALWAYS && currentScope.initialized) {
276
- if (!hasRequires) {
277
- return false;
278
- }
279
- }
280
- }
281
- if (currentScope.required && hasRequires) {
282
- return false;
283
- }
284
- recordTypes(statementType, declarations, currentScope);
285
- return true;
286
- }
287
-
288
- /**
289
- * Fixer to join VariableDeclaration's into a single declaration
290
- * @param {VariableDeclarator[]} declarations The `VariableDeclaration` to join
291
- * @returns {Function} The fixer function
292
- */
293
- function joinDeclarations(declarations) {
294
- const declaration = declarations[0];
295
- const body = Array.isArray(declaration.parent.parent.body) ? declaration.parent.parent.body : [];
296
- const currentIndex = body.findIndex(node => node.range[0] === declaration.parent.range[0]);
297
- const previousNode = body[currentIndex - 1];
298
-
299
- return fixer => {
300
- const type = sourceCode.getTokenBefore(declaration);
301
- const prevSemi = sourceCode.getTokenBefore(type);
302
- const res = [];
303
-
304
- if (previousNode && previousNode.kind === sourceCode.getText(type)) {
305
- if (prevSemi.value === ";") {
306
- res.push(fixer.replaceText(prevSemi, ","));
307
- } else {
308
- res.push(fixer.insertTextAfter(prevSemi, ","));
309
- }
310
- res.push(fixer.replaceText(type, ""));
311
- }
312
-
313
- return res;
314
- };
315
- }
316
-
317
- /**
318
- * Fixer to split a VariableDeclaration into individual declarations
319
- * @param {VariableDeclaration} declaration The `VariableDeclaration` to split
320
- * @returns {Function|null} The fixer function
321
- */
322
- function splitDeclarations(declaration) {
323
- const { parent } = declaration;
324
-
325
- // don't autofix code such as: if (foo) var x, y;
326
- if (!isInStatementList(parent.type === "ExportNamedDeclaration" ? parent : declaration)) {
327
- return null;
328
- }
329
-
330
- return fixer => declaration.declarations.map(declarator => {
331
- const tokenAfterDeclarator = sourceCode.getTokenAfter(declarator);
332
-
333
- if (tokenAfterDeclarator === null) {
334
- return null;
335
- }
336
-
337
- const afterComma = sourceCode.getTokenAfter(tokenAfterDeclarator, { includeComments: true });
338
-
339
- if (tokenAfterDeclarator.value !== ",") {
340
- return null;
341
- }
342
-
343
- const exportPlacement = declaration.parent.type === "ExportNamedDeclaration" ? "export " : "";
344
-
345
- /*
346
- * `var x,y`
347
- * tokenAfterDeclarator ^^ afterComma
348
- */
349
- if (afterComma.range[0] === tokenAfterDeclarator.range[1]) {
350
- return fixer.replaceText(tokenAfterDeclarator, `; ${exportPlacement}${declaration.kind} `);
351
- }
352
-
353
- /*
354
- * `var x,
355
- * tokenAfterDeclarator ^
356
- * y`
357
- * ^ afterComma
358
- */
359
- if (
360
- afterComma.loc.start.line > tokenAfterDeclarator.loc.end.line ||
361
- afterComma.type === "Line" ||
362
- afterComma.type === "Block"
363
- ) {
364
- let lastComment = afterComma;
365
-
366
- while (lastComment.type === "Line" || lastComment.type === "Block") {
367
- lastComment = sourceCode.getTokenAfter(lastComment, { includeComments: true });
368
- }
369
-
370
- return fixer.replaceTextRange(
371
- [tokenAfterDeclarator.range[0], lastComment.range[0]],
372
- `;${sourceCode.text.slice(tokenAfterDeclarator.range[1], lastComment.range[0])}${exportPlacement}${declaration.kind} `
373
- );
374
- }
375
-
376
- return fixer.replaceText(tokenAfterDeclarator, `; ${exportPlacement}${declaration.kind}`);
377
- }).filter(x => x);
378
- }
379
-
380
- /**
381
- * Checks a given VariableDeclaration node for errors.
382
- * @param {ASTNode} node The VariableDeclaration node to check
383
- * @returns {void}
384
- * @private
385
- */
386
- function checkVariableDeclaration(node) {
387
- const parent = node.parent;
388
- const type = node.kind;
389
-
390
- if (!options[type]) {
391
- return;
392
- }
393
-
394
- const declarations = node.declarations;
395
- const declarationCounts = countDeclarations(declarations);
396
- const mixedRequires = declarations.some(isRequire) && !declarations.every(isRequire);
397
-
398
- if (options[type].initialized === MODE_ALWAYS) {
399
- if (options.separateRequires && mixedRequires) {
400
- context.report({
401
- node,
402
- messageId: "splitRequires"
403
- });
404
- }
405
- }
406
-
407
- // consecutive
408
- const nodeIndex = (parent.body && parent.body.length > 0 && parent.body.indexOf(node)) || 0;
409
-
410
- if (nodeIndex > 0) {
411
- const previousNode = parent.body[nodeIndex - 1];
412
- const isPreviousNodeDeclaration = previousNode.type === "VariableDeclaration";
413
- const declarationsWithPrevious = declarations.concat(previousNode.declarations || []);
414
-
415
- if (
416
- isPreviousNodeDeclaration &&
417
- previousNode.kind === type &&
418
- !(declarationsWithPrevious.some(isRequire) && !declarationsWithPrevious.every(isRequire))
419
- ) {
420
- const previousDeclCounts = countDeclarations(previousNode.declarations);
421
-
422
- if (options[type].initialized === MODE_CONSECUTIVE && options[type].uninitialized === MODE_CONSECUTIVE) {
423
- context.report({
424
- node,
425
- messageId: "combine",
426
- data: {
427
- type
428
- },
429
- fix: joinDeclarations(declarations)
430
- });
431
- } else if (options[type].initialized === MODE_CONSECUTIVE && declarationCounts.initialized > 0 && previousDeclCounts.initialized > 0) {
432
- context.report({
433
- node,
434
- messageId: "combineInitialized",
435
- data: {
436
- type
437
- },
438
- fix: joinDeclarations(declarations)
439
- });
440
- } else if (options[type].uninitialized === MODE_CONSECUTIVE &&
441
- declarationCounts.uninitialized > 0 &&
442
- previousDeclCounts.uninitialized > 0) {
443
- context.report({
444
- node,
445
- messageId: "combineUninitialized",
446
- data: {
447
- type
448
- },
449
- fix: joinDeclarations(declarations)
450
- });
451
- }
452
- }
453
- }
454
-
455
- // always
456
- if (!hasOnlyOneStatement(type, declarations)) {
457
- if (options[type].initialized === MODE_ALWAYS && options[type].uninitialized === MODE_ALWAYS) {
458
- context.report({
459
- node,
460
- messageId: "combine",
461
- data: {
462
- type
463
- },
464
- fix: joinDeclarations(declarations)
465
- });
466
- } else {
467
- if (options[type].initialized === MODE_ALWAYS && declarationCounts.initialized > 0) {
468
- context.report({
469
- node,
470
- messageId: "combineInitialized",
471
- data: {
472
- type
473
- },
474
- fix: joinDeclarations(declarations)
475
- });
476
- }
477
- if (options[type].uninitialized === MODE_ALWAYS && declarationCounts.uninitialized > 0) {
478
- if (node.parent.left === node && (node.parent.type === "ForInStatement" || node.parent.type === "ForOfStatement")) {
479
- return;
480
- }
481
- context.report({
482
- node,
483
- messageId: "combineUninitialized",
484
- data: {
485
- type
486
- },
487
- fix: joinDeclarations(declarations)
488
- });
489
- }
490
- }
491
- }
492
-
493
- // never
494
- if (parent.type !== "ForStatement" || parent.init !== node) {
495
- const totalDeclarations = declarationCounts.uninitialized + declarationCounts.initialized;
496
-
497
- if (totalDeclarations > 1) {
498
- if (options[type].initialized === MODE_NEVER && options[type].uninitialized === MODE_NEVER) {
499
-
500
- // both initialized and uninitialized
501
- context.report({
502
- node,
503
- messageId: "split",
504
- data: {
505
- type
506
- },
507
- fix: splitDeclarations(node)
508
- });
509
- } else if (options[type].initialized === MODE_NEVER && declarationCounts.initialized > 0) {
510
-
511
- // initialized
512
- context.report({
513
- node,
514
- messageId: "splitInitialized",
515
- data: {
516
- type
517
- },
518
- fix: splitDeclarations(node)
519
- });
520
- } else if (options[type].uninitialized === MODE_NEVER && declarationCounts.uninitialized > 0) {
521
-
522
- // uninitialized
523
- context.report({
524
- node,
525
- messageId: "splitUninitialized",
526
- data: {
527
- type
528
- },
529
- fix: splitDeclarations(node)
530
- });
531
- }
532
- }
533
- }
534
- }
535
-
536
- //--------------------------------------------------------------------------
537
- // Public API
538
- //--------------------------------------------------------------------------
539
-
540
- return {
541
- Program: startFunction,
542
- FunctionDeclaration: startFunction,
543
- FunctionExpression: startFunction,
544
- ArrowFunctionExpression: startFunction,
545
- StaticBlock: startFunction, // StaticBlock creates a new scope for `var` variables
546
-
547
- BlockStatement: startBlock,
548
- ForStatement: startBlock,
549
- ForInStatement: startBlock,
550
- ForOfStatement: startBlock,
551
- SwitchStatement: startBlock,
552
- VariableDeclaration: checkVariableDeclaration,
553
- "ForStatement:exit": endBlock,
554
- "ForOfStatement:exit": endBlock,
555
- "ForInStatement:exit": endBlock,
556
- "SwitchStatement:exit": endBlock,
557
- "BlockStatement:exit": endBlock,
558
-
559
- "Program:exit": endFunction,
560
- "FunctionDeclaration:exit": endFunction,
561
- "FunctionExpression:exit": endFunction,
562
- "ArrowFunctionExpression:exit": endFunction,
563
- "StaticBlock:exit": endFunction
564
- };
565
-
566
- }
33
+ meta: {
34
+ type: "suggestion",
35
+
36
+ docs: {
37
+ description:
38
+ "Enforce variables to be declared either together or separately in functions",
39
+ recommended: false,
40
+ frozen: true,
41
+ url: "https://eslint.org/docs/latest/rules/one-var",
42
+ },
43
+
44
+ fixable: "code",
45
+
46
+ schema: [
47
+ {
48
+ oneOf: [
49
+ {
50
+ enum: ["always", "never", "consecutive"],
51
+ },
52
+ {
53
+ type: "object",
54
+ properties: {
55
+ separateRequires: {
56
+ type: "boolean",
57
+ },
58
+ var: {
59
+ enum: ["always", "never", "consecutive"],
60
+ },
61
+ let: {
62
+ enum: ["always", "never", "consecutive"],
63
+ },
64
+ const: {
65
+ enum: ["always", "never", "consecutive"],
66
+ },
67
+ using: {
68
+ enum: ["always", "never", "consecutive"],
69
+ },
70
+ awaitUsing: {
71
+ enum: ["always", "never", "consecutive"],
72
+ },
73
+ },
74
+ additionalProperties: false,
75
+ },
76
+ {
77
+ type: "object",
78
+ properties: {
79
+ initialized: {
80
+ enum: ["always", "never", "consecutive"],
81
+ },
82
+ uninitialized: {
83
+ enum: ["always", "never", "consecutive"],
84
+ },
85
+ },
86
+ additionalProperties: false,
87
+ },
88
+ ],
89
+ },
90
+ ],
91
+
92
+ messages: {
93
+ combineUninitialized:
94
+ "Combine this with the previous '{{type}}' statement with uninitialized variables.",
95
+ combineInitialized:
96
+ "Combine this with the previous '{{type}}' statement with initialized variables.",
97
+ splitUninitialized:
98
+ "Split uninitialized '{{type}}' declarations into multiple statements.",
99
+ splitInitialized:
100
+ "Split initialized '{{type}}' declarations into multiple statements.",
101
+ splitRequires:
102
+ "Split requires to be separated into a single block.",
103
+ combine: "Combine this with the previous '{{type}}' statement.",
104
+ split: "Split '{{type}}' declarations into multiple statements.",
105
+ },
106
+ },
107
+
108
+ create(context) {
109
+ const MODE_ALWAYS = "always";
110
+ const MODE_NEVER = "never";
111
+ const MODE_CONSECUTIVE = "consecutive";
112
+ const mode = context.options[0] || MODE_ALWAYS;
113
+
114
+ const options = {};
115
+
116
+ if (typeof mode === "string") {
117
+ // simple options configuration with just a string
118
+ options.var = { uninitialized: mode, initialized: mode };
119
+ options.let = { uninitialized: mode, initialized: mode };
120
+ options.const = { uninitialized: mode, initialized: mode };
121
+ options.using = { uninitialized: mode, initialized: mode };
122
+ options.awaitUsing = { uninitialized: mode, initialized: mode };
123
+ } else if (typeof mode === "object") {
124
+ // options configuration is an object
125
+ options.separateRequires = !!mode.separateRequires;
126
+ options.var = { uninitialized: mode.var, initialized: mode.var };
127
+ options.let = { uninitialized: mode.let, initialized: mode.let };
128
+ options.const = {
129
+ uninitialized: mode.const,
130
+ initialized: mode.const,
131
+ };
132
+ options.using = {
133
+ uninitialized: mode.using,
134
+ initialized: mode.using,
135
+ };
136
+ options.awaitUsing = {
137
+ uninitialized: mode.awaitUsing,
138
+ initialized: mode.awaitUsing,
139
+ };
140
+ if (Object.hasOwn(mode, "uninitialized")) {
141
+ options.var.uninitialized = mode.uninitialized;
142
+ options.let.uninitialized = mode.uninitialized;
143
+ options.const.uninitialized = mode.uninitialized;
144
+ options.using.uninitialized = mode.uninitialized;
145
+ options.awaitUsing.uninitialized = mode.uninitialized;
146
+ }
147
+ if (Object.hasOwn(mode, "initialized")) {
148
+ options.var.initialized = mode.initialized;
149
+ options.let.initialized = mode.initialized;
150
+ options.const.initialized = mode.initialized;
151
+ options.using.initialized = mode.initialized;
152
+ options.awaitUsing.initialized = mode.initialized;
153
+ }
154
+ }
155
+
156
+ const sourceCode = context.sourceCode;
157
+
158
+ //--------------------------------------------------------------------------
159
+ // Helpers
160
+ //--------------------------------------------------------------------------
161
+
162
+ const functionStack = [];
163
+ const blockStack = [];
164
+
165
+ /**
166
+ * Increments the blockStack counter.
167
+ * @returns {void}
168
+ * @private
169
+ */
170
+ function startBlock() {
171
+ blockStack.push({
172
+ let: { initialized: false, uninitialized: false },
173
+ const: { initialized: false, uninitialized: false },
174
+ using: { initialized: false, uninitialized: false },
175
+ awaitUsing: { initialized: false, uninitialized: false },
176
+ });
177
+ }
178
+
179
+ /**
180
+ * Increments the functionStack counter.
181
+ * @returns {void}
182
+ * @private
183
+ */
184
+ function startFunction() {
185
+ functionStack.push({ initialized: false, uninitialized: false });
186
+ startBlock();
187
+ }
188
+
189
+ /**
190
+ * Decrements the blockStack counter.
191
+ * @returns {void}
192
+ * @private
193
+ */
194
+ function endBlock() {
195
+ blockStack.pop();
196
+ }
197
+
198
+ /**
199
+ * Decrements the functionStack counter.
200
+ * @returns {void}
201
+ * @private
202
+ */
203
+ function endFunction() {
204
+ functionStack.pop();
205
+ endBlock();
206
+ }
207
+
208
+ /**
209
+ * Check if a variable declaration is a require.
210
+ * @param {ASTNode} decl variable declaration Node
211
+ * @returns {bool} if decl is a require, return true; else return false.
212
+ * @private
213
+ */
214
+ function isRequire(decl) {
215
+ return (
216
+ decl.init &&
217
+ decl.init.type === "CallExpression" &&
218
+ decl.init.callee.name === "require"
219
+ );
220
+ }
221
+
222
+ /**
223
+ * Records whether initialized/uninitialized/required variables are defined in current scope.
224
+ * @param {string} statementType one of: "var", "let", "const", "using", or "awaitUsing"
225
+ * @param {ASTNode[]} declarations List of declarations
226
+ * @param {Object} currentScope The scope being investigated
227
+ * @returns {void}
228
+ * @private
229
+ */
230
+ function recordTypes(statementType, declarations, currentScope) {
231
+ for (let i = 0; i < declarations.length; i++) {
232
+ if (declarations[i].init === null) {
233
+ if (
234
+ options[statementType] &&
235
+ options[statementType].uninitialized === MODE_ALWAYS
236
+ ) {
237
+ currentScope.uninitialized = true;
238
+ }
239
+ } else {
240
+ if (
241
+ options[statementType] &&
242
+ options[statementType].initialized === MODE_ALWAYS
243
+ ) {
244
+ if (
245
+ options.separateRequires &&
246
+ isRequire(declarations[i])
247
+ ) {
248
+ currentScope.required = true;
249
+ } else {
250
+ currentScope.initialized = true;
251
+ }
252
+ }
253
+ }
254
+ }
255
+ }
256
+
257
+ /**
258
+ * Determines the current scope (function or block)
259
+ * @param {string} statementType one of: "var", "let", "const", "using", or "awaitUsing"
260
+ * @returns {Object} The scope associated with statementType
261
+ */
262
+ function getCurrentScope(statementType) {
263
+ let currentScope;
264
+
265
+ if (statementType === "var") {
266
+ currentScope = functionStack.at(-1);
267
+ } else if (statementType === "let") {
268
+ currentScope = blockStack.at(-1).let;
269
+ } else if (statementType === "const") {
270
+ currentScope = blockStack.at(-1).const;
271
+ } else if (statementType === "using") {
272
+ currentScope = blockStack.at(-1).using;
273
+ } else if (statementType === "awaitUsing") {
274
+ currentScope = blockStack.at(-1).awaitUsing;
275
+ }
276
+ return currentScope;
277
+ }
278
+
279
+ /**
280
+ * Counts the number of initialized and uninitialized declarations in a list of declarations
281
+ * @param {ASTNode[]} declarations List of declarations
282
+ * @returns {Object} Counts of 'uninitialized' and 'initialized' declarations
283
+ * @private
284
+ */
285
+ function countDeclarations(declarations) {
286
+ const counts = { uninitialized: 0, initialized: 0 };
287
+
288
+ for (let i = 0; i < declarations.length; i++) {
289
+ if (declarations[i].init === null) {
290
+ counts.uninitialized++;
291
+ } else {
292
+ counts.initialized++;
293
+ }
294
+ }
295
+ return counts;
296
+ }
297
+
298
+ /**
299
+ * Determines if there is more than one var statement in the current scope.
300
+ * @param {string} statementType one of: "var", "let", "const", "using", or "awaitUsing"
301
+ * @param {ASTNode[]} declarations List of declarations
302
+ * @returns {boolean} Returns true if it is the first var declaration, false if not.
303
+ * @private
304
+ */
305
+ function hasOnlyOneStatement(statementType, declarations) {
306
+ const declarationCounts = countDeclarations(declarations);
307
+ const currentOptions = options[statementType] || {};
308
+ const currentScope = getCurrentScope(statementType);
309
+ const hasRequires = declarations.some(isRequire);
310
+
311
+ if (
312
+ currentOptions.uninitialized === MODE_ALWAYS &&
313
+ currentOptions.initialized === MODE_ALWAYS
314
+ ) {
315
+ if (currentScope.uninitialized || currentScope.initialized) {
316
+ if (!hasRequires) {
317
+ return false;
318
+ }
319
+ }
320
+ }
321
+
322
+ if (declarationCounts.uninitialized > 0) {
323
+ if (
324
+ currentOptions.uninitialized === MODE_ALWAYS &&
325
+ currentScope.uninitialized
326
+ ) {
327
+ return false;
328
+ }
329
+ }
330
+ if (declarationCounts.initialized > 0) {
331
+ if (
332
+ currentOptions.initialized === MODE_ALWAYS &&
333
+ currentScope.initialized
334
+ ) {
335
+ if (!hasRequires) {
336
+ return false;
337
+ }
338
+ }
339
+ }
340
+ if (currentScope.required && hasRequires) {
341
+ return false;
342
+ }
343
+ recordTypes(statementType, declarations, currentScope);
344
+ return true;
345
+ }
346
+
347
+ /**
348
+ * Fixer to join VariableDeclaration's into a single declaration
349
+ * @param {VariableDeclarator[]} declarations The `VariableDeclaration` to join
350
+ * @returns {Function} The fixer function
351
+ */
352
+ function joinDeclarations(declarations) {
353
+ const declaration = declarations[0];
354
+ const body = Array.isArray(declaration.parent.parent.body)
355
+ ? declaration.parent.parent.body
356
+ : [];
357
+ const currentIndex = body.findIndex(
358
+ node => node.range[0] === declaration.parent.range[0],
359
+ );
360
+ const previousNode = body[currentIndex - 1];
361
+
362
+ return function* joinDeclarationsFixer(fixer) {
363
+ const type = sourceCode.getFirstToken(declaration.parent);
364
+ const beforeType = sourceCode.getTokenBefore(type);
365
+
366
+ if (
367
+ previousNode &&
368
+ previousNode.kind === declaration.parent.kind
369
+ ) {
370
+ if (beforeType.value === ";") {
371
+ yield fixer.replaceText(beforeType, ",");
372
+ } else {
373
+ yield fixer.insertTextAfter(beforeType, ",");
374
+ }
375
+
376
+ if (declaration.parent.kind === "await using") {
377
+ const usingToken = sourceCode.getTokenAfter(type);
378
+ yield fixer.remove(usingToken);
379
+ }
380
+
381
+ yield fixer.replaceText(type, "");
382
+ }
383
+ };
384
+ }
385
+
386
+ /**
387
+ * Fixer to split a VariableDeclaration into individual declarations
388
+ * @param {VariableDeclaration} declaration The `VariableDeclaration` to split
389
+ * @returns {Function|null} The fixer function
390
+ */
391
+ function splitDeclarations(declaration) {
392
+ const { parent } = declaration;
393
+
394
+ // don't autofix code such as: if (foo) var x, y;
395
+ if (
396
+ !isInStatementList(
397
+ parent.type === "ExportNamedDeclaration"
398
+ ? parent
399
+ : declaration,
400
+ )
401
+ ) {
402
+ return null;
403
+ }
404
+
405
+ return fixer =>
406
+ declaration.declarations
407
+ .map(declarator => {
408
+ const tokenAfterDeclarator =
409
+ sourceCode.getTokenAfter(declarator);
410
+
411
+ if (tokenAfterDeclarator === null) {
412
+ return null;
413
+ }
414
+
415
+ const afterComma = sourceCode.getTokenAfter(
416
+ tokenAfterDeclarator,
417
+ { includeComments: true },
418
+ );
419
+
420
+ if (tokenAfterDeclarator.value !== ",") {
421
+ return null;
422
+ }
423
+
424
+ const exportPlacement =
425
+ declaration.parent.type === "ExportNamedDeclaration"
426
+ ? "export "
427
+ : "";
428
+
429
+ /*
430
+ * `var x,y`
431
+ * tokenAfterDeclarator ^^ afterComma
432
+ */
433
+ if (
434
+ afterComma.range[0] ===
435
+ tokenAfterDeclarator.range[1]
436
+ ) {
437
+ return fixer.replaceText(
438
+ tokenAfterDeclarator,
439
+ `; ${exportPlacement}${declaration.kind} `,
440
+ );
441
+ }
442
+
443
+ /*
444
+ * `var x,
445
+ * tokenAfterDeclarator ^
446
+ * y`
447
+ * ^ afterComma
448
+ */
449
+ if (
450
+ afterComma.loc.start.line >
451
+ tokenAfterDeclarator.loc.end.line ||
452
+ afterComma.type === "Line" ||
453
+ afterComma.type === "Block"
454
+ ) {
455
+ let lastComment = afterComma;
456
+
457
+ while (
458
+ lastComment.type === "Line" ||
459
+ lastComment.type === "Block"
460
+ ) {
461
+ lastComment = sourceCode.getTokenAfter(
462
+ lastComment,
463
+ { includeComments: true },
464
+ );
465
+ }
466
+
467
+ return fixer.replaceTextRange(
468
+ [
469
+ tokenAfterDeclarator.range[0],
470
+ lastComment.range[0],
471
+ ],
472
+ `;${sourceCode.text.slice(
473
+ tokenAfterDeclarator.range[1],
474
+ lastComment.range[0],
475
+ )}${exportPlacement}${declaration.kind} `,
476
+ );
477
+ }
478
+
479
+ return fixer.replaceText(
480
+ tokenAfterDeclarator,
481
+ `; ${exportPlacement}${declaration.kind}`,
482
+ );
483
+ })
484
+ .filter(x => x);
485
+ }
486
+
487
+ /**
488
+ * Checks a given VariableDeclaration node for errors.
489
+ * @param {ASTNode} node The VariableDeclaration node to check
490
+ * @returns {void}
491
+ * @private
492
+ */
493
+ function checkVariableDeclaration(node) {
494
+ const parent = node.parent;
495
+ const type = node.kind;
496
+ const key = type === "await using" ? "awaitUsing" : type;
497
+
498
+ if (!options[key]) {
499
+ return;
500
+ }
501
+
502
+ const declarations = node.declarations;
503
+ const declarationCounts = countDeclarations(declarations);
504
+ const mixedRequires =
505
+ declarations.some(isRequire) && !declarations.every(isRequire);
506
+
507
+ if (options[key].initialized === MODE_ALWAYS) {
508
+ if (options.separateRequires && mixedRequires) {
509
+ context.report({
510
+ node,
511
+ messageId: "splitRequires",
512
+ });
513
+ }
514
+ }
515
+
516
+ // consecutive
517
+ const nodeIndex =
518
+ (parent.body &&
519
+ parent.body.length > 0 &&
520
+ parent.body.indexOf(node)) ||
521
+ 0;
522
+
523
+ if (nodeIndex > 0) {
524
+ const previousNode = parent.body[nodeIndex - 1];
525
+ const isPreviousNodeDeclaration =
526
+ previousNode.type === "VariableDeclaration";
527
+ const declarationsWithPrevious = declarations.concat(
528
+ previousNode.declarations || [],
529
+ );
530
+
531
+ if (
532
+ isPreviousNodeDeclaration &&
533
+ previousNode.kind === type &&
534
+ !(
535
+ declarationsWithPrevious.some(isRequire) &&
536
+ !declarationsWithPrevious.every(isRequire)
537
+ )
538
+ ) {
539
+ const previousDeclCounts = countDeclarations(
540
+ previousNode.declarations,
541
+ );
542
+
543
+ if (
544
+ options[key].initialized === MODE_CONSECUTIVE &&
545
+ options[key].uninitialized === MODE_CONSECUTIVE
546
+ ) {
547
+ context.report({
548
+ node,
549
+ messageId: "combine",
550
+ data: {
551
+ type,
552
+ },
553
+ fix: joinDeclarations(declarations),
554
+ });
555
+ } else if (
556
+ options[key].initialized === MODE_CONSECUTIVE &&
557
+ declarationCounts.initialized > 0 &&
558
+ previousDeclCounts.initialized > 0
559
+ ) {
560
+ context.report({
561
+ node,
562
+ messageId: "combineInitialized",
563
+ data: {
564
+ type,
565
+ },
566
+ fix: joinDeclarations(declarations),
567
+ });
568
+ } else if (
569
+ options[key].uninitialized === MODE_CONSECUTIVE &&
570
+ declarationCounts.uninitialized > 0 &&
571
+ previousDeclCounts.uninitialized > 0
572
+ ) {
573
+ context.report({
574
+ node,
575
+ messageId: "combineUninitialized",
576
+ data: {
577
+ type,
578
+ },
579
+ fix: joinDeclarations(declarations),
580
+ });
581
+ }
582
+ }
583
+ }
584
+
585
+ // always
586
+ if (!hasOnlyOneStatement(key, declarations)) {
587
+ if (
588
+ options[key].initialized === MODE_ALWAYS &&
589
+ options[key].uninitialized === MODE_ALWAYS
590
+ ) {
591
+ context.report({
592
+ node,
593
+ messageId: "combine",
594
+ data: {
595
+ type,
596
+ },
597
+ fix: joinDeclarations(declarations),
598
+ });
599
+ } else {
600
+ if (
601
+ options[key].initialized === MODE_ALWAYS &&
602
+ declarationCounts.initialized > 0
603
+ ) {
604
+ context.report({
605
+ node,
606
+ messageId: "combineInitialized",
607
+ data: {
608
+ type,
609
+ },
610
+ fix: joinDeclarations(declarations),
611
+ });
612
+ }
613
+ if (
614
+ options[key].uninitialized === MODE_ALWAYS &&
615
+ declarationCounts.uninitialized > 0
616
+ ) {
617
+ if (
618
+ node.parent.left === node &&
619
+ (node.parent.type === "ForInStatement" ||
620
+ node.parent.type === "ForOfStatement")
621
+ ) {
622
+ return;
623
+ }
624
+ context.report({
625
+ node,
626
+ messageId: "combineUninitialized",
627
+ data: {
628
+ type,
629
+ },
630
+ fix: joinDeclarations(declarations),
631
+ });
632
+ }
633
+ }
634
+ }
635
+
636
+ // never
637
+ if (parent.type !== "ForStatement" || parent.init !== node) {
638
+ const totalDeclarations =
639
+ declarationCounts.uninitialized +
640
+ declarationCounts.initialized;
641
+
642
+ if (totalDeclarations > 1) {
643
+ if (
644
+ options[key].initialized === MODE_NEVER &&
645
+ options[key].uninitialized === MODE_NEVER
646
+ ) {
647
+ // both initialized and uninitialized
648
+ context.report({
649
+ node,
650
+ messageId: "split",
651
+ data: {
652
+ type,
653
+ },
654
+ fix: splitDeclarations(node),
655
+ });
656
+ } else if (
657
+ options[key].initialized === MODE_NEVER &&
658
+ declarationCounts.initialized > 0
659
+ ) {
660
+ // initialized
661
+ context.report({
662
+ node,
663
+ messageId: "splitInitialized",
664
+ data: {
665
+ type,
666
+ },
667
+ fix: splitDeclarations(node),
668
+ });
669
+ } else if (
670
+ options[key].uninitialized === MODE_NEVER &&
671
+ declarationCounts.uninitialized > 0
672
+ ) {
673
+ // uninitialized
674
+ context.report({
675
+ node,
676
+ messageId: "splitUninitialized",
677
+ data: {
678
+ type,
679
+ },
680
+ fix: splitDeclarations(node),
681
+ });
682
+ }
683
+ }
684
+ }
685
+ }
686
+
687
+ //--------------------------------------------------------------------------
688
+ // Public API
689
+ //--------------------------------------------------------------------------
690
+
691
+ return {
692
+ Program: startFunction,
693
+ FunctionDeclaration: startFunction,
694
+ FunctionExpression: startFunction,
695
+ ArrowFunctionExpression: startFunction,
696
+ StaticBlock: startFunction, // StaticBlock creates a new scope for `var` variables
697
+
698
+ BlockStatement: startBlock,
699
+ ForStatement: startBlock,
700
+ ForInStatement: startBlock,
701
+ ForOfStatement: startBlock,
702
+ SwitchStatement: startBlock,
703
+ VariableDeclaration: checkVariableDeclaration,
704
+ "ForStatement:exit": endBlock,
705
+ "ForOfStatement:exit": endBlock,
706
+ "ForInStatement:exit": endBlock,
707
+ "SwitchStatement:exit": endBlock,
708
+ "BlockStatement:exit": endBlock,
709
+
710
+ "Program:exit": endFunction,
711
+ "FunctionDeclaration:exit": endFunction,
712
+ "FunctionExpression:exit": endFunction,
713
+ "ArrowFunctionExpression:exit": endFunction,
714
+ "StaticBlock:exit": endFunction,
715
+ };
716
+ },
567
717
  };