eslint 8.57.1 → 9.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (458) hide show
  1. package/README.md +165 -115
  2. package/bin/eslint.js +112 -89
  3. package/conf/default-cli-options.js +22 -22
  4. package/conf/ecma-version.js +16 -0
  5. package/conf/globals.js +109 -94
  6. package/conf/replacements.json +24 -20
  7. package/conf/rule-type-list.json +89 -26
  8. package/lib/api.js +16 -20
  9. package/lib/cli-engine/cli-engine.js +841 -810
  10. package/lib/cli-engine/file-enumerator.js +384 -390
  11. package/lib/cli-engine/formatters/formatters-meta.json +17 -45
  12. package/lib/cli-engine/formatters/html.js +110 -102
  13. package/lib/cli-engine/formatters/json-with-metadata.js +5 -5
  14. package/lib/cli-engine/formatters/json.js +2 -2
  15. package/lib/cli-engine/formatters/stylish.js +97 -76
  16. package/lib/cli-engine/hash.js +1 -1
  17. package/lib/cli-engine/index.js +1 -1
  18. package/lib/cli-engine/lint-result-cache.js +165 -148
  19. package/lib/cli-engine/load-rules.js +17 -17
  20. package/lib/cli.js +481 -399
  21. package/lib/config/config-loader.js +816 -0
  22. package/lib/config/config.js +674 -0
  23. package/lib/config/default-config.js +57 -46
  24. package/lib/config/flat-config-array.js +170 -333
  25. package/lib/config/flat-config-schema.js +389 -389
  26. package/lib/config-api.js +12 -0
  27. package/lib/eslint/eslint-helpers.js +1196 -663
  28. package/lib/eslint/eslint.js +1262 -607
  29. package/lib/eslint/index.js +3 -3
  30. package/lib/eslint/legacy-eslint.js +786 -0
  31. package/lib/eslint/worker.js +173 -0
  32. package/lib/languages/js/index.js +336 -0
  33. package/lib/languages/js/source-code/index.js +7 -0
  34. package/lib/languages/js/source-code/source-code.js +1364 -0
  35. package/lib/languages/js/source-code/token-store/backward-token-comment-cursor.js +61 -0
  36. package/lib/languages/js/source-code/token-store/backward-token-cursor.js +57 -0
  37. package/lib/{source-code → languages/js/source-code}/token-store/cursor.js +36 -36
  38. package/lib/languages/js/source-code/token-store/cursors.js +120 -0
  39. package/lib/{source-code → languages/js/source-code}/token-store/decorative-cursor.js +17 -18
  40. package/lib/{source-code → languages/js/source-code}/token-store/filter-cursor.js +19 -20
  41. package/lib/languages/js/source-code/token-store/forward-token-comment-cursor.js +65 -0
  42. package/lib/languages/js/source-code/token-store/forward-token-cursor.js +62 -0
  43. package/lib/languages/js/source-code/token-store/index.js +721 -0
  44. package/lib/{source-code → languages/js/source-code}/token-store/limit-cursor.js +17 -18
  45. package/lib/languages/js/source-code/token-store/padded-token-cursor.js +45 -0
  46. package/lib/{source-code → languages/js/source-code}/token-store/skip-cursor.js +19 -20
  47. package/lib/languages/js/source-code/token-store/utils.js +110 -0
  48. package/lib/languages/js/validate-language-options.js +196 -0
  49. package/lib/linter/apply-disable-directives.js +490 -371
  50. package/lib/linter/code-path-analysis/code-path-analyzer.js +650 -674
  51. package/lib/linter/code-path-analysis/code-path-segment.js +215 -216
  52. package/lib/linter/code-path-analysis/code-path-state.js +2118 -2096
  53. package/lib/linter/code-path-analysis/code-path.js +307 -317
  54. package/lib/linter/code-path-analysis/debug-helpers.js +183 -163
  55. package/lib/linter/code-path-analysis/fork-context.js +297 -272
  56. package/lib/linter/code-path-analysis/id-generator.js +22 -23
  57. package/lib/linter/esquery.js +332 -0
  58. package/lib/linter/file-context.js +144 -0
  59. package/lib/linter/file-report.js +608 -0
  60. package/lib/linter/index.js +3 -5
  61. package/lib/linter/interpolate.js +38 -16
  62. package/lib/linter/linter.js +2328 -1785
  63. package/lib/linter/rule-fixer.js +136 -107
  64. package/lib/linter/rules.js +37 -46
  65. package/lib/linter/source-code-fixer.js +96 -94
  66. package/lib/linter/source-code-traverser.js +333 -0
  67. package/lib/linter/source-code-visitor.js +81 -0
  68. package/lib/linter/timing.js +145 -97
  69. package/lib/linter/vfile.js +115 -0
  70. package/lib/options.js +464 -326
  71. package/lib/rule-tester/index.js +3 -1
  72. package/lib/rule-tester/rule-tester.js +1371 -998
  73. package/lib/rules/accessor-pairs.js +333 -259
  74. package/lib/rules/array-bracket-newline.js +250 -220
  75. package/lib/rules/array-bracket-spacing.js +286 -229
  76. package/lib/rules/array-callback-return.js +401 -354
  77. package/lib/rules/array-element-newline.js +358 -295
  78. package/lib/rules/arrow-body-style.js +400 -278
  79. package/lib/rules/arrow-parens.js +206 -155
  80. package/lib/rules/arrow-spacing.js +169 -145
  81. package/lib/rules/block-scoped-var.js +125 -123
  82. package/lib/rules/block-spacing.js +186 -158
  83. package/lib/rules/brace-style.js +262 -181
  84. package/lib/rules/callback-return.js +203 -174
  85. package/lib/rules/camelcase.js +403 -380
  86. package/lib/rules/capitalized-comments.js +253 -228
  87. package/lib/rules/class-methods-use-this.js +231 -168
  88. package/lib/rules/comma-dangle.js +379 -328
  89. package/lib/rules/comma-spacing.js +193 -177
  90. package/lib/rules/comma-style.js +375 -298
  91. package/lib/rules/complexity.js +180 -144
  92. package/lib/rules/computed-property-spacing.js +236 -193
  93. package/lib/rules/consistent-return.js +181 -170
  94. package/lib/rules/consistent-this.js +167 -141
  95. package/lib/rules/constructor-super.js +418 -411
  96. package/lib/rules/curly.js +407 -468
  97. package/lib/rules/default-case-last.js +39 -32
  98. package/lib/rules/default-case.js +89 -83
  99. package/lib/rules/default-param-last.js +69 -53
  100. package/lib/rules/dot-location.js +122 -92
  101. package/lib/rules/dot-notation.js +193 -153
  102. package/lib/rules/eol-last.js +122 -102
  103. package/lib/rules/eqeqeq.js +191 -155
  104. package/lib/rules/for-direction.js +150 -122
  105. package/lib/rules/func-call-spacing.js +261 -213
  106. package/lib/rules/func-name-matching.js +294 -209
  107. package/lib/rules/func-names.js +165 -164
  108. package/lib/rules/func-style.js +209 -86
  109. package/lib/rules/function-call-argument-newline.js +152 -111
  110. package/lib/rules/function-paren-newline.js +349 -273
  111. package/lib/rules/generator-star-spacing.js +229 -192
  112. package/lib/rules/getter-return.js +208 -170
  113. package/lib/rules/global-require.js +85 -58
  114. package/lib/rules/grouped-accessor-pairs.js +201 -148
  115. package/lib/rules/guard-for-in.js +72 -63
  116. package/lib/rules/handle-callback-err.js +108 -87
  117. package/lib/rules/id-blacklist.js +182 -187
  118. package/lib/rules/id-denylist.js +174 -179
  119. package/lib/rules/id-length.js +197 -157
  120. package/lib/rules/id-match.js +350 -286
  121. package/lib/rules/implicit-arrow-linebreak.js +102 -61
  122. package/lib/rules/indent-legacy.js +1345 -1102
  123. package/lib/rules/indent.js +2272 -1741
  124. package/lib/rules/index.js +320 -294
  125. package/lib/rules/init-declarations.js +139 -106
  126. package/lib/rules/jsx-quotes.js +94 -64
  127. package/lib/rules/key-spacing.js +750 -615
  128. package/lib/rules/keyword-spacing.js +648 -587
  129. package/lib/rules/line-comment-position.js +143 -108
  130. package/lib/rules/linebreak-style.js +115 -88
  131. package/lib/rules/lines-around-comment.js +540 -430
  132. package/lib/rules/lines-around-directive.js +233 -185
  133. package/lib/rules/lines-between-class-members.js +305 -216
  134. package/lib/rules/logical-assignment-operators.js +582 -398
  135. package/lib/rules/max-classes-per-file.js +69 -68
  136. package/lib/rules/max-depth.js +146 -143
  137. package/lib/rules/max-len.js +473 -416
  138. package/lib/rules/max-lines-per-function.js +201 -176
  139. package/lib/rules/max-lines.js +158 -162
  140. package/lib/rules/max-nested-callbacks.js +102 -104
  141. package/lib/rules/max-params.js +102 -75
  142. package/lib/rules/max-statements-per-line.js +205 -180
  143. package/lib/rules/max-statements.js +168 -164
  144. package/lib/rules/multiline-comment-style.js +638 -460
  145. package/lib/rules/multiline-ternary.js +241 -158
  146. package/lib/rules/new-cap.js +233 -232
  147. package/lib/rules/new-parens.js +88 -61
  148. package/lib/rules/newline-after-var.js +287 -233
  149. package/lib/rules/newline-before-return.js +229 -204
  150. package/lib/rules/newline-per-chained-call.js +142 -109
  151. package/lib/rules/no-alert.js +90 -79
  152. package/lib/rules/no-array-constructor.js +175 -113
  153. package/lib/rules/no-async-promise-executor.js +30 -24
  154. package/lib/rules/no-await-in-loop.js +79 -70
  155. package/lib/rules/no-bitwise.js +113 -87
  156. package/lib/rules/no-buffer-constructor.js +61 -37
  157. package/lib/rules/no-caller.js +39 -33
  158. package/lib/rules/no-case-declarations.js +61 -45
  159. package/lib/rules/no-catch-shadow.js +76 -62
  160. package/lib/rules/no-class-assign.js +51 -48
  161. package/lib/rules/no-compare-neg-zero.js +62 -48
  162. package/lib/rules/no-cond-assign.js +148 -132
  163. package/lib/rules/no-confusing-arrow.js +98 -63
  164. package/lib/rules/no-console.js +202 -188
  165. package/lib/rules/no-const-assign.js +58 -41
  166. package/lib/rules/no-constant-binary-expression.js +501 -407
  167. package/lib/rules/no-constant-condition.js +158 -131
  168. package/lib/rules/no-constructor-return.js +49 -49
  169. package/lib/rules/no-continue.js +25 -26
  170. package/lib/rules/no-control-regex.js +125 -121
  171. package/lib/rules/no-debugger.js +28 -30
  172. package/lib/rules/no-delete-var.js +29 -29
  173. package/lib/rules/no-div-regex.js +47 -40
  174. package/lib/rules/no-dupe-args.js +79 -69
  175. package/lib/rules/no-dupe-class-members.js +102 -89
  176. package/lib/rules/no-dupe-else-if.js +100 -77
  177. package/lib/rules/no-dupe-keys.js +133 -110
  178. package/lib/rules/no-duplicate-case.js +50 -43
  179. package/lib/rules/no-duplicate-imports.js +266 -188
  180. package/lib/rules/no-else-return.js +430 -385
  181. package/lib/rules/no-empty-character-class.js +57 -50
  182. package/lib/rules/no-empty-function.js +197 -128
  183. package/lib/rules/no-empty-pattern.js +63 -56
  184. package/lib/rules/no-empty-static-block.js +61 -35
  185. package/lib/rules/no-empty.js +135 -85
  186. package/lib/rules/no-eq-null.js +37 -32
  187. package/lib/rules/no-eval.js +258 -249
  188. package/lib/rules/no-ex-assign.js +42 -39
  189. package/lib/rules/no-extend-native.js +161 -160
  190. package/lib/rules/no-extra-bind.js +201 -190
  191. package/lib/rules/no-extra-boolean-cast.js +398 -295
  192. package/lib/rules/no-extra-label.js +150 -130
  193. package/lib/rules/no-extra-parens.js +1654 -1307
  194. package/lib/rules/no-extra-semi.js +146 -126
  195. package/lib/rules/no-fallthrough.js +200 -136
  196. package/lib/rules/no-floating-decimal.js +74 -48
  197. package/lib/rules/no-func-assign.js +54 -55
  198. package/lib/rules/no-global-assign.js +78 -72
  199. package/lib/rules/no-implicit-coercion.js +350 -262
  200. package/lib/rules/no-implicit-globals.js +174 -133
  201. package/lib/rules/no-implied-eval.js +150 -112
  202. package/lib/rules/no-import-assign.js +145 -159
  203. package/lib/rules/no-inline-comments.js +101 -96
  204. package/lib/rules/no-inner-declarations.js +115 -78
  205. package/lib/rules/no-invalid-regexp.js +223 -174
  206. package/lib/rules/no-invalid-this.js +145 -117
  207. package/lib/rules/no-irregular-whitespace.js +266 -250
  208. package/lib/rules/no-iterator.js +29 -33
  209. package/lib/rules/no-label-var.js +59 -61
  210. package/lib/rules/no-labels.js +138 -131
  211. package/lib/rules/no-lone-blocks.js +127 -123
  212. package/lib/rules/no-lonely-if.js +105 -67
  213. package/lib/rules/no-loop-func.js +245 -184
  214. package/lib/rules/no-loss-of-precision.js +236 -201
  215. package/lib/rules/no-magic-numbers.js +339 -217
  216. package/lib/rules/no-misleading-character-class.js +548 -253
  217. package/lib/rules/no-mixed-operators.js +188 -164
  218. package/lib/rules/no-mixed-requires.js +253 -224
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +135 -103
  220. package/lib/rules/no-multi-assign.js +46 -47
  221. package/lib/rules/no-multi-spaces.js +163 -125
  222. package/lib/rules/no-multi-str.js +42 -40
  223. package/lib/rules/no-multiple-empty-lines.js +196 -140
  224. package/lib/rules/no-native-reassign.js +90 -74
  225. package/lib/rules/no-negated-condition.js +79 -74
  226. package/lib/rules/no-negated-in-lhs.js +45 -32
  227. package/lib/rules/no-nested-ternary.js +33 -31
  228. package/lib/rules/no-new-func.js +71 -62
  229. package/lib/rules/no-new-native-nonconstructor.js +43 -39
  230. package/lib/rules/no-new-object.js +48 -39
  231. package/lib/rules/no-new-require.js +48 -31
  232. package/lib/rules/no-new-symbol.js +61 -43
  233. package/lib/rules/no-new-wrappers.js +43 -41
  234. package/lib/rules/no-new.js +28 -29
  235. package/lib/rules/no-nonoctal-decimal-escape.js +149 -121
  236. package/lib/rules/no-obj-calls.js +66 -53
  237. package/lib/rules/no-object-constructor.js +104 -97
  238. package/lib/rules/no-octal-escape.js +40 -43
  239. package/lib/rules/no-octal.js +29 -32
  240. package/lib/rules/no-param-reassign.js +236 -218
  241. package/lib/rules/no-path-concat.js +66 -51
  242. package/lib/rules/no-plusplus.js +60 -63
  243. package/lib/rules/no-process-env.js +49 -32
  244. package/lib/rules/no-process-exit.js +48 -28
  245. package/lib/rules/no-promise-executor-return.js +205 -204
  246. package/lib/rules/no-proto.js +26 -29
  247. package/lib/rules/no-prototype-builtins.js +146 -124
  248. package/lib/rules/no-redeclare.js +154 -155
  249. package/lib/rules/no-regex-spaces.js +183 -161
  250. package/lib/rules/no-restricted-exports.js +208 -174
  251. package/lib/rules/no-restricted-globals.js +254 -112
  252. package/lib/rules/no-restricted-imports.js +824 -384
  253. package/lib/rules/no-restricted-modules.js +222 -186
  254. package/lib/rules/no-restricted-properties.js +218 -153
  255. package/lib/rules/no-restricted-syntax.js +56 -52
  256. package/lib/rules/no-return-assign.js +56 -49
  257. package/lib/rules/no-return-await.js +147 -120
  258. package/lib/rules/no-script-url.js +53 -46
  259. package/lib/rules/no-self-assign.js +148 -145
  260. package/lib/rules/no-self-compare.js +63 -46
  261. package/lib/rules/no-sequences.js +135 -115
  262. package/lib/rules/no-setter-return.js +176 -178
  263. package/lib/rules/no-shadow-restricted-names.js +84 -36
  264. package/lib/rules/no-shadow.js +598 -310
  265. package/lib/rules/no-spaced-func.js +82 -60
  266. package/lib/rules/no-sparse-arrays.js +46 -28
  267. package/lib/rules/no-sync.js +61 -44
  268. package/lib/rules/no-tabs.js +83 -54
  269. package/lib/rules/no-template-curly-in-string.js +33 -32
  270. package/lib/rules/no-ternary.js +25 -28
  271. package/lib/rules/no-this-before-super.js +332 -298
  272. package/lib/rules/no-throw-literal.js +31 -36
  273. package/lib/rules/no-trailing-spaces.js +208 -174
  274. package/lib/rules/no-unassigned-vars.js +80 -0
  275. package/lib/rules/no-undef-init.js +86 -60
  276. package/lib/rules/no-undef.js +52 -47
  277. package/lib/rules/no-undefined.js +73 -74
  278. package/lib/rules/no-underscore-dangle.js +370 -322
  279. package/lib/rules/no-unexpected-multiline.js +112 -102
  280. package/lib/rules/no-unmodified-loop-condition.js +254 -254
  281. package/lib/rules/no-unneeded-ternary.js +212 -146
  282. package/lib/rules/no-unreachable-loop.js +145 -140
  283. package/lib/rules/no-unreachable.js +255 -248
  284. package/lib/rules/no-unsafe-finally.js +93 -85
  285. package/lib/rules/no-unsafe-negation.js +105 -81
  286. package/lib/rules/no-unsafe-optional-chaining.js +193 -177
  287. package/lib/rules/no-unused-expressions.js +199 -158
  288. package/lib/rules/no-unused-labels.js +139 -124
  289. package/lib/rules/no-unused-private-class-members.js +206 -182
  290. package/lib/rules/no-unused-vars.js +1708 -687
  291. package/lib/rules/no-use-before-define.js +327 -229
  292. package/lib/rules/no-useless-assignment.js +654 -0
  293. package/lib/rules/no-useless-backreference.js +212 -143
  294. package/lib/rules/no-useless-call.js +58 -53
  295. package/lib/rules/no-useless-catch.js +40 -40
  296. package/lib/rules/no-useless-computed-key.js +144 -108
  297. package/lib/rules/no-useless-concat.js +65 -59
  298. package/lib/rules/no-useless-constructor.js +160 -97
  299. package/lib/rules/no-useless-escape.js +364 -291
  300. package/lib/rules/no-useless-rename.js +183 -153
  301. package/lib/rules/no-useless-return.js +344 -307
  302. package/lib/rules/no-var.js +245 -212
  303. package/lib/rules/no-void.js +51 -46
  304. package/lib/rules/no-warning-comments.js +191 -183
  305. package/lib/rules/no-whitespace-before-property.js +131 -97
  306. package/lib/rules/no-with.js +24 -26
  307. package/lib/rules/nonblock-statement-body-position.js +149 -112
  308. package/lib/rules/object-curly-newline.js +306 -247
  309. package/lib/rules/object-curly-spacing.js +360 -296
  310. package/lib/rules/object-property-newline.js +137 -88
  311. package/lib/rules/object-shorthand.js +632 -500
  312. package/lib/rules/one-var-declaration-per-line.js +104 -82
  313. package/lib/rules/one-var.js +686 -536
  314. package/lib/rules/operator-assignment.js +219 -158
  315. package/lib/rules/operator-linebreak.js +295 -233
  316. package/lib/rules/padded-blocks.js +346 -290
  317. package/lib/rules/padding-line-between-statements.js +443 -421
  318. package/lib/rules/prefer-arrow-callback.js +371 -315
  319. package/lib/rules/prefer-const.js +418 -373
  320. package/lib/rules/prefer-destructuring.js +309 -278
  321. package/lib/rules/prefer-exponentiation-operator.js +176 -132
  322. package/lib/rules/prefer-named-capture-group.js +160 -141
  323. package/lib/rules/prefer-numeric-literals.js +121 -112
  324. package/lib/rules/prefer-object-has-own.js +116 -82
  325. package/lib/rules/prefer-object-spread.js +214 -193
  326. package/lib/rules/prefer-promise-reject-errors.js +140 -118
  327. package/lib/rules/prefer-reflect.js +126 -103
  328. package/lib/rules/prefer-regex-literals.js +561 -463
  329. package/lib/rules/prefer-rest-params.js +79 -80
  330. package/lib/rules/prefer-spread.js +47 -43
  331. package/lib/rules/prefer-template.js +266 -194
  332. package/lib/rules/preserve-caught-error.js +535 -0
  333. package/lib/rules/quote-props.js +373 -289
  334. package/lib/rules/quotes.js +374 -308
  335. package/lib/rules/radix.js +152 -134
  336. package/lib/rules/require-atomic-updates.js +316 -282
  337. package/lib/rules/require-await.js +153 -82
  338. package/lib/rules/require-unicode-regexp.js +296 -108
  339. package/lib/rules/require-yield.js +53 -54
  340. package/lib/rules/rest-spread-spacing.js +128 -98
  341. package/lib/rules/semi-spacing.js +281 -232
  342. package/lib/rules/semi-style.js +176 -116
  343. package/lib/rules/semi.js +456 -418
  344. package/lib/rules/sort-imports.js +307 -229
  345. package/lib/rules/sort-keys.js +219 -181
  346. package/lib/rules/sort-vars.js +127 -91
  347. package/lib/rules/space-before-blocks.js +199 -171
  348. package/lib/rules/space-before-function-paren.js +186 -148
  349. package/lib/rules/space-in-parens.js +359 -270
  350. package/lib/rules/space-infix-ops.js +237 -183
  351. package/lib/rules/space-unary-ops.js +356 -280
  352. package/lib/rules/spaced-comment.js +363 -301
  353. package/lib/rules/strict.js +266 -229
  354. package/lib/rules/switch-colon-spacing.js +130 -104
  355. package/lib/rules/symbol-description.js +45 -48
  356. package/lib/rules/template-curly-spacing.js +148 -124
  357. package/lib/rules/template-tag-spacing.js +98 -70
  358. package/lib/rules/unicode-bom.js +54 -54
  359. package/lib/rules/use-isnan.js +237 -110
  360. package/lib/rules/utils/ast-utils.js +2139 -1688
  361. package/lib/rules/utils/char-source.js +247 -0
  362. package/lib/rules/utils/fix-tracker.js +99 -88
  363. package/lib/rules/utils/keywords.js +59 -59
  364. package/lib/rules/utils/lazy-loading-rule-map.js +81 -78
  365. package/lib/rules/utils/regular-expressions.js +35 -19
  366. package/lib/rules/utils/unicode/index.js +9 -4
  367. package/lib/rules/utils/unicode/is-combining-character.js +1 -1
  368. package/lib/rules/utils/unicode/is-emoji-modifier.js +1 -1
  369. package/lib/rules/utils/unicode/is-regional-indicator-symbol.js +1 -1
  370. package/lib/rules/utils/unicode/is-surrogate-pair.js +1 -1
  371. package/lib/rules/valid-typeof.js +153 -109
  372. package/lib/rules/vars-on-top.js +152 -144
  373. package/lib/rules/wrap-iife.js +204 -173
  374. package/lib/rules/wrap-regex.js +77 -47
  375. package/lib/rules/yield-star-spacing.js +145 -116
  376. package/lib/rules/yoda.js +283 -274
  377. package/lib/services/parser-service.js +65 -0
  378. package/lib/services/processor-service.js +101 -0
  379. package/lib/services/suppressions-service.js +302 -0
  380. package/lib/services/warning-service.js +98 -0
  381. package/lib/shared/ajv.js +14 -14
  382. package/lib/shared/assert.js +21 -0
  383. package/lib/shared/ast-utils.js +7 -6
  384. package/lib/shared/deep-merge-arrays.js +62 -0
  385. package/lib/shared/directives.js +3 -2
  386. package/lib/shared/flags.js +108 -0
  387. package/lib/shared/logging.js +24 -16
  388. package/lib/shared/naming.js +109 -0
  389. package/lib/shared/option-utils.js +63 -0
  390. package/lib/shared/relative-module-resolver.js +18 -40
  391. package/lib/shared/runtime-info.js +138 -128
  392. package/lib/shared/serialization.js +78 -0
  393. package/lib/shared/severity.js +22 -22
  394. package/lib/shared/stats.js +30 -0
  395. package/lib/shared/string-utils.js +19 -21
  396. package/lib/shared/text-table.js +68 -0
  397. package/lib/shared/translate-cli-options.js +281 -0
  398. package/lib/shared/traverser.js +153 -146
  399. package/lib/types/config-api.d.ts +12 -0
  400. package/lib/types/index.d.ts +1473 -0
  401. package/lib/types/rules.d.ts +5589 -0
  402. package/lib/types/universal.d.ts +6 -0
  403. package/lib/types/use-at-your-own-risk.d.ts +87 -0
  404. package/lib/universal.js +10 -0
  405. package/lib/unsupported-api.js +8 -9
  406. package/messages/all-files-ignored.js +3 -3
  407. package/messages/all-matched-files-ignored.js +21 -0
  408. package/messages/config-file-missing.js +16 -0
  409. package/messages/config-plugin-missing.js +14 -0
  410. package/messages/config-serialize-function.js +30 -0
  411. package/messages/eslintrc-incompat.js +35 -16
  412. package/messages/eslintrc-plugins.js +8 -5
  413. package/messages/extend-config-missing.js +3 -3
  414. package/messages/failed-to-read-json.js +3 -3
  415. package/messages/file-not-found.js +3 -3
  416. package/messages/invalid-rule-options.js +2 -2
  417. package/messages/invalid-rule-severity.js +2 -2
  418. package/messages/no-config-found.js +4 -4
  419. package/messages/plugin-conflict.js +9 -9
  420. package/messages/plugin-invalid.js +4 -4
  421. package/messages/plugin-missing.js +4 -4
  422. package/messages/print-config-with-directory-path.js +2 -2
  423. package/messages/shared.js +6 -1
  424. package/messages/whitespace-found.js +3 -3
  425. package/package.json +105 -60
  426. package/conf/config-schema.js +0 -93
  427. package/lib/cli-engine/formatters/checkstyle.js +0 -60
  428. package/lib/cli-engine/formatters/compact.js +0 -60
  429. package/lib/cli-engine/formatters/jslint-xml.js +0 -41
  430. package/lib/cli-engine/formatters/junit.js +0 -82
  431. package/lib/cli-engine/formatters/tap.js +0 -95
  432. package/lib/cli-engine/formatters/unix.js +0 -58
  433. package/lib/cli-engine/formatters/visualstudio.js +0 -63
  434. package/lib/cli-engine/xml-escape.js +0 -34
  435. package/lib/config/flat-config-helpers.js +0 -111
  436. package/lib/config/rule-validator.js +0 -158
  437. package/lib/eslint/flat-eslint.js +0 -1159
  438. package/lib/linter/config-comment-parser.js +0 -185
  439. package/lib/linter/node-event-generator.js +0 -354
  440. package/lib/linter/report-translator.js +0 -369
  441. package/lib/linter/safe-emitter.js +0 -52
  442. package/lib/rule-tester/flat-rule-tester.js +0 -1131
  443. package/lib/rules/require-jsdoc.js +0 -122
  444. package/lib/rules/utils/patterns/letters.js +0 -36
  445. package/lib/rules/valid-jsdoc.js +0 -516
  446. package/lib/shared/config-validator.js +0 -347
  447. package/lib/shared/deprecation-warnings.js +0 -58
  448. package/lib/shared/types.js +0 -216
  449. package/lib/source-code/index.js +0 -5
  450. package/lib/source-code/source-code.js +0 -1055
  451. package/lib/source-code/token-store/backward-token-comment-cursor.js +0 -57
  452. package/lib/source-code/token-store/backward-token-cursor.js +0 -58
  453. package/lib/source-code/token-store/cursors.js +0 -90
  454. package/lib/source-code/token-store/forward-token-comment-cursor.js +0 -57
  455. package/lib/source-code/token-store/forward-token-cursor.js +0 -63
  456. package/lib/source-code/token-store/index.js +0 -627
  457. package/lib/source-code/token-store/padded-token-cursor.js +0 -38
  458. package/lib/source-code/token-store/utils.js +0 -107
@@ -5,10 +5,28 @@
5
5
 
6
6
  "use strict";
7
7
 
8
- const globals = require("globals");
9
- const { isNullLiteral, isConstant, isReferenceToGlobalVariable, isLogicalAssignmentOperator } = require("./utils/ast-utils");
10
-
11
- 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
+ ]);
12
30
 
13
31
  //------------------------------------------------------------------------------
14
32
  // Helpers
@@ -24,11 +42,13 @@ const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set(["+", "-", "*", "/", "%", "|"
24
42
  * @public
25
43
  */
26
44
  function isNullOrUndefined(scope, node) {
27
- return (
28
- isNullLiteral(node) ||
29
- (node.type === "Identifier" && node.name === "undefined" && isReferenceToGlobalVariable(scope, node)) ||
30
- (node.type === "UnaryExpression" && node.operator === "void")
31
- );
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
+ );
32
52
  }
33
53
 
34
54
  /**
@@ -42,79 +62,88 @@ function isNullOrUndefined(scope, node) {
42
62
  * @returns {boolean} Does `node` have constant nullishness?
43
63
  */
44
64
  function hasConstantNullishness(scope, node, nonNullish) {
45
- if (nonNullish && isNullOrUndefined(scope, node)) {
46
- return false;
47
- }
48
-
49
- switch (node.type) {
50
- case "ObjectExpression": // Objects are never nullish
51
- case "ArrayExpression": // Arrays are never nullish
52
- case "ArrowFunctionExpression": // Functions never nullish
53
- case "FunctionExpression": // Functions are never nullish
54
- case "ClassExpression": // Classes are never nullish
55
- case "NewExpression": // Objects are never nullish
56
- case "Literal": // Nullish, or non-nullish, literals never change
57
- case "TemplateLiteral": // A string is never nullish
58
- case "UpdateExpression": // Numbers are never nullish
59
- case "BinaryExpression": // Numbers, strings, or booleans are never nullish
60
- return true;
61
- case "CallExpression": {
62
- if (node.callee.type !== "Identifier") {
63
- return false;
64
- }
65
- const functionName = node.callee.name;
66
-
67
- return (functionName === "Boolean" || functionName === "String" || functionName === "Number") &&
68
- isReferenceToGlobalVariable(scope, node.callee);
69
- }
70
- case "LogicalExpression": {
71
- return node.operator === "??" && hasConstantNullishness(scope, node.right, true);
72
- }
73
- case "AssignmentExpression":
74
- if (node.operator === "=") {
75
- return hasConstantNullishness(scope, node.right, nonNullish);
76
- }
77
-
78
- /*
79
- * Handling short-circuiting assignment operators would require
80
- * walking the scope. We won't attempt that (for now...) /
81
- */
82
- if (isLogicalAssignmentOperator(node.operator)) {
83
- return false;
84
- }
85
-
86
- /*
87
- * The remaining assignment expressions all result in a numeric or
88
- * string (non-nullish) value:
89
- * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
90
- */
91
-
92
- return true;
93
- case "UnaryExpression":
94
-
95
- /*
96
- * "void" Always returns `undefined`
97
- * "typeof" All types are strings, and thus non-nullish
98
- * "!" Boolean is never nullish
99
- * "delete" Returns a boolean, which is never nullish
100
- * Math operators always return numbers or strings, neither of which
101
- * are non-nullish "+", "-", "~"
102
- */
103
-
104
- return true;
105
- case "SequenceExpression": {
106
- const last = node.expressions[node.expressions.length - 1];
107
-
108
- return hasConstantNullishness(scope, last, nonNullish);
109
- }
110
- case "Identifier":
111
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
112
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
113
- case "JSXFragment":
114
- return false;
115
- default:
116
- return false;
117
- }
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
+ }
118
147
  }
119
148
 
120
149
  /**
@@ -128,139 +157,149 @@ function hasConstantNullishness(scope, node, nonNullish) {
128
157
  * @returns {boolean} Is `node` guaranteed to be a boolean?
129
158
  */
130
159
  function isStaticBoolean(scope, node) {
131
- switch (node.type) {
132
- case "Literal":
133
- return typeof node.value === "boolean";
134
- case "CallExpression":
135
- return node.callee.type === "Identifier" && node.callee.name === "Boolean" &&
136
- isReferenceToGlobalVariable(scope, node.callee) &&
137
- (node.arguments.length === 0 || isConstant(scope, node.arguments[0], true));
138
- case "UnaryExpression":
139
- return node.operator === "!" && isConstant(scope, node.argument, true);
140
- default:
141
- return false;
142
- }
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
+ }
143
178
  }
144
179
 
145
-
146
180
  /**
147
181
  * Test if an AST node will always give the same result when compared to a
148
182
  * boolean value. Note that comparison to boolean values is different than
149
183
  * truthiness.
150
184
  * https://262.ecma-international.org/5.1/#sec-11.9.3
151
185
  *
152
- * Javascript `==` operator works by converting the boolean to `1` (true) or
186
+ * JavaScript `==` operator works by converting the boolean to `1` (true) or
153
187
  * `+0` (false) and then checks the values `==` equality to that number.
154
188
  * @param {Scope} scope The scope in which node was found.
155
189
  * @param {ASTNode} node The node to test.
156
190
  * @returns {boolean} Will `node` always coerce to the same boolean value?
157
191
  */
158
192
  function hasConstantLooseBooleanComparison(scope, node) {
159
- switch (node.type) {
160
- case "ObjectExpression":
161
- case "ClassExpression":
162
-
163
- /**
164
- * In theory objects like:
165
- *
166
- * `{toString: () => a}`
167
- * `{valueOf: () => a}`
168
- *
169
- * Or a classes like:
170
- *
171
- * `class { static toString() { return a } }`
172
- * `class { static valueOf() { return a } }`
173
- *
174
- * Are not constant verifiably when `inBooleanPosition` is
175
- * false, but it's an edge case we've opted not to handle.
176
- */
177
- return true;
178
- case "ArrayExpression": {
179
- const nonSpreadElements = node.elements.filter(e =>
180
-
181
- // Elements can be `null` in sparse arrays: `[,,]`;
182
- e !== null && e.type !== "SpreadElement");
183
-
184
-
185
- /*
186
- * Possible future direction if needed: We could check if the
187
- * single value would result in variable boolean comparison.
188
- * For now we will err on the side of caution since `[x]` could
189
- * evaluate to `[0]` or `[1]`.
190
- */
191
- return node.elements.length === 0 || nonSpreadElements.length > 1;
192
- }
193
- case "ArrowFunctionExpression":
194
- case "FunctionExpression":
195
- return true;
196
- case "UnaryExpression":
197
- if (node.operator === "void" || // Always returns `undefined`
198
- node.operator === "typeof" // All `typeof` strings, when coerced to number, are not 0 or 1.
199
- ) {
200
- return true;
201
- }
202
- if (node.operator === "!") {
203
- return isConstant(scope, node.argument, true);
204
- }
205
-
206
- /*
207
- * We won't try to reason about +, -, ~, or delete
208
- * In theory, for the mathematical operators, we could look at the
209
- * argument and try to determine if it coerces to a constant numeric
210
- * value.
211
- */
212
- return false;
213
- case "NewExpression": // Objects might have custom `.valueOf` or `.toString`.
214
- return false;
215
- case "CallExpression": {
216
- if (node.callee.type === "Identifier" &&
217
- node.callee.name === "Boolean" &&
218
- isReferenceToGlobalVariable(scope, node.callee)
219
- ) {
220
- return node.arguments.length === 0 || isConstant(scope, node.arguments[0], true);
221
- }
222
- return false;
223
- }
224
- case "Literal": // True or false, literals never change
225
- return true;
226
- case "Identifier":
227
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
228
- case "TemplateLiteral":
229
-
230
- /*
231
- * In theory we could try to check if the quasi are sufficient to
232
- * prove that the expression will always be true, but it would be
233
- * tricky to get right. For example: `000.${foo}000`
234
- */
235
- return node.expressions.length === 0;
236
- case "AssignmentExpression":
237
- if (node.operator === "=") {
238
- return hasConstantLooseBooleanComparison(scope, node.right);
239
- }
240
-
241
- /*
242
- * Handling short-circuiting assignment operators would require
243
- * walking the scope. We won't attempt that (for now...)
244
- *
245
- * The remaining assignment expressions all result in a numeric or
246
- * string (non-nullish) values which could be truthy or falsy:
247
- * "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=", "|=", "^=", "&="
248
- */
249
- return false;
250
- case "SequenceExpression": {
251
- const last = node.expressions[node.expressions.length - 1];
252
-
253
- return hasConstantLooseBooleanComparison(scope, last);
254
- }
255
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
256
- case "JSXFragment":
257
- return false;
258
- default:
259
- return false;
260
- }
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
+ }
261
301
  }
262
302
 
263
-
264
303
  /**
265
304
  * Test if an AST node will always give the same result when _strictly_ compared
266
305
  * to a boolean value. This can happen if the expression can never be boolean, or
@@ -271,82 +310,90 @@ function hasConstantLooseBooleanComparison(scope, node) {
271
310
  * static boolean value?
272
311
  */
273
312
  function hasConstantStrictBooleanComparison(scope, node) {
274
- switch (node.type) {
275
- case "ObjectExpression": // Objects are not booleans
276
- case "ArrayExpression": // Arrays are not booleans
277
- case "ArrowFunctionExpression": // Functions are not booleans
278
- case "FunctionExpression":
279
- case "ClassExpression": // Classes are not booleans
280
- case "NewExpression": // Objects are not booleans
281
- case "TemplateLiteral": // Strings are not booleans
282
- case "Literal": // True, false, or not boolean, literals never change.
283
- case "UpdateExpression": // Numbers are not booleans
284
- return true;
285
- case "BinaryExpression":
286
- return NUMERIC_OR_STRING_BINARY_OPERATORS.has(node.operator);
287
- case "UnaryExpression": {
288
- if (node.operator === "delete") {
289
- return false;
290
- }
291
- if (node.operator === "!") {
292
- return isConstant(scope, node.argument, true);
293
- }
294
-
295
- /*
296
- * The remaining operators return either strings or numbers, neither
297
- * of which are boolean.
298
- */
299
- return true;
300
- }
301
- case "SequenceExpression": {
302
- const last = node.expressions[node.expressions.length - 1];
303
-
304
- return hasConstantStrictBooleanComparison(scope, last);
305
- }
306
- case "Identifier":
307
- return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
308
- case "AssignmentExpression":
309
- if (node.operator === "=") {
310
- return hasConstantStrictBooleanComparison(scope, node.right);
311
- }
312
-
313
- /*
314
- * Handling short-circuiting assignment operators would require
315
- * walking the scope. We won't attempt that (for now...)
316
- */
317
- if (isLogicalAssignmentOperator(node.operator)) {
318
- return false;
319
- }
320
-
321
- /*
322
- * The remaining assignment expressions all result in either a number
323
- * or a string, neither of which can ever be boolean.
324
- */
325
- return true;
326
- case "CallExpression": {
327
- if (node.callee.type !== "Identifier") {
328
- return false;
329
- }
330
- const functionName = node.callee.name;
331
-
332
- if (
333
- (functionName === "String" || functionName === "Number") &&
334
- isReferenceToGlobalVariable(scope, node.callee)
335
- ) {
336
- return true;
337
- }
338
- if (functionName === "Boolean" && isReferenceToGlobalVariable(scope, node.callee)) {
339
- return (
340
- node.arguments.length === 0 || isConstant(scope, node.arguments[0], true));
341
- }
342
- return false;
343
- }
344
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
345
- case "JSXFragment":
346
- return false;
347
- default:
348
- return false;
349
- }
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
+ }
350
397
  }
351
398
 
352
399
  /**
@@ -356,51 +403,55 @@ function hasConstantStrictBooleanComparison(scope, node) {
356
403
  * @returns {boolean} Will `node` always be new?
357
404
  */
358
405
  function isAlwaysNew(scope, node) {
359
- switch (node.type) {
360
- case "ObjectExpression":
361
- case "ArrayExpression":
362
- case "ArrowFunctionExpression":
363
- case "FunctionExpression":
364
- case "ClassExpression":
365
- return true;
366
- case "NewExpression": {
367
- if (node.callee.type !== "Identifier") {
368
- return false;
369
- }
370
-
371
- /*
372
- * All the built-in constructors are always new, but
373
- * user-defined constructors could return a sentinel
374
- * object.
375
- *
376
- * Catching these is especially useful for primitive constructors
377
- * which return boxed values, a surprising gotcha' in JavaScript.
378
- */
379
- return Object.hasOwnProperty.call(globals.builtin, node.callee.name) &&
380
- isReferenceToGlobalVariable(scope, node.callee);
381
- }
382
- case "Literal":
383
-
384
- // Regular expressions are objects, and thus always new
385
- return typeof node.regex === "object";
386
- case "SequenceExpression": {
387
- const last = node.expressions[node.expressions.length - 1];
388
-
389
- return isAlwaysNew(scope, last);
390
- }
391
- case "AssignmentExpression":
392
- if (node.operator === "=") {
393
- return isAlwaysNew(scope, node.right);
394
- }
395
- return false;
396
- case "ConditionalExpression":
397
- return isAlwaysNew(scope, node.consequent) && isAlwaysNew(scope, node.alternate);
398
- case "JSXElement": // ESLint has a policy of not assuming any specific JSX behavior.
399
- case "JSXFragment":
400
- return false;
401
- default:
402
- return false;
403
- }
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
+ }
404
455
  }
405
456
 
406
457
  /**
@@ -412,98 +463,141 @@ function isAlwaysNew(scope, node) {
412
463
  * @returns {ASTNode | null} The node which will cause the expression to have a constant result.
413
464
  */
414
465
  function findBinaryExpressionConstantOperand(scope, a, b, operator) {
415
- if (operator === "==" || operator === "!=") {
416
- if (
417
- (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
418
- (isStaticBoolean(scope, a) && hasConstantLooseBooleanComparison(scope, b))
419
- ) {
420
- return b;
421
- }
422
- } else if (operator === "===" || operator === "!==") {
423
- if (
424
- (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
425
- (isStaticBoolean(scope, a) && hasConstantStrictBooleanComparison(scope, b))
426
- ) {
427
- return b;
428
- }
429
- }
430
- 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;
431
486
  }
432
487
 
433
488
  //------------------------------------------------------------------------------
434
489
  // Rule Definition
435
490
  //------------------------------------------------------------------------------
436
491
 
437
- /** @type {import('../shared/types').Rule} */
492
+ /** @type {import('../types').Rule.RuleModule} */
438
493
  module.exports = {
439
- meta: {
440
- type: "problem",
441
- docs: {
442
- description: "Disallow expressions where the operation doesn't affect the value",
443
- recommended: false,
444
- url: "https://eslint.org/docs/latest/rules/no-constant-binary-expression"
445
- },
446
- schema: [],
447
- messages: {
448
- constantBinaryOperand: "Unexpected constant binary expression. Compares constantly with the {{otherSide}}-hand side of the `{{operator}}`.",
449
- constantShortCircuit: "Unexpected constant {{property}} on the left-hand side of a `{{operator}}` expression.",
450
- alwaysNew: "Unexpected comparison to newly constructed object. These two values can never be equal.",
451
- bothAlwaysNew: "Unexpected comparison of two newly constructed objects. These two values can never be equal."
452
- }
453
- },
454
-
455
- create(context) {
456
- const sourceCode = context.sourceCode;
457
-
458
- return {
459
- LogicalExpression(node) {
460
- const { operator, left } = node;
461
- const scope = sourceCode.getScope(node);
462
-
463
- if ((operator === "&&" || operator === "||") && isConstant(scope, left, true)) {
464
- context.report({ node: left, messageId: "constantShortCircuit", data: { property: "truthiness", operator } });
465
- } else if (operator === "??" && hasConstantNullishness(scope, left, false)) {
466
- context.report({ node: left, messageId: "constantShortCircuit", data: { property: "nullishness", operator } });
467
- }
468
- },
469
- BinaryExpression(node) {
470
- const scope = sourceCode.getScope(node);
471
- const { right, left, operator } = node;
472
- const rightConstantOperand = findBinaryExpressionConstantOperand(scope, left, right, operator);
473
- const leftConstantOperand = findBinaryExpressionConstantOperand(scope, right, left, operator);
474
-
475
- if (rightConstantOperand) {
476
- context.report({ node: rightConstantOperand, messageId: "constantBinaryOperand", data: { operator, otherSide: "left" } });
477
- } else if (leftConstantOperand) {
478
- context.report({ node: leftConstantOperand, messageId: "constantBinaryOperand", data: { operator, otherSide: "right" } });
479
- } else if (operator === "===" || operator === "!==") {
480
- if (isAlwaysNew(scope, left)) {
481
- context.report({ node: left, messageId: "alwaysNew" });
482
- } else if (isAlwaysNew(scope, right)) {
483
- context.report({ node: right, messageId: "alwaysNew" });
484
- }
485
- } else if (operator === "==" || operator === "!=") {
486
-
487
- /*
488
- * If both sides are "new", then both sides are objects and
489
- * therefore they will be compared by reference even with `==`
490
- * equality.
491
- */
492
- if (isAlwaysNew(scope, left) && isAlwaysNew(scope, right)) {
493
- context.report({ node: left, messageId: "bothAlwaysNew" });
494
- }
495
- }
496
-
497
- }
498
-
499
- /*
500
- * In theory we could handle short-circuiting assignment operators,
501
- * for some constant values, but that would require walking the
502
- * scope to find the value of the variable being assigned. This is
503
- * dependant on https://github.com/eslint/eslint/issues/13776
504
- *
505
- * AssignmentExpression() {},
506
- */
507
- };
508
- }
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
+ },
509
603
  };