eslint 9.22.0 → 9.23.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 (415) hide show
  1. package/README.md +47 -45
  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 +828 -808
  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 +541 -457
  21. package/lib/config/config-loader.js +648 -618
  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 +65 -68
  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 +709 -679
  30. package/lib/eslint/eslint.js +944 -886
  31. package/lib/eslint/index.js +2 -2
  32. package/lib/eslint/legacy-eslint.js +576 -532
  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 +2402 -2044
  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 +35 -35
  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 +375 -361
  71. package/lib/rule-tester/index.js +1 -1
  72. package/lib/rule-tester/rule-tester.js +1307 -1045
  73. package/lib/rules/accessor-pairs.js +297 -262
  74. package/lib/rules/array-bracket-newline.js +249 -237
  75. package/lib/rules/array-bracket-spacing.js +262 -223
  76. package/lib/rules/array-callback-return.js +401 -355
  77. package/lib/rules/array-element-newline.js +357 -312
  78. package/lib/rules/arrow-body-style.js +399 -280
  79. package/lib/rules/arrow-parens.js +205 -172
  80. package/lib/rules/arrow-spacing.js +168 -162
  81. package/lib/rules/block-scoped-var.js +124 -122
  82. package/lib/rules/block-spacing.js +185 -175
  83. package/lib/rules/brace-style.js +261 -198
  84. package/lib/rules/callback-return.js +202 -189
  85. package/lib/rules/camelcase.js +402 -391
  86. package/lib/rules/capitalized-comments.js +252 -231
  87. package/lib/rules/class-methods-use-this.js +179 -171
  88. package/lib/rules/comma-dangle.js +378 -345
  89. package/lib/rules/comma-spacing.js +192 -194
  90. package/lib/rules/comma-style.js +374 -315
  91. package/lib/rules/complexity.js +172 -168
  92. package/lib/rules/computed-property-spacing.js +235 -210
  93. package/lib/rules/consistent-return.js +180 -169
  94. package/lib/rules/consistent-this.js +166 -146
  95. package/lib/rules/constructor-super.js +411 -403
  96. package/lib/rules/curly.js +406 -331
  97. package/lib/rules/default-case-last.js +37 -30
  98. package/lib/rules/default-case.js +88 -84
  99. package/lib/rules/default-param-last.js +68 -53
  100. package/lib/rules/dot-location.js +121 -109
  101. package/lib/rules/dot-notation.js +191 -155
  102. package/lib/rules/eol-last.js +121 -119
  103. package/lib/rules/eqeqeq.js +167 -154
  104. package/lib/rules/for-direction.js +145 -120
  105. package/lib/rules/func-call-spacing.js +260 -230
  106. package/lib/rules/func-name-matching.js +292 -208
  107. package/lib/rules/func-names.js +164 -163
  108. package/lib/rules/func-style.js +158 -126
  109. package/lib/rules/function-call-argument-newline.js +151 -128
  110. package/lib/rules/function-paren-newline.js +348 -290
  111. package/lib/rules/generator-star-spacing.js +228 -209
  112. package/lib/rules/getter-return.js +207 -171
  113. package/lib/rules/global-require.js +84 -73
  114. package/lib/rules/grouped-accessor-pairs.js +169 -149
  115. package/lib/rules/guard-for-in.js +71 -62
  116. package/lib/rules/handle-callback-err.js +107 -102
  117. package/lib/rules/id-blacklist.js +181 -198
  118. package/lib/rules/id-denylist.js +167 -186
  119. package/lib/rules/id-length.js +196 -170
  120. package/lib/rules/id-match.js +343 -288
  121. package/lib/rules/implicit-arrow-linebreak.js +101 -78
  122. package/lib/rules/indent-legacy.js +1343 -1117
  123. package/lib/rules/indent.js +2271 -1758
  124. package/lib/rules/index.js +317 -292
  125. package/lib/rules/init-declarations.js +115 -106
  126. package/lib/rules/jsx-quotes.js +93 -81
  127. package/lib/rules/key-spacing.js +749 -632
  128. package/lib/rules/keyword-spacing.js +647 -604
  129. package/lib/rules/line-comment-position.js +141 -127
  130. package/lib/rules/linebreak-style.js +106 -105
  131. package/lib/rules/lines-around-comment.js +539 -447
  132. package/lib/rules/lines-around-directive.js +232 -202
  133. package/lib/rules/lines-between-class-members.js +304 -233
  134. package/lib/rules/logical-assignment-operators.js +581 -398
  135. package/lib/rules/max-classes-per-file.js +68 -67
  136. package/lib/rules/max-depth.js +145 -142
  137. package/lib/rules/max-len.js +472 -433
  138. package/lib/rules/max-lines-per-function.js +200 -175
  139. package/lib/rules/max-lines.js +157 -161
  140. package/lib/rules/max-nested-callbacks.js +101 -103
  141. package/lib/rules/max-params.js +77 -75
  142. package/lib/rules/max-statements-per-line.js +204 -197
  143. package/lib/rules/max-statements.js +167 -163
  144. package/lib/rules/multiline-comment-style.js +636 -478
  145. package/lib/rules/multiline-ternary.js +240 -175
  146. package/lib/rules/new-cap.js +232 -212
  147. package/lib/rules/new-parens.js +87 -78
  148. package/lib/rules/newline-after-var.js +286 -249
  149. package/lib/rules/newline-before-return.js +228 -221
  150. package/lib/rules/newline-per-chained-call.js +141 -126
  151. package/lib/rules/no-alert.js +89 -78
  152. package/lib/rules/no-array-constructor.js +121 -112
  153. package/lib/rules/no-async-promise-executor.js +29 -23
  154. package/lib/rules/no-await-in-loop.js +68 -70
  155. package/lib/rules/no-bitwise.js +123 -99
  156. package/lib/rules/no-buffer-constructor.js +54 -46
  157. package/lib/rules/no-caller.js +38 -32
  158. package/lib/rules/no-case-declarations.js +60 -56
  159. package/lib/rules/no-catch-shadow.js +75 -72
  160. package/lib/rules/no-class-assign.js +50 -47
  161. package/lib/rules/no-compare-neg-zero.js +61 -47
  162. package/lib/rules/no-cond-assign.js +147 -131
  163. package/lib/rules/no-confusing-arrow.js +97 -80
  164. package/lib/rules/no-console.js +201 -198
  165. package/lib/rules/no-const-assign.js +46 -40
  166. package/lib/rules/no-constant-binary-expression.js +499 -404
  167. package/lib/rules/no-constant-condition.js +157 -142
  168. package/lib/rules/no-constructor-return.js +48 -48
  169. package/lib/rules/no-continue.js +24 -26
  170. package/lib/rules/no-control-regex.js +124 -120
  171. package/lib/rules/no-debugger.js +27 -29
  172. package/lib/rules/no-delete-var.js +28 -28
  173. package/lib/rules/no-div-regex.js +46 -40
  174. package/lib/rules/no-dupe-args.js +67 -68
  175. package/lib/rules/no-dupe-class-members.js +92 -88
  176. package/lib/rules/no-dupe-else-if.js +99 -76
  177. package/lib/rules/no-dupe-keys.js +132 -109
  178. package/lib/rules/no-duplicate-case.js +49 -42
  179. package/lib/rules/no-duplicate-imports.js +178 -175
  180. package/lib/rules/no-else-return.js +429 -384
  181. package/lib/rules/no-empty-character-class.js +56 -49
  182. package/lib/rules/no-empty-function.js +126 -127
  183. package/lib/rules/no-empty-pattern.js +62 -57
  184. package/lib/rules/no-empty-static-block.js +36 -34
  185. package/lib/rules/no-empty.js +97 -85
  186. package/lib/rules/no-eq-null.js +36 -31
  187. package/lib/rules/no-eval.js +255 -249
  188. package/lib/rules/no-ex-assign.js +41 -38
  189. package/lib/rules/no-extend-native.js +160 -158
  190. package/lib/rules/no-extra-bind.js +200 -189
  191. package/lib/rules/no-extra-boolean-cast.js +397 -347
  192. package/lib/rules/no-extra-label.js +149 -130
  193. package/lib/rules/no-extra-parens.js +1653 -1324
  194. package/lib/rules/no-extra-semi.js +145 -143
  195. package/lib/rules/no-fallthrough.js +198 -156
  196. package/lib/rules/no-floating-decimal.js +73 -65
  197. package/lib/rules/no-func-assign.js +53 -54
  198. package/lib/rules/no-global-assign.js +77 -72
  199. package/lib/rules/no-implicit-coercion.js +348 -292
  200. package/lib/rules/no-implicit-globals.js +157 -134
  201. package/lib/rules/no-implied-eval.js +139 -111
  202. package/lib/rules/no-import-assign.js +144 -158
  203. package/lib/rules/no-inline-comments.js +100 -94
  204. package/lib/rules/no-inner-declarations.js +114 -100
  205. package/lib/rules/no-invalid-regexp.js +221 -189
  206. package/lib/rules/no-invalid-this.js +122 -116
  207. package/lib/rules/no-irregular-whitespace.js +265 -251
  208. package/lib/rules/no-iterator.js +28 -32
  209. package/lib/rules/no-label-var.js +58 -61
  210. package/lib/rules/no-labels.js +137 -132
  211. package/lib/rules/no-lone-blocks.js +126 -122
  212. package/lib/rules/no-lonely-if.js +107 -76
  213. package/lib/rules/no-loop-func.js +233 -212
  214. package/lib/rules/no-loss-of-precision.js +215 -200
  215. package/lib/rules/no-magic-numbers.js +245 -217
  216. package/lib/rules/no-misleading-character-class.js +498 -445
  217. package/lib/rules/no-mixed-operators.js +187 -181
  218. package/lib/rules/no-mixed-requires.js +252 -239
  219. package/lib/rules/no-mixed-spaces-and-tabs.js +133 -120
  220. package/lib/rules/no-multi-assign.js +45 -43
  221. package/lib/rules/no-multi-spaces.js +162 -142
  222. package/lib/rules/no-multi-str.js +41 -40
  223. package/lib/rules/no-multiple-empty-lines.js +195 -157
  224. package/lib/rules/no-native-reassign.js +89 -84
  225. package/lib/rules/no-negated-condition.js +78 -74
  226. package/lib/rules/no-negated-in-lhs.js +44 -42
  227. package/lib/rules/no-nested-ternary.js +32 -31
  228. package/lib/rules/no-new-func.js +70 -61
  229. package/lib/rules/no-new-native-nonconstructor.js +42 -38
  230. package/lib/rules/no-new-object.js +47 -47
  231. package/lib/rules/no-new-require.js +47 -46
  232. package/lib/rules/no-new-symbol.js +51 -49
  233. package/lib/rules/no-new-wrappers.js +42 -40
  234. package/lib/rules/no-new.js +27 -28
  235. package/lib/rules/no-nonoctal-decimal-escape.js +140 -120
  236. package/lib/rules/no-obj-calls.js +65 -52
  237. package/lib/rules/no-object-constructor.js +103 -96
  238. package/lib/rules/no-octal-escape.js +39 -42
  239. package/lib/rules/no-octal.js +31 -31
  240. package/lib/rules/no-param-reassign.js +234 -216
  241. package/lib/rules/no-path-concat.js +65 -66
  242. package/lib/rules/no-plusplus.js +59 -60
  243. package/lib/rules/no-process-env.js +48 -47
  244. package/lib/rules/no-process-exit.js +53 -49
  245. package/lib/rules/no-promise-executor-return.js +213 -181
  246. package/lib/rules/no-proto.js +25 -28
  247. package/lib/rules/no-prototype-builtins.js +145 -123
  248. package/lib/rules/no-redeclare.js +153 -151
  249. package/lib/rules/no-regex-spaces.js +182 -160
  250. package/lib/rules/no-restricted-exports.js +207 -184
  251. package/lib/rules/no-restricted-globals.js +110 -111
  252. package/lib/rules/no-restricted-imports.js +656 -536
  253. package/lib/rules/no-restricted-modules.js +221 -201
  254. package/lib/rules/no-restricted-properties.js +180 -152
  255. package/lib/rules/no-restricted-syntax.js +55 -51
  256. package/lib/rules/no-return-assign.js +54 -49
  257. package/lib/rules/no-return-await.js +147 -123
  258. package/lib/rules/no-script-url.js +51 -44
  259. package/lib/rules/no-self-assign.js +147 -145
  260. package/lib/rules/no-self-compare.js +62 -45
  261. package/lib/rules/no-sequences.js +134 -115
  262. package/lib/rules/no-setter-return.js +184 -151
  263. package/lib/rules/no-shadow-restricted-names.js +60 -45
  264. package/lib/rules/no-shadow.js +341 -315
  265. package/lib/rules/no-spaced-func.js +81 -76
  266. package/lib/rules/no-sparse-arrays.js +53 -58
  267. package/lib/rules/no-sync.js +60 -59
  268. package/lib/rules/no-tabs.js +82 -71
  269. package/lib/rules/no-template-curly-in-string.js +32 -31
  270. package/lib/rules/no-ternary.js +24 -28
  271. package/lib/rules/no-this-before-super.js +320 -318
  272. package/lib/rules/no-throw-literal.js +30 -35
  273. package/lib/rules/no-trailing-spaces.js +198 -190
  274. package/lib/rules/no-undef-init.js +75 -60
  275. package/lib/rules/no-undef.js +50 -47
  276. package/lib/rules/no-undefined.js +72 -74
  277. package/lib/rules/no-underscore-dangle.js +369 -326
  278. package/lib/rules/no-unexpected-multiline.js +111 -101
  279. package/lib/rules/no-unmodified-loop-condition.js +253 -253
  280. package/lib/rules/no-unneeded-ternary.js +211 -146
  281. package/lib/rules/no-unreachable-loop.js +144 -141
  282. package/lib/rules/no-unreachable.js +254 -247
  283. package/lib/rules/no-unsafe-finally.js +92 -84
  284. package/lib/rules/no-unsafe-negation.js +104 -82
  285. package/lib/rules/no-unsafe-optional-chaining.js +191 -177
  286. package/lib/rules/no-unused-expressions.js +177 -161
  287. package/lib/rules/no-unused-labels.js +138 -123
  288. package/lib/rules/no-unused-private-class-members.js +205 -181
  289. package/lib/rules/no-unused-vars.js +1668 -1448
  290. package/lib/rules/no-use-before-define.js +228 -230
  291. package/lib/rules/no-useless-assignment.js +589 -510
  292. package/lib/rules/no-useless-backreference.js +211 -192
  293. package/lib/rules/no-useless-call.js +57 -52
  294. package/lib/rules/no-useless-catch.js +39 -39
  295. package/lib/rules/no-useless-computed-key.js +143 -114
  296. package/lib/rules/no-useless-concat.js +64 -59
  297. package/lib/rules/no-useless-constructor.js +157 -110
  298. package/lib/rules/no-useless-escape.js +341 -290
  299. package/lib/rules/no-useless-rename.js +182 -155
  300. package/lib/rules/no-useless-return.js +343 -311
  301. package/lib/rules/no-var.js +232 -211
  302. package/lib/rules/no-void.js +49 -47
  303. package/lib/rules/no-warning-comments.js +190 -185
  304. package/lib/rules/no-whitespace-before-property.js +130 -114
  305. package/lib/rules/no-with.js +23 -25
  306. package/lib/rules/nonblock-statement-body-position.js +148 -129
  307. package/lib/rules/object-curly-newline.js +305 -264
  308. package/lib/rules/object-curly-spacing.js +359 -313
  309. package/lib/rules/object-property-newline.js +136 -105
  310. package/lib/rules/object-shorthand.js +606 -501
  311. package/lib/rules/one-var-declaration-per-line.js +103 -99
  312. package/lib/rules/one-var.js +652 -536
  313. package/lib/rules/operator-assignment.js +218 -160
  314. package/lib/rules/operator-linebreak.js +294 -250
  315. package/lib/rules/padded-blocks.js +345 -307
  316. package/lib/rules/padding-line-between-statements.js +442 -438
  317. package/lib/rules/prefer-arrow-callback.js +361 -312
  318. package/lib/rules/prefer-const.js +417 -376
  319. package/lib/rules/prefer-destructuring.js +300 -278
  320. package/lib/rules/prefer-exponentiation-operator.js +175 -132
  321. package/lib/rules/prefer-named-capture-group.js +152 -139
  322. package/lib/rules/prefer-numeric-literals.js +120 -112
  323. package/lib/rules/prefer-object-has-own.js +115 -81
  324. package/lib/rules/prefer-object-spread.js +212 -192
  325. package/lib/rules/prefer-promise-reject-errors.js +139 -121
  326. package/lib/rules/prefer-reflect.js +126 -106
  327. package/lib/rules/prefer-regex-literals.js +577 -465
  328. package/lib/rules/prefer-rest-params.js +78 -79
  329. package/lib/rules/prefer-spread.js +46 -43
  330. package/lib/rules/prefer-template.js +265 -194
  331. package/lib/rules/quote-props.js +372 -306
  332. package/lib/rules/quotes.js +373 -325
  333. package/lib/rules/radix.js +151 -135
  334. package/lib/rules/require-atomic-updates.js +315 -284
  335. package/lib/rules/require-await.js +143 -115
  336. package/lib/rules/require-unicode-regexp.js +281 -176
  337. package/lib/rules/require-yield.js +52 -53
  338. package/lib/rules/rest-spread-spacing.js +127 -115
  339. package/lib/rules/semi-spacing.js +280 -249
  340. package/lib/rules/semi-style.js +175 -133
  341. package/lib/rules/semi.js +455 -435
  342. package/lib/rules/sort-imports.js +305 -232
  343. package/lib/rules/sort-keys.js +218 -187
  344. package/lib/rules/sort-vars.js +126 -92
  345. package/lib/rules/space-before-blocks.js +198 -188
  346. package/lib/rules/space-before-function-paren.js +185 -165
  347. package/lib/rules/space-in-parens.js +358 -287
  348. package/lib/rules/space-infix-ops.js +236 -200
  349. package/lib/rules/space-unary-ops.js +355 -297
  350. package/lib/rules/spaced-comment.js +362 -318
  351. package/lib/rules/strict.js +264 -229
  352. package/lib/rules/switch-colon-spacing.js +129 -121
  353. package/lib/rules/symbol-description.js +44 -47
  354. package/lib/rules/template-curly-spacing.js +147 -141
  355. package/lib/rules/template-tag-spacing.js +97 -87
  356. package/lib/rules/unicode-bom.js +53 -55
  357. package/lib/rules/use-isnan.js +236 -205
  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 +152 -110
  370. package/lib/rules/vars-on-top.js +151 -144
  371. package/lib/rules/wrap-iife.js +203 -190
  372. package/lib/rules/wrap-regex.js +69 -57
  373. package/lib/rules/yield-star-spacing.js +144 -133
  374. package/lib/rules/yoda.js +282 -271
  375. package/lib/services/parser-service.js +35 -35
  376. package/lib/services/processor-service.js +66 -73
  377. package/lib/shared/ajv.js +14 -14
  378. package/lib/shared/assert.js +3 -4
  379. package/lib/shared/ast-utils.js +7 -6
  380. package/lib/shared/deep-merge-arrays.js +24 -22
  381. package/lib/shared/directives.js +3 -2
  382. package/lib/shared/flags.js +46 -17
  383. package/lib/shared/logging.js +24 -25
  384. package/lib/shared/option-utils.js +43 -36
  385. package/lib/shared/runtime-info.js +136 -127
  386. package/lib/shared/serialization.js +27 -27
  387. package/lib/shared/severity.js +22 -22
  388. package/lib/shared/stats.js +5 -5
  389. package/lib/shared/string-utils.js +16 -16
  390. package/lib/shared/text-table.js +28 -27
  391. package/lib/shared/traverser.js +153 -146
  392. package/lib/types/index.d.ts +2010 -1559
  393. package/lib/types/rules.d.ts +5253 -5140
  394. package/lib/types/use-at-your-own-risk.d.ts +32 -30
  395. package/lib/unsupported-api.js +5 -5
  396. package/messages/all-files-ignored.js +3 -3
  397. package/messages/all-matched-files-ignored.js +3 -3
  398. package/messages/config-file-missing.js +2 -2
  399. package/messages/config-plugin-missing.js +3 -3
  400. package/messages/config-serialize-function.js +9 -7
  401. package/messages/eslintrc-incompat.js +13 -15
  402. package/messages/eslintrc-plugins.js +3 -4
  403. package/messages/extend-config-missing.js +3 -3
  404. package/messages/failed-to-read-json.js +3 -3
  405. package/messages/file-not-found.js +3 -3
  406. package/messages/invalid-rule-options.js +2 -2
  407. package/messages/invalid-rule-severity.js +2 -2
  408. package/messages/no-config-found.js +3 -3
  409. package/messages/plugin-conflict.js +8 -8
  410. package/messages/plugin-invalid.js +3 -3
  411. package/messages/plugin-missing.js +3 -3
  412. package/messages/print-config-with-directory-path.js +2 -2
  413. package/messages/shared.js +6 -1
  414. package/messages/whitespace-found.js +3 -3
  415. package/package.json +11 -17
package/lib/cli.js CHANGED
@@ -16,15 +16,21 @@
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");
29
35
  const debug = require("debug")("eslint:cli");
30
36
 
@@ -54,23 +60,32 @@ const writeFile = promisify(fs.writeFile);
54
60
  * @returns {Promise<Record<string, Plugin>>} A mapping of plugin short names to implementations.
55
61
  */
56
62
  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;
63
+ const plugins = {};
64
+
65
+ await Promise.all(
66
+ pluginNames.map(async pluginName => {
67
+ const longName = naming.normalizePackageName(
68
+ pluginName,
69
+ "eslint-plugin",
70
+ );
71
+ const module = await importer.import(longName);
72
+
73
+ if (!("default" in module)) {
74
+ throw new Error(
75
+ `"${longName}" cannot be used with the \`--plugin\` option because its default module does not provide a \`default\` export`,
76
+ );
77
+ }
78
+
79
+ const shortName = naming.getShorthandName(
80
+ pluginName,
81
+ "eslint-plugin",
82
+ );
83
+
84
+ plugins[shortName] = module.default;
85
+ }),
86
+ );
87
+
88
+ return plugins;
74
89
  }
75
90
 
76
91
  /**
@@ -81,7 +96,7 @@ async function loadPlugins(importer, pluginNames) {
81
96
  * autofixed), false otherwise.
82
97
  */
83
98
  function quietFixPredicate(message) {
84
- return message.severity === 2;
99
+ return message.severity === 2;
85
100
  }
86
101
 
87
102
  /**
@@ -91,7 +106,7 @@ function quietFixPredicate(message) {
91
106
  * @returns {boolean} True if the lint rule should run, false otherwise.
92
107
  */
93
108
  function quietRuleFilter(rule) {
94
- return rule.severity === 2;
109
+ return rule.severity === 2;
95
110
  }
96
111
 
97
112
  /**
@@ -102,165 +117,192 @@ function quietRuleFilter(rule) {
102
117
  * @returns {Promise<ESLintOptions>} The options object for the ESLint constructor.
103
118
  * @private
104
119
  */
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;
120
+ async function translateOptions(
121
+ {
122
+ cache,
123
+ cacheFile,
124
+ cacheLocation,
125
+ cacheStrategy,
126
+ config,
127
+ configLookup,
128
+ env,
129
+ errorOnUnmatchedPattern,
130
+ eslintrc,
131
+ ext,
132
+ fix,
133
+ fixDryRun,
134
+ fixType,
135
+ flag,
136
+ global,
137
+ ignore,
138
+ ignorePath,
139
+ ignorePattern,
140
+ inlineConfig,
141
+ parser,
142
+ parserOptions,
143
+ plugin,
144
+ quiet,
145
+ reportUnusedDisableDirectives,
146
+ reportUnusedDisableDirectivesSeverity,
147
+ reportUnusedInlineConfigs,
148
+ resolvePluginsRelativeTo,
149
+ rule,
150
+ rulesdir,
151
+ stats,
152
+ warnIgnored,
153
+ passOnNoPatterns,
154
+ maxWarnings,
155
+ },
156
+ configType,
157
+ ) {
158
+ let overrideConfig, overrideConfigFile;
159
+ const importer = new ModuleImporter();
160
+
161
+ if (configType === "flat") {
162
+ overrideConfigFile =
163
+ typeof config === "string" ? config : !configLookup;
164
+ if (overrideConfigFile === false) {
165
+ overrideConfigFile = void 0;
166
+ }
167
+
168
+ const languageOptions = {};
169
+
170
+ if (global) {
171
+ languageOptions.globals = global.reduce((obj, name) => {
172
+ if (name.endsWith(":true")) {
173
+ obj[name.slice(0, -5)] = "writable";
174
+ } else {
175
+ obj[name] = "readonly";
176
+ }
177
+ return obj;
178
+ }, {});
179
+ }
180
+
181
+ if (parserOptions) {
182
+ languageOptions.parserOptions = parserOptions;
183
+ }
184
+
185
+ if (parser) {
186
+ languageOptions.parser = await importer.import(parser);
187
+ }
188
+
189
+ overrideConfig = [
190
+ {
191
+ ...(Object.keys(languageOptions).length > 0
192
+ ? { languageOptions }
193
+ : {}),
194
+ rules: rule ? rule : {},
195
+ },
196
+ ];
197
+
198
+ if (
199
+ reportUnusedDisableDirectives ||
200
+ reportUnusedDisableDirectivesSeverity !== void 0
201
+ ) {
202
+ overrideConfig[0].linterOptions = {
203
+ reportUnusedDisableDirectives: reportUnusedDisableDirectives
204
+ ? "error"
205
+ : normalizeSeverityToString(
206
+ reportUnusedDisableDirectivesSeverity,
207
+ ),
208
+ };
209
+ }
210
+
211
+ if (reportUnusedInlineConfigs !== void 0) {
212
+ overrideConfig[0].linterOptions = {
213
+ ...overrideConfig[0].linterOptions,
214
+ reportUnusedInlineConfigs: normalizeSeverityToString(
215
+ reportUnusedInlineConfigs,
216
+ ),
217
+ };
218
+ }
219
+
220
+ if (plugin) {
221
+ overrideConfig[0].plugins = await loadPlugins(importer, plugin);
222
+ }
223
+
224
+ if (ext) {
225
+ overrideConfig.push({
226
+ files: ext.map(
227
+ extension =>
228
+ `**/*${extension.startsWith(".") ? "" : "."}${extension}`,
229
+ ),
230
+ });
231
+ }
232
+ } else {
233
+ overrideConfigFile = config;
234
+
235
+ overrideConfig = {
236
+ env:
237
+ env &&
238
+ env.reduce((obj, name) => {
239
+ obj[name] = true;
240
+ return obj;
241
+ }, {}),
242
+ globals:
243
+ global &&
244
+ global.reduce((obj, name) => {
245
+ if (name.endsWith(":true")) {
246
+ obj[name.slice(0, -5)] = "writable";
247
+ } else {
248
+ obj[name] = "readonly";
249
+ }
250
+ return obj;
251
+ }, {}),
252
+ ignorePatterns: ignorePattern,
253
+ parser,
254
+ parserOptions,
255
+ plugins: plugin,
256
+ rules: rule,
257
+ };
258
+ }
259
+
260
+ const options = {
261
+ allowInlineConfig: inlineConfig,
262
+ cache,
263
+ cacheLocation: cacheLocation || cacheFile,
264
+ cacheStrategy,
265
+ errorOnUnmatchedPattern,
266
+ fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
267
+ fixTypes: fixType,
268
+ ignore,
269
+ overrideConfig,
270
+ overrideConfigFile,
271
+ passOnNoPatterns,
272
+ };
273
+
274
+ if (configType === "flat") {
275
+ options.ignorePatterns = ignorePattern;
276
+ options.stats = stats;
277
+ options.warnIgnored = warnIgnored;
278
+ options.flags = flag;
279
+
280
+ /*
281
+ * For performance reasons rules not marked as 'error' are filtered out in quiet mode. As maxWarnings
282
+ * requires rules set to 'warn' to be run, we only filter out 'warn' rules if maxWarnings is not specified.
283
+ */
284
+ options.ruleFilter =
285
+ quiet && maxWarnings === -1 ? quietRuleFilter : () => true;
286
+ } else {
287
+ options.resolvePluginsRelativeTo = resolvePluginsRelativeTo;
288
+ options.rulePaths = rulesdir;
289
+ options.useEslintrc = eslintrc;
290
+ options.extensions = ext;
291
+ options.ignorePath = ignorePath;
292
+ if (
293
+ reportUnusedDisableDirectives ||
294
+ reportUnusedDisableDirectivesSeverity !== void 0
295
+ ) {
296
+ options.reportUnusedDisableDirectives =
297
+ reportUnusedDisableDirectives
298
+ ? "error"
299
+ : normalizeSeverityToString(
300
+ reportUnusedDisableDirectivesSeverity,
301
+ );
302
+ }
303
+ }
304
+
305
+ return options;
264
306
  }
265
307
 
266
308
  /**
@@ -269,17 +311,17 @@ async function translateOptions({
269
311
  * @returns {{errorCount:number;fatalErrorCount:number,warningCount:number}} The number of error messages.
270
312
  */
271
313
  function countErrors(results) {
272
- let errorCount = 0;
273
- let fatalErrorCount = 0;
274
- let warningCount = 0;
314
+ let errorCount = 0;
315
+ let fatalErrorCount = 0;
316
+ let warningCount = 0;
275
317
 
276
- for (const result of results) {
277
- errorCount += result.errorCount;
278
- fatalErrorCount += result.fatalErrorCount;
279
- warningCount += result.warningCount;
280
- }
318
+ for (const result of results) {
319
+ errorCount += result.errorCount;
320
+ fatalErrorCount += result.fatalErrorCount;
321
+ warningCount += result.warningCount;
322
+ }
281
323
 
282
- return { errorCount, fatalErrorCount, warningCount };
324
+ return { errorCount, fatalErrorCount, warningCount };
283
325
  }
284
326
 
285
327
  /**
@@ -288,14 +330,14 @@ function countErrors(results) {
288
330
  * @returns {Promise<boolean>} `true` if the given path is a directory.
289
331
  */
290
332
  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
- }
333
+ try {
334
+ return (await stat(filePath)).isDirectory();
335
+ } catch (error) {
336
+ if (error.code === "ENOENT" || error.code === "ENOTDIR") {
337
+ return false;
338
+ }
339
+ throw error;
340
+ }
299
341
  }
300
342
 
301
343
  /**
@@ -309,37 +351,40 @@ async function isDirectory(filePath) {
309
351
  * @private
310
352
  */
311
353
  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;
354
+ let formatter;
355
+
356
+ try {
357
+ formatter = await engine.loadFormatter(format);
358
+ } catch (e) {
359
+ log.error(e.message);
360
+ return false;
361
+ }
362
+
363
+ const output = await formatter.format(results, resultsMeta);
364
+
365
+ if (outputFile) {
366
+ const filePath = path.resolve(process.cwd(), outputFile);
367
+
368
+ if (await isDirectory(filePath)) {
369
+ log.error(
370
+ "Cannot write to output file path, it is a directory: %s",
371
+ outputFile,
372
+ );
373
+ return false;
374
+ }
375
+
376
+ try {
377
+ await mkdir(path.dirname(filePath), { recursive: true });
378
+ await writeFile(filePath, output);
379
+ } catch (ex) {
380
+ log.error("There was a problem writing the output file:\n%s", ex);
381
+ return false;
382
+ }
383
+ } else if (output) {
384
+ log.info(output);
385
+ }
386
+
387
+ return true;
343
388
  }
344
389
 
345
390
  //------------------------------------------------------------------------------
@@ -351,228 +396,267 @@ async function printResults(engine, results, format, outputFile, resultsMeta) {
351
396
  * for other Node.js programs to effectively run the CLI.
352
397
  */
353
398
  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
- }
399
+ /**
400
+ * Calculates the command string for the --inspect-config operation.
401
+ * @param {string} configFile The path to the config file to inspect.
402
+ * @returns {Promise<string>} The command string to execute.
403
+ */
404
+ async calculateInspectConfigFlags(configFile) {
405
+ // find the config file
406
+ const { configFilePath, basePath } = await locateConfigFileToUse({
407
+ cwd: process.cwd(),
408
+ configFile,
409
+ });
410
+
411
+ return ["--config", configFilePath, "--basePath", basePath];
412
+ },
413
+
414
+ /**
415
+ * Executes the CLI based on an array of arguments that is passed in.
416
+ * @param {string|Array|Object} args The arguments to process.
417
+ * @param {string} [text] The text to lint (used for TTY).
418
+ * @param {boolean} [allowFlatConfig=true] Whether or not to allow flat config.
419
+ * @returns {Promise<number>} The exit code for the operation.
420
+ */
421
+ async execute(args, text, allowFlatConfig = true) {
422
+ if (Array.isArray(args)) {
423
+ debug("CLI args: %o", args.slice(2));
424
+ }
425
+
426
+ /*
427
+ * Before doing anything, we need to see if we are using a
428
+ * flat config file. If so, then we need to change the way command
429
+ * line args are parsed. This is temporary, and when we fully
430
+ * switch to flat config we can remove this logic.
431
+ */
432
+
433
+ const usingFlatConfig =
434
+ allowFlatConfig && (await shouldUseFlatConfig());
435
+
436
+ debug("Using flat config?", usingFlatConfig);
437
+
438
+ if (allowFlatConfig && !usingFlatConfig) {
439
+ process.emitWarning(
440
+ "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.",
441
+ "ESLintRCWarning",
442
+ );
443
+ }
444
+
445
+ const CLIOptions = createCLIOptions(usingFlatConfig);
446
+
447
+ /** @type {ParsedCLIOptions} */
448
+ let options;
449
+
450
+ try {
451
+ options = CLIOptions.parse(args);
452
+ } catch (error) {
453
+ debug("Error parsing CLI options:", error.message);
454
+
455
+ let errorMessage = error.message;
456
+
457
+ if (usingFlatConfig) {
458
+ errorMessage +=
459
+ "\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.";
460
+ }
461
+
462
+ log.error(errorMessage);
463
+ return 2;
464
+ }
465
+
466
+ const files = options._;
467
+ const useStdin = typeof text === "string";
468
+
469
+ if (options.help) {
470
+ log.info(CLIOptions.generateHelp());
471
+ return 0;
472
+ }
473
+ if (options.version) {
474
+ log.info(RuntimeInfo.version());
475
+ return 0;
476
+ }
477
+ if (options.envInfo) {
478
+ try {
479
+ log.info(RuntimeInfo.environment());
480
+ return 0;
481
+ } catch (err) {
482
+ debug("Error retrieving environment info");
483
+ log.error(err.message);
484
+ return 2;
485
+ }
486
+ }
487
+
488
+ if (options.printConfig) {
489
+ if (files.length) {
490
+ log.error(
491
+ "The --print-config option must be used with exactly one file name.",
492
+ );
493
+ return 2;
494
+ }
495
+ if (useStdin) {
496
+ log.error(
497
+ "The --print-config option is not available for piped-in code.",
498
+ );
499
+ return 2;
500
+ }
501
+
502
+ const engine = usingFlatConfig
503
+ ? new ESLint(await translateOptions(options, "flat"))
504
+ : new LegacyESLint(await translateOptions(options));
505
+ const fileConfig = await engine.calculateConfigForFile(
506
+ options.printConfig,
507
+ );
508
+
509
+ log.info(JSON.stringify(fileConfig, null, " "));
510
+ return 0;
511
+ }
512
+
513
+ if (options.inspectConfig) {
514
+ log.info(
515
+ "You can also run this command directly using 'npx @eslint/config-inspector@latest' in the same directory as your configuration file.",
516
+ );
517
+
518
+ try {
519
+ const flatOptions = await translateOptions(options, "flat");
520
+ const spawn = require("cross-spawn");
521
+ const flags = await cli.calculateInspectConfigFlags(
522
+ flatOptions.overrideConfigFile,
523
+ );
524
+
525
+ spawn.sync(
526
+ "npx",
527
+ ["@eslint/config-inspector@latest", ...flags],
528
+ { encoding: "utf8", stdio: "inherit" },
529
+ );
530
+ } catch (error) {
531
+ log.error(error);
532
+ return 2;
533
+ }
534
+
535
+ return 0;
536
+ }
537
+
538
+ debug(`Running on ${useStdin ? "text" : "files"}`);
539
+
540
+ if (options.fix && options.fixDryRun) {
541
+ log.error(
542
+ "The --fix option and the --fix-dry-run option cannot be used together.",
543
+ );
544
+ return 2;
545
+ }
546
+ if (useStdin && options.fix) {
547
+ log.error(
548
+ "The --fix option is not available for piped-in code; use --fix-dry-run instead.",
549
+ );
550
+ return 2;
551
+ }
552
+ if (options.fixType && !options.fix && !options.fixDryRun) {
553
+ log.error(
554
+ "The --fix-type option requires either --fix or --fix-dry-run.",
555
+ );
556
+ return 2;
557
+ }
558
+
559
+ if (
560
+ options.reportUnusedDisableDirectives &&
561
+ options.reportUnusedDisableDirectivesSeverity !== void 0
562
+ ) {
563
+ log.error(
564
+ "The --report-unused-disable-directives option and the --report-unused-disable-directives-severity option cannot be used together.",
565
+ );
566
+ return 2;
567
+ }
568
+
569
+ if (usingFlatConfig && options.ext) {
570
+ // Passing `--ext ""` results in `options.ext` being an empty array.
571
+ if (options.ext.length === 0) {
572
+ log.error("The --ext option value cannot be empty.");
573
+ return 2;
574
+ }
575
+
576
+ // Passing `--ext ,ts` results in an empty string at index 0. Passing `--ext ts,,tsx` results in an empty string at index 1.
577
+ const emptyStringIndex = options.ext.indexOf("");
578
+
579
+ if (emptyStringIndex >= 0) {
580
+ log.error(
581
+ `The --ext option arguments cannot be empty strings. Found an empty string at index ${emptyStringIndex}.`,
582
+ );
583
+ return 2;
584
+ }
585
+ }
586
+
587
+ const ActiveESLint = usingFlatConfig ? ESLint : LegacyESLint;
588
+ const eslintOptions = await translateOptions(
589
+ options,
590
+ usingFlatConfig ? "flat" : "eslintrc",
591
+ );
592
+ const engine = new ActiveESLint(eslintOptions);
593
+ let results;
594
+
595
+ if (useStdin) {
596
+ results = await engine.lintText(text, {
597
+ filePath: options.stdinFilename,
598
+
599
+ // flatConfig respects CLI flag and constructor warnIgnored, eslintrc forces true for backwards compatibility
600
+ warnIgnored: usingFlatConfig ? void 0 : true,
601
+ });
602
+ } else {
603
+ results = await engine.lintFiles(files);
604
+ }
605
+
606
+ if (options.fix) {
607
+ debug("Fix mode enabled - applying fixes");
608
+ await ActiveESLint.outputFixes(results);
609
+ }
610
+
611
+ let resultsToPrint = results;
612
+
613
+ if (options.quiet) {
614
+ debug("Quiet mode enabled - filtering out warnings");
615
+ resultsToPrint = ActiveESLint.getErrorResults(resultsToPrint);
616
+ }
617
+
618
+ const resultCounts = countErrors(results);
619
+ const tooManyWarnings =
620
+ options.maxWarnings >= 0 &&
621
+ resultCounts.warningCount > options.maxWarnings;
622
+ const resultsMeta = tooManyWarnings
623
+ ? {
624
+ maxWarningsExceeded: {
625
+ maxWarnings: options.maxWarnings,
626
+ foundWarnings: resultCounts.warningCount,
627
+ },
628
+ }
629
+ : {};
630
+
631
+ if (
632
+ await printResults(
633
+ engine,
634
+ resultsToPrint,
635
+ options.format,
636
+ options.outputFile,
637
+ resultsMeta,
638
+ )
639
+ ) {
640
+ // Errors and warnings from the original unfiltered results should determine the exit code
641
+ const shouldExitForFatalErrors =
642
+ options.exitOnFatalError && resultCounts.fatalErrorCount > 0;
643
+
644
+ if (!resultCounts.errorCount && tooManyWarnings) {
645
+ log.error(
646
+ "ESLint found too many warnings (maximum: %s).",
647
+ options.maxWarnings,
648
+ );
649
+ }
650
+
651
+ if (shouldExitForFatalErrors) {
652
+ return 2;
653
+ }
654
+
655
+ return resultCounts.errorCount || tooManyWarnings ? 1 : 0;
656
+ }
657
+
658
+ return 2;
659
+ },
576
660
  };
577
661
 
578
662
  module.exports = cli;