eslint 9.22.0 → 9.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. package/README.md +48 -46
  2. package/bin/eslint.js +92 -90
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +1 -1
  5. package/conf/globals.js +97 -98
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +88 -92
  8. package/lib/api.js +12 -12
  9. package/lib/cli-engine/cli-engine.js +830 -810
  10. package/lib/cli-engine/file-enumerator.js +381 -387
  11. package/lib/cli-engine/formatters/formatters-meta.json +16 -16
  12. package/lib/cli-engine/formatters/html.js +107 -99
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +96 -75
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +144 -145
  19. package/lib/cli-engine/load-rules.js +16 -16
  20. package/lib/cli.js +638 -457
  21. package/lib/config/config-loader.js +726 -622
  22. package/lib/config/config.js +247 -221
  23. package/lib/config/default-config.js +54 -45
  24. package/lib/config/flat-config-array.js +167 -172
  25. package/lib/config/flat-config-helpers.js +72 -72
  26. package/lib/config/flat-config-schema.js +375 -368
  27. package/lib/config/rule-validator.js +139 -144
  28. package/lib/config-api.js +2 -2
  29. package/lib/eslint/eslint-helpers.js +756 -681
  30. package/lib/eslint/eslint.js +934 -912
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +577 -533
  33. package/lib/languages/js/index.js +263 -264
  34. package/lib/languages/js/source-code/index.js +1 -1
  35. package/lib/languages/js/source-code/source-code.js +1128 -1057
  36. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +39 -35
  37. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +35 -36
  38. package/lib/languages/js/source-code/token-store/cursor.js +36 -36
  39. package/lib/languages/js/source-code/token-store/cursors.js +80 -52
  40. package/lib/languages/js/source-code/token-store/decorative-cursor.js +17 -18
  41. package/lib/languages/js/source-code/token-store/filter-cursor.js +19 -20
  42. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +40 -32
  43. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +40 -41
  44. package/lib/languages/js/source-code/token-store/index.js +592 -498
  45. package/lib/languages/js/source-code/token-store/limit-cursor.js +17 -18
  46. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +23 -16
  47. package/lib/languages/js/source-code/token-store/skip-cursor.js +19 -20
  48. package/lib/languages/js/source-code/token-store/utils.js +63 -60
  49. package/lib/languages/js/validate-language-options.js +104 -89
  50. package/lib/linter/apply-disable-directives.js +467 -383
  51. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -672
  52. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  53. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  54. package/lib/linter/code-path-analysis/code-path.js +307 -319
  55. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  56. package/lib/linter/code-path-analysis/fork-context.js +296 -271
  57. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  58. package/lib/linter/file-context.js +119 -120
  59. package/lib/linter/index.js +3 -3
  60. package/lib/linter/interpolate.js +16 -16
  61. package/lib/linter/linter.js +2403 -2045
  62. package/lib/linter/node-event-generator.js +284 -225
  63. package/lib/linter/report-translator.js +256 -219
  64. package/lib/linter/rule-fixer.js +122 -124
  65. package/lib/linter/rules.js +36 -36
  66. package/lib/linter/safe-emitter.js +18 -18
  67. package/lib/linter/source-code-fixer.js +94 -92
  68. package/lib/linter/timing.js +104 -101
  69. package/lib/linter/vfile.js +70 -73
  70. package/lib/options.js +404 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1308 -1046
  73. package/lib/rules/accessor-pairs.js +298 -263
  74. package/lib/rules/array-bracket-newline.js +250 -238
  75. package/lib/rules/array-bracket-spacing.js +263 -224
  76. package/lib/rules/array-callback-return.js +402 -356
  77. package/lib/rules/array-element-newline.js +358 -313
  78. package/lib/rules/arrow-body-style.js +400 -281
  79. package/lib/rules/arrow-parens.js +206 -173
  80. package/lib/rules/arrow-spacing.js +169 -163
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -176
  83. package/lib/rules/brace-style.js +262 -199
  84. package/lib/rules/callback-return.js +203 -190
  85. package/lib/rules/camelcase.js +403 -392
  86. package/lib/rules/capitalized-comments.js +253 -232
  87. package/lib/rules/class-methods-use-this.js +224 -172
  88. package/lib/rules/comma-dangle.js +379 -346
  89. package/lib/rules/comma-spacing.js +193 -195
  90. package/lib/rules/comma-style.js +375 -316
  91. package/lib/rules/complexity.js +173 -169
  92. package/lib/rules/computed-property-spacing.js +236 -211
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -147
  95. package/lib/rules/constructor-super.js +412 -404
  96. package/lib/rules/curly.js +407 -332
  97. package/lib/rules/default-case-last.js +38 -31
  98. package/lib/rules/default-case.js +89 -85
  99. package/lib/rules/default-param-last.js +69 -54
  100. package/lib/rules/dot-location.js +122 -110
  101. package/lib/rules/dot-notation.js +192 -156
  102. package/lib/rules/eol-last.js +122 -120
  103. package/lib/rules/eqeqeq.js +168 -155
  104. package/lib/rules/for-direction.js +146 -121
  105. package/lib/rules/func-call-spacing.js +261 -231
  106. package/lib/rules/func-name-matching.js +293 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +159 -127
  109. package/lib/rules/function-call-argument-newline.js +152 -129
  110. package/lib/rules/function-paren-newline.js +349 -291
  111. package/lib/rules/generator-star-spacing.js +229 -210
  112. package/lib/rules/getter-return.js +208 -172
  113. package/lib/rules/global-require.js +85 -74
  114. package/lib/rules/grouped-accessor-pairs.js +170 -150
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -103
  117. package/lib/rules/id-blacklist.js +182 -199
  118. package/lib/rules/id-denylist.js +168 -187
  119. package/lib/rules/id-length.js +197 -171
  120. package/lib/rules/id-match.js +344 -289
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -79
  122. package/lib/rules/indent-legacy.js +1344 -1118
  123. package/lib/rules/indent.js +2272 -1759
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +137 -107
  126. package/lib/rules/jsx-quotes.js +94 -82
  127. package/lib/rules/key-spacing.js +750 -633
  128. package/lib/rules/keyword-spacing.js +648 -605
  129. package/lib/rules/line-comment-position.js +142 -128
  130. package/lib/rules/linebreak-style.js +107 -106
  131. package/lib/rules/lines-around-comment.js +540 -448
  132. package/lib/rules/lines-around-directive.js +233 -203
  133. package/lib/rules/lines-between-class-members.js +305 -234
  134. package/lib/rules/logical-assignment-operators.js +582 -399
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -434
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +78 -76
  142. package/lib/rules/max-statements-per-line.js +205 -198
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +637 -479
  145. package/lib/rules/multiline-ternary.js +241 -176
  146. package/lib/rules/new-cap.js +233 -213
  147. package/lib/rules/new-parens.js +88 -79
  148. package/lib/rules/newline-after-var.js +287 -250
  149. package/lib/rules/newline-before-return.js +229 -222
  150. package/lib/rules/newline-per-chained-call.js +142 -127
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +125 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +69 -71
  155. package/lib/rules/no-bitwise.js +124 -100
  156. package/lib/rules/no-buffer-constructor.js +55 -47
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -57
  159. package/lib/rules/no-catch-shadow.js +76 -73
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -81
  164. package/lib/rules/no-console.js +202 -199
  165. package/lib/rules/no-const-assign.js +47 -41
  166. package/lib/rules/no-constant-binary-expression.js +500 -405
  167. package/lib/rules/no-constant-condition.js +158 -143
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -27
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -41
  174. package/lib/rules/no-dupe-args.js +68 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +179 -176
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +127 -128
  183. package/lib/rules/no-empty-pattern.js +63 -58
  184. package/lib/rules/no-empty-static-block.js +37 -35
  185. package/lib/rules/no-empty.js +98 -86
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +256 -250
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -159
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -348
  192. package/lib/rules/no-extra-label.js +150 -131
  193. package/lib/rules/no-extra-parens.js +1654 -1325
  194. package/lib/rules/no-extra-semi.js +146 -144
  195. package/lib/rules/no-fallthrough.js +199 -157
  196. package/lib/rules/no-floating-decimal.js +74 -66
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -73
  199. package/lib/rules/no-implicit-coercion.js +349 -293
  200. package/lib/rules/no-implicit-globals.js +158 -135
  201. package/lib/rules/no-implied-eval.js +140 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -95
  204. package/lib/rules/no-inner-declarations.js +115 -101
  205. package/lib/rules/no-invalid-regexp.js +222 -190
  206. package/lib/rules/no-invalid-this.js +123 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -252
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -62
  210. package/lib/rules/no-labels.js +138 -133
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +108 -77
  213. package/lib/rules/no-loop-func.js +238 -213
  214. package/lib/rules/no-loss-of-precision.js +218 -201
  215. package/lib/rules/no-magic-numbers.js +246 -218
  216. package/lib/rules/no-misleading-character-class.js +499 -446
  217. package/lib/rules/no-mixed-operators.js +188 -182
  218. package/lib/rules/no-mixed-requires.js +253 -240
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +134 -121
  220. package/lib/rules/no-multi-assign.js +46 -44
  221. package/lib/rules/no-multi-spaces.js +163 -143
  222. package/lib/rules/no-multi-str.js +42 -41
  223. package/lib/rules/no-multiple-empty-lines.js +196 -158
  224. package/lib/rules/no-native-reassign.js +90 -85
  225. package/lib/rules/no-negated-condition.js +79 -75
  226. package/lib/rules/no-negated-in-lhs.js +45 -43
  227. package/lib/rules/no-nested-ternary.js +33 -32
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -48
  231. package/lib/rules/no-new-require.js +48 -47
  232. package/lib/rules/no-new-symbol.js +52 -50
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +141 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +32 -32
  240. package/lib/rules/no-param-reassign.js +235 -217
  241. package/lib/rules/no-path-concat.js +66 -67
  242. package/lib/rules/no-plusplus.js +60 -61
  243. package/lib/rules/no-process-env.js +49 -48
  244. package/lib/rules/no-process-exit.js +54 -50
  245. package/lib/rules/no-promise-executor-return.js +214 -182
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -152
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -185
  251. package/lib/rules/no-restricted-globals.js +111 -112
  252. package/lib/rules/no-restricted-imports.js +657 -537
  253. package/lib/rules/no-restricted-modules.js +222 -202
  254. package/lib/rules/no-restricted-properties.js +181 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +55 -50
  257. package/lib/rules/no-return-await.js +148 -124
  258. package/lib/rules/no-script-url.js +52 -45
  259. package/lib/rules/no-self-assign.js +148 -146
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -116
  262. package/lib/rules/no-setter-return.js +185 -152
  263. package/lib/rules/no-shadow-restricted-names.js +61 -46
  264. package/lib/rules/no-shadow.js +342 -316
  265. package/lib/rules/no-spaced-func.js +82 -77
  266. package/lib/rules/no-sparse-arrays.js +54 -59
  267. package/lib/rules/no-sync.js +61 -60
  268. package/lib/rules/no-tabs.js +83 -72
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -29
  271. package/lib/rules/no-this-before-super.js +321 -319
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +199 -191
  274. package/lib/rules/no-undef-init.js +76 -61
  275. package/lib/rules/no-undef.js +51 -48
  276. package/lib/rules/no-undefined.js +73 -75
  277. package/lib/rules/no-underscore-dangle.js +370 -327
  278. package/lib/rules/no-unexpected-multiline.js +112 -102
  279. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  280. package/lib/rules/no-unneeded-ternary.js +212 -147
  281. package/lib/rules/no-unreachable-loop.js +145 -142
  282. package/lib/rules/no-unreachable.js +255 -248
  283. package/lib/rules/no-unsafe-finally.js +93 -85
  284. package/lib/rules/no-unsafe-negation.js +105 -83
  285. package/lib/rules/no-unsafe-optional-chaining.js +192 -178
  286. package/lib/rules/no-unused-expressions.js +178 -162
  287. package/lib/rules/no-unused-labels.js +139 -124
  288. package/lib/rules/no-unused-private-class-members.js +206 -182
  289. package/lib/rules/no-unused-vars.js +1669 -1449
  290. package/lib/rules/no-use-before-define.js +229 -231
  291. package/lib/rules/no-useless-assignment.js +590 -511
  292. package/lib/rules/no-useless-backreference.js +212 -193
  293. package/lib/rules/no-useless-call.js +58 -53
  294. package/lib/rules/no-useless-catch.js +40 -40
  295. package/lib/rules/no-useless-computed-key.js +144 -115
  296. package/lib/rules/no-useless-concat.js +65 -60
  297. package/lib/rules/no-useless-constructor.js +158 -111
  298. package/lib/rules/no-useless-escape.js +342 -291
  299. package/lib/rules/no-useless-rename.js +183 -156
  300. package/lib/rules/no-useless-return.js +344 -312
  301. package/lib/rules/no-var.js +233 -212
  302. package/lib/rules/no-void.js +50 -48
  303. package/lib/rules/no-warning-comments.js +191 -186
  304. package/lib/rules/no-whitespace-before-property.js +131 -115
  305. package/lib/rules/no-with.js +24 -26
  306. package/lib/rules/nonblock-statement-body-position.js +149 -130
  307. package/lib/rules/object-curly-newline.js +306 -265
  308. package/lib/rules/object-curly-spacing.js +360 -314
  309. package/lib/rules/object-property-newline.js +137 -106
  310. package/lib/rules/object-shorthand.js +607 -502
  311. package/lib/rules/one-var-declaration-per-line.js +104 -100
  312. package/lib/rules/one-var.js +653 -537
  313. package/lib/rules/operator-assignment.js +219 -161
  314. package/lib/rules/operator-linebreak.js +295 -251
  315. package/lib/rules/padded-blocks.js +346 -308
  316. package/lib/rules/padding-line-between-statements.js +443 -439
  317. package/lib/rules/prefer-arrow-callback.js +362 -313
  318. package/lib/rules/prefer-const.js +418 -377
  319. package/lib/rules/prefer-destructuring.js +301 -279
  320. package/lib/rules/prefer-exponentiation-operator.js +176 -133
  321. package/lib/rules/prefer-named-capture-group.js +153 -140
  322. package/lib/rules/prefer-numeric-literals.js +121 -113
  323. package/lib/rules/prefer-object-has-own.js +116 -82
  324. package/lib/rules/prefer-object-spread.js +213 -193
  325. package/lib/rules/prefer-promise-reject-errors.js +140 -122
  326. package/lib/rules/prefer-reflect.js +127 -107
  327. package/lib/rules/prefer-regex-literals.js +578 -466
  328. package/lib/rules/prefer-rest-params.js +79 -80
  329. package/lib/rules/prefer-spread.js +47 -44
  330. package/lib/rules/prefer-template.js +266 -195
  331. package/lib/rules/quote-props.js +373 -307
  332. package/lib/rules/quotes.js +374 -326
  333. package/lib/rules/radix.js +152 -136
  334. package/lib/rules/require-atomic-updates.js +316 -285
  335. package/lib/rules/require-await.js +144 -116
  336. package/lib/rules/require-unicode-regexp.js +282 -177
  337. package/lib/rules/require-yield.js +53 -54
  338. package/lib/rules/rest-spread-spacing.js +128 -116
  339. package/lib/rules/semi-spacing.js +281 -250
  340. package/lib/rules/semi-style.js +176 -134
  341. package/lib/rules/semi.js +456 -436
  342. package/lib/rules/sort-imports.js +306 -233
  343. package/lib/rules/sort-keys.js +219 -188
  344. package/lib/rules/sort-vars.js +127 -93
  345. package/lib/rules/space-before-blocks.js +199 -189
  346. package/lib/rules/space-before-function-paren.js +186 -166
  347. package/lib/rules/space-in-parens.js +359 -288
  348. package/lib/rules/space-infix-ops.js +237 -201
  349. package/lib/rules/space-unary-ops.js +356 -298
  350. package/lib/rules/spaced-comment.js +363 -319
  351. package/lib/rules/strict.js +265 -230
  352. package/lib/rules/switch-colon-spacing.js +130 -122
  353. package/lib/rules/symbol-description.js +45 -48
  354. package/lib/rules/template-curly-spacing.js +148 -142
  355. package/lib/rules/template-tag-spacing.js +98 -88
  356. package/lib/rules/unicode-bom.js +54 -56
  357. package/lib/rules/use-isnan.js +237 -206
  358. package/lib/rules/utils/ast-utils.js +2039 -1860
  359. package/lib/rules/utils/char-source.js +162 -155
  360. package/lib/rules/utils/fix-tracker.js +83 -80
  361. package/lib/rules/utils/keywords.js +59 -59
  362. package/lib/rules/utils/lazy-loading-rule-map.js +79 -76
  363. package/lib/rules/utils/regular-expressions.js +32 -24
  364. package/lib/rules/utils/unicode/index.js +4 -4
  365. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  366. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  367. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  368. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  369. package/lib/rules/valid-typeof.js +153 -111
  370. package/lib/rules/vars-on-top.js +152 -145
  371. package/lib/rules/wrap-iife.js +204 -191
  372. package/lib/rules/wrap-regex.js +70 -58
  373. package/lib/rules/yield-star-spacing.js +145 -134
  374. package/lib/rules/yoda.js +283 -272
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/services/suppressions-service.js +289 -0
  378. package/lib/shared/ajv.js +14 -14
  379. package/lib/shared/assert.js +3 -4
  380. package/lib/shared/ast-utils.js +7 -6
  381. package/lib/shared/deep-merge-arrays.js +24 -22
  382. package/lib/shared/directives.js +3 -2
  383. package/lib/shared/flags.js +50 -17
  384. package/lib/shared/logging.js +24 -25
  385. package/lib/shared/option-utils.js +43 -36
  386. package/lib/shared/runtime-info.js +136 -127
  387. package/lib/shared/serialization.js +27 -27
  388. package/lib/shared/severity.js +22 -22
  389. package/lib/shared/stats.js +5 -5
  390. package/lib/shared/string-utils.js +16 -16
  391. package/lib/shared/text-table.js +28 -27
  392. package/lib/shared/traverser.js +153 -146
  393. package/lib/shared/types.js +4 -27
  394. package/lib/types/index.d.ts +2010 -1559
  395. package/lib/types/rules.d.ts +5253 -5140
  396. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  397. package/lib/unsupported-api.js +5 -5
  398. package/messages/all-files-ignored.js +3 -3
  399. package/messages/all-matched-files-ignored.js +3 -3
  400. package/messages/config-file-missing.js +2 -2
  401. package/messages/config-plugin-missing.js +3 -3
  402. package/messages/config-serialize-function.js +9 -7
  403. package/messages/eslintrc-incompat.js +13 -15
  404. package/messages/eslintrc-plugins.js +3 -4
  405. package/messages/extend-config-missing.js +3 -3
  406. package/messages/failed-to-read-json.js +3 -3
  407. package/messages/file-not-found.js +3 -3
  408. package/messages/invalid-rule-options.js +2 -2
  409. package/messages/invalid-rule-severity.js +2 -2
  410. package/messages/no-config-found.js +3 -3
  411. package/messages/plugin-conflict.js +8 -8
  412. package/messages/plugin-invalid.js +3 -3
  413. package/messages/plugin-missing.js +3 -3
  414. package/messages/print-config-with-directory-path.js +2 -2
  415. package/messages/shared.js +6 -1
  416. package/messages/whitespace-found.js +3 -3
  417. package/package.json +14 -20
@@ -16,390 +16,435 @@ const FixTracker = require("./utils/fix-tracker");
16
16
  // Rule Definition
17
17
  //------------------------------------------------------------------------------
18
18
 
19
- /** @type {import('../shared/types').Rule} */
19
+ /** @type {import('../types').Rule.RuleModule} */
20
20
  module.exports = {
21
- meta: {
22
- type: "suggestion",
23
-
24
- defaultOptions: [{ allowElseIf: true }],
25
-
26
- docs: {
27
- description: "Disallow `else` blocks after `return` statements in `if` statements",
28
- recommended: false,
29
- frozen: true,
30
- url: "https://eslint.org/docs/latest/rules/no-else-return"
31
- },
32
-
33
- schema: [{
34
- type: "object",
35
- properties: {
36
- allowElseIf: {
37
- type: "boolean"
38
- }
39
- },
40
- additionalProperties: false
41
- }],
42
-
43
- fixable: "code",
44
-
45
- messages: {
46
- unexpected: "Unnecessary 'else' after 'return'."
47
- }
48
- },
49
-
50
- create(context) {
51
- const [{ allowElseIf }] = context.options;
52
- const sourceCode = context.sourceCode;
53
-
54
- //--------------------------------------------------------------------------
55
- // Helpers
56
- //--------------------------------------------------------------------------
57
-
58
- /**
59
- * Checks whether the given names can be safely used to declare block-scoped variables
60
- * in the given scope. Name collisions can produce redeclaration syntax errors,
61
- * or silently change references and modify behavior of the original code.
62
- *
63
- * This is not a generic function. In particular, it is assumed that the scope is a function scope or
64
- * a function's inner scope, and that the names can be valid identifiers in the given scope.
65
- * @param {string[]} names Array of variable names.
66
- * @param {eslint-scope.Scope} scope Function scope or a function's inner scope.
67
- * @returns {boolean} True if all names can be safely declared, false otherwise.
68
- */
69
- function isSafeToDeclare(names, scope) {
70
-
71
- if (names.length === 0) {
72
- return true;
73
- }
74
-
75
- const functionScope = scope.variableScope;
76
-
77
- /*
78
- * If this is a function scope, scope.variables will contain parameters, implicit variables such as "arguments",
79
- * all function-scoped variables ('var'), and block-scoped variables defined in the scope.
80
- * If this is an inner scope, scope.variables will contain block-scoped variables defined in the scope.
81
- *
82
- * Redeclaring any of these would cause a syntax error, except for the implicit variables.
83
- */
84
- const declaredVariables = scope.variables.filter(({ defs }) => defs.length > 0);
85
-
86
- if (declaredVariables.some(({ name }) => names.includes(name))) {
87
- return false;
88
- }
89
-
90
- // Redeclaring a catch variable would also cause a syntax error.
91
- if (scope !== functionScope && scope.upper.type === "catch") {
92
- if (scope.upper.variables.some(({ name }) => names.includes(name))) {
93
- return false;
94
- }
95
- }
96
-
97
- /*
98
- * Redeclaring an implicit variable, such as "arguments", would not cause a syntax error.
99
- * However, if the variable was used, declaring a new one with the same name would change references
100
- * and modify behavior.
101
- */
102
- const usedImplicitVariables = scope.variables.filter(({ defs, references }) =>
103
- defs.length === 0 && references.length > 0);
104
-
105
- if (usedImplicitVariables.some(({ name }) => names.includes(name))) {
106
- return false;
107
- }
108
-
109
- /*
110
- * Declaring a variable with a name that was already used to reference a variable from an upper scope
111
- * would change references and modify behavior.
112
- */
113
- if (scope.through.some(t => names.includes(t.identifier.name))) {
114
- return false;
115
- }
116
-
117
- /*
118
- * If the scope is an inner scope (not the function scope), an uninitialized `var` variable declared inside
119
- * the scope node (directly or in one of its descendants) is neither declared nor 'through' in the scope.
120
- *
121
- * For example, this would be a syntax error "Identifier 'a' has already been declared":
122
- * function foo() { if (bar) { let a; if (baz) { var a; } } }
123
- */
124
- if (scope !== functionScope) {
125
- const scopeNodeRange = scope.block.range;
126
- const variablesToCheck = functionScope.variables.filter(({ name }) => names.includes(name));
127
-
128
- if (variablesToCheck.some(v => v.defs.some(({ node: { range } }) =>
129
- scopeNodeRange[0] <= range[0] && range[1] <= scopeNodeRange[1]))) {
130
- return false;
131
- }
132
- }
133
-
134
- return true;
135
- }
136
-
137
-
138
- /**
139
- * Checks whether the removal of `else` and its braces is safe from variable name collisions.
140
- * @param {Node} node The 'else' node.
141
- * @param {eslint-scope.Scope} scope The scope in which the node and the whole 'if' statement is.
142
- * @returns {boolean} True if it is safe, false otherwise.
143
- */
144
- function isSafeFromNameCollisions(node, scope) {
145
-
146
- if (node.type === "FunctionDeclaration") {
147
-
148
- // Conditional function declaration. Scope and hoisting are unpredictable, different engines work differently.
149
- return false;
150
- }
151
-
152
- if (node.type !== "BlockStatement") {
153
- return true;
154
- }
155
-
156
- const elseBlockScope = scope.childScopes.find(({ block }) => block === node);
157
-
158
- if (!elseBlockScope) {
159
-
160
- // ecmaVersion < 6, `else` block statement cannot have its own scope, no possible collisions.
161
- return true;
162
- }
163
-
164
- /*
165
- * elseBlockScope is supposed to merge into its upper scope. elseBlockScope.variables array contains
166
- * only block-scoped variables (such as let and const variables or class and function declarations)
167
- * defined directly in the elseBlockScope. These are exactly the only names that could cause collisions.
168
- */
169
- const namesToCheck = elseBlockScope.variables.map(({ name }) => name);
170
-
171
- return isSafeToDeclare(namesToCheck, scope);
172
- }
173
-
174
- /**
175
- * Display the context report if rule is violated
176
- * @param {Node} elseNode The 'else' node
177
- * @returns {void}
178
- */
179
- function displayReport(elseNode) {
180
- const currentScope = sourceCode.getScope(elseNode.parent);
181
-
182
- context.report({
183
- node: elseNode,
184
- messageId: "unexpected",
185
- fix(fixer) {
186
-
187
- if (!isSafeFromNameCollisions(elseNode, currentScope)) {
188
- return null;
189
- }
190
-
191
- const startToken = sourceCode.getFirstToken(elseNode);
192
- const elseToken = sourceCode.getTokenBefore(startToken);
193
- const source = sourceCode.getText(elseNode);
194
- const lastIfToken = sourceCode.getTokenBefore(elseToken);
195
- let fixedSource, firstTokenOfElseBlock;
196
-
197
- if (startToken.type === "Punctuator" && startToken.value === "{") {
198
- firstTokenOfElseBlock = sourceCode.getTokenAfter(startToken);
199
- } else {
200
- firstTokenOfElseBlock = startToken;
201
- }
202
-
203
- /*
204
- * If the if block does not have curly braces and does not end in a semicolon
205
- * and the else block starts with (, [, /, +, ` or -, then it is not
206
- * safe to remove the else keyword, because ASI will not add a semicolon
207
- * after the if block
208
- */
209
- const ifBlockMaybeUnsafe = elseNode.parent.consequent.type !== "BlockStatement" && lastIfToken.value !== ";";
210
- const elseBlockUnsafe = /^[([/+`-]/u.test(firstTokenOfElseBlock.value);
211
-
212
- if (ifBlockMaybeUnsafe && elseBlockUnsafe) {
213
- return null;
214
- }
215
-
216
- const endToken = sourceCode.getLastToken(elseNode);
217
- const lastTokenOfElseBlock = sourceCode.getTokenBefore(endToken);
218
-
219
- if (lastTokenOfElseBlock.value !== ";") {
220
- const nextToken = sourceCode.getTokenAfter(endToken);
221
-
222
- const nextTokenUnsafe = nextToken && /^[([/+`-]/u.test(nextToken.value);
223
- const nextTokenOnSameLine = nextToken && nextToken.loc.start.line === lastTokenOfElseBlock.loc.start.line;
224
-
225
- /*
226
- * If the else block contents does not end in a semicolon,
227
- * and the else block starts with (, [, /, +, ` or -, then it is not
228
- * safe to remove the else block, because ASI will not add a semicolon
229
- * after the remaining else block contents
230
- */
231
- if (nextTokenUnsafe || (nextTokenOnSameLine && nextToken.value !== "}")) {
232
- return null;
233
- }
234
- }
235
-
236
- if (startToken.type === "Punctuator" && startToken.value === "{") {
237
- fixedSource = source.slice(1, -1);
238
- } else {
239
- fixedSource = source;
240
- }
241
-
242
- /*
243
- * Extend the replacement range to include the entire
244
- * function to avoid conflicting with no-useless-return.
245
- * https://github.com/eslint/eslint/issues/8026
246
- *
247
- * Also, to avoid name collisions between two else blocks.
248
- */
249
- return new FixTracker(fixer, sourceCode)
250
- .retainEnclosingFunction(elseNode)
251
- .replaceTextRange([elseToken.range[0], elseNode.range[1]], fixedSource);
252
- }
253
- });
254
- }
255
-
256
- /**
257
- * Check to see if the node is a ReturnStatement
258
- * @param {Node} node The node being evaluated
259
- * @returns {boolean} True if node is a return
260
- */
261
- function checkForReturn(node) {
262
- return node.type === "ReturnStatement";
263
- }
264
-
265
- /**
266
- * Naive return checking, does not iterate through the whole
267
- * BlockStatement because we make the assumption that the ReturnStatement
268
- * will be the last node in the body of the BlockStatement.
269
- * @param {Node} node The consequent/alternate node
270
- * @returns {boolean} True if it has a return
271
- */
272
- function naiveHasReturn(node) {
273
- if (node.type === "BlockStatement") {
274
- const body = node.body,
275
- lastChildNode = body.at(-1);
276
-
277
- return lastChildNode && checkForReturn(lastChildNode);
278
- }
279
- return checkForReturn(node);
280
- }
281
-
282
- /**
283
- * Check to see if the node is valid for evaluation,
284
- * meaning it has an else.
285
- * @param {Node} node The node being evaluated
286
- * @returns {boolean} True if the node is valid
287
- */
288
- function hasElse(node) {
289
- return node.alternate && node.consequent;
290
- }
291
-
292
- /**
293
- * If the consequent is an IfStatement, check to see if it has an else
294
- * and both its consequent and alternate path return, meaning this is
295
- * a nested case of rule violation. If-Else not considered currently.
296
- * @param {Node} node The consequent node
297
- * @returns {boolean} True if this is a nested rule violation
298
- */
299
- function checkForIf(node) {
300
- return node.type === "IfStatement" && hasElse(node) &&
301
- naiveHasReturn(node.alternate) && naiveHasReturn(node.consequent);
302
- }
303
-
304
- /**
305
- * Check the consequent/body node to make sure it is not
306
- * a ReturnStatement or an IfStatement that returns on both
307
- * code paths.
308
- * @param {Node} node The consequent or body node
309
- * @returns {boolean} `true` if it is a Return/If node that always returns.
310
- */
311
- function checkForReturnOrIf(node) {
312
- return checkForReturn(node) || checkForIf(node);
313
- }
314
-
315
-
316
- /**
317
- * Check whether a node returns in every codepath.
318
- * @param {Node} node The node to be checked
319
- * @returns {boolean} `true` if it returns on every codepath.
320
- */
321
- function alwaysReturns(node) {
322
- if (node.type === "BlockStatement") {
323
-
324
- // If we have a BlockStatement, check each consequent body node.
325
- return node.body.some(checkForReturnOrIf);
326
- }
327
-
328
- /*
329
- * If not a block statement, make sure the consequent isn't a
330
- * ReturnStatement or an IfStatement with returns on both paths.
331
- */
332
- return checkForReturnOrIf(node);
333
- }
334
-
335
-
336
- /**
337
- * Check the if statement, but don't catch else-if blocks.
338
- * @returns {void}
339
- * @param {Node} node The node for the if statement to check
340
- * @private
341
- */
342
- function checkIfWithoutElse(node) {
343
- const parent = node.parent;
344
-
345
- /*
346
- * Fixing this would require splitting one statement into two, so no error should
347
- * be reported if this node is in a position where only one statement is allowed.
348
- */
349
- if (!astUtils.STATEMENT_LIST_PARENTS.has(parent.type)) {
350
- return;
351
- }
352
-
353
- const consequents = [];
354
- let alternate;
355
-
356
- for (let currentNode = node; currentNode.type === "IfStatement"; currentNode = currentNode.alternate) {
357
- if (!currentNode.alternate) {
358
- return;
359
- }
360
- consequents.push(currentNode.consequent);
361
- alternate = currentNode.alternate;
362
- }
363
-
364
- if (consequents.every(alwaysReturns)) {
365
- displayReport(alternate);
366
- }
367
- }
368
-
369
- /**
370
- * Check the if statement
371
- * @returns {void}
372
- * @param {Node} node The node for the if statement to check
373
- * @private
374
- */
375
- function checkIfWithElse(node) {
376
- const parent = node.parent;
377
-
378
-
379
- /*
380
- * Fixing this would require splitting one statement into two, so no error should
381
- * be reported if this node is in a position where only one statement is allowed.
382
- */
383
- if (!astUtils.STATEMENT_LIST_PARENTS.has(parent.type)) {
384
- return;
385
- }
386
-
387
- const alternate = node.alternate;
388
-
389
- if (alternate && alwaysReturns(node.consequent)) {
390
- displayReport(alternate);
391
- }
392
- }
393
-
394
- //--------------------------------------------------------------------------
395
- // Public API
396
- //--------------------------------------------------------------------------
397
-
398
- return {
399
-
400
- "IfStatement:exit": allowElseIf ? checkIfWithoutElse : checkIfWithElse
401
-
402
- };
403
-
404
- }
21
+ meta: {
22
+ type: "suggestion",
23
+
24
+ defaultOptions: [{ allowElseIf: true }],
25
+
26
+ docs: {
27
+ description:
28
+ "Disallow `else` blocks after `return` statements in `if` statements",
29
+ recommended: false,
30
+ frozen: true,
31
+ url: "https://eslint.org/docs/latest/rules/no-else-return",
32
+ },
33
+
34
+ schema: [
35
+ {
36
+ type: "object",
37
+ properties: {
38
+ allowElseIf: {
39
+ type: "boolean",
40
+ },
41
+ },
42
+ additionalProperties: false,
43
+ },
44
+ ],
45
+
46
+ fixable: "code",
47
+
48
+ messages: {
49
+ unexpected: "Unnecessary 'else' after 'return'.",
50
+ },
51
+ },
52
+
53
+ create(context) {
54
+ const [{ allowElseIf }] = context.options;
55
+ const sourceCode = context.sourceCode;
56
+
57
+ //--------------------------------------------------------------------------
58
+ // Helpers
59
+ //--------------------------------------------------------------------------
60
+
61
+ /**
62
+ * Checks whether the given names can be safely used to declare block-scoped variables
63
+ * in the given scope. Name collisions can produce redeclaration syntax errors,
64
+ * or silently change references and modify behavior of the original code.
65
+ *
66
+ * This is not a generic function. In particular, it is assumed that the scope is a function scope or
67
+ * a function's inner scope, and that the names can be valid identifiers in the given scope.
68
+ * @param {string[]} names Array of variable names.
69
+ * @param {eslint-scope.Scope} scope Function scope or a function's inner scope.
70
+ * @returns {boolean} True if all names can be safely declared, false otherwise.
71
+ */
72
+ function isSafeToDeclare(names, scope) {
73
+ if (names.length === 0) {
74
+ return true;
75
+ }
76
+
77
+ const functionScope = scope.variableScope;
78
+
79
+ /*
80
+ * If this is a function scope, scope.variables will contain parameters, implicit variables such as "arguments",
81
+ * all function-scoped variables ('var'), and block-scoped variables defined in the scope.
82
+ * If this is an inner scope, scope.variables will contain block-scoped variables defined in the scope.
83
+ *
84
+ * Redeclaring any of these would cause a syntax error, except for the implicit variables.
85
+ */
86
+ const declaredVariables = scope.variables.filter(
87
+ ({ defs }) => defs.length > 0,
88
+ );
89
+
90
+ if (declaredVariables.some(({ name }) => names.includes(name))) {
91
+ return false;
92
+ }
93
+
94
+ // Redeclaring a catch variable would also cause a syntax error.
95
+ if (scope !== functionScope && scope.upper.type === "catch") {
96
+ if (
97
+ scope.upper.variables.some(({ name }) =>
98
+ names.includes(name),
99
+ )
100
+ ) {
101
+ return false;
102
+ }
103
+ }
104
+
105
+ /*
106
+ * Redeclaring an implicit variable, such as "arguments", would not cause a syntax error.
107
+ * However, if the variable was used, declaring a new one with the same name would change references
108
+ * and modify behavior.
109
+ */
110
+ const usedImplicitVariables = scope.variables.filter(
111
+ ({ defs, references }) =>
112
+ defs.length === 0 && references.length > 0,
113
+ );
114
+
115
+ if (
116
+ usedImplicitVariables.some(({ name }) => names.includes(name))
117
+ ) {
118
+ return false;
119
+ }
120
+
121
+ /*
122
+ * Declaring a variable with a name that was already used to reference a variable from an upper scope
123
+ * would change references and modify behavior.
124
+ */
125
+ if (scope.through.some(t => names.includes(t.identifier.name))) {
126
+ return false;
127
+ }
128
+
129
+ /*
130
+ * If the scope is an inner scope (not the function scope), an uninitialized `var` variable declared inside
131
+ * the scope node (directly or in one of its descendants) is neither declared nor 'through' in the scope.
132
+ *
133
+ * For example, this would be a syntax error "Identifier 'a' has already been declared":
134
+ * function foo() { if (bar) { let a; if (baz) { var a; } } }
135
+ */
136
+ if (scope !== functionScope) {
137
+ const scopeNodeRange = scope.block.range;
138
+ const variablesToCheck = functionScope.variables.filter(
139
+ ({ name }) => names.includes(name),
140
+ );
141
+
142
+ if (
143
+ variablesToCheck.some(v =>
144
+ v.defs.some(
145
+ ({ node: { range } }) =>
146
+ scopeNodeRange[0] <= range[0] &&
147
+ range[1] <= scopeNodeRange[1],
148
+ ),
149
+ )
150
+ ) {
151
+ return false;
152
+ }
153
+ }
154
+
155
+ return true;
156
+ }
157
+
158
+ /**
159
+ * Checks whether the removal of `else` and its braces is safe from variable name collisions.
160
+ * @param {Node} node The 'else' node.
161
+ * @param {eslint-scope.Scope} scope The scope in which the node and the whole 'if' statement is.
162
+ * @returns {boolean} True if it is safe, false otherwise.
163
+ */
164
+ function isSafeFromNameCollisions(node, scope) {
165
+ if (node.type === "FunctionDeclaration") {
166
+ // Conditional function declaration. Scope and hoisting are unpredictable, different engines work differently.
167
+ return false;
168
+ }
169
+
170
+ if (node.type !== "BlockStatement") {
171
+ return true;
172
+ }
173
+
174
+ const elseBlockScope = scope.childScopes.find(
175
+ ({ block }) => block === node,
176
+ );
177
+
178
+ if (!elseBlockScope) {
179
+ // ecmaVersion < 6, `else` block statement cannot have its own scope, no possible collisions.
180
+ return true;
181
+ }
182
+
183
+ /*
184
+ * elseBlockScope is supposed to merge into its upper scope. elseBlockScope.variables array contains
185
+ * only block-scoped variables (such as let and const variables or class and function declarations)
186
+ * defined directly in the elseBlockScope. These are exactly the only names that could cause collisions.
187
+ */
188
+ const namesToCheck = elseBlockScope.variables.map(
189
+ ({ name }) => name,
190
+ );
191
+
192
+ return isSafeToDeclare(namesToCheck, scope);
193
+ }
194
+
195
+ /**
196
+ * Display the context report if rule is violated
197
+ * @param {Node} elseNode The 'else' node
198
+ * @returns {void}
199
+ */
200
+ function displayReport(elseNode) {
201
+ const currentScope = sourceCode.getScope(elseNode.parent);
202
+
203
+ context.report({
204
+ node: elseNode,
205
+ messageId: "unexpected",
206
+ fix(fixer) {
207
+ if (!isSafeFromNameCollisions(elseNode, currentScope)) {
208
+ return null;
209
+ }
210
+
211
+ const startToken = sourceCode.getFirstToken(elseNode);
212
+ const elseToken = sourceCode.getTokenBefore(startToken);
213
+ const source = sourceCode.getText(elseNode);
214
+ const lastIfToken = sourceCode.getTokenBefore(elseToken);
215
+ let fixedSource, firstTokenOfElseBlock;
216
+
217
+ if (
218
+ startToken.type === "Punctuator" &&
219
+ startToken.value === "{"
220
+ ) {
221
+ firstTokenOfElseBlock =
222
+ sourceCode.getTokenAfter(startToken);
223
+ } else {
224
+ firstTokenOfElseBlock = startToken;
225
+ }
226
+
227
+ /*
228
+ * If the if block does not have curly braces and does not end in a semicolon
229
+ * and the else block starts with (, [, /, +, ` or -, then it is not
230
+ * safe to remove the else keyword, because ASI will not add a semicolon
231
+ * after the if block
232
+ */
233
+ const ifBlockMaybeUnsafe =
234
+ elseNode.parent.consequent.type !== "BlockStatement" &&
235
+ lastIfToken.value !== ";";
236
+ const elseBlockUnsafe = /^[([/+`-]/u.test(
237
+ firstTokenOfElseBlock.value,
238
+ );
239
+
240
+ if (ifBlockMaybeUnsafe && elseBlockUnsafe) {
241
+ return null;
242
+ }
243
+
244
+ const endToken = sourceCode.getLastToken(elseNode);
245
+ const lastTokenOfElseBlock =
246
+ sourceCode.getTokenBefore(endToken);
247
+
248
+ if (lastTokenOfElseBlock.value !== ";") {
249
+ const nextToken = sourceCode.getTokenAfter(endToken);
250
+
251
+ const nextTokenUnsafe =
252
+ nextToken && /^[([/+`-]/u.test(nextToken.value);
253
+ const nextTokenOnSameLine =
254
+ nextToken &&
255
+ nextToken.loc.start.line ===
256
+ lastTokenOfElseBlock.loc.start.line;
257
+
258
+ /*
259
+ * If the else block contents does not end in a semicolon,
260
+ * and the else block starts with (, [, /, +, ` or -, then it is not
261
+ * safe to remove the else block, because ASI will not add a semicolon
262
+ * after the remaining else block contents
263
+ */
264
+ if (
265
+ nextTokenUnsafe ||
266
+ (nextTokenOnSameLine && nextToken.value !== "}")
267
+ ) {
268
+ return null;
269
+ }
270
+ }
271
+
272
+ if (
273
+ startToken.type === "Punctuator" &&
274
+ startToken.value === "{"
275
+ ) {
276
+ fixedSource = source.slice(1, -1);
277
+ } else {
278
+ fixedSource = source;
279
+ }
280
+
281
+ /*
282
+ * Extend the replacement range to include the entire
283
+ * function to avoid conflicting with no-useless-return.
284
+ * https://github.com/eslint/eslint/issues/8026
285
+ *
286
+ * Also, to avoid name collisions between two else blocks.
287
+ */
288
+ return new FixTracker(fixer, sourceCode)
289
+ .retainEnclosingFunction(elseNode)
290
+ .replaceTextRange(
291
+ [elseToken.range[0], elseNode.range[1]],
292
+ fixedSource,
293
+ );
294
+ },
295
+ });
296
+ }
297
+
298
+ /**
299
+ * Check to see if the node is a ReturnStatement
300
+ * @param {Node} node The node being evaluated
301
+ * @returns {boolean} True if node is a return
302
+ */
303
+ function checkForReturn(node) {
304
+ return node.type === "ReturnStatement";
305
+ }
306
+
307
+ /**
308
+ * Naive return checking, does not iterate through the whole
309
+ * BlockStatement because we make the assumption that the ReturnStatement
310
+ * will be the last node in the body of the BlockStatement.
311
+ * @param {Node} node The consequent/alternate node
312
+ * @returns {boolean} True if it has a return
313
+ */
314
+ function naiveHasReturn(node) {
315
+ if (node.type === "BlockStatement") {
316
+ const body = node.body,
317
+ lastChildNode = body.at(-1);
318
+
319
+ return lastChildNode && checkForReturn(lastChildNode);
320
+ }
321
+ return checkForReturn(node);
322
+ }
323
+
324
+ /**
325
+ * Check to see if the node is valid for evaluation,
326
+ * meaning it has an else.
327
+ * @param {Node} node The node being evaluated
328
+ * @returns {boolean} True if the node is valid
329
+ */
330
+ function hasElse(node) {
331
+ return node.alternate && node.consequent;
332
+ }
333
+
334
+ /**
335
+ * If the consequent is an IfStatement, check to see if it has an else
336
+ * and both its consequent and alternate path return, meaning this is
337
+ * a nested case of rule violation. If-Else not considered currently.
338
+ * @param {Node} node The consequent node
339
+ * @returns {boolean} True if this is a nested rule violation
340
+ */
341
+ function checkForIf(node) {
342
+ return (
343
+ node.type === "IfStatement" &&
344
+ hasElse(node) &&
345
+ naiveHasReturn(node.alternate) &&
346
+ naiveHasReturn(node.consequent)
347
+ );
348
+ }
349
+
350
+ /**
351
+ * Check the consequent/body node to make sure it is not
352
+ * a ReturnStatement or an IfStatement that returns on both
353
+ * code paths.
354
+ * @param {Node} node The consequent or body node
355
+ * @returns {boolean} `true` if it is a Return/If node that always returns.
356
+ */
357
+ function checkForReturnOrIf(node) {
358
+ return checkForReturn(node) || checkForIf(node);
359
+ }
360
+
361
+ /**
362
+ * Check whether a node returns in every codepath.
363
+ * @param {Node} node The node to be checked
364
+ * @returns {boolean} `true` if it returns on every codepath.
365
+ */
366
+ function alwaysReturns(node) {
367
+ if (node.type === "BlockStatement") {
368
+ // If we have a BlockStatement, check each consequent body node.
369
+ return node.body.some(checkForReturnOrIf);
370
+ }
371
+
372
+ /*
373
+ * If not a block statement, make sure the consequent isn't a
374
+ * ReturnStatement or an IfStatement with returns on both paths.
375
+ */
376
+ return checkForReturnOrIf(node);
377
+ }
378
+
379
+ /**
380
+ * Check the if statement, but don't catch else-if blocks.
381
+ * @returns {void}
382
+ * @param {Node} node The node for the if statement to check
383
+ * @private
384
+ */
385
+ function checkIfWithoutElse(node) {
386
+ const parent = node.parent;
387
+
388
+ /*
389
+ * Fixing this would require splitting one statement into two, so no error should
390
+ * be reported if this node is in a position where only one statement is allowed.
391
+ */
392
+ if (!astUtils.STATEMENT_LIST_PARENTS.has(parent.type)) {
393
+ return;
394
+ }
395
+
396
+ const consequents = [];
397
+ let alternate;
398
+
399
+ for (
400
+ let currentNode = node;
401
+ currentNode.type === "IfStatement";
402
+ currentNode = currentNode.alternate
403
+ ) {
404
+ if (!currentNode.alternate) {
405
+ return;
406
+ }
407
+ consequents.push(currentNode.consequent);
408
+ alternate = currentNode.alternate;
409
+ }
410
+
411
+ if (consequents.every(alwaysReturns)) {
412
+ displayReport(alternate);
413
+ }
414
+ }
415
+
416
+ /**
417
+ * Check the if statement
418
+ * @returns {void}
419
+ * @param {Node} node The node for the if statement to check
420
+ * @private
421
+ */
422
+ function checkIfWithElse(node) {
423
+ const parent = node.parent;
424
+
425
+ /*
426
+ * Fixing this would require splitting one statement into two, so no error should
427
+ * be reported if this node is in a position where only one statement is allowed.
428
+ */
429
+ if (!astUtils.STATEMENT_LIST_PARENTS.has(parent.type)) {
430
+ return;
431
+ }
432
+
433
+ const alternate = node.alternate;
434
+
435
+ if (alternate && alwaysReturns(node.consequent)) {
436
+ displayReport(alternate);
437
+ }
438
+ }
439
+
440
+ //--------------------------------------------------------------------------
441
+ // Public API
442
+ //--------------------------------------------------------------------------
443
+
444
+ return {
445
+ "IfStatement:exit": allowElseIf
446
+ ? checkIfWithoutElse
447
+ : checkIfWithElse,
448
+ };
449
+ },
405
450
  };