eslint 9.22.0 → 9.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/README.md +48 -46
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +830 -810
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +638 -457
  21. package/lib/config/config-loader.js +726 -622
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +72 -72
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +756 -681
  30. package/lib/eslint/eslint.js +934 -912
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +577 -533
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2403 -2045
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +36 -36
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +404 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1308 -1046
  73. package/lib/rules/accessor-pairs.js +298 -263
  74. package/lib/rules/array-bracket-newline.js +250 -238
  75. package/lib/rules/array-bracket-spacing.js +263 -224
  76. package/lib/rules/array-callback-return.js +402 -356
  77. package/lib/rules/array-element-newline.js +358 -313
  78. package/lib/rules/arrow-body-style.js +400 -281
  79. package/lib/rules/arrow-parens.js +206 -173
  80. package/lib/rules/arrow-spacing.js +169 -163
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -176
  83. package/lib/rules/brace-style.js +262 -199
  84. package/lib/rules/callback-return.js +203 -190
  85. package/lib/rules/camelcase.js +403 -392
  86. package/lib/rules/capitalized-comments.js +253 -232
  87. package/lib/rules/class-methods-use-this.js +224 -172
  88. package/lib/rules/comma-dangle.js +379 -346
  89. package/lib/rules/comma-spacing.js +193 -195
  90. package/lib/rules/comma-style.js +375 -316
  91. package/lib/rules/complexity.js +173 -169
  92. package/lib/rules/computed-property-spacing.js +236 -211
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -147
  95. package/lib/rules/constructor-super.js +412 -404
  96. package/lib/rules/curly.js +407 -332
  97. package/lib/rules/default-case-last.js +38 -31
  98. package/lib/rules/default-case.js +89 -85
  99. package/lib/rules/default-param-last.js +69 -54
  100. package/lib/rules/dot-location.js +122 -110
  101. package/lib/rules/dot-notation.js +192 -156
  102. package/lib/rules/eol-last.js +122 -120
  103. package/lib/rules/eqeqeq.js +168 -155
  104. package/lib/rules/for-direction.js +146 -121
  105. package/lib/rules/func-call-spacing.js +261 -231
  106. package/lib/rules/func-name-matching.js +293 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +159 -127
  109. package/lib/rules/function-call-argument-newline.js +152 -129
  110. package/lib/rules/function-paren-newline.js +349 -291
  111. package/lib/rules/generator-star-spacing.js +229 -210
  112. package/lib/rules/getter-return.js +208 -172
  113. package/lib/rules/global-require.js +85 -74
  114. package/lib/rules/grouped-accessor-pairs.js +170 -150
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -103
  117. package/lib/rules/id-blacklist.js +182 -199
  118. package/lib/rules/id-denylist.js +168 -187
  119. package/lib/rules/id-length.js +197 -171
  120. package/lib/rules/id-match.js +344 -289
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -79
  122. package/lib/rules/indent-legacy.js +1344 -1118
  123. package/lib/rules/indent.js +2272 -1759
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +137 -107
  126. package/lib/rules/jsx-quotes.js +94 -82
  127. package/lib/rules/key-spacing.js +750 -633
  128. package/lib/rules/keyword-spacing.js +648 -605
  129. package/lib/rules/line-comment-position.js +142 -128
  130. package/lib/rules/linebreak-style.js +107 -106
  131. package/lib/rules/lines-around-comment.js +540 -448
  132. package/lib/rules/lines-around-directive.js +233 -203
  133. package/lib/rules/lines-between-class-members.js +305 -234
  134. package/lib/rules/logical-assignment-operators.js +582 -399
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -434
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +78 -76
  142. package/lib/rules/max-statements-per-line.js +205 -198
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +637 -479
  145. package/lib/rules/multiline-ternary.js +241 -176
  146. package/lib/rules/new-cap.js +233 -213
  147. package/lib/rules/new-parens.js +88 -79
  148. package/lib/rules/newline-after-var.js +287 -250
  149. package/lib/rules/newline-before-return.js +229 -222
  150. package/lib/rules/newline-per-chained-call.js +142 -127
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +125 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +69 -71
  155. package/lib/rules/no-bitwise.js +124 -100
  156. package/lib/rules/no-buffer-constructor.js +55 -47
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -57
  159. package/lib/rules/no-catch-shadow.js +76 -73
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -81
  164. package/lib/rules/no-console.js +202 -199
  165. package/lib/rules/no-const-assign.js +47 -41
  166. package/lib/rules/no-constant-binary-expression.js +500 -405
  167. package/lib/rules/no-constant-condition.js +158 -143
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -27
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -41
  174. package/lib/rules/no-dupe-args.js +68 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +179 -176
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +127 -128
  183. package/lib/rules/no-empty-pattern.js +63 -58
  184. package/lib/rules/no-empty-static-block.js +37 -35
  185. package/lib/rules/no-empty.js +98 -86
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +256 -250
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -159
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -348
  192. package/lib/rules/no-extra-label.js +150 -131
  193. package/lib/rules/no-extra-parens.js +1654 -1325
  194. package/lib/rules/no-extra-semi.js +146 -144
  195. package/lib/rules/no-fallthrough.js +199 -157
  196. package/lib/rules/no-floating-decimal.js +74 -66
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -73
  199. package/lib/rules/no-implicit-coercion.js +349 -293
  200. package/lib/rules/no-implicit-globals.js +158 -135
  201. package/lib/rules/no-implied-eval.js +140 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -95
  204. package/lib/rules/no-inner-declarations.js +115 -101
  205. package/lib/rules/no-invalid-regexp.js +222 -190
  206. package/lib/rules/no-invalid-this.js +123 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -252
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -62
  210. package/lib/rules/no-labels.js +138 -133
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +108 -77
  213. package/lib/rules/no-loop-func.js +238 -213
  214. package/lib/rules/no-loss-of-precision.js +218 -201
  215. package/lib/rules/no-magic-numbers.js +246 -218
  216. package/lib/rules/no-misleading-character-class.js +499 -446
  217. package/lib/rules/no-mixed-operators.js +188 -182
  218. package/lib/rules/no-mixed-requires.js +253 -240
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +134 -121
  220. package/lib/rules/no-multi-assign.js +46 -44
  221. package/lib/rules/no-multi-spaces.js +163 -143
  222. package/lib/rules/no-multi-str.js +42 -41
  223. package/lib/rules/no-multiple-empty-lines.js +196 -158
  224. package/lib/rules/no-native-reassign.js +90 -85
  225. package/lib/rules/no-negated-condition.js +79 -75
  226. package/lib/rules/no-negated-in-lhs.js +45 -43
  227. package/lib/rules/no-nested-ternary.js +33 -32
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -48
  231. package/lib/rules/no-new-require.js +48 -47
  232. package/lib/rules/no-new-symbol.js +52 -50
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +141 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +32 -32
  240. package/lib/rules/no-param-reassign.js +235 -217
  241. package/lib/rules/no-path-concat.js +66 -67
  242. package/lib/rules/no-plusplus.js +60 -61
  243. package/lib/rules/no-process-env.js +49 -48
  244. package/lib/rules/no-process-exit.js +54 -50
  245. package/lib/rules/no-promise-executor-return.js +214 -182
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -152
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -185
  251. package/lib/rules/no-restricted-globals.js +111 -112
  252. package/lib/rules/no-restricted-imports.js +657 -537
  253. package/lib/rules/no-restricted-modules.js +222 -202
  254. package/lib/rules/no-restricted-properties.js +181 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +55 -50
  257. package/lib/rules/no-return-await.js +148 -124
  258. package/lib/rules/no-script-url.js +52 -45
  259. package/lib/rules/no-self-assign.js +148 -146
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -116
  262. package/lib/rules/no-setter-return.js +185 -152
  263. package/lib/rules/no-shadow-restricted-names.js +61 -46
  264. package/lib/rules/no-shadow.js +342 -316
  265. package/lib/rules/no-spaced-func.js +82 -77
  266. package/lib/rules/no-sparse-arrays.js +54 -59
  267. package/lib/rules/no-sync.js +61 -60
  268. package/lib/rules/no-tabs.js +83 -72
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -29
  271. package/lib/rules/no-this-before-super.js +321 -319
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +199 -191
  274. package/lib/rules/no-undef-init.js +76 -61
  275. package/lib/rules/no-undef.js +51 -48
  276. package/lib/rules/no-undefined.js +73 -75
  277. package/lib/rules/no-underscore-dangle.js +370 -327
  278. package/lib/rules/no-unexpected-multiline.js +112 -102
  279. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  280. package/lib/rules/no-unneeded-ternary.js +212 -147
  281. package/lib/rules/no-unreachable-loop.js +145 -142
  282. package/lib/rules/no-unreachable.js +255 -248
  283. package/lib/rules/no-unsafe-finally.js +93 -85
  284. package/lib/rules/no-unsafe-negation.js +105 -83
  285. package/lib/rules/no-unsafe-optional-chaining.js +192 -178
  286. package/lib/rules/no-unused-expressions.js +178 -162
  287. package/lib/rules/no-unused-labels.js +139 -124
  288. package/lib/rules/no-unused-private-class-members.js +206 -182
  289. package/lib/rules/no-unused-vars.js +1669 -1449
  290. package/lib/rules/no-use-before-define.js +229 -231
  291. package/lib/rules/no-useless-assignment.js +590 -511
  292. package/lib/rules/no-useless-backreference.js +212 -193
  293. package/lib/rules/no-useless-call.js +58 -53
  294. package/lib/rules/no-useless-catch.js +40 -40
  295. package/lib/rules/no-useless-computed-key.js +144 -115
  296. package/lib/rules/no-useless-concat.js +65 -60
  297. package/lib/rules/no-useless-constructor.js +158 -111
  298. package/lib/rules/no-useless-escape.js +342 -291
  299. package/lib/rules/no-useless-rename.js +183 -156
  300. package/lib/rules/no-useless-return.js +344 -312
  301. package/lib/rules/no-var.js +233 -212
  302. package/lib/rules/no-void.js +50 -48
  303. package/lib/rules/no-warning-comments.js +191 -186
  304. package/lib/rules/no-whitespace-before-property.js +131 -115
  305. package/lib/rules/no-with.js +24 -26
  306. package/lib/rules/nonblock-statement-body-position.js +149 -130
  307. package/lib/rules/object-curly-newline.js +306 -265
  308. package/lib/rules/object-curly-spacing.js +360 -314
  309. package/lib/rules/object-property-newline.js +137 -106
  310. package/lib/rules/object-shorthand.js +607 -502
  311. package/lib/rules/one-var-declaration-per-line.js +104 -100
  312. package/lib/rules/one-var.js +653 -537
  313. package/lib/rules/operator-assignment.js +219 -161
  314. package/lib/rules/operator-linebreak.js +295 -251
  315. package/lib/rules/padded-blocks.js +346 -308
  316. package/lib/rules/padding-line-between-statements.js +443 -439
  317. package/lib/rules/prefer-arrow-callback.js +362 -313
  318. package/lib/rules/prefer-const.js +418 -377
  319. package/lib/rules/prefer-destructuring.js +301 -279
  320. package/lib/rules/prefer-exponentiation-operator.js +176 -133
  321. package/lib/rules/prefer-named-capture-group.js +153 -140
  322. package/lib/rules/prefer-numeric-literals.js +121 -113
  323. package/lib/rules/prefer-object-has-own.js +116 -82
  324. package/lib/rules/prefer-object-spread.js +213 -193
  325. package/lib/rules/prefer-promise-reject-errors.js +140 -122
  326. package/lib/rules/prefer-reflect.js +127 -107
  327. package/lib/rules/prefer-regex-literals.js +578 -466
  328. package/lib/rules/prefer-rest-params.js +79 -80
  329. package/lib/rules/prefer-spread.js +47 -44
  330. package/lib/rules/prefer-template.js +266 -195
  331. package/lib/rules/quote-props.js +373 -307
  332. package/lib/rules/quotes.js +374 -326
  333. package/lib/rules/radix.js +152 -136
  334. package/lib/rules/require-atomic-updates.js +316 -285
  335. package/lib/rules/require-await.js +144 -116
  336. package/lib/rules/require-unicode-regexp.js +282 -177
  337. package/lib/rules/require-yield.js +53 -54
  338. package/lib/rules/rest-spread-spacing.js +128 -116
  339. package/lib/rules/semi-spacing.js +281 -250
  340. package/lib/rules/semi-style.js +176 -134
  341. package/lib/rules/semi.js +456 -436
  342. package/lib/rules/sort-imports.js +306 -233
  343. package/lib/rules/sort-keys.js +219 -188
  344. package/lib/rules/sort-vars.js +127 -93
  345. package/lib/rules/space-before-blocks.js +199 -189
  346. package/lib/rules/space-before-function-paren.js +186 -166
  347. package/lib/rules/space-in-parens.js +359 -288
  348. package/lib/rules/space-infix-ops.js +237 -201
  349. package/lib/rules/space-unary-ops.js +356 -298
  350. package/lib/rules/spaced-comment.js +363 -319
  351. package/lib/rules/strict.js +265 -230
  352. package/lib/rules/switch-colon-spacing.js +130 -122
  353. package/lib/rules/symbol-description.js +45 -48
  354. package/lib/rules/template-curly-spacing.js +148 -142
  355. package/lib/rules/template-tag-spacing.js +98 -88
  356. package/lib/rules/unicode-bom.js +54 -56
  357. package/lib/rules/use-isnan.js +237 -206
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +153 -111
  370. package/lib/rules/vars-on-top.js +152 -145
  371. package/lib/rules/wrap-iife.js +204 -191
  372. package/lib/rules/wrap-regex.js +70 -58
  373. package/lib/rules/yield-star-spacing.js +145 -134
  374. package/lib/rules/yoda.js +283 -272
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/services/suppressions-service.js +289 -0
  378. package/lib/shared/ajv.js +14 -14
  379. package/lib/shared/assert.js +3 -4
  380. package/lib/shared/ast-utils.js +7 -6
  381. package/lib/shared/deep-merge-arrays.js +24 -22
  382. package/lib/shared/directives.js +3 -2
  383. package/lib/shared/flags.js +50 -17
  384. package/lib/shared/logging.js +24 -25
  385. package/lib/shared/option-utils.js +43 -36
  386. package/lib/shared/runtime-info.js +136 -127
  387. package/lib/shared/serialization.js +27 -27
  388. package/lib/shared/severity.js +22 -22
  389. package/lib/shared/stats.js +5 -5
  390. package/lib/shared/string-utils.js +16 -16
  391. package/lib/shared/text-table.js +28 -27
  392. package/lib/shared/traverser.js +153 -146
  393. package/lib/shared/types.js +4 -27
  394. package/lib/types/index.d.ts +2010 -1559
  395. package/lib/types/rules.d.ts +5253 -5140
  396. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  397. package/lib/unsupported-api.js +5 -5
  398. package/messages/all-files-ignored.js +3 -3
  399. package/messages/all-matched-files-ignored.js +3 -3
  400. package/messages/config-file-missing.js +2 -2
  401. package/messages/config-plugin-missing.js +3 -3
  402. package/messages/config-serialize-function.js +9 -7
  403. package/messages/eslintrc-incompat.js +13 -15
  404. package/messages/eslintrc-plugins.js +3 -4
  405. package/messages/extend-config-missing.js +3 -3
  406. package/messages/failed-to-read-json.js +3 -3
  407. package/messages/file-not-found.js +3 -3
  408. package/messages/invalid-rule-options.js +2 -2
  409. package/messages/invalid-rule-severity.js +2 -2
  410. package/messages/no-config-found.js +3 -3
  411. package/messages/plugin-conflict.js +8 -8
  412. package/messages/plugin-invalid.js +3 -3
  413. package/messages/plugin-missing.js +3 -3
  414. package/messages/print-config-with-directory-path.js +2 -2
  415. package/messages/shared.js +6 -1
  416. package/messages/whitespace-found.js +3 -3
  417. package/package.json +14 -20
@@ -21,548 +21,664 @@ 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
- frozen: true,
40
- url: "https://eslint.org/docs/latest/rules/one-var"
41
- },
42
-
43
- fixable: "code",
44
-
45
- schema: [
46
- {
47
- oneOf: [
48
- {
49
- enum: ["always", "never", "consecutive"]
50
- },
51
- {
52
- type: "object",
53
- properties: {
54
- separateRequires: {
55
- type: "boolean"
56
- },
57
- var: {
58
- enum: ["always", "never", "consecutive"]
59
- },
60
- let: {
61
- enum: ["always", "never", "consecutive"]
62
- },
63
- const: {
64
- enum: ["always", "never", "consecutive"]
65
- }
66
- },
67
- additionalProperties: false
68
- },
69
- {
70
- type: "object",
71
- properties: {
72
- initialized: {
73
- enum: ["always", "never", "consecutive"]
74
- },
75
- uninitialized: {
76
- enum: ["always", "never", "consecutive"]
77
- }
78
- },
79
- additionalProperties: false
80
- }
81
- ]
82
- }
83
- ],
84
-
85
- messages: {
86
- combineUninitialized: "Combine this with the previous '{{type}}' statement with uninitialized variables.",
87
- combineInitialized: "Combine this with the previous '{{type}}' statement with initialized variables.",
88
- splitUninitialized: "Split uninitialized '{{type}}' declarations into multiple statements.",
89
- splitInitialized: "Split initialized '{{type}}' declarations into multiple statements.",
90
- splitRequires: "Split requires to be separated into a single block.",
91
- combine: "Combine this with the previous '{{type}}' statement.",
92
- split: "Split '{{type}}' declarations into multiple statements."
93
- }
94
- },
95
-
96
- create(context) {
97
- const MODE_ALWAYS = "always";
98
- const MODE_NEVER = "never";
99
- const MODE_CONSECUTIVE = "consecutive";
100
- const mode = context.options[0] || MODE_ALWAYS;
101
-
102
- const options = {};
103
-
104
- if (typeof mode === "string") { // simple options configuration with just a string
105
- options.var = { uninitialized: mode, initialized: mode };
106
- options.let = { uninitialized: mode, initialized: mode };
107
- options.const = { uninitialized: mode, initialized: mode };
108
- } else if (typeof mode === "object") { // options configuration is an object
109
- options.separateRequires = !!mode.separateRequires;
110
- options.var = { uninitialized: mode.var, initialized: mode.var };
111
- options.let = { uninitialized: mode.let, initialized: mode.let };
112
- options.const = { uninitialized: mode.const, initialized: mode.const };
113
- if (Object.hasOwn(mode, "uninitialized")) {
114
- options.var.uninitialized = mode.uninitialized;
115
- options.let.uninitialized = mode.uninitialized;
116
- options.const.uninitialized = mode.uninitialized;
117
- }
118
- if (Object.hasOwn(mode, "initialized")) {
119
- options.var.initialized = mode.initialized;
120
- options.let.initialized = mode.initialized;
121
- options.const.initialized = mode.initialized;
122
- }
123
- }
124
-
125
- const sourceCode = context.sourceCode;
126
-
127
- //--------------------------------------------------------------------------
128
- // Helpers
129
- //--------------------------------------------------------------------------
130
-
131
- const functionStack = [];
132
- const blockStack = [];
133
-
134
- /**
135
- * Increments the blockStack counter.
136
- * @returns {void}
137
- * @private
138
- */
139
- function startBlock() {
140
- blockStack.push({
141
- let: { initialized: false, uninitialized: false },
142
- const: { initialized: false, uninitialized: false }
143
- });
144
- }
145
-
146
- /**
147
- * Increments the functionStack counter.
148
- * @returns {void}
149
- * @private
150
- */
151
- function startFunction() {
152
- functionStack.push({ initialized: false, uninitialized: false });
153
- startBlock();
154
- }
155
-
156
- /**
157
- * Decrements the blockStack counter.
158
- * @returns {void}
159
- * @private
160
- */
161
- function endBlock() {
162
- blockStack.pop();
163
- }
164
-
165
- /**
166
- * Decrements the functionStack counter.
167
- * @returns {void}
168
- * @private
169
- */
170
- function endFunction() {
171
- functionStack.pop();
172
- endBlock();
173
- }
174
-
175
- /**
176
- * Check if a variable declaration is a require.
177
- * @param {ASTNode} decl variable declaration Node
178
- * @returns {bool} if decl is a require, return true; else return false.
179
- * @private
180
- */
181
- function isRequire(decl) {
182
- return decl.init && decl.init.type === "CallExpression" && decl.init.callee.name === "require";
183
- }
184
-
185
- /**
186
- * Records whether initialized/uninitialized/required variables are defined in current scope.
187
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
188
- * @param {ASTNode[]} declarations List of declarations
189
- * @param {Object} currentScope The scope being investigated
190
- * @returns {void}
191
- * @private
192
- */
193
- function recordTypes(statementType, declarations, currentScope) {
194
- for (let i = 0; i < declarations.length; i++) {
195
- if (declarations[i].init === null) {
196
- if (options[statementType] && options[statementType].uninitialized === MODE_ALWAYS) {
197
- currentScope.uninitialized = true;
198
- }
199
- } else {
200
- if (options[statementType] && options[statementType].initialized === MODE_ALWAYS) {
201
- if (options.separateRequires && isRequire(declarations[i])) {
202
- currentScope.required = true;
203
- } else {
204
- currentScope.initialized = true;
205
- }
206
- }
207
- }
208
- }
209
- }
210
-
211
- /**
212
- * Determines the current scope (function or block)
213
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
214
- * @returns {Object} The scope associated with statementType
215
- */
216
- function getCurrentScope(statementType) {
217
- let currentScope;
218
-
219
- if (statementType === "var") {
220
- currentScope = functionStack.at(-1);
221
- } else if (statementType === "let") {
222
- currentScope = blockStack.at(-1).let;
223
- } else if (statementType === "const") {
224
- currentScope = blockStack.at(-1).const;
225
- }
226
- return currentScope;
227
- }
228
-
229
- /**
230
- * Counts the number of initialized and uninitialized declarations in a list of declarations
231
- * @param {ASTNode[]} declarations List of declarations
232
- * @returns {Object} Counts of 'uninitialized' and 'initialized' declarations
233
- * @private
234
- */
235
- function countDeclarations(declarations) {
236
- const counts = { uninitialized: 0, initialized: 0 };
237
-
238
- for (let i = 0; i < declarations.length; i++) {
239
- if (declarations[i].init === null) {
240
- counts.uninitialized++;
241
- } else {
242
- counts.initialized++;
243
- }
244
- }
245
- return counts;
246
- }
247
-
248
- /**
249
- * Determines if there is more than one var statement in the current scope.
250
- * @param {string} statementType node.kind, one of: "var", "let", or "const"
251
- * @param {ASTNode[]} declarations List of declarations
252
- * @returns {boolean} Returns true if it is the first var declaration, false if not.
253
- * @private
254
- */
255
- function hasOnlyOneStatement(statementType, declarations) {
256
-
257
- const declarationCounts = countDeclarations(declarations);
258
- const currentOptions = options[statementType] || {};
259
- const currentScope = getCurrentScope(statementType);
260
- const hasRequires = declarations.some(isRequire);
261
-
262
- if (currentOptions.uninitialized === MODE_ALWAYS && currentOptions.initialized === MODE_ALWAYS) {
263
- if (currentScope.uninitialized || currentScope.initialized) {
264
- if (!hasRequires) {
265
- return false;
266
- }
267
- }
268
- }
269
-
270
- if (declarationCounts.uninitialized > 0) {
271
- if (currentOptions.uninitialized === MODE_ALWAYS && currentScope.uninitialized) {
272
- return false;
273
- }
274
- }
275
- if (declarationCounts.initialized > 0) {
276
- if (currentOptions.initialized === MODE_ALWAYS && currentScope.initialized) {
277
- if (!hasRequires) {
278
- return false;
279
- }
280
- }
281
- }
282
- if (currentScope.required && hasRequires) {
283
- return false;
284
- }
285
- recordTypes(statementType, declarations, currentScope);
286
- return true;
287
- }
288
-
289
- /**
290
- * Fixer to join VariableDeclaration's into a single declaration
291
- * @param {VariableDeclarator[]} declarations The `VariableDeclaration` to join
292
- * @returns {Function} The fixer function
293
- */
294
- function joinDeclarations(declarations) {
295
- const declaration = declarations[0];
296
- const body = Array.isArray(declaration.parent.parent.body) ? declaration.parent.parent.body : [];
297
- const currentIndex = body.findIndex(node => node.range[0] === declaration.parent.range[0]);
298
- const previousNode = body[currentIndex - 1];
299
-
300
- return fixer => {
301
- const type = sourceCode.getTokenBefore(declaration);
302
- const prevSemi = sourceCode.getTokenBefore(type);
303
- const res = [];
304
-
305
- if (previousNode && previousNode.kind === sourceCode.getText(type)) {
306
- if (prevSemi.value === ";") {
307
- res.push(fixer.replaceText(prevSemi, ","));
308
- } else {
309
- res.push(fixer.insertTextAfter(prevSemi, ","));
310
- }
311
- res.push(fixer.replaceText(type, ""));
312
- }
313
-
314
- return res;
315
- };
316
- }
317
-
318
- /**
319
- * Fixer to split a VariableDeclaration into individual declarations
320
- * @param {VariableDeclaration} declaration The `VariableDeclaration` to split
321
- * @returns {Function|null} The fixer function
322
- */
323
- function splitDeclarations(declaration) {
324
- const { parent } = declaration;
325
-
326
- // don't autofix code such as: if (foo) var x, y;
327
- if (!isInStatementList(parent.type === "ExportNamedDeclaration" ? parent : declaration)) {
328
- return null;
329
- }
330
-
331
- return fixer => declaration.declarations.map(declarator => {
332
- const tokenAfterDeclarator = sourceCode.getTokenAfter(declarator);
333
-
334
- if (tokenAfterDeclarator === null) {
335
- return null;
336
- }
337
-
338
- const afterComma = sourceCode.getTokenAfter(tokenAfterDeclarator, { includeComments: true });
339
-
340
- if (tokenAfterDeclarator.value !== ",") {
341
- return null;
342
- }
343
-
344
- const exportPlacement = declaration.parent.type === "ExportNamedDeclaration" ? "export " : "";
345
-
346
- /*
347
- * `var x,y`
348
- * tokenAfterDeclarator ^^ afterComma
349
- */
350
- if (afterComma.range[0] === tokenAfterDeclarator.range[1]) {
351
- return fixer.replaceText(tokenAfterDeclarator, `; ${exportPlacement}${declaration.kind} `);
352
- }
353
-
354
- /*
355
- * `var x,
356
- * tokenAfterDeclarator ^
357
- * y`
358
- * ^ afterComma
359
- */
360
- if (
361
- afterComma.loc.start.line > tokenAfterDeclarator.loc.end.line ||
362
- afterComma.type === "Line" ||
363
- afterComma.type === "Block"
364
- ) {
365
- let lastComment = afterComma;
366
-
367
- while (lastComment.type === "Line" || lastComment.type === "Block") {
368
- lastComment = sourceCode.getTokenAfter(lastComment, { includeComments: true });
369
- }
370
-
371
- return fixer.replaceTextRange(
372
- [tokenAfterDeclarator.range[0], lastComment.range[0]],
373
- `;${sourceCode.text.slice(tokenAfterDeclarator.range[1], lastComment.range[0])}${exportPlacement}${declaration.kind} `
374
- );
375
- }
376
-
377
- return fixer.replaceText(tokenAfterDeclarator, `; ${exportPlacement}${declaration.kind}`);
378
- }).filter(x => x);
379
- }
380
-
381
- /**
382
- * Checks a given VariableDeclaration node for errors.
383
- * @param {ASTNode} node The VariableDeclaration node to check
384
- * @returns {void}
385
- * @private
386
- */
387
- function checkVariableDeclaration(node) {
388
- const parent = node.parent;
389
- const type = node.kind;
390
-
391
- if (!options[type]) {
392
- return;
393
- }
394
-
395
- const declarations = node.declarations;
396
- const declarationCounts = countDeclarations(declarations);
397
- const mixedRequires = declarations.some(isRequire) && !declarations.every(isRequire);
398
-
399
- if (options[type].initialized === MODE_ALWAYS) {
400
- if (options.separateRequires && mixedRequires) {
401
- context.report({
402
- node,
403
- messageId: "splitRequires"
404
- });
405
- }
406
- }
407
-
408
- // consecutive
409
- const nodeIndex = (parent.body && parent.body.length > 0 && parent.body.indexOf(node)) || 0;
410
-
411
- if (nodeIndex > 0) {
412
- const previousNode = parent.body[nodeIndex - 1];
413
- const isPreviousNodeDeclaration = previousNode.type === "VariableDeclaration";
414
- const declarationsWithPrevious = declarations.concat(previousNode.declarations || []);
415
-
416
- if (
417
- isPreviousNodeDeclaration &&
418
- previousNode.kind === type &&
419
- !(declarationsWithPrevious.some(isRequire) && !declarationsWithPrevious.every(isRequire))
420
- ) {
421
- const previousDeclCounts = countDeclarations(previousNode.declarations);
422
-
423
- if (options[type].initialized === MODE_CONSECUTIVE && options[type].uninitialized === MODE_CONSECUTIVE) {
424
- context.report({
425
- node,
426
- messageId: "combine",
427
- data: {
428
- type
429
- },
430
- fix: joinDeclarations(declarations)
431
- });
432
- } else if (options[type].initialized === MODE_CONSECUTIVE && declarationCounts.initialized > 0 && previousDeclCounts.initialized > 0) {
433
- context.report({
434
- node,
435
- messageId: "combineInitialized",
436
- data: {
437
- type
438
- },
439
- fix: joinDeclarations(declarations)
440
- });
441
- } else if (options[type].uninitialized === MODE_CONSECUTIVE &&
442
- declarationCounts.uninitialized > 0 &&
443
- previousDeclCounts.uninitialized > 0) {
444
- context.report({
445
- node,
446
- messageId: "combineUninitialized",
447
- data: {
448
- type
449
- },
450
- fix: joinDeclarations(declarations)
451
- });
452
- }
453
- }
454
- }
455
-
456
- // always
457
- if (!hasOnlyOneStatement(type, declarations)) {
458
- if (options[type].initialized === MODE_ALWAYS && options[type].uninitialized === MODE_ALWAYS) {
459
- context.report({
460
- node,
461
- messageId: "combine",
462
- data: {
463
- type
464
- },
465
- fix: joinDeclarations(declarations)
466
- });
467
- } else {
468
- if (options[type].initialized === MODE_ALWAYS && declarationCounts.initialized > 0) {
469
- context.report({
470
- node,
471
- messageId: "combineInitialized",
472
- data: {
473
- type
474
- },
475
- fix: joinDeclarations(declarations)
476
- });
477
- }
478
- if (options[type].uninitialized === MODE_ALWAYS && declarationCounts.uninitialized > 0) {
479
- if (node.parent.left === node && (node.parent.type === "ForInStatement" || node.parent.type === "ForOfStatement")) {
480
- return;
481
- }
482
- context.report({
483
- node,
484
- messageId: "combineUninitialized",
485
- data: {
486
- type
487
- },
488
- fix: joinDeclarations(declarations)
489
- });
490
- }
491
- }
492
- }
493
-
494
- // never
495
- if (parent.type !== "ForStatement" || parent.init !== node) {
496
- const totalDeclarations = declarationCounts.uninitialized + declarationCounts.initialized;
497
-
498
- if (totalDeclarations > 1) {
499
- if (options[type].initialized === MODE_NEVER && options[type].uninitialized === MODE_NEVER) {
500
-
501
- // both initialized and uninitialized
502
- context.report({
503
- node,
504
- messageId: "split",
505
- data: {
506
- type
507
- },
508
- fix: splitDeclarations(node)
509
- });
510
- } else if (options[type].initialized === MODE_NEVER && declarationCounts.initialized > 0) {
511
-
512
- // initialized
513
- context.report({
514
- node,
515
- messageId: "splitInitialized",
516
- data: {
517
- type
518
- },
519
- fix: splitDeclarations(node)
520
- });
521
- } else if (options[type].uninitialized === MODE_NEVER && declarationCounts.uninitialized > 0) {
522
-
523
- // uninitialized
524
- context.report({
525
- node,
526
- messageId: "splitUninitialized",
527
- data: {
528
- type
529
- },
530
- fix: splitDeclarations(node)
531
- });
532
- }
533
- }
534
- }
535
- }
536
-
537
- //--------------------------------------------------------------------------
538
- // Public API
539
- //--------------------------------------------------------------------------
540
-
541
- return {
542
- Program: startFunction,
543
- FunctionDeclaration: startFunction,
544
- FunctionExpression: startFunction,
545
- ArrowFunctionExpression: startFunction,
546
- StaticBlock: startFunction, // StaticBlock creates a new scope for `var` variables
547
-
548
- BlockStatement: startBlock,
549
- ForStatement: startBlock,
550
- ForInStatement: startBlock,
551
- ForOfStatement: startBlock,
552
- SwitchStatement: startBlock,
553
- VariableDeclaration: checkVariableDeclaration,
554
- "ForStatement:exit": endBlock,
555
- "ForOfStatement:exit": endBlock,
556
- "ForInStatement:exit": endBlock,
557
- "SwitchStatement:exit": endBlock,
558
- "BlockStatement:exit": endBlock,
559
-
560
- "Program:exit": endFunction,
561
- "FunctionDeclaration:exit": endFunction,
562
- "FunctionExpression:exit": endFunction,
563
- "ArrowFunctionExpression:exit": endFunction,
564
- "StaticBlock:exit": endFunction
565
- };
566
-
567
- }
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
+ },
68
+ additionalProperties: false,
69
+ },
70
+ {
71
+ type: "object",
72
+ properties: {
73
+ initialized: {
74
+ enum: ["always", "never", "consecutive"],
75
+ },
76
+ uninitialized: {
77
+ enum: ["always", "never", "consecutive"],
78
+ },
79
+ },
80
+ additionalProperties: false,
81
+ },
82
+ ],
83
+ },
84
+ ],
85
+
86
+ messages: {
87
+ combineUninitialized:
88
+ "Combine this with the previous '{{type}}' statement with uninitialized variables.",
89
+ combineInitialized:
90
+ "Combine this with the previous '{{type}}' statement with initialized variables.",
91
+ splitUninitialized:
92
+ "Split uninitialized '{{type}}' declarations into multiple statements.",
93
+ splitInitialized:
94
+ "Split initialized '{{type}}' declarations into multiple statements.",
95
+ splitRequires:
96
+ "Split requires to be separated into a single block.",
97
+ combine: "Combine this with the previous '{{type}}' statement.",
98
+ split: "Split '{{type}}' declarations into multiple statements.",
99
+ },
100
+ },
101
+
102
+ create(context) {
103
+ const MODE_ALWAYS = "always";
104
+ const MODE_NEVER = "never";
105
+ const MODE_CONSECUTIVE = "consecutive";
106
+ const mode = context.options[0] || MODE_ALWAYS;
107
+
108
+ const options = {};
109
+
110
+ if (typeof mode === "string") {
111
+ // simple options configuration with just a string
112
+ options.var = { uninitialized: mode, initialized: mode };
113
+ options.let = { uninitialized: mode, initialized: mode };
114
+ options.const = { uninitialized: mode, initialized: mode };
115
+ } else if (typeof mode === "object") {
116
+ // options configuration is an object
117
+ options.separateRequires = !!mode.separateRequires;
118
+ options.var = { uninitialized: mode.var, initialized: mode.var };
119
+ options.let = { uninitialized: mode.let, initialized: mode.let };
120
+ options.const = {
121
+ uninitialized: mode.const,
122
+ initialized: mode.const,
123
+ };
124
+ if (Object.hasOwn(mode, "uninitialized")) {
125
+ options.var.uninitialized = mode.uninitialized;
126
+ options.let.uninitialized = mode.uninitialized;
127
+ options.const.uninitialized = mode.uninitialized;
128
+ }
129
+ if (Object.hasOwn(mode, "initialized")) {
130
+ options.var.initialized = mode.initialized;
131
+ options.let.initialized = mode.initialized;
132
+ options.const.initialized = mode.initialized;
133
+ }
134
+ }
135
+
136
+ const sourceCode = context.sourceCode;
137
+
138
+ //--------------------------------------------------------------------------
139
+ // Helpers
140
+ //--------------------------------------------------------------------------
141
+
142
+ const functionStack = [];
143
+ const blockStack = [];
144
+
145
+ /**
146
+ * Increments the blockStack counter.
147
+ * @returns {void}
148
+ * @private
149
+ */
150
+ function startBlock() {
151
+ blockStack.push({
152
+ let: { initialized: false, uninitialized: false },
153
+ const: { initialized: false, uninitialized: false },
154
+ });
155
+ }
156
+
157
+ /**
158
+ * Increments the functionStack counter.
159
+ * @returns {void}
160
+ * @private
161
+ */
162
+ function startFunction() {
163
+ functionStack.push({ initialized: false, uninitialized: false });
164
+ startBlock();
165
+ }
166
+
167
+ /**
168
+ * Decrements the blockStack counter.
169
+ * @returns {void}
170
+ * @private
171
+ */
172
+ function endBlock() {
173
+ blockStack.pop();
174
+ }
175
+
176
+ /**
177
+ * Decrements the functionStack counter.
178
+ * @returns {void}
179
+ * @private
180
+ */
181
+ function endFunction() {
182
+ functionStack.pop();
183
+ endBlock();
184
+ }
185
+
186
+ /**
187
+ * Check if a variable declaration is a require.
188
+ * @param {ASTNode} decl variable declaration Node
189
+ * @returns {bool} if decl is a require, return true; else return false.
190
+ * @private
191
+ */
192
+ function isRequire(decl) {
193
+ return (
194
+ decl.init &&
195
+ decl.init.type === "CallExpression" &&
196
+ decl.init.callee.name === "require"
197
+ );
198
+ }
199
+
200
+ /**
201
+ * Records whether initialized/uninitialized/required variables are defined in current scope.
202
+ * @param {string} statementType node.kind, one of: "var", "let", or "const"
203
+ * @param {ASTNode[]} declarations List of declarations
204
+ * @param {Object} currentScope The scope being investigated
205
+ * @returns {void}
206
+ * @private
207
+ */
208
+ function recordTypes(statementType, declarations, currentScope) {
209
+ for (let i = 0; i < declarations.length; i++) {
210
+ if (declarations[i].init === null) {
211
+ if (
212
+ options[statementType] &&
213
+ options[statementType].uninitialized === MODE_ALWAYS
214
+ ) {
215
+ currentScope.uninitialized = true;
216
+ }
217
+ } else {
218
+ if (
219
+ options[statementType] &&
220
+ options[statementType].initialized === MODE_ALWAYS
221
+ ) {
222
+ if (
223
+ options.separateRequires &&
224
+ isRequire(declarations[i])
225
+ ) {
226
+ currentScope.required = true;
227
+ } else {
228
+ currentScope.initialized = true;
229
+ }
230
+ }
231
+ }
232
+ }
233
+ }
234
+
235
+ /**
236
+ * Determines the current scope (function or block)
237
+ * @param {string} statementType node.kind, one of: "var", "let", or "const"
238
+ * @returns {Object} The scope associated with statementType
239
+ */
240
+ function getCurrentScope(statementType) {
241
+ let currentScope;
242
+
243
+ if (statementType === "var") {
244
+ currentScope = functionStack.at(-1);
245
+ } else if (statementType === "let") {
246
+ currentScope = blockStack.at(-1).let;
247
+ } else if (statementType === "const") {
248
+ currentScope = blockStack.at(-1).const;
249
+ }
250
+ return currentScope;
251
+ }
252
+
253
+ /**
254
+ * Counts the number of initialized and uninitialized declarations in a list of declarations
255
+ * @param {ASTNode[]} declarations List of declarations
256
+ * @returns {Object} Counts of 'uninitialized' and 'initialized' declarations
257
+ * @private
258
+ */
259
+ function countDeclarations(declarations) {
260
+ const counts = { uninitialized: 0, initialized: 0 };
261
+
262
+ for (let i = 0; i < declarations.length; i++) {
263
+ if (declarations[i].init === null) {
264
+ counts.uninitialized++;
265
+ } else {
266
+ counts.initialized++;
267
+ }
268
+ }
269
+ return counts;
270
+ }
271
+
272
+ /**
273
+ * Determines if there is more than one var statement in the current scope.
274
+ * @param {string} statementType node.kind, one of: "var", "let", or "const"
275
+ * @param {ASTNode[]} declarations List of declarations
276
+ * @returns {boolean} Returns true if it is the first var declaration, false if not.
277
+ * @private
278
+ */
279
+ function hasOnlyOneStatement(statementType, declarations) {
280
+ const declarationCounts = countDeclarations(declarations);
281
+ const currentOptions = options[statementType] || {};
282
+ const currentScope = getCurrentScope(statementType);
283
+ const hasRequires = declarations.some(isRequire);
284
+
285
+ if (
286
+ currentOptions.uninitialized === MODE_ALWAYS &&
287
+ currentOptions.initialized === MODE_ALWAYS
288
+ ) {
289
+ if (currentScope.uninitialized || currentScope.initialized) {
290
+ if (!hasRequires) {
291
+ return false;
292
+ }
293
+ }
294
+ }
295
+
296
+ if (declarationCounts.uninitialized > 0) {
297
+ if (
298
+ currentOptions.uninitialized === MODE_ALWAYS &&
299
+ currentScope.uninitialized
300
+ ) {
301
+ return false;
302
+ }
303
+ }
304
+ if (declarationCounts.initialized > 0) {
305
+ if (
306
+ currentOptions.initialized === MODE_ALWAYS &&
307
+ currentScope.initialized
308
+ ) {
309
+ if (!hasRequires) {
310
+ return false;
311
+ }
312
+ }
313
+ }
314
+ if (currentScope.required && hasRequires) {
315
+ return false;
316
+ }
317
+ recordTypes(statementType, declarations, currentScope);
318
+ return true;
319
+ }
320
+
321
+ /**
322
+ * Fixer to join VariableDeclaration's into a single declaration
323
+ * @param {VariableDeclarator[]} declarations The `VariableDeclaration` to join
324
+ * @returns {Function} The fixer function
325
+ */
326
+ function joinDeclarations(declarations) {
327
+ const declaration = declarations[0];
328
+ const body = Array.isArray(declaration.parent.parent.body)
329
+ ? declaration.parent.parent.body
330
+ : [];
331
+ const currentIndex = body.findIndex(
332
+ node => node.range[0] === declaration.parent.range[0],
333
+ );
334
+ const previousNode = body[currentIndex - 1];
335
+
336
+ return fixer => {
337
+ const type = sourceCode.getTokenBefore(declaration);
338
+ const prevSemi = sourceCode.getTokenBefore(type);
339
+ const res = [];
340
+
341
+ if (
342
+ previousNode &&
343
+ previousNode.kind === sourceCode.getText(type)
344
+ ) {
345
+ if (prevSemi.value === ";") {
346
+ res.push(fixer.replaceText(prevSemi, ","));
347
+ } else {
348
+ res.push(fixer.insertTextAfter(prevSemi, ","));
349
+ }
350
+ res.push(fixer.replaceText(type, ""));
351
+ }
352
+
353
+ return res;
354
+ };
355
+ }
356
+
357
+ /**
358
+ * Fixer to split a VariableDeclaration into individual declarations
359
+ * @param {VariableDeclaration} declaration The `VariableDeclaration` to split
360
+ * @returns {Function|null} The fixer function
361
+ */
362
+ function splitDeclarations(declaration) {
363
+ const { parent } = declaration;
364
+
365
+ // don't autofix code such as: if (foo) var x, y;
366
+ if (
367
+ !isInStatementList(
368
+ parent.type === "ExportNamedDeclaration"
369
+ ? parent
370
+ : declaration,
371
+ )
372
+ ) {
373
+ return null;
374
+ }
375
+
376
+ return fixer =>
377
+ declaration.declarations
378
+ .map(declarator => {
379
+ const tokenAfterDeclarator =
380
+ sourceCode.getTokenAfter(declarator);
381
+
382
+ if (tokenAfterDeclarator === null) {
383
+ return null;
384
+ }
385
+
386
+ const afterComma = sourceCode.getTokenAfter(
387
+ tokenAfterDeclarator,
388
+ { includeComments: true },
389
+ );
390
+
391
+ if (tokenAfterDeclarator.value !== ",") {
392
+ return null;
393
+ }
394
+
395
+ const exportPlacement =
396
+ declaration.parent.type === "ExportNamedDeclaration"
397
+ ? "export "
398
+ : "";
399
+
400
+ /*
401
+ * `var x,y`
402
+ * tokenAfterDeclarator ^^ afterComma
403
+ */
404
+ if (
405
+ afterComma.range[0] ===
406
+ tokenAfterDeclarator.range[1]
407
+ ) {
408
+ return fixer.replaceText(
409
+ tokenAfterDeclarator,
410
+ `; ${exportPlacement}${declaration.kind} `,
411
+ );
412
+ }
413
+
414
+ /*
415
+ * `var x,
416
+ * tokenAfterDeclarator ^
417
+ * y`
418
+ * ^ afterComma
419
+ */
420
+ if (
421
+ afterComma.loc.start.line >
422
+ tokenAfterDeclarator.loc.end.line ||
423
+ afterComma.type === "Line" ||
424
+ afterComma.type === "Block"
425
+ ) {
426
+ let lastComment = afterComma;
427
+
428
+ while (
429
+ lastComment.type === "Line" ||
430
+ lastComment.type === "Block"
431
+ ) {
432
+ lastComment = sourceCode.getTokenAfter(
433
+ lastComment,
434
+ { includeComments: true },
435
+ );
436
+ }
437
+
438
+ return fixer.replaceTextRange(
439
+ [
440
+ tokenAfterDeclarator.range[0],
441
+ lastComment.range[0],
442
+ ],
443
+ `;${sourceCode.text.slice(tokenAfterDeclarator.range[1], lastComment.range[0])}${exportPlacement}${declaration.kind} `,
444
+ );
445
+ }
446
+
447
+ return fixer.replaceText(
448
+ tokenAfterDeclarator,
449
+ `; ${exportPlacement}${declaration.kind}`,
450
+ );
451
+ })
452
+ .filter(x => x);
453
+ }
454
+
455
+ /**
456
+ * Checks a given VariableDeclaration node for errors.
457
+ * @param {ASTNode} node The VariableDeclaration node to check
458
+ * @returns {void}
459
+ * @private
460
+ */
461
+ function checkVariableDeclaration(node) {
462
+ const parent = node.parent;
463
+ const type = node.kind;
464
+
465
+ if (!options[type]) {
466
+ return;
467
+ }
468
+
469
+ const declarations = node.declarations;
470
+ const declarationCounts = countDeclarations(declarations);
471
+ const mixedRequires =
472
+ declarations.some(isRequire) && !declarations.every(isRequire);
473
+
474
+ if (options[type].initialized === MODE_ALWAYS) {
475
+ if (options.separateRequires && mixedRequires) {
476
+ context.report({
477
+ node,
478
+ messageId: "splitRequires",
479
+ });
480
+ }
481
+ }
482
+
483
+ // consecutive
484
+ const nodeIndex =
485
+ (parent.body &&
486
+ parent.body.length > 0 &&
487
+ parent.body.indexOf(node)) ||
488
+ 0;
489
+
490
+ if (nodeIndex > 0) {
491
+ const previousNode = parent.body[nodeIndex - 1];
492
+ const isPreviousNodeDeclaration =
493
+ previousNode.type === "VariableDeclaration";
494
+ const declarationsWithPrevious = declarations.concat(
495
+ previousNode.declarations || [],
496
+ );
497
+
498
+ if (
499
+ isPreviousNodeDeclaration &&
500
+ previousNode.kind === type &&
501
+ !(
502
+ declarationsWithPrevious.some(isRequire) &&
503
+ !declarationsWithPrevious.every(isRequire)
504
+ )
505
+ ) {
506
+ const previousDeclCounts = countDeclarations(
507
+ previousNode.declarations,
508
+ );
509
+
510
+ if (
511
+ options[type].initialized === MODE_CONSECUTIVE &&
512
+ options[type].uninitialized === MODE_CONSECUTIVE
513
+ ) {
514
+ context.report({
515
+ node,
516
+ messageId: "combine",
517
+ data: {
518
+ type,
519
+ },
520
+ fix: joinDeclarations(declarations),
521
+ });
522
+ } else if (
523
+ options[type].initialized === MODE_CONSECUTIVE &&
524
+ declarationCounts.initialized > 0 &&
525
+ previousDeclCounts.initialized > 0
526
+ ) {
527
+ context.report({
528
+ node,
529
+ messageId: "combineInitialized",
530
+ data: {
531
+ type,
532
+ },
533
+ fix: joinDeclarations(declarations),
534
+ });
535
+ } else if (
536
+ options[type].uninitialized === MODE_CONSECUTIVE &&
537
+ declarationCounts.uninitialized > 0 &&
538
+ previousDeclCounts.uninitialized > 0
539
+ ) {
540
+ context.report({
541
+ node,
542
+ messageId: "combineUninitialized",
543
+ data: {
544
+ type,
545
+ },
546
+ fix: joinDeclarations(declarations),
547
+ });
548
+ }
549
+ }
550
+ }
551
+
552
+ // always
553
+ if (!hasOnlyOneStatement(type, declarations)) {
554
+ if (
555
+ options[type].initialized === MODE_ALWAYS &&
556
+ options[type].uninitialized === MODE_ALWAYS
557
+ ) {
558
+ context.report({
559
+ node,
560
+ messageId: "combine",
561
+ data: {
562
+ type,
563
+ },
564
+ fix: joinDeclarations(declarations),
565
+ });
566
+ } else {
567
+ if (
568
+ options[type].initialized === MODE_ALWAYS &&
569
+ declarationCounts.initialized > 0
570
+ ) {
571
+ context.report({
572
+ node,
573
+ messageId: "combineInitialized",
574
+ data: {
575
+ type,
576
+ },
577
+ fix: joinDeclarations(declarations),
578
+ });
579
+ }
580
+ if (
581
+ options[type].uninitialized === MODE_ALWAYS &&
582
+ declarationCounts.uninitialized > 0
583
+ ) {
584
+ if (
585
+ node.parent.left === node &&
586
+ (node.parent.type === "ForInStatement" ||
587
+ node.parent.type === "ForOfStatement")
588
+ ) {
589
+ return;
590
+ }
591
+ context.report({
592
+ node,
593
+ messageId: "combineUninitialized",
594
+ data: {
595
+ type,
596
+ },
597
+ fix: joinDeclarations(declarations),
598
+ });
599
+ }
600
+ }
601
+ }
602
+
603
+ // never
604
+ if (parent.type !== "ForStatement" || parent.init !== node) {
605
+ const totalDeclarations =
606
+ declarationCounts.uninitialized +
607
+ declarationCounts.initialized;
608
+
609
+ if (totalDeclarations > 1) {
610
+ if (
611
+ options[type].initialized === MODE_NEVER &&
612
+ options[type].uninitialized === MODE_NEVER
613
+ ) {
614
+ // both initialized and uninitialized
615
+ context.report({
616
+ node,
617
+ messageId: "split",
618
+ data: {
619
+ type,
620
+ },
621
+ fix: splitDeclarations(node),
622
+ });
623
+ } else if (
624
+ options[type].initialized === MODE_NEVER &&
625
+ declarationCounts.initialized > 0
626
+ ) {
627
+ // initialized
628
+ context.report({
629
+ node,
630
+ messageId: "splitInitialized",
631
+ data: {
632
+ type,
633
+ },
634
+ fix: splitDeclarations(node),
635
+ });
636
+ } else if (
637
+ options[type].uninitialized === MODE_NEVER &&
638
+ declarationCounts.uninitialized > 0
639
+ ) {
640
+ // uninitialized
641
+ context.report({
642
+ node,
643
+ messageId: "splitUninitialized",
644
+ data: {
645
+ type,
646
+ },
647
+ fix: splitDeclarations(node),
648
+ });
649
+ }
650
+ }
651
+ }
652
+ }
653
+
654
+ //--------------------------------------------------------------------------
655
+ // Public API
656
+ //--------------------------------------------------------------------------
657
+
658
+ return {
659
+ Program: startFunction,
660
+ FunctionDeclaration: startFunction,
661
+ FunctionExpression: startFunction,
662
+ ArrowFunctionExpression: startFunction,
663
+ StaticBlock: startFunction, // StaticBlock creates a new scope for `var` variables
664
+
665
+ BlockStatement: startBlock,
666
+ ForStatement: startBlock,
667
+ ForInStatement: startBlock,
668
+ ForOfStatement: startBlock,
669
+ SwitchStatement: startBlock,
670
+ VariableDeclaration: checkVariableDeclaration,
671
+ "ForStatement:exit": endBlock,
672
+ "ForOfStatement:exit": endBlock,
673
+ "ForInStatement:exit": endBlock,
674
+ "SwitchStatement:exit": endBlock,
675
+ "BlockStatement:exit": endBlock,
676
+
677
+ "Program:exit": endFunction,
678
+ "FunctionDeclaration:exit": endFunction,
679
+ "FunctionExpression:exit": endFunction,
680
+ "ArrowFunctionExpression:exit": endFunction,
681
+ "StaticBlock:exit": endFunction,
682
+ };
683
+ },
568
684
  };