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
@@ -5,9 +5,28 @@
5
5
 
6
6
  "use strict";
7
7
 
8
- const { isNullLiteral, isConstant, isReferenceToGlobalVariable, isLogicalAssignmentOperator, ECMASCRIPT_GLOBALS } = require("./utils/ast-utils");
9
-
10
- const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set(["+", "-", "*", "/", "%", "|", "^", "&", "**", "<<", ">>", ">>>"]);
8
+ const {
9
+ isNullLiteral,
10
+ isConstant,
11
+ isReferenceToGlobalVariable,
12
+ isLogicalAssignmentOperator,
13
+ ECMASCRIPT_GLOBALS,
14
+ } = require("./utils/ast-utils");
15
+
16
+ const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set([
17
+ "+",
18
+ "-",
19
+ "*",
20
+ "/",
21
+ "%",
22
+ "|",
23
+ "^",
24
+ "&",
25
+ "**",
26
+ "<<",
27
+ ">>",
28
+ ">>>",
29
+ ]);
11
30
 
12
31
  //------------------------------------------------------------------------------
13
32
  // Helpers
@@ -23,11 +42,13 @@ const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set(["+", "-", "*", "/", "%", "|"
23
42
  * @public
24
43
  */
25
44
  function isNullOrUndefined(scope, node) {
26
- return (
27
- isNullLiteral(node) ||
28
- (node.type === "Identifier" && node.name === "undefined" && isReferenceToGlobalVariable(scope, node)) ||
29
- (node.type === "UnaryExpression" && node.operator === "void")
30
- );
45
+ return (
46
+ isNullLiteral(node) ||
47
+ (node.type === "Identifier" &&
48
+ node.name === "undefined" &&
49
+ isReferenceToGlobalVariable(scope, node)) ||
50
+ (node.type === "UnaryExpression" && node.operator === "void")
51
+ );
31
52
  }
32
53
 
33
54
  /**
@@ -41,79 +62,88 @@ function isNullOrUndefined(scope, node) {
41
62
  * @returns {boolean} Does `node` have constant nullishness?
42
63
  */
43
64
  function hasConstantNullishness(scope, node, nonNullish) {
44
- if (nonNullish && isNullOrUndefined(scope, node)) {
45
- return false;
46
- }
47
-
48
- switch (node.type) {
49
- case "ObjectExpression": // Objects are never nullish
50
- case "ArrayExpression": // Arrays are never nullish
51
- case "ArrowFunctionExpression": // Functions never nullish
52
- case "FunctionExpression": // Functions are never nullish
53
- case "ClassExpression": // Classes are never nullish
54
- case "NewExpression": // Objects are never nullish
55
- case "Literal": // Nullish, or non-nullish, literals never change
56
- case "TemplateLiteral": // A string is never nullish
57
- case "UpdateExpression": // Numbers are never nullish
58
- case "BinaryExpression": // Numbers, strings, or booleans are never nullish
59
- return true;
60
- case "CallExpression": {
61
- if (node.callee.type !== "Identifier") {
62
- return false;
63
- }
64
- const functionName = node.callee.name;
65
-
66
- return (functionName === "Boolean" || functionName === "String" || functionName === "Number") &&
67
- isReferenceToGlobalVariable(scope, node.callee);
68
- }
69
- case "LogicalExpression": {
70
- return node.operator === "??" && hasConstantNullishness(scope, node.right, true);
71
- }
72
- case "AssignmentExpression":
73
- if (node.operator === "=") {
74
- return hasConstantNullishness(scope, node.right, nonNullish);
75
- }
76
-
77
- /*
78
- * Handling short-circuiting assignment operators would require
79
- * walking the scope. We won't attempt that (for now...) /
80
- */
81
- if (isLogicalAssignmentOperator(node.operator)) {
82
- return false;
83
- }
84
-
85
- /*
86
- * The remaining assignment expressions all result in a numeric or
87
- * string (non-nullish) value:
88
- * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
89
- */
90
-
91
- return true;
92
- case "UnaryExpression":
93
-
94
- /*
95
- * "void" Always returns `undefined`
96
- * "typeof" All types are strings, and thus non-nullish
97
- * "!" Boolean is never nullish
98
- * "delete" Returns a boolean, which is never nullish
99
- * Math operators always return numbers or strings, neither of which
100
- * are non-nullish "+", "-", "~"
101
- */
102
-
103
- return true;
104
- case "SequenceExpression": {
105
- const last = node.expressions.at(-1);
106
-
107
- return hasConstantNullishness(scope, last, nonNullish);
108
- }
109
- case "Identifier":
110
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
111
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
112
- case "JSXFragment":
113
- return false;
114
- default:
115
- return false;
116
- }
65
+ if (nonNullish && isNullOrUndefined(scope, node)) {
66
+ return false;
67
+ }
68
+
69
+ switch (node.type) {
70
+ case "ObjectExpression": // Objects are never nullish
71
+ case "ArrayExpression": // Arrays are never nullish
72
+ case "ArrowFunctionExpression": // Functions never nullish
73
+ case "FunctionExpression": // Functions are never nullish
74
+ case "ClassExpression": // Classes are never nullish
75
+ case "NewExpression": // Objects are never nullish
76
+ case "Literal": // Nullish, or non-nullish, literals never change
77
+ case "TemplateLiteral": // A string is never nullish
78
+ case "UpdateExpression": // Numbers are never nullish
79
+ case "BinaryExpression": // Numbers, strings, or booleans are never nullish
80
+ return true;
81
+ case "CallExpression": {
82
+ if (node.callee.type !== "Identifier") {
83
+ return false;
84
+ }
85
+ const functionName = node.callee.name;
86
+
87
+ return (
88
+ (functionName === "Boolean" ||
89
+ functionName === "String" ||
90
+ functionName === "Number") &&
91
+ isReferenceToGlobalVariable(scope, node.callee)
92
+ );
93
+ }
94
+ case "LogicalExpression": {
95
+ return (
96
+ node.operator === "??" &&
97
+ hasConstantNullishness(scope, node.right, true)
98
+ );
99
+ }
100
+ case "AssignmentExpression":
101
+ if (node.operator === "=") {
102
+ return hasConstantNullishness(scope, node.right, nonNullish);
103
+ }
104
+
105
+ /*
106
+ * Handling short-circuiting assignment operators would require
107
+ * walking the scope. We won't attempt that (for now...) /
108
+ */
109
+ if (isLogicalAssignmentOperator(node.operator)) {
110
+ return false;
111
+ }
112
+
113
+ /*
114
+ * The remaining assignment expressions all result in a numeric or
115
+ * string (non-nullish) value:
116
+ * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
117
+ */
118
+
119
+ return true;
120
+ case "UnaryExpression":
121
+ /*
122
+ * "void" Always returns `undefined`
123
+ * "typeof" All types are strings, and thus non-nullish
124
+ * "!" Boolean is never nullish
125
+ * "delete" Returns a boolean, which is never nullish
126
+ * Math operators always return numbers or strings, neither of which
127
+ * are non-nullish "+", "-", "~"
128
+ */
129
+
130
+ return true;
131
+ case "SequenceExpression": {
132
+ const last = node.expressions.at(-1);
133
+
134
+ return hasConstantNullishness(scope, last, nonNullish);
135
+ }
136
+ case "Identifier":
137
+ return (
138
+ node.name === "undefined" &&
139
+ isReferenceToGlobalVariable(scope, node)
140
+ );
141
+ case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
142
+ case "JSXFragment":
143
+ return false;
144
+ default:
145
+ return false;
146
+ }
117
147
  }
118
148
 
119
149
  /**
@@ -127,21 +157,26 @@ function hasConstantNullishness(scope, node, nonNullish) {
127
157
  * @returns {boolean} Is `node` guaranteed to be a boolean?
128
158
  */
129
159
  function isStaticBoolean(scope, node) {
130
- switch (node.type) {
131
- case "Literal":
132
- return typeof node.value === "boolean";
133
- case "CallExpression":
134
- return node.callee.type === "Identifier" && node.callee.name === "Boolean" &&
135
- isReferenceToGlobalVariable(scope, node.callee) &&
136
- (node.arguments.length === 0 || isConstant(scope, node.arguments[0], true));
137
- case "UnaryExpression":
138
- return node.operator === "!" && isConstant(scope, node.argument, true);
139
- default:
140
- return false;
141
- }
160
+ switch (node.type) {
161
+ case "Literal":
162
+ return typeof node.value === "boolean";
163
+ case "CallExpression":
164
+ return (
165
+ node.callee.type === "Identifier" &&
166
+ node.callee.name === "Boolean" &&
167
+ isReferenceToGlobalVariable(scope, node.callee) &&
168
+ (node.arguments.length === 0 ||
169
+ isConstant(scope, node.arguments[0], true))
170
+ );
171
+ case "UnaryExpression":
172
+ return (
173
+ node.operator === "!" && isConstant(scope, node.argument, true)
174
+ );
175
+ default:
176
+ return false;
177
+ }
142
178
  }
143
179
 
144
-
145
180
  /**
146
181
  * Test if an AST node will always give the same result when compared to a
147
182
  * boolean value. Note that comparison to boolean values is different than
@@ -155,111 +190,116 @@ function isStaticBoolean(scope, node) {
155
190
  * @returns {boolean} Will `node` always coerce to the same boolean value?
156
191
  */
157
192
  function hasConstantLooseBooleanComparison(scope, node) {
158
- switch (node.type) {
159
- case "ObjectExpression":
160
- case "ClassExpression":
161
-
162
- /**
163
- * In theory objects like:
164
- *
165
- * `{toString: () => a}`
166
- * `{valueOf: () => a}`
167
- *
168
- * Or a classes like:
169
- *
170
- * `class { static toString() { return a } }`
171
- * `class { static valueOf() { return a } }`
172
- *
173
- * Are not constant verifiably when `inBooleanPosition` is
174
- * false, but it's an edge case we've opted not to handle.
175
- */
176
- return true;
177
- case "ArrayExpression": {
178
- const nonSpreadElements = node.elements.filter(e =>
179
-
180
- // Elements can be `null` in sparse arrays: `[,,]`;
181
- e !== null && e.type !== "SpreadElement");
182
-
183
-
184
- /*
185
- * Possible future direction if needed: We could check if the
186
- * single value would result in variable boolean comparison.
187
- * For now we will err on the side of caution since `[x]` could
188
- * evaluate to `[0]` or `[1]`.
189
- */
190
- return node.elements.length === 0 || nonSpreadElements.length > 1;
191
- }
192
- case "ArrowFunctionExpression":
193
- case "FunctionExpression":
194
- return true;
195
- case "UnaryExpression":
196
- if (node.operator === "void" || // Always returns `undefined`
197
- node.operator === "typeof" // All `typeof` strings, when coerced to number, are not 0 or 1.
198
- ) {
199
- return true;
200
- }
201
- if (node.operator === "!") {
202
- return isConstant(scope, node.argument, true);
203
- }
204
-
205
- /*
206
- * We won't try to reason about +, -, ~, or delete
207
- * In theory, for the mathematical operators, we could look at the
208
- * argument and try to determine if it coerces to a constant numeric
209
- * value.
210
- */
211
- return false;
212
- case "NewExpression": // Objects might have custom `.valueOf` or `.toString`.
213
- return false;
214
- case "CallExpression": {
215
- if (node.callee.type === "Identifier" &&
216
- node.callee.name === "Boolean" &&
217
- isReferenceToGlobalVariable(scope, node.callee)
218
- ) {
219
- return node.arguments.length === 0 || isConstant(scope, node.arguments[0], true);
220
- }
221
- return false;
222
- }
223
- case "Literal": // True or false, literals never change
224
- return true;
225
- case "Identifier":
226
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
227
- case "TemplateLiteral":
228
-
229
- /*
230
- * In theory we could try to check if the quasi are sufficient to
231
- * prove that the expression will always be true, but it would be
232
- * tricky to get right. For example: `000.${foo}000`
233
- */
234
- return node.expressions.length === 0;
235
- case "AssignmentExpression":
236
- if (node.operator === "=") {
237
- return hasConstantLooseBooleanComparison(scope, node.right);
238
- }
239
-
240
- /*
241
- * Handling short-circuiting assignment operators would require
242
- * walking the scope. We won't attempt that (for now...)
243
- *
244
- * The remaining assignment expressions all result in a numeric or
245
- * string (non-nullish) values which could be truthy or falsy:
246
- * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
247
- */
248
- return false;
249
- case "SequenceExpression": {
250
- const last = node.expressions.at(-1);
251
-
252
- return hasConstantLooseBooleanComparison(scope, last);
253
- }
254
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
255
- case "JSXFragment":
256
- return false;
257
- default:
258
- return false;
259
- }
193
+ switch (node.type) {
194
+ case "ObjectExpression":
195
+ case "ClassExpression":
196
+ /**
197
+ * In theory objects like:
198
+ *
199
+ * `{toString: () => a}`
200
+ * `{valueOf: () => a}`
201
+ *
202
+ * Or a classes like:
203
+ *
204
+ * `class { static toString() { return a } }`
205
+ * `class { static valueOf() { return a } }`
206
+ *
207
+ * Are not constant verifiably when `inBooleanPosition` is
208
+ * false, but it's an edge case we've opted not to handle.
209
+ */
210
+ return true;
211
+ case "ArrayExpression": {
212
+ const nonSpreadElements = node.elements.filter(
213
+ e =>
214
+ // Elements can be `null` in sparse arrays: `[,,]`;
215
+ e !== null && e.type !== "SpreadElement",
216
+ );
217
+
218
+ /*
219
+ * Possible future direction if needed: We could check if the
220
+ * single value would result in variable boolean comparison.
221
+ * For now we will err on the side of caution since `[x]` could
222
+ * evaluate to `[0]` or `[1]`.
223
+ */
224
+ return node.elements.length === 0 || nonSpreadElements.length > 1;
225
+ }
226
+ case "ArrowFunctionExpression":
227
+ case "FunctionExpression":
228
+ return true;
229
+ case "UnaryExpression":
230
+ if (
231
+ node.operator === "void" || // Always returns `undefined`
232
+ node.operator === "typeof" // All `typeof` strings, when coerced to number, are not 0 or 1.
233
+ ) {
234
+ return true;
235
+ }
236
+ if (node.operator === "!") {
237
+ return isConstant(scope, node.argument, true);
238
+ }
239
+
240
+ /*
241
+ * We won't try to reason about +, -, ~, or delete
242
+ * In theory, for the mathematical operators, we could look at the
243
+ * argument and try to determine if it coerces to a constant numeric
244
+ * value.
245
+ */
246
+ return false;
247
+ case "NewExpression": // Objects might have custom `.valueOf` or `.toString`.
248
+ return false;
249
+ case "CallExpression": {
250
+ if (
251
+ node.callee.type === "Identifier" &&
252
+ node.callee.name === "Boolean" &&
253
+ isReferenceToGlobalVariable(scope, node.callee)
254
+ ) {
255
+ return (
256
+ node.arguments.length === 0 ||
257
+ isConstant(scope, node.arguments[0], true)
258
+ );
259
+ }
260
+ return false;
261
+ }
262
+ case "Literal": // True or false, literals never change
263
+ return true;
264
+ case "Identifier":
265
+ return (
266
+ node.name === "undefined" &&
267
+ isReferenceToGlobalVariable(scope, node)
268
+ );
269
+ case "TemplateLiteral":
270
+ /*
271
+ * In theory we could try to check if the quasi are sufficient to
272
+ * prove that the expression will always be true, but it would be
273
+ * tricky to get right. For example: `000.${foo}000`
274
+ */
275
+ return node.expressions.length === 0;
276
+ case "AssignmentExpression":
277
+ if (node.operator === "=") {
278
+ return hasConstantLooseBooleanComparison(scope, node.right);
279
+ }
280
+
281
+ /*
282
+ * Handling short-circuiting assignment operators would require
283
+ * walking the scope. We won't attempt that (for now...)
284
+ *
285
+ * The remaining assignment expressions all result in a numeric or
286
+ * string (non-nullish) values which could be truthy or falsy:
287
+ * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
288
+ */
289
+ return false;
290
+ case "SequenceExpression": {
291
+ const last = node.expressions.at(-1);
292
+
293
+ return hasConstantLooseBooleanComparison(scope, last);
294
+ }
295
+ case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
296
+ case "JSXFragment":
297
+ return false;
298
+ default:
299
+ return false;
300
+ }
260
301
  }
261
302
 
262
-
263
303
  /**
264
304
  * Test if an AST node will always give the same result when _strictly_ compared
265
305
  * to a boolean value. This can happen if the expression can never be boolean, or
@@ -270,82 +310,90 @@ function hasConstantLooseBooleanComparison(scope, node) {
270
310
  * static boolean value?
271
311
  */
272
312
  function hasConstantStrictBooleanComparison(scope, node) {
273
- switch (node.type) {
274
- case "ObjectExpression": // Objects are not booleans
275
- case "ArrayExpression": // Arrays are not booleans
276
- case "ArrowFunctionExpression": // Functions are not booleans
277
- case "FunctionExpression":
278
- case "ClassExpression": // Classes are not booleans
279
- case "NewExpression": // Objects are not booleans
280
- case "TemplateLiteral": // Strings are not booleans
281
- case "Literal": // True, false, or not boolean, literals never change.
282
- case "UpdateExpression": // Numbers are not booleans
283
- return true;
284
- case "BinaryExpression":
285
- return NUMERIC_OR_STRING_BINARY_OPERATORS.has(node.operator);
286
- case "UnaryExpression": {
287
- if (node.operator === "delete") {
288
- return false;
289
- }
290
- if (node.operator === "!") {
291
- return isConstant(scope, node.argument, true);
292
- }
293
-
294
- /*
295
- * The remaining operators return either strings or numbers, neither
296
- * of which are boolean.
297
- */
298
- return true;
299
- }
300
- case "SequenceExpression": {
301
- const last = node.expressions.at(-1);
302
-
303
- return hasConstantStrictBooleanComparison(scope, last);
304
- }
305
- case "Identifier":
306
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
307
- case "AssignmentExpression":
308
- if (node.operator === "=") {
309
- return hasConstantStrictBooleanComparison(scope, node.right);
310
- }
311
-
312
- /*
313
- * Handling short-circuiting assignment operators would require
314
- * walking the scope. We won't attempt that (for now...)
315
- */
316
- if (isLogicalAssignmentOperator(node.operator)) {
317
- return false;
318
- }
319
-
320
- /*
321
- * The remaining assignment expressions all result in either a number
322
- * or a string, neither of which can ever be boolean.
323
- */
324
- return true;
325
- case "CallExpression": {
326
- if (node.callee.type !== "Identifier") {
327
- return false;
328
- }
329
- const functionName = node.callee.name;
330
-
331
- if (
332
- (functionName === "String" || functionName === "Number") &&
333
- isReferenceToGlobalVariable(scope, node.callee)
334
- ) {
335
- return true;
336
- }
337
- if (functionName === "Boolean" && isReferenceToGlobalVariable(scope, node.callee)) {
338
- return (
339
- node.arguments.length === 0 || isConstant(scope, node.arguments[0], true));
340
- }
341
- return false;
342
- }
343
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
344
- case "JSXFragment":
345
- return false;
346
- default:
347
- return false;
348
- }
313
+ switch (node.type) {
314
+ case "ObjectExpression": // Objects are not booleans
315
+ case "ArrayExpression": // Arrays are not booleans
316
+ case "ArrowFunctionExpression": // Functions are not booleans
317
+ case "FunctionExpression":
318
+ case "ClassExpression": // Classes are not booleans
319
+ case "NewExpression": // Objects are not booleans
320
+ case "TemplateLiteral": // Strings are not booleans
321
+ case "Literal": // True, false, or not boolean, literals never change.
322
+ case "UpdateExpression": // Numbers are not booleans
323
+ return true;
324
+ case "BinaryExpression":
325
+ return NUMERIC_OR_STRING_BINARY_OPERATORS.has(node.operator);
326
+ case "UnaryExpression": {
327
+ if (node.operator === "delete") {
328
+ return false;
329
+ }
330
+ if (node.operator === "!") {
331
+ return isConstant(scope, node.argument, true);
332
+ }
333
+
334
+ /*
335
+ * The remaining operators return either strings or numbers, neither
336
+ * of which are boolean.
337
+ */
338
+ return true;
339
+ }
340
+ case "SequenceExpression": {
341
+ const last = node.expressions.at(-1);
342
+
343
+ return hasConstantStrictBooleanComparison(scope, last);
344
+ }
345
+ case "Identifier":
346
+ return (
347
+ node.name === "undefined" &&
348
+ isReferenceToGlobalVariable(scope, node)
349
+ );
350
+ case "AssignmentExpression":
351
+ if (node.operator === "=") {
352
+ return hasConstantStrictBooleanComparison(scope, node.right);
353
+ }
354
+
355
+ /*
356
+ * Handling short-circuiting assignment operators would require
357
+ * walking the scope. We won't attempt that (for now...)
358
+ */
359
+ if (isLogicalAssignmentOperator(node.operator)) {
360
+ return false;
361
+ }
362
+
363
+ /*
364
+ * The remaining assignment expressions all result in either a number
365
+ * or a string, neither of which can ever be boolean.
366
+ */
367
+ return true;
368
+ case "CallExpression": {
369
+ if (node.callee.type !== "Identifier") {
370
+ return false;
371
+ }
372
+ const functionName = node.callee.name;
373
+
374
+ if (
375
+ (functionName === "String" || functionName === "Number") &&
376
+ isReferenceToGlobalVariable(scope, node.callee)
377
+ ) {
378
+ return true;
379
+ }
380
+ if (
381
+ functionName === "Boolean" &&
382
+ isReferenceToGlobalVariable(scope, node.callee)
383
+ ) {
384
+ return (
385
+ node.arguments.length === 0 ||
386
+ isConstant(scope, node.arguments[0], true)
387
+ );
388
+ }
389
+ return false;
390
+ }
391
+ case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
392
+ case "JSXFragment":
393
+ return false;
394
+ default:
395
+ return false;
396
+ }
349
397
  }
350
398
 
351
399
  /**
@@ -355,51 +403,55 @@ function hasConstantStrictBooleanComparison(scope, node) {
355
403
  * @returns {boolean} Will `node` always be new?
356
404
  */
357
405
  function isAlwaysNew(scope, node) {
358
- switch (node.type) {
359
- case "ObjectExpression":
360
- case "ArrayExpression":
361
- case "ArrowFunctionExpression":
362
- case "FunctionExpression":
363
- case "ClassExpression":
364
- return true;
365
- case "NewExpression": {
366
- if (node.callee.type !== "Identifier") {
367
- return false;
368
- }
369
-
370
- /*
371
- * All the built-in constructors are always new, but
372
- * user-defined constructors could return a sentinel
373
- * object.
374
- *
375
- * Catching these is especially useful for primitive constructors
376
- * which return boxed values, a surprising gotcha' in JavaScript.
377
- */
378
- return Object.hasOwn(ECMASCRIPT_GLOBALS, node.callee.name) &&
379
- isReferenceToGlobalVariable(scope, node.callee);
380
- }
381
- case "Literal":
382
-
383
- // Regular expressions are objects, and thus always new
384
- return typeof node.regex === "object";
385
- case "SequenceExpression": {
386
- const last = node.expressions.at(-1);
387
-
388
- return isAlwaysNew(scope, last);
389
- }
390
- case "AssignmentExpression":
391
- if (node.operator === "=") {
392
- return isAlwaysNew(scope, node.right);
393
- }
394
- return false;
395
- case "ConditionalExpression":
396
- return isAlwaysNew(scope, node.consequent) && isAlwaysNew(scope, node.alternate);
397
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
398
- case "JSXFragment":
399
- return false;
400
- default:
401
- return false;
402
- }
406
+ switch (node.type) {
407
+ case "ObjectExpression":
408
+ case "ArrayExpression":
409
+ case "ArrowFunctionExpression":
410
+ case "FunctionExpression":
411
+ case "ClassExpression":
412
+ return true;
413
+ case "NewExpression": {
414
+ if (node.callee.type !== "Identifier") {
415
+ return false;
416
+ }
417
+
418
+ /*
419
+ * All the built-in constructors are always new, but
420
+ * user-defined constructors could return a sentinel
421
+ * object.
422
+ *
423
+ * Catching these is especially useful for primitive constructors
424
+ * which return boxed values, a surprising gotcha' in JavaScript.
425
+ */
426
+ return (
427
+ Object.hasOwn(ECMASCRIPT_GLOBALS, node.callee.name) &&
428
+ isReferenceToGlobalVariable(scope, node.callee)
429
+ );
430
+ }
431
+ case "Literal":
432
+ // Regular expressions are objects, and thus always new
433
+ return typeof node.regex === "object";
434
+ case "SequenceExpression": {
435
+ const last = node.expressions.at(-1);
436
+
437
+ return isAlwaysNew(scope, last);
438
+ }
439
+ case "AssignmentExpression":
440
+ if (node.operator === "=") {
441
+ return isAlwaysNew(scope, node.right);
442
+ }
443
+ return false;
444
+ case "ConditionalExpression":
445
+ return (
446
+ isAlwaysNew(scope, node.consequent) &&
447
+ isAlwaysNew(scope, node.alternate)
448
+ );
449
+ case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
450
+ case "JSXFragment":
451
+ return false;
452
+ default:
453
+ return false;
454
+ }
403
455
  }
404
456
 
405
457
  /**
@@ -411,98 +463,141 @@ function isAlwaysNew(scope, node) {
411
463
  * @returns {ASTNode | null} The node which will cause the expression to have a constant result.
412
464
  */
413
465
  function findBinaryExpressionConstantOperand(scope, a, b, operator) {
414
- if (operator === "==" || operator === "!=") {
415
- if (
416
- (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
417
- (isStaticBoolean(scope, a) && hasConstantLooseBooleanComparison(scope, b))
418
- ) {
419
- return b;
420
- }
421
- } else if (operator === "===" || operator === "!==") {
422
- if (
423
- (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
424
- (isStaticBoolean(scope, a) && hasConstantStrictBooleanComparison(scope, b))
425
- ) {
426
- return b;
427
- }
428
- }
429
- return null;
466
+ if (operator === "==" || operator === "!=") {
467
+ if (
468
+ (isNullOrUndefined(scope, a) &&
469
+ hasConstantNullishness(scope, b, false)) ||
470
+ (isStaticBoolean(scope, a) &&
471
+ hasConstantLooseBooleanComparison(scope, b))
472
+ ) {
473
+ return b;
474
+ }
475
+ } else if (operator === "===" || operator === "!==") {
476
+ if (
477
+ (isNullOrUndefined(scope, a) &&
478
+ hasConstantNullishness(scope, b, false)) ||
479
+ (isStaticBoolean(scope, a) &&
480
+ hasConstantStrictBooleanComparison(scope, b))
481
+ ) {
482
+ return b;
483
+ }
484
+ }
485
+ return null;
430
486
  }
431
487
 
432
488
  //------------------------------------------------------------------------------
433
489
  // Rule Definition
434
490
  //------------------------------------------------------------------------------
435
491
 
436
- /** @type {import('../shared/types').Rule} */
492
+ /** @type {import('../types').Rule.RuleModule} */
437
493
  module.exports = {
438
- meta: {
439
- type: "problem",
440
- docs: {
441
- description: "Disallow expressions where the operation doesn't affect the value",
442
- recommended: true,
443
- url: "https://eslint.org/docs/latest/rules/no-constant-binary-expression"
444
- },
445
- schema: [],
446
- messages: {
447
- constantBinaryOperand: "Unexpected constant binary expression. Compares constantly with the {{otherSide}}-hand side of the `{{operator}}`.",
448
- constantShortCircuit: "Unexpected constant {{property}} on the left-hand side of a `{{operator}}` expression.",
449
- alwaysNew: "Unexpected comparison to newly constructed object. These two values can never be equal.",
450
- bothAlwaysNew: "Unexpected comparison of two newly constructed objects. These two values can never be equal."
451
- }
452
- },
453
-
454
- create(context) {
455
- const sourceCode = context.sourceCode;
456
-
457
- return {
458
- LogicalExpression(node) {
459
- const { operator, left } = node;
460
- const scope = sourceCode.getScope(node);
461
-
462
- if ((operator === "&&" || operator === "||") && isConstant(scope, left, true)) {
463
- context.report({ node: left, messageId: "constantShortCircuit", data: { property: "truthiness", operator } });
464
- } else if (operator === "??" && hasConstantNullishness(scope, left, false)) {
465
- context.report({ node: left, messageId: "constantShortCircuit", data: { property: "nullishness", operator } });
466
- }
467
- },
468
- BinaryExpression(node) {
469
- const scope = sourceCode.getScope(node);
470
- const { right, left, operator } = node;
471
- const rightConstantOperand = findBinaryExpressionConstantOperand(scope, left, right, operator);
472
- const leftConstantOperand = findBinaryExpressionConstantOperand(scope, right, left, operator);
473
-
474
- if (rightConstantOperand) {
475
- context.report({ node: rightConstantOperand, messageId: "constantBinaryOperand", data: { operator, otherSide: "left" } });
476
- } else if (leftConstantOperand) {
477
- context.report({ node: leftConstantOperand, messageId: "constantBinaryOperand", data: { operator, otherSide: "right" } });
478
- } else if (operator === "===" || operator === "!==") {
479
- if (isAlwaysNew(scope, left)) {
480
- context.report({ node: left, messageId: "alwaysNew" });
481
- } else if (isAlwaysNew(scope, right)) {
482
- context.report({ node: right, messageId: "alwaysNew" });
483
- }
484
- } else if (operator === "==" || operator === "!=") {
485
-
486
- /*
487
- * If both sides are "new", then both sides are objects and
488
- * therefore they will be compared by reference even with `==`
489
- * equality.
490
- */
491
- if (isAlwaysNew(scope, left) && isAlwaysNew(scope, right)) {
492
- context.report({ node: left, messageId: "bothAlwaysNew" });
493
- }
494
- }
495
-
496
- }
497
-
498
- /*
499
- * In theory we could handle short-circuiting assignment operators,
500
- * for some constant values, but that would require walking the
501
- * scope to find the value of the variable being assigned. This is
502
- * dependant on https://github.com/eslint/eslint/issues/13776
503
- *
504
- * AssignmentExpression() {},
505
- */
506
- };
507
- }
494
+ meta: {
495
+ type: "problem",
496
+ docs: {
497
+ description:
498
+ "Disallow expressions where the operation doesn't affect the value",
499
+ recommended: true,
500
+ url: "https://eslint.org/docs/latest/rules/no-constant-binary-expression",
501
+ },
502
+ schema: [],
503
+ messages: {
504
+ constantBinaryOperand:
505
+ "Unexpected constant binary expression. Compares constantly with the {{otherSide}}-hand side of the `{{operator}}`.",
506
+ constantShortCircuit:
507
+ "Unexpected constant {{property}} on the left-hand side of a `{{operator}}` expression.",
508
+ alwaysNew:
509
+ "Unexpected comparison to newly constructed object. These two values can never be equal.",
510
+ bothAlwaysNew:
511
+ "Unexpected comparison of two newly constructed objects. These two values can never be equal.",
512
+ },
513
+ },
514
+
515
+ create(context) {
516
+ const sourceCode = context.sourceCode;
517
+
518
+ return {
519
+ LogicalExpression(node) {
520
+ const { operator, left } = node;
521
+ const scope = sourceCode.getScope(node);
522
+
523
+ if (
524
+ (operator === "&&" || operator === "||") &&
525
+ isConstant(scope, left, true)
526
+ ) {
527
+ context.report({
528
+ node: left,
529
+ messageId: "constantShortCircuit",
530
+ data: { property: "truthiness", operator },
531
+ });
532
+ } else if (
533
+ operator === "??" &&
534
+ hasConstantNullishness(scope, left, false)
535
+ ) {
536
+ context.report({
537
+ node: left,
538
+ messageId: "constantShortCircuit",
539
+ data: { property: "nullishness", operator },
540
+ });
541
+ }
542
+ },
543
+ BinaryExpression(node) {
544
+ const scope = sourceCode.getScope(node);
545
+ const { right, left, operator } = node;
546
+ const rightConstantOperand =
547
+ findBinaryExpressionConstantOperand(
548
+ scope,
549
+ left,
550
+ right,
551
+ operator,
552
+ );
553
+ const leftConstantOperand = findBinaryExpressionConstantOperand(
554
+ scope,
555
+ right,
556
+ left,
557
+ operator,
558
+ );
559
+
560
+ if (rightConstantOperand) {
561
+ context.report({
562
+ node: rightConstantOperand,
563
+ messageId: "constantBinaryOperand",
564
+ data: { operator, otherSide: "left" },
565
+ });
566
+ } else if (leftConstantOperand) {
567
+ context.report({
568
+ node: leftConstantOperand,
569
+ messageId: "constantBinaryOperand",
570
+ data: { operator, otherSide: "right" },
571
+ });
572
+ } else if (operator === "===" || operator === "!==") {
573
+ if (isAlwaysNew(scope, left)) {
574
+ context.report({ node: left, messageId: "alwaysNew" });
575
+ } else if (isAlwaysNew(scope, right)) {
576
+ context.report({ node: right, messageId: "alwaysNew" });
577
+ }
578
+ } else if (operator === "==" || operator === "!=") {
579
+ /*
580
+ * If both sides are "new", then both sides are objects and
581
+ * therefore they will be compared by reference even with `==`
582
+ * equality.
583
+ */
584
+ if (isAlwaysNew(scope, left) && isAlwaysNew(scope, right)) {
585
+ context.report({
586
+ node: left,
587
+ messageId: "bothAlwaysNew",
588
+ });
589
+ }
590
+ }
591
+ },
592
+
593
+ /*
594
+ * In theory we could handle short-circuiting assignment operators,
595
+ * for some constant values, but that would require walking the
596
+ * scope to find the value of the variable being assigned. This is
597
+ * dependent on https://github.com/eslint/eslint/issues/13776
598
+ *
599
+ * AssignmentExpression() {},
600
+ */
601
+ };
602
+ },
508
603
  };