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
@@ -18,8 +18,8 @@ const astUtils = require("./utils/ast-utils");
18
18
 
19
19
  const LT = `[${Array.from(astUtils.LINEBREAKS).join("")}]`;
20
20
  const PADDING_LINE_SEQUENCE = new RegExp(
21
- String.raw`^(\s*?${LT})\s*${LT}(\s*;?)$`,
22
- "u"
21
+ String.raw`^(\s*?${LT})\s*${LT}(\s*;?)$`,
22
+ "u",
23
23
  );
24
24
  const CJS_EXPORT = /^(?:module\s*\.\s*)?exports(?:\s*\.|\s*\[|$)/u;
25
25
  const CJS_IMPORT = /^require\(/u;
@@ -31,10 +31,10 @@ const CJS_IMPORT = /^require\(/u;
31
31
  * @private
32
32
  */
33
33
  function newKeywordTester(keyword) {
34
- return {
35
- test: (node, sourceCode) =>
36
- sourceCode.getFirstToken(node).value === keyword
37
- };
34
+ return {
35
+ test: (node, sourceCode) =>
36
+ sourceCode.getFirstToken(node).value === keyword,
37
+ };
38
38
  }
39
39
 
40
40
  /**
@@ -44,11 +44,11 @@ function newKeywordTester(keyword) {
44
44
  * @private
45
45
  */
46
46
  function newSinglelineKeywordTester(keyword) {
47
- return {
48
- test: (node, sourceCode) =>
49
- node.loc.start.line === node.loc.end.line &&
50
- sourceCode.getFirstToken(node).value === keyword
51
- };
47
+ return {
48
+ test: (node, sourceCode) =>
49
+ node.loc.start.line === node.loc.end.line &&
50
+ sourceCode.getFirstToken(node).value === keyword,
51
+ };
52
52
  }
53
53
 
54
54
  /**
@@ -58,11 +58,11 @@ function newSinglelineKeywordTester(keyword) {
58
58
  * @private
59
59
  */
60
60
  function newMultilineKeywordTester(keyword) {
61
- return {
62
- test: (node, sourceCode) =>
63
- node.loc.start.line !== node.loc.end.line &&
64
- sourceCode.getFirstToken(node).value === keyword
65
- };
61
+ return {
62
+ test: (node, sourceCode) =>
63
+ node.loc.start.line !== node.loc.end.line &&
64
+ sourceCode.getFirstToken(node).value === keyword,
65
+ };
66
66
  }
67
67
 
68
68
  /**
@@ -72,10 +72,9 @@ function newMultilineKeywordTester(keyword) {
72
72
  * @private
73
73
  */
74
74
  function newNodeTypeTester(type) {
75
- return {
76
- test: node =>
77
- node.type === type
78
- };
75
+ return {
76
+ test: node => node.type === type,
77
+ };
79
78
  }
80
79
 
81
80
  /**
@@ -85,15 +84,17 @@ function newNodeTypeTester(type) {
85
84
  * @private
86
85
  */
87
86
  function isIIFEStatement(node) {
88
- if (node.type === "ExpressionStatement") {
89
- let call = astUtils.skipChainExpression(node.expression);
90
-
91
- if (call.type === "UnaryExpression") {
92
- call = astUtils.skipChainExpression(call.argument);
93
- }
94
- return call.type === "CallExpression" && astUtils.isFunction(call.callee);
95
- }
96
- return false;
87
+ if (node.type === "ExpressionStatement") {
88
+ let call = astUtils.skipChainExpression(node.expression);
89
+
90
+ if (call.type === "UnaryExpression") {
91
+ call = astUtils.skipChainExpression(call.argument);
92
+ }
93
+ return (
94
+ call.type === "CallExpression" && astUtils.isFunction(call.callee)
95
+ );
96
+ }
97
+ return false;
97
98
  }
98
99
 
99
100
  /**
@@ -105,30 +106,37 @@ function isIIFEStatement(node) {
105
106
  * @private
106
107
  */
107
108
  function isBlockLikeStatement(sourceCode, node) {
108
-
109
- // do-while with a block is a block-like statement.
110
- if (node.type === "DoWhileStatement" && node.body.type === "BlockStatement") {
111
- return true;
112
- }
113
-
114
- /*
115
- * IIFE is a block-like statement specially from
116
- * JSCS#disallowPaddingNewLinesAfterBlocks.
117
- */
118
- if (isIIFEStatement(node)) {
119
- return true;
120
- }
121
-
122
- // Checks the last token is a closing brace of blocks.
123
- const lastToken = sourceCode.getLastToken(node, astUtils.isNotSemicolonToken);
124
- const belongingNode = lastToken && astUtils.isClosingBraceToken(lastToken)
125
- ? sourceCode.getNodeByRangeIndex(lastToken.range[0])
126
- : null;
127
-
128
- return Boolean(belongingNode) && (
129
- belongingNode.type === "BlockStatement" ||
130
- belongingNode.type === "SwitchStatement"
131
- );
109
+ // do-while with a block is a block-like statement.
110
+ if (
111
+ node.type === "DoWhileStatement" &&
112
+ node.body.type === "BlockStatement"
113
+ ) {
114
+ return true;
115
+ }
116
+
117
+ /*
118
+ * IIFE is a block-like statement specially from
119
+ * JSCS#disallowPaddingNewLinesAfterBlocks.
120
+ */
121
+ if (isIIFEStatement(node)) {
122
+ return true;
123
+ }
124
+
125
+ // Checks the last token is a closing brace of blocks.
126
+ const lastToken = sourceCode.getLastToken(
127
+ node,
128
+ astUtils.isNotSemicolonToken,
129
+ );
130
+ const belongingNode =
131
+ lastToken && astUtils.isClosingBraceToken(lastToken)
132
+ ? sourceCode.getNodeByRangeIndex(lastToken.range[0])
133
+ : null;
134
+
135
+ return (
136
+ Boolean(belongingNode) &&
137
+ (belongingNode.type === "BlockStatement" ||
138
+ belongingNode.type === "SwitchStatement")
139
+ );
132
140
  }
133
141
 
134
142
  /**
@@ -145,19 +153,19 @@ function isBlockLikeStatement(sourceCode, node) {
145
153
  * @private
146
154
  */
147
155
  function getActualLastToken(sourceCode, node) {
148
- const semiToken = sourceCode.getLastToken(node);
149
- const prevToken = sourceCode.getTokenBefore(semiToken);
150
- const nextToken = sourceCode.getTokenAfter(semiToken);
151
- const isSemicolonLessStyle = Boolean(
152
- prevToken &&
153
- nextToken &&
154
- prevToken.range[0] >= node.range[0] &&
155
- astUtils.isSemicolonToken(semiToken) &&
156
- semiToken.loc.start.line !== prevToken.loc.end.line &&
157
- semiToken.loc.end.line === nextToken.loc.start.line
158
- );
159
-
160
- return isSemicolonLessStyle ? prevToken : semiToken;
156
+ const semiToken = sourceCode.getLastToken(node);
157
+ const prevToken = sourceCode.getTokenBefore(semiToken);
158
+ const nextToken = sourceCode.getTokenAfter(semiToken);
159
+ const isSemicolonLessStyle = Boolean(
160
+ prevToken &&
161
+ nextToken &&
162
+ prevToken.range[0] >= node.range[0] &&
163
+ astUtils.isSemicolonToken(semiToken) &&
164
+ semiToken.loc.start.line !== prevToken.loc.end.line &&
165
+ semiToken.loc.end.line === nextToken.loc.start.line,
166
+ );
167
+
168
+ return isSemicolonLessStyle ? prevToken : semiToken;
161
169
  }
162
170
 
163
171
  /**
@@ -169,7 +177,7 @@ function getActualLastToken(sourceCode, node) {
169
177
  * @private
170
178
  */
171
179
  function replacerToRemovePaddingLines(_, trailingSpaces, indentSpaces) {
172
- return trailingSpaces + indentSpaces;
180
+ return trailingSpaces + indentSpaces;
173
181
  }
174
182
 
175
183
  /**
@@ -178,8 +186,7 @@ function replacerToRemovePaddingLines(_, trailingSpaces, indentSpaces) {
178
186
  * @returns {void}
179
187
  * @private
180
188
  */
181
- function verifyForAny() {
182
- }
189
+ function verifyForAny() {}
183
190
 
184
191
  /**
185
192
  * Check and report statements for `never` configuration.
@@ -195,29 +202,29 @@ function verifyForAny() {
195
202
  * @private
196
203
  */
197
204
  function verifyForNever(context, _, nextNode, paddingLines) {
198
- if (paddingLines.length === 0) {
199
- return;
200
- }
201
-
202
- context.report({
203
- node: nextNode,
204
- messageId: "unexpectedBlankLine",
205
- fix(fixer) {
206
- if (paddingLines.length >= 2) {
207
- return null;
208
- }
209
-
210
- const prevToken = paddingLines[0][0];
211
- const nextToken = paddingLines[0][1];
212
- const start = prevToken.range[1];
213
- const end = nextToken.range[0];
214
- const text = context.sourceCode.text
215
- .slice(start, end)
216
- .replace(PADDING_LINE_SEQUENCE, replacerToRemovePaddingLines);
217
-
218
- return fixer.replaceTextRange([start, end], text);
219
- }
220
- });
205
+ if (paddingLines.length === 0) {
206
+ return;
207
+ }
208
+
209
+ context.report({
210
+ node: nextNode,
211
+ messageId: "unexpectedBlankLine",
212
+ fix(fixer) {
213
+ if (paddingLines.length >= 2) {
214
+ return null;
215
+ }
216
+
217
+ const prevToken = paddingLines[0][0];
218
+ const nextToken = paddingLines[0][1];
219
+ const start = prevToken.range[1];
220
+ const end = nextToken.range[0];
221
+ const text = context.sourceCode.text
222
+ .slice(start, end)
223
+ .replace(PADDING_LINE_SEQUENCE, replacerToRemovePaddingLines);
224
+
225
+ return fixer.replaceTextRange([start, end], text);
226
+ },
227
+ });
221
228
  }
222
229
 
223
230
  /**
@@ -234,58 +241,55 @@ function verifyForNever(context, _, nextNode, paddingLines) {
234
241
  * @private
235
242
  */
236
243
  function verifyForAlways(context, prevNode, nextNode, paddingLines) {
237
- if (paddingLines.length > 0) {
238
- return;
239
- }
240
-
241
- context.report({
242
- node: nextNode,
243
- messageId: "expectedBlankLine",
244
- fix(fixer) {
245
- const sourceCode = context.sourceCode;
246
- let prevToken = getActualLastToken(sourceCode, prevNode);
247
- const nextToken = sourceCode.getFirstTokenBetween(
248
- prevToken,
249
- nextNode,
250
- {
251
- includeComments: true,
252
-
253
- /**
254
- * Skip the trailing comments of the previous node.
255
- * This inserts a blank line after the last trailing comment.
256
- *
257
- * For example:
258
- *
259
- * foo(); // trailing comment.
260
- * // comment.
261
- * bar();
262
- *
263
- * Get fixed to:
264
- *
265
- * foo(); // trailing comment.
266
- *
267
- * // comment.
268
- * bar();
269
- * @param {Token} token The token to check.
270
- * @returns {boolean} `true` if the token is not a trailing comment.
271
- * @private
272
- */
273
- filter(token) {
274
- if (astUtils.isTokenOnSameLine(prevToken, token)) {
275
- prevToken = token;
276
- return false;
277
- }
278
- return true;
279
- }
280
- }
281
- ) || nextNode;
282
- const insertText = astUtils.isTokenOnSameLine(prevToken, nextToken)
283
- ? "\n\n"
284
- : "\n";
285
-
286
- return fixer.insertTextAfter(prevToken, insertText);
287
- }
288
- });
244
+ if (paddingLines.length > 0) {
245
+ return;
246
+ }
247
+
248
+ context.report({
249
+ node: nextNode,
250
+ messageId: "expectedBlankLine",
251
+ fix(fixer) {
252
+ const sourceCode = context.sourceCode;
253
+ let prevToken = getActualLastToken(sourceCode, prevNode);
254
+ const nextToken =
255
+ sourceCode.getFirstTokenBetween(prevToken, nextNode, {
256
+ includeComments: true,
257
+
258
+ /**
259
+ * Skip the trailing comments of the previous node.
260
+ * This inserts a blank line after the last trailing comment.
261
+ *
262
+ * For example:
263
+ *
264
+ * foo(); // trailing comment.
265
+ * // comment.
266
+ * bar();
267
+ *
268
+ * Get fixed to:
269
+ *
270
+ * foo(); // trailing comment.
271
+ *
272
+ * // comment.
273
+ * bar();
274
+ * @param {Token} token The token to check.
275
+ * @returns {boolean} `true` if the token is not a trailing comment.
276
+ * @private
277
+ */
278
+ filter(token) {
279
+ if (astUtils.isTokenOnSameLine(prevToken, token)) {
280
+ prevToken = token;
281
+ return false;
282
+ }
283
+ return true;
284
+ },
285
+ }) || nextNode;
286
+ const insertText = astUtils.isTokenOnSameLine(prevToken, nextToken)
287
+ ? "\n\n"
288
+ : "\n";
289
+
290
+ return fixer.insertTextAfter(prevToken, insertText);
291
+ },
292
+ });
289
293
  }
290
294
 
291
295
  /**
@@ -295,9 +299,9 @@ function verifyForAlways(context, prevNode, nextNode, paddingLines) {
295
299
  * @private
296
300
  */
297
301
  const PaddingTypes = {
298
- any: { verify: verifyForAny },
299
- never: { verify: verifyForNever },
300
- always: { verify: verifyForAlways }
302
+ any: { verify: verifyForAny },
303
+ never: { verify: verifyForNever },
304
+ always: { verify: verifyForAlways },
301
305
  };
302
306
 
303
307
  /**
@@ -306,303 +310,303 @@ const PaddingTypes = {
306
310
  * @private
307
311
  */
308
312
  const StatementTypes = {
309
- "*": { test: () => true },
310
- "block-like": {
311
- test: (node, sourceCode) => isBlockLikeStatement(sourceCode, node)
312
- },
313
- "cjs-export": {
314
- test: (node, sourceCode) =>
315
- node.type === "ExpressionStatement" &&
316
- node.expression.type === "AssignmentExpression" &&
317
- CJS_EXPORT.test(sourceCode.getText(node.expression.left))
318
- },
319
- "cjs-import": {
320
- test: (node, sourceCode) =>
321
- node.type === "VariableDeclaration" &&
322
- node.declarations.length > 0 &&
323
- Boolean(node.declarations[0].init) &&
324
- CJS_IMPORT.test(sourceCode.getText(node.declarations[0].init))
325
- },
326
- directive: {
327
- test: astUtils.isDirective
328
- },
329
- expression: {
330
- test: node => node.type === "ExpressionStatement" && !astUtils.isDirective(node)
331
- },
332
- iife: {
333
- test: isIIFEStatement
334
- },
335
- "multiline-block-like": {
336
- test: (node, sourceCode) =>
337
- node.loc.start.line !== node.loc.end.line &&
338
- isBlockLikeStatement(sourceCode, node)
339
- },
340
- "multiline-expression": {
341
- test: node =>
342
- node.loc.start.line !== node.loc.end.line &&
343
- node.type === "ExpressionStatement" &&
344
- !astUtils.isDirective(node)
345
- },
346
-
347
- "multiline-const": newMultilineKeywordTester("const"),
348
- "multiline-let": newMultilineKeywordTester("let"),
349
- "multiline-var": newMultilineKeywordTester("var"),
350
- "singleline-const": newSinglelineKeywordTester("const"),
351
- "singleline-let": newSinglelineKeywordTester("let"),
352
- "singleline-var": newSinglelineKeywordTester("var"),
353
-
354
- block: newNodeTypeTester("BlockStatement"),
355
- empty: newNodeTypeTester("EmptyStatement"),
356
- function: newNodeTypeTester("FunctionDeclaration"),
357
-
358
- break: newKeywordTester("break"),
359
- case: newKeywordTester("case"),
360
- class: newKeywordTester("class"),
361
- const: newKeywordTester("const"),
362
- continue: newKeywordTester("continue"),
363
- debugger: newKeywordTester("debugger"),
364
- default: newKeywordTester("default"),
365
- do: newKeywordTester("do"),
366
- export: newKeywordTester("export"),
367
- for: newKeywordTester("for"),
368
- if: newKeywordTester("if"),
369
- import: newKeywordTester("import"),
370
- let: newKeywordTester("let"),
371
- return: newKeywordTester("return"),
372
- switch: newKeywordTester("switch"),
373
- throw: newKeywordTester("throw"),
374
- try: newKeywordTester("try"),
375
- var: newKeywordTester("var"),
376
- while: newKeywordTester("while"),
377
- with: newKeywordTester("with")
313
+ "*": { test: () => true },
314
+ "block-like": {
315
+ test: (node, sourceCode) => isBlockLikeStatement(sourceCode, node),
316
+ },
317
+ "cjs-export": {
318
+ test: (node, sourceCode) =>
319
+ node.type === "ExpressionStatement" &&
320
+ node.expression.type === "AssignmentExpression" &&
321
+ CJS_EXPORT.test(sourceCode.getText(node.expression.left)),
322
+ },
323
+ "cjs-import": {
324
+ test: (node, sourceCode) =>
325
+ node.type === "VariableDeclaration" &&
326
+ node.declarations.length > 0 &&
327
+ Boolean(node.declarations[0].init) &&
328
+ CJS_IMPORT.test(sourceCode.getText(node.declarations[0].init)),
329
+ },
330
+ directive: {
331
+ test: astUtils.isDirective,
332
+ },
333
+ expression: {
334
+ test: node =>
335
+ node.type === "ExpressionStatement" && !astUtils.isDirective(node),
336
+ },
337
+ iife: {
338
+ test: isIIFEStatement,
339
+ },
340
+ "multiline-block-like": {
341
+ test: (node, sourceCode) =>
342
+ node.loc.start.line !== node.loc.end.line &&
343
+ isBlockLikeStatement(sourceCode, node),
344
+ },
345
+ "multiline-expression": {
346
+ test: node =>
347
+ node.loc.start.line !== node.loc.end.line &&
348
+ node.type === "ExpressionStatement" &&
349
+ !astUtils.isDirective(node),
350
+ },
351
+
352
+ "multiline-const": newMultilineKeywordTester("const"),
353
+ "multiline-let": newMultilineKeywordTester("let"),
354
+ "multiline-var": newMultilineKeywordTester("var"),
355
+ "singleline-const": newSinglelineKeywordTester("const"),
356
+ "singleline-let": newSinglelineKeywordTester("let"),
357
+ "singleline-var": newSinglelineKeywordTester("var"),
358
+
359
+ block: newNodeTypeTester("BlockStatement"),
360
+ empty: newNodeTypeTester("EmptyStatement"),
361
+ function: newNodeTypeTester("FunctionDeclaration"),
362
+
363
+ break: newKeywordTester("break"),
364
+ case: newKeywordTester("case"),
365
+ class: newKeywordTester("class"),
366
+ const: newKeywordTester("const"),
367
+ continue: newKeywordTester("continue"),
368
+ debugger: newKeywordTester("debugger"),
369
+ default: newKeywordTester("default"),
370
+ do: newKeywordTester("do"),
371
+ export: newKeywordTester("export"),
372
+ for: newKeywordTester("for"),
373
+ if: newKeywordTester("if"),
374
+ import: newKeywordTester("import"),
375
+ let: newKeywordTester("let"),
376
+ return: newKeywordTester("return"),
377
+ switch: newKeywordTester("switch"),
378
+ throw: newKeywordTester("throw"),
379
+ try: newKeywordTester("try"),
380
+ var: newKeywordTester("var"),
381
+ while: newKeywordTester("while"),
382
+ with: newKeywordTester("with"),
378
383
  };
379
384
 
380
385
  //------------------------------------------------------------------------------
381
386
  // Rule Definition
382
387
  //------------------------------------------------------------------------------
383
388
 
384
- /** @type {import('../shared/types').Rule} */
389
+ /** @type {import('../types').Rule.RuleModule} */
385
390
  module.exports = {
386
- meta: {
387
- deprecated: {
388
- message: "Formatting rules are being moved out of ESLint core.",
389
- url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
390
- deprecatedSince: "8.53.0",
391
- availableUntil: "10.0.0",
392
- replacedBy: [
393
- {
394
- message: "ESLint Stylistic now maintains deprecated stylistic core rules.",
395
- url: "https://eslint.style/guide/migration",
396
- plugin: {
397
- name: "@stylistic/eslint-plugin-js",
398
- url: "https://eslint.style/packages/js"
399
- },
400
- rule: {
401
- name: "padding-line-between-statements",
402
- url: "https://eslint.style/rules/js/padding-line-between-statements"
403
- }
404
- }
405
- ]
406
- },
407
- type: "layout",
408
-
409
- docs: {
410
- description: "Require or disallow padding lines between statements",
411
- recommended: false,
412
- url: "https://eslint.org/docs/latest/rules/padding-line-between-statements"
413
- },
414
-
415
- fixable: "whitespace",
416
-
417
- schema: {
418
- definitions: {
419
- paddingType: {
420
- enum: Object.keys(PaddingTypes)
421
- },
422
- statementType: {
423
- anyOf: [
424
- { enum: Object.keys(StatementTypes) },
425
- {
426
- type: "array",
427
- items: { enum: Object.keys(StatementTypes) },
428
- minItems: 1,
429
- uniqueItems: true
430
- }
431
- ]
432
- }
433
- },
434
- type: "array",
435
- items: {
436
- type: "object",
437
- properties: {
438
- blankLine: { $ref: "#/definitions/paddingType" },
439
- prev: { $ref: "#/definitions/statementType" },
440
- next: { $ref: "#/definitions/statementType" }
441
- },
442
- additionalProperties: false,
443
- required: ["blankLine", "prev", "next"]
444
- }
445
- },
446
-
447
- messages: {
448
- unexpectedBlankLine: "Unexpected blank line before this statement.",
449
- expectedBlankLine: "Expected blank line before this statement."
450
- }
451
- },
452
-
453
- create(context) {
454
- const sourceCode = context.sourceCode;
455
- const configureList = context.options || [];
456
- let scopeInfo = null;
457
-
458
- /**
459
- * Processes to enter to new scope.
460
- * This manages the current previous statement.
461
- * @returns {void}
462
- * @private
463
- */
464
- function enterScope() {
465
- scopeInfo = {
466
- upper: scopeInfo,
467
- prevNode: null
468
- };
469
- }
470
-
471
- /**
472
- * Processes to exit from the current scope.
473
- * @returns {void}
474
- * @private
475
- */
476
- function exitScope() {
477
- scopeInfo = scopeInfo.upper;
478
- }
479
-
480
- /**
481
- * Checks whether the given node matches the given type.
482
- * @param {ASTNode} node The statement node to check.
483
- * @param {string|string[]} type The statement type to check.
484
- * @returns {boolean} `true` if the statement node matched the type.
485
- * @private
486
- */
487
- function match(node, type) {
488
- let innerStatementNode = node;
489
-
490
- while (innerStatementNode.type === "LabeledStatement") {
491
- innerStatementNode = innerStatementNode.body;
492
- }
493
- if (Array.isArray(type)) {
494
- return type.some(match.bind(null, innerStatementNode));
495
- }
496
- return StatementTypes[type].test(innerStatementNode, sourceCode);
497
- }
498
-
499
- /**
500
- * Finds the last matched configure from configureList.
501
- * @param {ASTNode} prevNode The previous statement to match.
502
- * @param {ASTNode} nextNode The current statement to match.
503
- * @returns {Object} The tester of the last matched configure.
504
- * @private
505
- */
506
- function getPaddingType(prevNode, nextNode) {
507
- for (let i = configureList.length - 1; i >= 0; --i) {
508
- const configure = configureList[i];
509
- const matched =
510
- match(prevNode, configure.prev) &&
511
- match(nextNode, configure.next);
512
-
513
- if (matched) {
514
- return PaddingTypes[configure.blankLine];
515
- }
516
- }
517
- return PaddingTypes.any;
518
- }
519
-
520
- /**
521
- * Gets padding line sequences between the given 2 statements.
522
- * Comments are separators of the padding line sequences.
523
- * @param {ASTNode} prevNode The previous statement to count.
524
- * @param {ASTNode} nextNode The current statement to count.
525
- * @returns {Array<Token[]>} The array of token pairs.
526
- * @private
527
- */
528
- function getPaddingLineSequences(prevNode, nextNode) {
529
- const pairs = [];
530
- let prevToken = getActualLastToken(sourceCode, prevNode);
531
-
532
- if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
533
- do {
534
- const token = sourceCode.getTokenAfter(
535
- prevToken,
536
- { includeComments: true }
537
- );
538
-
539
- if (token.loc.start.line - prevToken.loc.end.line >= 2) {
540
- pairs.push([prevToken, token]);
541
- }
542
- prevToken = token;
543
-
544
- } while (prevToken.range[0] < nextNode.range[0]);
545
- }
546
-
547
- return pairs;
548
- }
549
-
550
- /**
551
- * Verify padding lines between the given node and the previous node.
552
- * @param {ASTNode} node The node to verify.
553
- * @returns {void}
554
- * @private
555
- */
556
- function verify(node) {
557
- const parentType = node.parent.type;
558
- const validParent =
559
- astUtils.STATEMENT_LIST_PARENTS.has(parentType) ||
560
- parentType === "SwitchStatement";
561
-
562
- if (!validParent) {
563
- return;
564
- }
565
-
566
- // Save this node as the current previous statement.
567
- const prevNode = scopeInfo.prevNode;
568
-
569
- // Verify.
570
- if (prevNode) {
571
- const type = getPaddingType(prevNode, node);
572
- const paddingLines = getPaddingLineSequences(prevNode, node);
573
-
574
- type.verify(context, prevNode, node, paddingLines);
575
- }
576
-
577
- scopeInfo.prevNode = node;
578
- }
579
-
580
- /**
581
- * Verify padding lines between the given node and the previous node.
582
- * Then process to enter to new scope.
583
- * @param {ASTNode} node The node to verify.
584
- * @returns {void}
585
- * @private
586
- */
587
- function verifyThenEnterScope(node) {
588
- verify(node);
589
- enterScope();
590
- }
591
-
592
- return {
593
- Program: enterScope,
594
- BlockStatement: enterScope,
595
- SwitchStatement: enterScope,
596
- StaticBlock: enterScope,
597
- "Program:exit": exitScope,
598
- "BlockStatement:exit": exitScope,
599
- "SwitchStatement:exit": exitScope,
600
- "StaticBlock:exit": exitScope,
601
-
602
- ":statement": verify,
603
-
604
- SwitchCase: verifyThenEnterScope,
605
- "SwitchCase:exit": exitScope
606
- };
607
- }
391
+ meta: {
392
+ deprecated: {
393
+ message: "Formatting rules are being moved out of ESLint core.",
394
+ url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
395
+ deprecatedSince: "8.53.0",
396
+ availableUntil: "10.0.0",
397
+ replacedBy: [
398
+ {
399
+ message:
400
+ "ESLint Stylistic now maintains deprecated stylistic core rules.",
401
+ url: "https://eslint.style/guide/migration",
402
+ plugin: {
403
+ name: "@stylistic/eslint-plugin-js",
404
+ url: "https://eslint.style/packages/js",
405
+ },
406
+ rule: {
407
+ name: "padding-line-between-statements",
408
+ url: "https://eslint.style/rules/js/padding-line-between-statements",
409
+ },
410
+ },
411
+ ],
412
+ },
413
+ type: "layout",
414
+
415
+ docs: {
416
+ description: "Require or disallow padding lines between statements",
417
+ recommended: false,
418
+ url: "https://eslint.org/docs/latest/rules/padding-line-between-statements",
419
+ },
420
+
421
+ fixable: "whitespace",
422
+
423
+ schema: {
424
+ definitions: {
425
+ paddingType: {
426
+ enum: Object.keys(PaddingTypes),
427
+ },
428
+ statementType: {
429
+ anyOf: [
430
+ { enum: Object.keys(StatementTypes) },
431
+ {
432
+ type: "array",
433
+ items: { enum: Object.keys(StatementTypes) },
434
+ minItems: 1,
435
+ uniqueItems: true,
436
+ },
437
+ ],
438
+ },
439
+ },
440
+ type: "array",
441
+ items: {
442
+ type: "object",
443
+ properties: {
444
+ blankLine: { $ref: "#/definitions/paddingType" },
445
+ prev: { $ref: "#/definitions/statementType" },
446
+ next: { $ref: "#/definitions/statementType" },
447
+ },
448
+ additionalProperties: false,
449
+ required: ["blankLine", "prev", "next"],
450
+ },
451
+ },
452
+
453
+ messages: {
454
+ unexpectedBlankLine: "Unexpected blank line before this statement.",
455
+ expectedBlankLine: "Expected blank line before this statement.",
456
+ },
457
+ },
458
+
459
+ create(context) {
460
+ const sourceCode = context.sourceCode;
461
+ const configureList = context.options || [];
462
+ let scopeInfo = null;
463
+
464
+ /**
465
+ * Processes to enter to new scope.
466
+ * This manages the current previous statement.
467
+ * @returns {void}
468
+ * @private
469
+ */
470
+ function enterScope() {
471
+ scopeInfo = {
472
+ upper: scopeInfo,
473
+ prevNode: null,
474
+ };
475
+ }
476
+
477
+ /**
478
+ * Processes to exit from the current scope.
479
+ * @returns {void}
480
+ * @private
481
+ */
482
+ function exitScope() {
483
+ scopeInfo = scopeInfo.upper;
484
+ }
485
+
486
+ /**
487
+ * Checks whether the given node matches the given type.
488
+ * @param {ASTNode} node The statement node to check.
489
+ * @param {string|string[]} type The statement type to check.
490
+ * @returns {boolean} `true` if the statement node matched the type.
491
+ * @private
492
+ */
493
+ function match(node, type) {
494
+ let innerStatementNode = node;
495
+
496
+ while (innerStatementNode.type === "LabeledStatement") {
497
+ innerStatementNode = innerStatementNode.body;
498
+ }
499
+ if (Array.isArray(type)) {
500
+ return type.some(match.bind(null, innerStatementNode));
501
+ }
502
+ return StatementTypes[type].test(innerStatementNode, sourceCode);
503
+ }
504
+
505
+ /**
506
+ * Finds the last matched configure from configureList.
507
+ * @param {ASTNode} prevNode The previous statement to match.
508
+ * @param {ASTNode} nextNode The current statement to match.
509
+ * @returns {Object} The tester of the last matched configure.
510
+ * @private
511
+ */
512
+ function getPaddingType(prevNode, nextNode) {
513
+ for (let i = configureList.length - 1; i >= 0; --i) {
514
+ const configure = configureList[i];
515
+ const matched =
516
+ match(prevNode, configure.prev) &&
517
+ match(nextNode, configure.next);
518
+
519
+ if (matched) {
520
+ return PaddingTypes[configure.blankLine];
521
+ }
522
+ }
523
+ return PaddingTypes.any;
524
+ }
525
+
526
+ /**
527
+ * Gets padding line sequences between the given 2 statements.
528
+ * Comments are separators of the padding line sequences.
529
+ * @param {ASTNode} prevNode The previous statement to count.
530
+ * @param {ASTNode} nextNode The current statement to count.
531
+ * @returns {Array<Token[]>} The array of token pairs.
532
+ * @private
533
+ */
534
+ function getPaddingLineSequences(prevNode, nextNode) {
535
+ const pairs = [];
536
+ let prevToken = getActualLastToken(sourceCode, prevNode);
537
+
538
+ if (nextNode.loc.start.line - prevToken.loc.end.line >= 2) {
539
+ do {
540
+ const token = sourceCode.getTokenAfter(prevToken, {
541
+ includeComments: true,
542
+ });
543
+
544
+ if (token.loc.start.line - prevToken.loc.end.line >= 2) {
545
+ pairs.push([prevToken, token]);
546
+ }
547
+ prevToken = token;
548
+ } while (prevToken.range[0] < nextNode.range[0]);
549
+ }
550
+
551
+ return pairs;
552
+ }
553
+
554
+ /**
555
+ * Verify padding lines between the given node and the previous node.
556
+ * @param {ASTNode} node The node to verify.
557
+ * @returns {void}
558
+ * @private
559
+ */
560
+ function verify(node) {
561
+ const parentType = node.parent.type;
562
+ const validParent =
563
+ astUtils.STATEMENT_LIST_PARENTS.has(parentType) ||
564
+ parentType === "SwitchStatement";
565
+
566
+ if (!validParent) {
567
+ return;
568
+ }
569
+
570
+ // Save this node as the current previous statement.
571
+ const prevNode = scopeInfo.prevNode;
572
+
573
+ // Verify.
574
+ if (prevNode) {
575
+ const type = getPaddingType(prevNode, node);
576
+ const paddingLines = getPaddingLineSequences(prevNode, node);
577
+
578
+ type.verify(context, prevNode, node, paddingLines);
579
+ }
580
+
581
+ scopeInfo.prevNode = node;
582
+ }
583
+
584
+ /**
585
+ * Verify padding lines between the given node and the previous node.
586
+ * Then process to enter to new scope.
587
+ * @param {ASTNode} node The node to verify.
588
+ * @returns {void}
589
+ * @private
590
+ */
591
+ function verifyThenEnterScope(node) {
592
+ verify(node);
593
+ enterScope();
594
+ }
595
+
596
+ return {
597
+ Program: enterScope,
598
+ BlockStatement: enterScope,
599
+ SwitchStatement: enterScope,
600
+ StaticBlock: enterScope,
601
+ "Program:exit": exitScope,
602
+ "BlockStatement:exit": exitScope,
603
+ "SwitchStatement:exit": exitScope,
604
+ "StaticBlock:exit": exitScope,
605
+
606
+ ":statement": verify,
607
+
608
+ SwitchCase: verifyThenEnterScope,
609
+ "SwitchCase:exit": exitScope,
610
+ };
611
+ },
608
612
  };