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
package/lib/cli.js CHANGED
@@ -16,16 +16,24 @@
16
16
  //------------------------------------------------------------------------------
17
17
 
18
18
  const fs = require("node:fs"),
19
- path = require("node:path"),
20
- { promisify } = require("node:util"),
21
- { LegacyESLint } = require("./eslint"),
22
- { ESLint, shouldUseFlatConfig, locateConfigFileToUse } = require("./eslint/eslint"),
23
- createCLIOptions = require("./options"),
24
- log = require("./shared/logging"),
25
- RuntimeInfo = require("./shared/runtime-info"),
26
- { normalizeSeverityToString } = require("./shared/severity");
27
- const { Legacy: { naming } } = require("@eslint/eslintrc");
19
+ path = require("node:path"),
20
+ { promisify } = require("node:util"),
21
+ { LegacyESLint } = require("./eslint"),
22
+ {
23
+ ESLint,
24
+ shouldUseFlatConfig,
25
+ locateConfigFileToUse,
26
+ } = require("./eslint/eslint"),
27
+ createCLIOptions = require("./options"),
28
+ log = require("./shared/logging"),
29
+ RuntimeInfo = require("./shared/runtime-info"),
30
+ { normalizeSeverityToString } = require("./shared/severity");
31
+ const {
32
+ Legacy: { naming },
33
+ } = require("@eslint/eslintrc");
28
34
  const { ModuleImporter } = require("@humanwhocodes/module-importer");
35
+ const { getCacheFile } = require("./eslint/eslint-helpers");
36
+ const { SuppressionsService } = require("./services/suppressions-service");
29
37
  const debug = require("debug")("eslint:cli");
30
38
 
31
39
  //------------------------------------------------------------------------------
@@ -54,23 +62,32 @@ const writeFile = promisify(fs.writeFile);
54
62
  * @returns {Promise<Record<string, Plugin>>} A mapping of plugin short names to implementations.
55
63
  */
56
64
  async function loadPlugins(importer, pluginNames) {
57
- const plugins = {};
58
-
59
- await Promise.all(pluginNames.map(async pluginName => {
60
-
61
- const longName = naming.normalizePackageName(pluginName, "eslint-plugin");
62
- const module = await importer.import(longName);
63
-
64
- if (!("default" in module)) {
65
- throw new Error(`"${longName}" cannot be used with the \`--plugin\` option because its default module does not provide a \`default\` export`);
66
- }
67
-
68
- const shortName = naming.getShorthandName(pluginName, "eslint-plugin");
69
-
70
- plugins[shortName] = module.default;
71
- }));
72
-
73
- return plugins;
65
+ const plugins = {};
66
+
67
+ await Promise.all(
68
+ pluginNames.map(async pluginName => {
69
+ const longName = naming.normalizePackageName(
70
+ pluginName,
71
+ "eslint-plugin",
72
+ );
73
+ const module = await importer.import(longName);
74
+
75
+ if (!("default" in module)) {
76
+ throw new Error(
77
+ `"${longName}" cannot be used with the \`--plugin\` option because its default module does not provide a \`default\` export`,
78
+ );
79
+ }
80
+
81
+ const shortName = naming.getShorthandName(
82
+ pluginName,
83
+ "eslint-plugin",
84
+ );
85
+
86
+ plugins[shortName] = module.default;
87
+ }),
88
+ );
89
+
90
+ return plugins;
74
91
  }
75
92
 
76
93
  /**
@@ -81,7 +98,7 @@ async function loadPlugins(importer, pluginNames) {
81
98
  * autofixed), false otherwise.
82
99
  */
83
100
  function quietFixPredicate(message) {
84
- return message.severity === 2;
101
+ return message.severity === 2;
85
102
  }
86
103
 
87
104
  /**
@@ -91,7 +108,7 @@ function quietFixPredicate(message) {
91
108
  * @returns {boolean} True if the lint rule should run, false otherwise.
92
109
  */
93
110
  function quietRuleFilter(rule) {
94
- return rule.severity === 2;
111
+ return rule.severity === 2;
95
112
  }
96
113
 
97
114
  /**
@@ -102,165 +119,192 @@ function quietRuleFilter(rule) {
102
119
  * @returns {Promise<ESLintOptions>} The options object for the ESLint constructor.
103
120
  * @private
104
121
  */
105
- async function translateOptions({
106
- cache,
107
- cacheFile,
108
- cacheLocation,
109
- cacheStrategy,
110
- config,
111
- configLookup,
112
- env,
113
- errorOnUnmatchedPattern,
114
- eslintrc,
115
- ext,
116
- fix,
117
- fixDryRun,
118
- fixType,
119
- flag,
120
- global,
121
- ignore,
122
- ignorePath,
123
- ignorePattern,
124
- inlineConfig,
125
- parser,
126
- parserOptions,
127
- plugin,
128
- quiet,
129
- reportUnusedDisableDirectives,
130
- reportUnusedDisableDirectivesSeverity,
131
- reportUnusedInlineConfigs,
132
- resolvePluginsRelativeTo,
133
- rule,
134
- rulesdir,
135
- stats,
136
- warnIgnored,
137
- passOnNoPatterns,
138
- maxWarnings
139
- }, configType) {
140
-
141
- let overrideConfig, overrideConfigFile;
142
- const importer = new ModuleImporter();
143
-
144
- if (configType === "flat") {
145
- overrideConfigFile = (typeof config === "string") ? config : !configLookup;
146
- if (overrideConfigFile === false) {
147
- overrideConfigFile = void 0;
148
- }
149
-
150
- const languageOptions = {};
151
-
152
- if (global) {
153
- languageOptions.globals = global.reduce((obj, name) => {
154
- if (name.endsWith(":true")) {
155
- obj[name.slice(0, -5)] = "writable";
156
- } else {
157
- obj[name] = "readonly";
158
- }
159
- return obj;
160
- }, {});
161
- }
162
-
163
- if (parserOptions) {
164
- languageOptions.parserOptions = parserOptions;
165
- }
166
-
167
- if (parser) {
168
- languageOptions.parser = await importer.import(parser);
169
- }
170
-
171
- overrideConfig = [{
172
- ...Object.keys(languageOptions).length > 0 ? { languageOptions } : {},
173
- rules: rule ? rule : {}
174
- }];
175
-
176
- if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
177
- overrideConfig[0].linterOptions = {
178
- reportUnusedDisableDirectives: reportUnusedDisableDirectives
179
- ? "error"
180
- : normalizeSeverityToString(reportUnusedDisableDirectivesSeverity)
181
- };
182
- }
183
-
184
- if (reportUnusedInlineConfigs !== void 0) {
185
- overrideConfig[0].linterOptions = {
186
- ...overrideConfig[0].linterOptions,
187
- reportUnusedInlineConfigs: normalizeSeverityToString(reportUnusedInlineConfigs)
188
- };
189
- }
190
-
191
- if (plugin) {
192
- overrideConfig[0].plugins = await loadPlugins(importer, plugin);
193
- }
194
-
195
- if (ext) {
196
- overrideConfig.push({
197
- files: ext.map(extension => `**/*${extension.startsWith(".") ? "" : "."}${extension}`)
198
- });
199
- }
200
-
201
- } else {
202
- overrideConfigFile = config;
203
-
204
- overrideConfig = {
205
- env: env && env.reduce((obj, name) => {
206
- obj[name] = true;
207
- return obj;
208
- }, {}),
209
- globals: global && global.reduce((obj, name) => {
210
- if (name.endsWith(":true")) {
211
- obj[name.slice(0, -5)] = "writable";
212
- } else {
213
- obj[name] = "readonly";
214
- }
215
- return obj;
216
- }, {}),
217
- ignorePatterns: ignorePattern,
218
- parser,
219
- parserOptions,
220
- plugins: plugin,
221
- rules: rule
222
- };
223
- }
224
-
225
- const options = {
226
- allowInlineConfig: inlineConfig,
227
- cache,
228
- cacheLocation: cacheLocation || cacheFile,
229
- cacheStrategy,
230
- errorOnUnmatchedPattern,
231
- fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
232
- fixTypes: fixType,
233
- ignore,
234
- overrideConfig,
235
- overrideConfigFile,
236
- passOnNoPatterns
237
- };
238
-
239
- if (configType === "flat") {
240
- options.ignorePatterns = ignorePattern;
241
- options.stats = stats;
242
- options.warnIgnored = warnIgnored;
243
- options.flags = flag;
244
-
245
- /*
246
- * For performance reasons rules not marked as 'error' are filtered out in quiet mode. As maxWarnings
247
- * requires rules set to 'warn' to be run, we only filter out 'warn' rules if maxWarnings is not specified.
248
- */
249
- options.ruleFilter = quiet && maxWarnings === -1 ? quietRuleFilter : () => true;
250
- } else {
251
- options.resolvePluginsRelativeTo = resolvePluginsRelativeTo;
252
- options.rulePaths = rulesdir;
253
- options.useEslintrc = eslintrc;
254
- options.extensions = ext;
255
- options.ignorePath = ignorePath;
256
- if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
257
- options.reportUnusedDisableDirectives = reportUnusedDisableDirectives
258
- ? "error"
259
- : normalizeSeverityToString(reportUnusedDisableDirectivesSeverity);
260
- }
261
- }
262
-
263
- return options;
122
+ async function translateOptions(
123
+ {
124
+ cache,
125
+ cacheFile,
126
+ cacheLocation,
127
+ cacheStrategy,
128
+ config,
129
+ configLookup,
130
+ env,
131
+ errorOnUnmatchedPattern,
132
+ eslintrc,
133
+ ext,
134
+ fix,
135
+ fixDryRun,
136
+ fixType,
137
+ flag,
138
+ global,
139
+ ignore,
140
+ ignorePath,
141
+ ignorePattern,
142
+ inlineConfig,
143
+ parser,
144
+ parserOptions,
145
+ plugin,
146
+ quiet,
147
+ reportUnusedDisableDirectives,
148
+ reportUnusedDisableDirectivesSeverity,
149
+ reportUnusedInlineConfigs,
150
+ resolvePluginsRelativeTo,
151
+ rule,
152
+ rulesdir,
153
+ stats,
154
+ warnIgnored,
155
+ passOnNoPatterns,
156
+ maxWarnings,
157
+ },
158
+ configType,
159
+ ) {
160
+ let overrideConfig, overrideConfigFile;
161
+ const importer = new ModuleImporter();
162
+
163
+ if (configType === "flat") {
164
+ overrideConfigFile =
165
+ typeof config === "string" ? config : !configLookup;
166
+ if (overrideConfigFile === false) {
167
+ overrideConfigFile = void 0;
168
+ }
169
+
170
+ const languageOptions = {};
171
+
172
+ if (global) {
173
+ languageOptions.globals = global.reduce((obj, name) => {
174
+ if (name.endsWith(":true")) {
175
+ obj[name.slice(0, -5)] = "writable";
176
+ } else {
177
+ obj[name] = "readonly";
178
+ }
179
+ return obj;
180
+ }, {});
181
+ }
182
+
183
+ if (parserOptions) {
184
+ languageOptions.parserOptions = parserOptions;
185
+ }
186
+
187
+ if (parser) {
188
+ languageOptions.parser = await importer.import(parser);
189
+ }
190
+
191
+ overrideConfig = [
192
+ {
193
+ ...(Object.keys(languageOptions).length > 0
194
+ ? { languageOptions }
195
+ : {}),
196
+ rules: rule ? rule : {},
197
+ },
198
+ ];
199
+
200
+ if (
201
+ reportUnusedDisableDirectives ||
202
+ reportUnusedDisableDirectivesSeverity !== void 0
203
+ ) {
204
+ overrideConfig[0].linterOptions = {
205
+ reportUnusedDisableDirectives: reportUnusedDisableDirectives
206
+ ? "error"
207
+ : normalizeSeverityToString(
208
+ reportUnusedDisableDirectivesSeverity,
209
+ ),
210
+ };
211
+ }
212
+
213
+ if (reportUnusedInlineConfigs !== void 0) {
214
+ overrideConfig[0].linterOptions = {
215
+ ...overrideConfig[0].linterOptions,
216
+ reportUnusedInlineConfigs: normalizeSeverityToString(
217
+ reportUnusedInlineConfigs,
218
+ ),
219
+ };
220
+ }
221
+
222
+ if (plugin) {
223
+ overrideConfig[0].plugins = await loadPlugins(importer, plugin);
224
+ }
225
+
226
+ if (ext) {
227
+ overrideConfig.push({
228
+ files: ext.map(
229
+ extension =>
230
+ `**/*${extension.startsWith(".") ? "" : "."}${extension}`,
231
+ ),
232
+ });
233
+ }
234
+ } else {
235
+ overrideConfigFile = config;
236
+
237
+ overrideConfig = {
238
+ env:
239
+ env &&
240
+ env.reduce((obj, name) => {
241
+ obj[name] = true;
242
+ return obj;
243
+ }, {}),
244
+ globals:
245
+ global &&
246
+ global.reduce((obj, name) => {
247
+ if (name.endsWith(":true")) {
248
+ obj[name.slice(0, -5)] = "writable";
249
+ } else {
250
+ obj[name] = "readonly";
251
+ }
252
+ return obj;
253
+ }, {}),
254
+ ignorePatterns: ignorePattern,
255
+ parser,
256
+ parserOptions,
257
+ plugins: plugin,
258
+ rules: rule,
259
+ };
260
+ }
261
+
262
+ const options = {
263
+ allowInlineConfig: inlineConfig,
264
+ cache,
265
+ cacheLocation: cacheLocation || cacheFile,
266
+ cacheStrategy,
267
+ errorOnUnmatchedPattern,
268
+ fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
269
+ fixTypes: fixType,
270
+ ignore,
271
+ overrideConfig,
272
+ overrideConfigFile,
273
+ passOnNoPatterns,
274
+ };
275
+
276
+ if (configType === "flat") {
277
+ options.ignorePatterns = ignorePattern;
278
+ options.stats = stats;
279
+ options.warnIgnored = warnIgnored;
280
+ options.flags = flag;
281
+
282
+ /*
283
+ * For performance reasons rules not marked as 'error' are filtered out in quiet mode. As maxWarnings
284
+ * requires rules set to 'warn' to be run, we only filter out 'warn' rules if maxWarnings is not specified.
285
+ */
286
+ options.ruleFilter =
287
+ quiet && maxWarnings === -1 ? quietRuleFilter : () => true;
288
+ } else {
289
+ options.resolvePluginsRelativeTo = resolvePluginsRelativeTo;
290
+ options.rulePaths = rulesdir;
291
+ options.useEslintrc = eslintrc;
292
+ options.extensions = ext;
293
+ options.ignorePath = ignorePath;
294
+ if (
295
+ reportUnusedDisableDirectives ||
296
+ reportUnusedDisableDirectivesSeverity !== void 0
297
+ ) {
298
+ options.reportUnusedDisableDirectives =
299
+ reportUnusedDisableDirectives
300
+ ? "error"
301
+ : normalizeSeverityToString(
302
+ reportUnusedDisableDirectivesSeverity,
303
+ );
304
+ }
305
+ }
306
+
307
+ return options;
264
308
  }
265
309
 
266
310
  /**
@@ -269,17 +313,17 @@ async function translateOptions({
269
313
  * @returns {{errorCount:number;fatalErrorCount:number,warningCount:number}} The number of error messages.
270
314
  */
271
315
  function countErrors(results) {
272
- let errorCount = 0;
273
- let fatalErrorCount = 0;
274
- let warningCount = 0;
316
+ let errorCount = 0;
317
+ let fatalErrorCount = 0;
318
+ let warningCount = 0;
275
319
 
276
- for (const result of results) {
277
- errorCount += result.errorCount;
278
- fatalErrorCount += result.fatalErrorCount;
279
- warningCount += result.warningCount;
280
- }
320
+ for (const result of results) {
321
+ errorCount += result.errorCount;
322
+ fatalErrorCount += result.fatalErrorCount;
323
+ warningCount += result.warningCount;
324
+ }
281
325
 
282
- return { errorCount, fatalErrorCount, warningCount };
326
+ return { errorCount, fatalErrorCount, warningCount };
283
327
  }
284
328
 
285
329
  /**
@@ -288,14 +332,14 @@ function countErrors(results) {
288
332
  * @returns {Promise<boolean>} `true` if the given path is a directory.
289
333
  */
290
334
  async function isDirectory(filePath) {
291
- try {
292
- return (await stat(filePath)).isDirectory();
293
- } catch (error) {
294
- if (error.code === "ENOENT" || error.code === "ENOTDIR") {
295
- return false;
296
- }
297
- throw error;
298
- }
335
+ try {
336
+ return (await stat(filePath)).isDirectory();
337
+ } catch (error) {
338
+ if (error.code === "ENOENT" || error.code === "ENOTDIR") {
339
+ return false;
340
+ }
341
+ throw error;
342
+ }
299
343
  }
300
344
 
301
345
  /**
@@ -309,37 +353,40 @@ async function isDirectory(filePath) {
309
353
  * @private
310
354
  */
311
355
  async function printResults(engine, results, format, outputFile, resultsMeta) {
312
- let formatter;
313
-
314
- try {
315
- formatter = await engine.loadFormatter(format);
316
- } catch (e) {
317
- log.error(e.message);
318
- return false;
319
- }
320
-
321
- const output = await formatter.format(results, resultsMeta);
322
-
323
- if (outputFile) {
324
- const filePath = path.resolve(process.cwd(), outputFile);
325
-
326
- if (await isDirectory(filePath)) {
327
- log.error("Cannot write to output file path, it is a directory: %s", outputFile);
328
- return false;
329
- }
330
-
331
- try {
332
- await mkdir(path.dirname(filePath), { recursive: true });
333
- await writeFile(filePath, output);
334
- } catch (ex) {
335
- log.error("There was a problem writing the output file:\n%s", ex);
336
- return false;
337
- }
338
- } else if (output) {
339
- log.info(output);
340
- }
341
-
342
- return true;
356
+ let formatter;
357
+
358
+ try {
359
+ formatter = await engine.loadFormatter(format);
360
+ } catch (e) {
361
+ log.error(e.message);
362
+ return false;
363
+ }
364
+
365
+ const output = await formatter.format(results, resultsMeta);
366
+
367
+ if (outputFile) {
368
+ const filePath = path.resolve(process.cwd(), outputFile);
369
+
370
+ if (await isDirectory(filePath)) {
371
+ log.error(
372
+ "Cannot write to output file path, it is a directory: %s",
373
+ outputFile,
374
+ );
375
+ return false;
376
+ }
377
+
378
+ try {
379
+ await mkdir(path.dirname(filePath), { recursive: true });
380
+ await writeFile(filePath, output);
381
+ } catch (ex) {
382
+ log.error("There was a problem writing the output file:\n%s", ex);
383
+ return false;
384
+ }
385
+ } else if (output) {
386
+ log.info(output);
387
+ }
388
+
389
+ return true;
343
390
  }
344
391
 
345
392
  //------------------------------------------------------------------------------
@@ -351,228 +398,362 @@ async function printResults(engine, results, format, outputFile, resultsMeta) {
351
398
  * for other Node.js programs to effectively run the CLI.
352
399
  */
353
400
  const cli = {
354
-
355
- /**
356
- * Calculates the command string for the --inspect-config operation.
357
- * @param {string} configFile The path to the config file to inspect.
358
- * @returns {Promise<string>} The command string to execute.
359
- */
360
- async calculateInspectConfigFlags(configFile) {
361
-
362
- // find the config file
363
- const {
364
- configFilePath,
365
- basePath
366
- } = await locateConfigFileToUse({ cwd: process.cwd(), configFile });
367
-
368
- return ["--config", configFilePath, "--basePath", basePath];
369
- },
370
-
371
- /**
372
- * Executes the CLI based on an array of arguments that is passed in.
373
- * @param {string|Array|Object} args The arguments to process.
374
- * @param {string} [text] The text to lint (used for TTY).
375
- * @param {boolean} [allowFlatConfig=true] Whether or not to allow flat config.
376
- * @returns {Promise<number>} The exit code for the operation.
377
- */
378
- async execute(args, text, allowFlatConfig = true) {
379
- if (Array.isArray(args)) {
380
- debug("CLI args: %o", args.slice(2));
381
- }
382
-
383
- /*
384
- * Before doing anything, we need to see if we are using a
385
- * flat config file. If so, then we need to change the way command
386
- * line args are parsed. This is temporary, and when we fully
387
- * switch to flat config we can remove this logic.
388
- */
389
-
390
- const usingFlatConfig = allowFlatConfig && await shouldUseFlatConfig();
391
-
392
- debug("Using flat config?", usingFlatConfig);
393
-
394
- if (allowFlatConfig && !usingFlatConfig) {
395
- process.emitWarning("You are using an eslintrc configuration file, which is deprecated and support will be removed in v10.0.0. Please migrate to an eslint.config.js file. See https://eslint.org/docs/latest/use/configure/migration-guide for details. An eslintrc configuration file is used because you have the ESLINT_USE_FLAT_CONFIG environment variable set to false. If you want to use an eslint.config.js file, remove the environment variable. If you want to find the location of the eslintrc configuration file, use the --debug flag.", "ESLintRCWarning");
396
- }
397
-
398
- const CLIOptions = createCLIOptions(usingFlatConfig);
399
-
400
- /** @type {ParsedCLIOptions} */
401
- let options;
402
-
403
- try {
404
- options = CLIOptions.parse(args);
405
- } catch (error) {
406
- debug("Error parsing CLI options:", error.message);
407
-
408
- let errorMessage = error.message;
409
-
410
- if (usingFlatConfig) {
411
- errorMessage += "\nYou're using eslint.config.js, some command line flags are no longer available. Please see https://eslint.org/docs/latest/use/command-line-interface for details.";
412
- }
413
-
414
- log.error(errorMessage);
415
- return 2;
416
- }
417
-
418
- const files = options._;
419
- const useStdin = typeof text === "string";
420
-
421
- if (options.help) {
422
- log.info(CLIOptions.generateHelp());
423
- return 0;
424
- }
425
- if (options.version) {
426
- log.info(RuntimeInfo.version());
427
- return 0;
428
- }
429
- if (options.envInfo) {
430
- try {
431
- log.info(RuntimeInfo.environment());
432
- return 0;
433
- } catch (err) {
434
- debug("Error retrieving environment info");
435
- log.error(err.message);
436
- return 2;
437
- }
438
- }
439
-
440
- if (options.printConfig) {
441
- if (files.length) {
442
- log.error("The --print-config option must be used with exactly one file name.");
443
- return 2;
444
- }
445
- if (useStdin) {
446
- log.error("The --print-config option is not available for piped-in code.");
447
- return 2;
448
- }
449
-
450
- const engine = usingFlatConfig
451
- ? new ESLint(await translateOptions(options, "flat"))
452
- : new LegacyESLint(await translateOptions(options));
453
- const fileConfig =
454
- await engine.calculateConfigForFile(options.printConfig);
455
-
456
- log.info(JSON.stringify(fileConfig, null, " "));
457
- return 0;
458
- }
459
-
460
- if (options.inspectConfig) {
461
-
462
- log.info("You can also run this command directly using 'npx @eslint/config-inspector@latest' in the same directory as your configuration file.");
463
-
464
- try {
465
- const flatOptions = await translateOptions(options, "flat");
466
- const spawn = require("cross-spawn");
467
- const flags = await cli.calculateInspectConfigFlags(flatOptions.overrideConfigFile);
468
-
469
- spawn.sync("npx", ["@eslint/config-inspector@latest", ...flags], { encoding: "utf8", stdio: "inherit" });
470
- } catch (error) {
471
- log.error(error);
472
- return 2;
473
- }
474
-
475
- return 0;
476
- }
477
-
478
- debug(`Running on ${useStdin ? "text" : "files"}`);
479
-
480
- if (options.fix && options.fixDryRun) {
481
- log.error("The --fix option and the --fix-dry-run option cannot be used together.");
482
- return 2;
483
- }
484
- if (useStdin && options.fix) {
485
- log.error("The --fix option is not available for piped-in code; use --fix-dry-run instead.");
486
- return 2;
487
- }
488
- if (options.fixType && !options.fix && !options.fixDryRun) {
489
- log.error("The --fix-type option requires either --fix or --fix-dry-run.");
490
- return 2;
491
- }
492
-
493
- if (options.reportUnusedDisableDirectives && options.reportUnusedDisableDirectivesSeverity !== void 0) {
494
- log.error("The --report-unused-disable-directives option and the --report-unused-disable-directives-severity option cannot be used together.");
495
- return 2;
496
- }
497
-
498
- if (usingFlatConfig && options.ext) {
499
-
500
- // Passing `--ext ""` results in `options.ext` being an empty array.
501
- if (options.ext.length === 0) {
502
- log.error("The --ext option value cannot be empty.");
503
- return 2;
504
- }
505
-
506
- // Passing `--ext ,ts` results in an empty string at index 0. Passing `--ext ts,,tsx` results in an empty string at index 1.
507
- const emptyStringIndex = options.ext.indexOf("");
508
-
509
- if (emptyStringIndex >= 0) {
510
- log.error(`The --ext option arguments cannot be empty strings. Found an empty string at index ${emptyStringIndex}.`);
511
- return 2;
512
- }
513
- }
514
-
515
- const ActiveESLint = usingFlatConfig ? ESLint : LegacyESLint;
516
- const eslintOptions = await translateOptions(options, usingFlatConfig ? "flat" : "eslintrc");
517
- const engine = new ActiveESLint(eslintOptions);
518
- let results;
519
-
520
- if (useStdin) {
521
- results = await engine.lintText(text, {
522
- filePath: options.stdinFilename,
523
-
524
- // flatConfig respects CLI flag and constructor warnIgnored, eslintrc forces true for backwards compatibility
525
- warnIgnored: usingFlatConfig ? void 0 : true
526
- });
527
- } else {
528
- results = await engine.lintFiles(files);
529
- }
530
-
531
- if (options.fix) {
532
- debug("Fix mode enabled - applying fixes");
533
- await ActiveESLint.outputFixes(results);
534
- }
535
-
536
- let resultsToPrint = results;
537
-
538
- if (options.quiet) {
539
- debug("Quiet mode enabled - filtering out warnings");
540
- resultsToPrint = ActiveESLint.getErrorResults(resultsToPrint);
541
- }
542
-
543
- const resultCounts = countErrors(results);
544
- const tooManyWarnings = options.maxWarnings >= 0 && resultCounts.warningCount > options.maxWarnings;
545
- const resultsMeta = tooManyWarnings
546
- ? {
547
- maxWarningsExceeded: {
548
- maxWarnings: options.maxWarnings,
549
- foundWarnings: resultCounts.warningCount
550
- }
551
- }
552
- : {};
553
-
554
- if (await printResults(engine, resultsToPrint, options.format, options.outputFile, resultsMeta)) {
555
-
556
- // Errors and warnings from the original unfiltered results should determine the exit code
557
- const shouldExitForFatalErrors =
558
- options.exitOnFatalError && resultCounts.fatalErrorCount > 0;
559
-
560
- if (!resultCounts.errorCount && tooManyWarnings) {
561
- log.error(
562
- "ESLint found too many warnings (maximum: %s).",
563
- options.maxWarnings
564
- );
565
- }
566
-
567
- if (shouldExitForFatalErrors) {
568
- return 2;
569
- }
570
-
571
- return (resultCounts.errorCount || tooManyWarnings) ? 1 : 0;
572
- }
573
-
574
- return 2;
575
- }
401
+ /**
402
+ * Calculates the command string for the --inspect-config operation.
403
+ * @param {string} configFile The path to the config file to inspect.
404
+ * @returns {Promise<string>} The command string to execute.
405
+ */
406
+ async calculateInspectConfigFlags(configFile) {
407
+ // find the config file
408
+ const { configFilePath, basePath } = await locateConfigFileToUse({
409
+ cwd: process.cwd(),
410
+ configFile,
411
+ });
412
+
413
+ return ["--config", configFilePath, "--basePath", basePath];
414
+ },
415
+
416
+ /**
417
+ * Executes the CLI based on an array of arguments that is passed in.
418
+ * @param {string|Array|Object} args The arguments to process.
419
+ * @param {string} [text] The text to lint (used for TTY).
420
+ * @param {boolean} [allowFlatConfig=true] Whether or not to allow flat config.
421
+ * @returns {Promise<number>} The exit code for the operation.
422
+ */
423
+ async execute(args, text, allowFlatConfig = true) {
424
+ if (Array.isArray(args)) {
425
+ debug("CLI args: %o", args.slice(2));
426
+ }
427
+
428
+ /*
429
+ * Before doing anything, we need to see if we are using a
430
+ * flat config file. If so, then we need to change the way command
431
+ * line args are parsed. This is temporary, and when we fully
432
+ * switch to flat config we can remove this logic.
433
+ */
434
+
435
+ const usingFlatConfig =
436
+ allowFlatConfig && (await shouldUseFlatConfig());
437
+
438
+ debug("Using flat config?", usingFlatConfig);
439
+
440
+ if (allowFlatConfig && !usingFlatConfig) {
441
+ process.emitWarning(
442
+ "You are using an eslintrc configuration file, which is deprecated and support will be removed in v10.0.0. Please migrate to an eslint.config.js file. See https://eslint.org/docs/latest/use/configure/migration-guide for details. An eslintrc configuration file is used because you have the ESLINT_USE_FLAT_CONFIG environment variable set to false. If you want to use an eslint.config.js file, remove the environment variable. If you want to find the location of the eslintrc configuration file, use the --debug flag.",
443
+ "ESLintRCWarning",
444
+ );
445
+ }
446
+
447
+ const CLIOptions = createCLIOptions(usingFlatConfig);
448
+
449
+ /** @type {ParsedCLIOptions} */
450
+ let options;
451
+
452
+ try {
453
+ options = CLIOptions.parse(args);
454
+ } catch (error) {
455
+ debug("Error parsing CLI options:", error.message);
456
+
457
+ let errorMessage = error.message;
458
+
459
+ if (usingFlatConfig) {
460
+ errorMessage +=
461
+ "\nYou're using eslint.config.js, some command line flags are no longer available. Please see https://eslint.org/docs/latest/use/command-line-interface for details.";
462
+ }
463
+
464
+ log.error(errorMessage);
465
+ return 2;
466
+ }
467
+
468
+ const files = options._;
469
+ const useStdin = typeof text === "string";
470
+
471
+ if (options.help) {
472
+ log.info(CLIOptions.generateHelp());
473
+ return 0;
474
+ }
475
+ if (options.version) {
476
+ log.info(RuntimeInfo.version());
477
+ return 0;
478
+ }
479
+ if (options.envInfo) {
480
+ try {
481
+ log.info(RuntimeInfo.environment());
482
+ return 0;
483
+ } catch (err) {
484
+ debug("Error retrieving environment info");
485
+ log.error(err.message);
486
+ return 2;
487
+ }
488
+ }
489
+
490
+ if (options.printConfig) {
491
+ if (files.length) {
492
+ log.error(
493
+ "The --print-config option must be used with exactly one file name.",
494
+ );
495
+ return 2;
496
+ }
497
+ if (useStdin) {
498
+ log.error(
499
+ "The --print-config option is not available for piped-in code.",
500
+ );
501
+ return 2;
502
+ }
503
+
504
+ const engine = usingFlatConfig
505
+ ? new ESLint(await translateOptions(options, "flat"))
506
+ : new LegacyESLint(await translateOptions(options));
507
+ const fileConfig = await engine.calculateConfigForFile(
508
+ options.printConfig,
509
+ );
510
+
511
+ log.info(JSON.stringify(fileConfig, null, " "));
512
+ return 0;
513
+ }
514
+
515
+ if (options.inspectConfig) {
516
+ log.info(
517
+ "You can also run this command directly using 'npx @eslint/config-inspector@latest' in the same directory as your configuration file.",
518
+ );
519
+
520
+ try {
521
+ const flatOptions = await translateOptions(options, "flat");
522
+ const spawn = require("cross-spawn");
523
+ const flags = await cli.calculateInspectConfigFlags(
524
+ flatOptions.overrideConfigFile,
525
+ );
526
+
527
+ spawn.sync(
528
+ "npx",
529
+ ["@eslint/config-inspector@latest", ...flags],
530
+ { encoding: "utf8", stdio: "inherit" },
531
+ );
532
+ } catch (error) {
533
+ log.error(error);
534
+ return 2;
535
+ }
536
+
537
+ return 0;
538
+ }
539
+
540
+ debug(`Running on ${useStdin ? "text" : "files"}`);
541
+
542
+ if (options.fix && options.fixDryRun) {
543
+ log.error(
544
+ "The --fix option and the --fix-dry-run option cannot be used together.",
545
+ );
546
+ return 2;
547
+ }
548
+ if (useStdin && options.fix) {
549
+ log.error(
550
+ "The --fix option is not available for piped-in code; use --fix-dry-run instead.",
551
+ );
552
+ return 2;
553
+ }
554
+ if (options.fixType && !options.fix && !options.fixDryRun) {
555
+ log.error(
556
+ "The --fix-type option requires either --fix or --fix-dry-run.",
557
+ );
558
+ return 2;
559
+ }
560
+
561
+ if (
562
+ options.reportUnusedDisableDirectives &&
563
+ options.reportUnusedDisableDirectivesSeverity !== void 0
564
+ ) {
565
+ log.error(
566
+ "The --report-unused-disable-directives option and the --report-unused-disable-directives-severity option cannot be used together.",
567
+ );
568
+ return 2;
569
+ }
570
+
571
+ if (usingFlatConfig && options.ext) {
572
+ // Passing `--ext ""` results in `options.ext` being an empty array.
573
+ if (options.ext.length === 0) {
574
+ log.error("The --ext option value cannot be empty.");
575
+ return 2;
576
+ }
577
+
578
+ // Passing `--ext ,ts` results in an empty string at index 0. Passing `--ext ts,,tsx` results in an empty string at index 1.
579
+ const emptyStringIndex = options.ext.indexOf("");
580
+
581
+ if (emptyStringIndex >= 0) {
582
+ log.error(
583
+ `The --ext option arguments cannot be empty strings. Found an empty string at index ${emptyStringIndex}.`,
584
+ );
585
+ return 2;
586
+ }
587
+ }
588
+
589
+ if (options.suppressAll && options.suppressRule) {
590
+ log.error(
591
+ "The --suppress-all option and the --suppress-rule option cannot be used together.",
592
+ );
593
+ return 2;
594
+ }
595
+
596
+ if (options.suppressAll && options.pruneSuppressions) {
597
+ log.error(
598
+ "The --suppress-all option and the --prune-suppressions option cannot be used together.",
599
+ );
600
+ return 2;
601
+ }
602
+
603
+ if (options.suppressRule && options.pruneSuppressions) {
604
+ log.error(
605
+ "The --suppress-rule option and the --prune-suppressions option cannot be used together.",
606
+ );
607
+ return 2;
608
+ }
609
+
610
+ if (
611
+ useStdin &&
612
+ (options.suppressAll ||
613
+ options.suppressRule ||
614
+ options.pruneSuppressions)
615
+ ) {
616
+ log.error(
617
+ "The --suppress-all, --suppress-rule, and --prune-suppressions options cannot be used with piped-in code.",
618
+ );
619
+ return 2;
620
+ }
621
+
622
+ const ActiveESLint = usingFlatConfig ? ESLint : LegacyESLint;
623
+ const eslintOptions = await translateOptions(
624
+ options,
625
+ usingFlatConfig ? "flat" : "eslintrc",
626
+ );
627
+ const engine = new ActiveESLint(eslintOptions);
628
+ let results;
629
+
630
+ if (useStdin) {
631
+ results = await engine.lintText(text, {
632
+ filePath: options.stdinFilename,
633
+
634
+ // flatConfig respects CLI flag and constructor warnIgnored, eslintrc forces true for backwards compatibility
635
+ warnIgnored: usingFlatConfig ? void 0 : true,
636
+ });
637
+ } else {
638
+ results = await engine.lintFiles(files);
639
+ }
640
+
641
+ if (options.fix) {
642
+ debug("Fix mode enabled - applying fixes");
643
+ await ActiveESLint.outputFixes(results);
644
+ }
645
+
646
+ let unusedSuppressions = {};
647
+
648
+ if (!useStdin) {
649
+ const suppressionsFileLocation = getCacheFile(
650
+ options.suppressionsLocation || "eslint-suppressions.json",
651
+ process.cwd(),
652
+ {
653
+ prefix: "suppressions_",
654
+ },
655
+ );
656
+
657
+ if (
658
+ options.suppressionsLocation &&
659
+ !fs.existsSync(suppressionsFileLocation) &&
660
+ !options.suppressAll &&
661
+ !options.suppressRule
662
+ ) {
663
+ log.error(
664
+ "The suppressions file does not exist. Please run the command with `--suppress-all` or `--suppress-rule` to create it.",
665
+ );
666
+ return 2;
667
+ }
668
+
669
+ if (
670
+ options.suppressAll ||
671
+ options.suppressRule ||
672
+ options.pruneSuppressions ||
673
+ fs.existsSync(suppressionsFileLocation)
674
+ ) {
675
+ const suppressions = new SuppressionsService({
676
+ filePath: suppressionsFileLocation,
677
+ cwd: process.cwd(),
678
+ });
679
+
680
+ if (options.suppressAll || options.suppressRule) {
681
+ await suppressions.suppress(results, options.suppressRule);
682
+ }
683
+
684
+ if (options.pruneSuppressions) {
685
+ await suppressions.prune(results);
686
+ }
687
+
688
+ const suppressionResults = suppressions.applySuppressions(
689
+ results,
690
+ await suppressions.load(),
691
+ );
692
+
693
+ results = suppressionResults.results;
694
+ unusedSuppressions = suppressionResults.unused;
695
+ }
696
+ }
697
+
698
+ let resultsToPrint = results;
699
+
700
+ if (options.quiet) {
701
+ debug("Quiet mode enabled - filtering out warnings");
702
+ resultsToPrint = ActiveESLint.getErrorResults(resultsToPrint);
703
+ }
704
+
705
+ const resultCounts = countErrors(results);
706
+ const tooManyWarnings =
707
+ options.maxWarnings >= 0 &&
708
+ resultCounts.warningCount > options.maxWarnings;
709
+ const resultsMeta = tooManyWarnings
710
+ ? {
711
+ maxWarningsExceeded: {
712
+ maxWarnings: options.maxWarnings,
713
+ foundWarnings: resultCounts.warningCount,
714
+ },
715
+ }
716
+ : {};
717
+
718
+ if (
719
+ await printResults(
720
+ engine,
721
+ resultsToPrint,
722
+ options.format,
723
+ options.outputFile,
724
+ resultsMeta,
725
+ )
726
+ ) {
727
+ // Errors and warnings from the original unfiltered results should determine the exit code
728
+ const shouldExitForFatalErrors =
729
+ options.exitOnFatalError && resultCounts.fatalErrorCount > 0;
730
+
731
+ if (!resultCounts.errorCount && tooManyWarnings) {
732
+ log.error(
733
+ "ESLint found too many warnings (maximum: %s).",
734
+ options.maxWarnings,
735
+ );
736
+ }
737
+
738
+ const unusedSuppressionsCount =
739
+ Object.keys(unusedSuppressions).length;
740
+
741
+ if (unusedSuppressionsCount > 0) {
742
+ log.error(
743
+ "There are suppressions left that do not occur anymore. Consider re-running the command with `--prune-suppressions`.",
744
+ );
745
+ debug(JSON.stringify(unusedSuppressions, null, 2));
746
+ }
747
+
748
+ if (shouldExitForFatalErrors || unusedSuppressionsCount > 0) {
749
+ return 2;
750
+ }
751
+
752
+ return resultCounts.errorCount || tooManyWarnings ? 1 : 0;
753
+ }
754
+
755
+ return 2;
756
+ },
576
757
  };
577
758
 
578
759
  module.exports = cli;