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
@@ -21,8 +21,10 @@ const { FlatConfigArray } = require("./flat-config-array");
21
21
  //-----------------------------------------------------------------------------
22
22
 
23
23
  /**
24
- * @typedef {import("../shared/types").FlatConfigObject} FlatConfigObject
25
- * @typedef {import("../shared/types").FlatConfigArray} FlatConfigArray
24
+ * @import { ConfigData, ConfigData as FlatConfigObject } from "../shared/types.js";
25
+ */
26
+
27
+ /**
26
28
  * @typedef {Object} ConfigLoaderOptions
27
29
  * @property {string|false|undefined} configFile The path to the config file to use.
28
30
  * @property {string} cwd The current working directory.
@@ -30,7 +32,8 @@ const { FlatConfigArray } = require("./flat-config-array");
30
32
  * @property {FlatConfigArray} [baseConfig] The base config to use.
31
33
  * @property {Array<FlatConfigObject>} [defaultConfigs] The default configs to use.
32
34
  * @property {Array<string>} [ignorePatterns] The ignore patterns to use.
33
- * @property {FlatConfigObject|Array<FlatConfigObject>} overrideConfig The override config to use.
35
+ * @property {FlatConfigObject|Array<FlatConfigObject>} [overrideConfig] The override config to use.
36
+ * @property {boolean} [hasUnstableNativeNodeJsTSConfigFlag] The flag to indicate whether the `unstable_native_nodejs_ts_config` flag is enabled.
34
37
  */
35
38
 
36
39
  //------------------------------------------------------------------------------
@@ -38,12 +41,12 @@ const { FlatConfigArray } = require("./flat-config-array");
38
41
  //------------------------------------------------------------------------------
39
42
 
40
43
  const FLAT_CONFIG_FILENAMES = [
41
- "eslint.config.js",
42
- "eslint.config.mjs",
43
- "eslint.config.cjs",
44
- "eslint.config.ts",
45
- "eslint.config.mts",
46
- "eslint.config.cts"
44
+ "eslint.config.js",
45
+ "eslint.config.mjs",
46
+ "eslint.config.cjs",
47
+ "eslint.config.ts",
48
+ "eslint.config.mts",
49
+ "eslint.config.cts",
47
50
  ];
48
51
 
49
52
  const importedConfigFileModificationTime = new Map();
@@ -55,9 +58,9 @@ const importedConfigFileModificationTime = new Map();
55
58
  * @throws {Error} If `filePath` is not a non-empty string.
56
59
  */
57
60
  function assertValidFilePath(filePath) {
58
- if (!filePath || typeof filePath !== "string") {
59
- throw new Error("'filePath' must be a non-empty string");
60
- }
61
+ if (!filePath || typeof filePath !== "string") {
62
+ throw new Error("'filePath' must be a non-empty string");
63
+ }
61
64
  }
62
65
 
63
66
  /**
@@ -71,18 +74,14 @@ function assertValidFilePath(filePath) {
71
74
  * @throws {Error} If no configuration exists.
72
75
  */
73
76
  function assertConfigurationExists(configFilePath, loaderOptions) {
77
+ const { configFile: useConfigFile } = loaderOptions;
74
78
 
75
- const {
76
- configFile: useConfigFile
77
- } = loaderOptions;
78
-
79
- if (!configFilePath && useConfigFile !== false) {
80
- const error = new Error("Could not find config file.");
81
-
82
- error.messageTemplate = "config-file-missing";
83
- throw error;
84
- }
79
+ if (!configFilePath && useConfigFile !== false) {
80
+ const error = new Error("Could not find config file.");
85
81
 
82
+ error.messageTemplate = "config-file-missing";
83
+ throw error;
84
+ }
86
85
  }
87
86
 
88
87
  /**
@@ -91,9 +90,9 @@ function assertConfigurationExists(configFilePath, loaderOptions) {
91
90
  * @returns {boolean} `true` if the file is a TypeScript file, `false` if it's not.
92
91
  */
93
92
  function isFileTS(filePath) {
94
- const fileExtension = path.extname(filePath);
93
+ const fileExtension = path.extname(filePath);
95
94
 
96
- return /^\.[mc]?ts$/u.test(fileExtension);
95
+ return /^\.[mc]?ts$/u.test(fileExtension);
97
96
  }
98
97
 
99
98
  /**
@@ -101,7 +100,7 @@ function isFileTS(filePath) {
101
100
  * @returns {boolean} `true` if the ESLint is running Bun, `false` if it's not.
102
101
  */
103
102
  function isRunningInBun() {
104
- return !!globalThis.Bun;
103
+ return !!globalThis.Bun;
105
104
  }
106
105
 
107
106
  /**
@@ -109,96 +108,167 @@ function isRunningInBun() {
109
108
  * @returns {boolean} `true` if the ESLint is running in Deno, `false` if it's not.
110
109
  */
111
110
  function isRunningInDeno() {
112
- return !!globalThis.Deno;
111
+ return !!globalThis.Deno;
112
+ }
113
+
114
+ /**
115
+ * Checks if native TypeScript support is
116
+ * enabled in the current Node.js process.
117
+ *
118
+ * This function determines if the
119
+ * {@linkcode NodeJS.ProcessFeatures.typescript | typescript}
120
+ * feature is present in the
121
+ * {@linkcode process.features} object
122
+ * and if its value is either "strip" or "transform".
123
+ * @returns {boolean} `true` if native TypeScript support is enabled, otherwise `false`.
124
+ * @since 9.24.0
125
+ */
126
+ function isNativeTypeScriptSupportEnabled() {
127
+ return (
128
+ // eslint-disable-next-line n/no-unsupported-features/node-builtins -- it's still an experimental feature.
129
+ ["strip", "transform"].includes(process.features.typescript)
130
+ );
131
+ }
132
+
133
+ /**
134
+ * Load the TypeScript configuration file.
135
+ * @param {string} filePath The absolute file path to load.
136
+ * @param {URL} fileURL The file URL to load.
137
+ * @param {number} mtime The last modified timestamp of the file.
138
+ * @returns {Promise<any>} The configuration loaded from the file.
139
+ * @since 9.24.0
140
+ */
141
+ async function loadTypeScriptConfigFileWithJiti(filePath, fileURL, mtime) {
142
+ // eslint-disable-next-line no-use-before-define -- `ConfigLoader.loadJiti` can be overwritten for testing
143
+ const { createJiti } = await ConfigLoader.loadJiti().catch(() => {
144
+ throw new Error(
145
+ "The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it.",
146
+ );
147
+ });
148
+
149
+ // `createJiti` was added in jiti v2.
150
+ if (typeof createJiti !== "function") {
151
+ throw new Error(
152
+ "You are using an outdated version of the 'jiti' library. Please update to the latest version of 'jiti' to ensure compatibility and access to the latest features.",
153
+ );
154
+ }
155
+
156
+ /*
157
+ * Disabling `moduleCache` allows us to reload a
158
+ * config file when the last modified timestamp changes.
159
+ */
160
+
161
+ const jiti = createJiti(__filename, {
162
+ moduleCache: false,
163
+ interopDefault: false,
164
+ });
165
+ const config = await jiti.import(fileURL.href);
166
+
167
+ importedConfigFileModificationTime.set(filePath, mtime);
168
+
169
+ return config?.default ?? config;
170
+ }
171
+
172
+ /**
173
+ * Dynamically imports a module from the given file path.
174
+ * @param {string} filePath The absolute file path of the module to import.
175
+ * @param {URL} fileURL The file URL to load.
176
+ * @param {number} mtime The last modified timestamp of the file.
177
+ * @returns {Promise<any>} - A {@linkcode Promise | promise} that resolves to the imported ESLint config.
178
+ * @since 9.24.0
179
+ */
180
+ async function dynamicImportConfig(filePath, fileURL, mtime) {
181
+ const module = await import(fileURL.href);
182
+
183
+ importedConfigFileModificationTime.set(filePath, mtime);
184
+
185
+ return module.default;
113
186
  }
114
187
 
115
188
  /**
116
189
  * Load the config array from the given filename.
117
190
  * @param {string} filePath The filename to load from.
191
+ * @param {boolean} hasUnstableNativeNodeJsTSConfigFlag The flag to indicate whether the `unstable_native_nodejs_ts_config` flag is enabled.
118
192
  * @returns {Promise<any>} The config loaded from the config file.
119
193
  */
120
- async function loadConfigFile(filePath) {
121
-
122
- debug(`Loading config from ${filePath}`);
123
-
124
- const fileURL = pathToFileURL(filePath);
125
-
126
- debug(`Config file URL is ${fileURL}`);
127
-
128
- const mtime = (await fs.stat(filePath)).mtime.getTime();
129
-
130
- /*
131
- * Append a query with the config file's modification time (`mtime`) in order
132
- * to import the current version of the config file. Without the query, `import()` would
133
- * cache the config file module by the pathname only, and then always return
134
- * the same version (the one that was actual when the module was imported for the first time).
135
- *
136
- * This ensures that the config file module is loaded and executed again
137
- * if it has been changed since the last time it was imported.
138
- * If it hasn't been changed, `import()` will just return the cached version.
139
- *
140
- * Note that we should not overuse queries (e.g., by appending the current time
141
- * to always reload the config file module) as that could cause memory leaks
142
- * because entries are never removed from the import cache.
143
- */
144
- fileURL.searchParams.append("mtime", mtime);
145
-
146
- /*
147
- * With queries, we can bypass the import cache. However, when import-ing a CJS module,
148
- * Node.js uses the require infrastructure under the hood. That includes the require cache,
149
- * which caches the config file module by its file path (queries have no effect).
150
- * Therefore, we also need to clear the require cache before importing the config file module.
151
- * In order to get the same behavior with ESM and CJS config files, in particular - to reload
152
- * the config file only if it has been changed, we track file modification times and clear
153
- * the require cache only if the file has been changed.
154
- */
155
- if (importedConfigFileModificationTime.get(filePath) !== mtime) {
156
- delete require.cache[filePath];
157
- }
158
-
159
- const isTS = isFileTS(filePath);
160
- const isBun = isRunningInBun();
161
- const isDeno = isRunningInDeno();
162
-
163
- /*
164
- * If we are dealing with a TypeScript file, then we need to use `jiti` to load it
165
- * in Node.js. Deno and Bun both allow native importing of TypeScript files.
166
- *
167
- * When Node.js supports native TypeScript imports, we can remove this check.
168
- */
169
- if (isTS && !isDeno && !isBun) {
170
-
171
- // eslint-disable-next-line no-use-before-define -- `ConfigLoader.loadJiti` can be overwritten for testing
172
- const { createJiti } = await ConfigLoader.loadJiti().catch(() => {
173
- throw new Error("The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it.");
174
- });
175
-
176
- // `createJiti` was added in jiti v2.
177
- if (typeof createJiti !== "function") {
178
- throw new Error("You are using an outdated version of the 'jiti' library. Please update to the latest version of 'jiti' to ensure compatibility and access to the latest features.");
179
- }
180
-
181
- /*
182
- * Disabling `moduleCache` allows us to reload a
183
- * config file when the last modified timestamp changes.
184
- */
185
-
186
- const jiti = createJiti(__filename, { moduleCache: false, interopDefault: false });
187
- const config = await jiti.import(fileURL.href);
188
-
189
- importedConfigFileModificationTime.set(filePath, mtime);
190
-
191
- return config?.default ?? config;
192
- }
193
-
194
-
195
- // fallback to normal runtime behavior
196
-
197
- const config = (await import(fileURL)).default;
198
-
199
- importedConfigFileModificationTime.set(filePath, mtime);
200
-
201
- return config;
194
+ async function loadConfigFile(filePath, hasUnstableNativeNodeJsTSConfigFlag) {
195
+ debug(`Loading config from ${filePath}`);
196
+
197
+ const fileURL = pathToFileURL(filePath);
198
+
199
+ debug(`Config file URL is ${fileURL}`);
200
+
201
+ const mtime = (await fs.stat(filePath)).mtime.getTime();
202
+
203
+ /*
204
+ * Append a query with the config file's modification time (`mtime`) in order
205
+ * to import the current version of the config file. Without the query, `import()` would
206
+ * cache the config file module by the pathname only, and then always return
207
+ * the same version (the one that was actual when the module was imported for the first time).
208
+ *
209
+ * This ensures that the config file module is loaded and executed again
210
+ * if it has been changed since the last time it was imported.
211
+ * If it hasn't been changed, `import()` will just return the cached version.
212
+ *
213
+ * Note that we should not overuse queries (e.g., by appending the current time
214
+ * to always reload the config file module) as that could cause memory leaks
215
+ * because entries are never removed from the import cache.
216
+ */
217
+ fileURL.searchParams.append("mtime", mtime);
218
+
219
+ /*
220
+ * With queries, we can bypass the import cache. However, when import-ing a CJS module,
221
+ * Node.js uses the require infrastructure under the hood. That includes the require cache,
222
+ * which caches the config file module by its file path (queries have no effect).
223
+ * Therefore, we also need to clear the require cache before importing the config file module.
224
+ * In order to get the same behavior with ESM and CJS config files, in particular - to reload
225
+ * the config file only if it has been changed, we track file modification times and clear
226
+ * the require cache only if the file has been changed.
227
+ */
228
+ if (importedConfigFileModificationTime.get(filePath) !== mtime) {
229
+ delete require.cache[filePath];
230
+ }
231
+
232
+ const isTS = isFileTS(filePath);
233
+ const isBun = isRunningInBun();
234
+ const isDeno = isRunningInDeno();
235
+
236
+ /*
237
+ * If we are dealing with a TypeScript file, then we need to use `jiti` to load it
238
+ * in Node.js. Deno and Bun both allow native importing of TypeScript files.
239
+ *
240
+ * When Node.js supports native TypeScript imports, we can remove this check.
241
+ */
242
+
243
+ if (isTS) {
244
+ if (hasUnstableNativeNodeJsTSConfigFlag) {
245
+ if (isNativeTypeScriptSupportEnabled()) {
246
+ return await dynamicImportConfig(filePath, fileURL, mtime);
247
+ }
248
+
249
+ if (!("typescript" in process.features)) {
250
+ throw new Error(
251
+ "The unstable_native_nodejs_ts_config flag is not supported in older versions of Node.js.",
252
+ );
253
+ }
254
+
255
+ throw new Error(
256
+ "The unstable_native_nodejs_ts_config flag is enabled, but native TypeScript support is not enabled in the current Node.js process. You need to either enable native TypeScript support by passing --experimental-strip-types or remove the unstable_native_nodejs_ts_config flag.",
257
+ );
258
+ }
259
+
260
+ if (!isDeno && !isBun) {
261
+ return await loadTypeScriptConfigFileWithJiti(
262
+ filePath,
263
+ fileURL,
264
+ mtime,
265
+ );
266
+ }
267
+ }
268
+
269
+ // fallback to normal runtime behavior
270
+
271
+ return await dynamicImportConfig(filePath, fileURL, mtime);
202
272
  }
203
273
 
204
274
  //-----------------------------------------------------------------------------
@@ -210,385 +280,415 @@ async function loadConfigFile(filePath) {
210
280
  * from the file being linted.
211
281
  */
212
282
  class ConfigLoader {
213
-
214
- /**
215
- * Map of config file paths to the config arrays for those directories.
216
- * @type {Map<string, FlatConfigArray|Promise<FlatConfigArray>>}
217
- */
218
- #configArrays = new Map();
219
-
220
- /**
221
- * Map of absolute directory names to the config file paths for those directories.
222
- * @type {Map<string, {configFilePath:string,basePath:string}|Promise<{configFilePath:string,basePath:string}>>}
223
- */
224
- #configFilePaths = new Map();
225
-
226
- /**
227
- * The options to use when loading configuration files.
228
- * @type {ConfigLoaderOptions}
229
- */
230
- #options;
231
-
232
- /**
233
- * Creates a new instance.
234
- * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
235
- */
236
- constructor(options) {
237
- this.#options = options;
238
- }
239
-
240
- /**
241
- * Determines which config file to use. This is determined by seeing if an
242
- * override config file was specified, and if so, using it; otherwise, as long
243
- * as override config file is not explicitly set to `false`, it will search
244
- * upwards from `fromDirectory` for a file named `eslint.config.js`.
245
- * @param {string} fromDirectory The directory from which to start searching.
246
- * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
247
- * the config file.
248
- */
249
- async #locateConfigFileToUse(fromDirectory) {
250
-
251
- // check cache first
252
- if (this.#configFilePaths.has(fromDirectory)) {
253
- return this.#configFilePaths.get(fromDirectory);
254
- }
255
-
256
- const resultPromise = ConfigLoader.locateConfigFileToUse({
257
- useConfigFile: this.#options.configFile,
258
- cwd: this.#options.cwd,
259
- fromDirectory
260
- });
261
-
262
- // ensure `ConfigLoader.locateConfigFileToUse` is called only once for `fromDirectory`
263
- this.#configFilePaths.set(fromDirectory, resultPromise);
264
-
265
- // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
266
- const result = await resultPromise;
267
-
268
- this.#configFilePaths.set(fromDirectory, result);
269
-
270
- return result;
271
- }
272
-
273
- /**
274
- * Calculates the config array for this run based on inputs.
275
- * @param {string} configFilePath The absolute path to the config file to use if not overridden.
276
- * @param {string} basePath The base path to use for relative paths in the config file.
277
- * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
278
- */
279
- async #calculateConfigArray(configFilePath, basePath) {
280
-
281
- // check for cached version first
282
- if (this.#configArrays.has(configFilePath)) {
283
- return this.#configArrays.get(configFilePath);
284
- }
285
-
286
- const configsPromise = ConfigLoader.calculateConfigArray(configFilePath, basePath, this.#options);
287
-
288
- // ensure `ConfigLoader.calculateConfigArray` is called only once for `configFilePath`
289
- this.#configArrays.set(configFilePath, configsPromise);
290
-
291
- // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
292
- const configs = await configsPromise;
293
-
294
- this.#configArrays.set(configFilePath, configs);
295
-
296
- return configs;
297
- }
298
-
299
- /**
300
- * Returns the config file path for the given directory or file. This will either use
301
- * the override config file that was specified in the constructor options or
302
- * search for a config file from the directory.
303
- * @param {string} fileOrDirPath The file or directory path to get the config file path for.
304
- * @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
305
- * @throws {Error} If `fileOrDirPath` is not a non-empty string.
306
- * @throws {Error} If `fileOrDirPath` is not an absolute path.
307
- */
308
- async findConfigFileForPath(fileOrDirPath) {
309
-
310
- assertValidFilePath(fileOrDirPath);
311
-
312
- const absoluteDirPath = path.resolve(this.#options.cwd, path.dirname(fileOrDirPath));
313
- const { configFilePath } = await this.#locateConfigFileToUse(absoluteDirPath);
314
-
315
- return configFilePath;
316
- }
317
-
318
- /**
319
- * Returns a configuration object for the given file based on the CLI options.
320
- * This is the same logic used by the ESLint CLI executable to determine
321
- * configuration for each file it processes.
322
- * @param {string} filePath The path of the file or directory to retrieve config for.
323
- * @returns {Promise<ConfigData|undefined>} A configuration object for the file
324
- * or `undefined` if there is no configuration data for the file.
325
- * @throws {Error} If no configuration for `filePath` exists.
326
- */
327
- async loadConfigArrayForFile(filePath) {
328
-
329
- assertValidFilePath(filePath);
330
-
331
- debug(`Calculating config for file ${filePath}`);
332
-
333
- const configFilePath = await this.findConfigFileForPath(filePath);
334
-
335
- assertConfigurationExists(configFilePath, this.#options);
336
-
337
- return this.loadConfigArrayForDirectory(filePath);
338
- }
339
-
340
- /**
341
- * Returns a configuration object for the given directory based on the CLI options.
342
- * This is the same logic used by the ESLint CLI executable to determine
343
- * configuration for each file it processes.
344
- * @param {string} dirPath The path of the directory to retrieve config for.
345
- * @returns {Promise<ConfigData|undefined>} A configuration object for the directory
346
- * or `undefined` if there is no configuration data for the directory.
347
- */
348
- async loadConfigArrayForDirectory(dirPath) {
349
-
350
- assertValidFilePath(dirPath);
351
-
352
- debug(`Calculating config for directory ${dirPath}`);
353
-
354
- const absoluteDirPath = path.resolve(this.#options.cwd, path.dirname(dirPath));
355
- const { configFilePath, basePath } = await this.#locateConfigFileToUse(absoluteDirPath);
356
-
357
- debug(`Using config file ${configFilePath} and base path ${basePath}`);
358
- return this.#calculateConfigArray(configFilePath, basePath);
359
- }
360
-
361
- /**
362
- * Returns a configuration array for the given file based on the CLI options.
363
- * This is a synchronous operation and does not read any files from disk. It's
364
- * intended to be used in locations where we know the config file has already
365
- * been loaded and we just need to get the configuration for a file.
366
- * @param {string} filePath The path of the file to retrieve a config object for.
367
- * @returns {ConfigData|undefined} A configuration object for the file
368
- * or `undefined` if there is no configuration data for the file.
369
- * @throws {Error} If `filePath` is not a non-empty string.
370
- * @throws {Error} If `filePath` is not an absolute path.
371
- * @throws {Error} If the config file was not already loaded.
372
- */
373
- getCachedConfigArrayForFile(filePath) {
374
- assertValidFilePath(filePath);
375
-
376
- debug(`Looking up cached config for ${filePath}`);
377
-
378
- return this.getCachedConfigArrayForPath(path.dirname(filePath));
379
- }
380
-
381
- /**
382
- * Returns a configuration array for the given directory based on the CLI options.
383
- * This is a synchronous operation and does not read any files from disk. It's
384
- * intended to be used in locations where we know the config file has already
385
- * been loaded and we just need to get the configuration for a file.
386
- * @param {string} fileOrDirPath The path of the directory to retrieve a config object for.
387
- * @returns {ConfigData|undefined} A configuration object for the directory
388
- * or `undefined` if there is no configuration data for the directory.
389
- * @throws {Error} If `dirPath` is not a non-empty string.
390
- * @throws {Error} If `dirPath` is not an absolute path.
391
- * @throws {Error} If the config file was not already loaded.
392
- */
393
- getCachedConfigArrayForPath(fileOrDirPath) {
394
- assertValidFilePath(fileOrDirPath);
395
-
396
- debug(`Looking up cached config for ${fileOrDirPath}`);
397
-
398
- const absoluteDirPath = path.resolve(this.#options.cwd, fileOrDirPath);
399
-
400
- if (!this.#configFilePaths.has(absoluteDirPath)) {
401
- throw new Error(`Could not find config file for ${fileOrDirPath}`);
402
- }
403
-
404
- const configFilePathInfo = this.#configFilePaths.get(absoluteDirPath);
405
-
406
- if (typeof configFilePathInfo.then === "function") {
407
- throw new Error(`Config file path for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`);
408
- }
409
-
410
- const { configFilePath } = configFilePathInfo;
411
-
412
- const configArray = this.#configArrays.get(configFilePath);
413
-
414
- if (!configArray || typeof configArray.then === "function") {
415
- throw new Error(`Config array for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`);
416
- }
417
-
418
- return configArray;
419
- }
420
-
421
- /**
422
- * Used to import the jiti dependency. This method is exposed internally for testing purposes.
423
- * @returns {Promise<Record<string, unknown>>} A promise that fulfills with a module object
424
- * or rejects with an error if jiti is not found.
425
- */
426
- static loadJiti() {
427
- return import("jiti");
428
- }
429
-
430
- /**
431
- * Determines which config file to use. This is determined by seeing if an
432
- * override config file was specified, and if so, using it; otherwise, as long
433
- * as override config file is not explicitly set to `false`, it will search
434
- * upwards from `fromDirectory` for a file named `eslint.config.js`.
435
- * This method is exposed internally for testing purposes.
436
- * @param {Object} [options] the options object
437
- * @param {string|false|undefined} options.useConfigFile The path to the config file to use.
438
- * @param {string} options.cwd Path to a directory that should be considered as the current working directory.
439
- * @param {string} [options.fromDirectory] The directory from which to start searching. Defaults to `cwd`.
440
- * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
441
- * the config file.
442
- */
443
- static async locateConfigFileToUse({ useConfigFile, cwd, fromDirectory = cwd }) {
444
-
445
- // determine where to load config file from
446
- let configFilePath;
447
- let basePath = cwd;
448
-
449
- if (typeof useConfigFile === "string") {
450
- debug(`Override config file path is ${useConfigFile}`);
451
- configFilePath = path.resolve(cwd, useConfigFile);
452
- basePath = cwd;
453
- } else if (useConfigFile !== false) {
454
- debug("Searching for eslint.config.js");
455
- configFilePath = await findUp(
456
- FLAT_CONFIG_FILENAMES,
457
- { cwd: fromDirectory }
458
- );
459
-
460
- if (configFilePath) {
461
- basePath = path.dirname(configFilePath);
462
- }
463
-
464
- }
465
-
466
- return {
467
- configFilePath,
468
- basePath
469
- };
470
-
471
- }
472
-
473
- /**
474
- * Calculates the config array for this run based on inputs.
475
- * This method is exposed internally for testing purposes.
476
- * @param {string} configFilePath The absolute path to the config file to use if not overridden.
477
- * @param {string} basePath The base path to use for relative paths in the config file.
478
- * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
479
- * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
480
- */
481
- static async calculateConfigArray(configFilePath, basePath, options) {
482
-
483
- const {
484
- cwd,
485
- baseConfig,
486
- ignoreEnabled,
487
- ignorePatterns,
488
- overrideConfig,
489
- defaultConfigs = []
490
- } = options;
491
-
492
- debug(`Calculating config array from config file ${configFilePath} and base path ${basePath}`);
493
-
494
- const configs = new FlatConfigArray(baseConfig || [], { basePath, shouldIgnore: ignoreEnabled });
495
-
496
- // load config file
497
- if (configFilePath) {
498
-
499
- debug(`Loading config file ${configFilePath}`);
500
- const fileConfig = await loadConfigFile(configFilePath);
501
-
502
- /*
503
- * It's possible that a config file could be empty or else
504
- * have an empty object or array. In this case, we want to
505
- * warn the user that they have an empty config.
506
- *
507
- * An empty CommonJS file exports an empty object while
508
- * an empty ESM file exports undefined.
509
- */
510
-
511
- let emptyConfig = typeof fileConfig === "undefined";
512
-
513
- debug(`Config file ${configFilePath} is ${emptyConfig ? "empty" : "not empty"}`);
514
-
515
- if (!emptyConfig) {
516
- if (Array.isArray(fileConfig)) {
517
- if (fileConfig.length === 0) {
518
- debug(`Config file ${configFilePath} is an empty array`);
519
- emptyConfig = true;
520
- } else {
521
- configs.push(...fileConfig);
522
- }
523
- } else {
524
- if (typeof fileConfig === "object" && fileConfig !== null && Object.keys(fileConfig).length === 0) {
525
- debug(`Config file ${configFilePath} is an empty object`);
526
- emptyConfig = true;
527
- } else {
528
- configs.push(fileConfig);
529
- }
530
- }
531
- }
532
-
533
- if (emptyConfig) {
534
- globalThis.process?.emitWarning?.(`Running ESLint with an empty config (from ${configFilePath}). Please double-check that this is what you want. If you want to run ESLint with an empty config, export [{}] to remove this warning.`, "ESLintEmptyConfigWarning");
535
- }
536
-
537
- }
538
-
539
- // add in any configured defaults
540
- configs.push(...defaultConfigs);
541
-
542
- // append command line ignore patterns
543
- if (ignorePatterns && ignorePatterns.length > 0) {
544
-
545
- let relativeIgnorePatterns;
546
-
547
- /*
548
- * If the config file basePath is different than the cwd, then
549
- * the ignore patterns won't work correctly. Here, we adjust the
550
- * ignore pattern to include the correct relative path. Patterns
551
- * passed as `ignorePatterns` are relative to the cwd, whereas
552
- * the config file basePath can be an ancestor of the cwd.
553
- */
554
- if (basePath === cwd) {
555
- relativeIgnorePatterns = ignorePatterns;
556
- } else {
557
-
558
- // relative path must only have Unix-style separators
559
- const relativeIgnorePath = path.relative(basePath, cwd).replace(/\\/gu, "/");
560
-
561
- relativeIgnorePatterns = ignorePatterns.map(pattern => {
562
- const negated = pattern.startsWith("!");
563
- const basePattern = negated ? pattern.slice(1) : pattern;
564
-
565
- return (negated ? "!" : "") +
566
- path.posix.join(relativeIgnorePath, basePattern);
567
- });
568
- }
569
-
570
- /*
571
- * Ignore patterns are added to the end of the config array
572
- * so they can override default ignores.
573
- */
574
- configs.push({
575
- ignores: relativeIgnorePatterns
576
- });
577
- }
578
-
579
- if (overrideConfig) {
580
- if (Array.isArray(overrideConfig)) {
581
- configs.push(...overrideConfig);
582
- } else {
583
- configs.push(overrideConfig);
584
- }
585
- }
586
-
587
- await configs.normalize();
588
-
589
- return configs;
590
- }
591
-
283
+ /**
284
+ * Map of config file paths to the config arrays for those directories.
285
+ * @type {Map<string, FlatConfigArray|Promise<FlatConfigArray>>}
286
+ */
287
+ #configArrays = new Map();
288
+
289
+ /**
290
+ * Map of absolute directory names to the config file paths for those directories.
291
+ * @type {Map<string, {configFilePath:string,basePath:string}|Promise<{configFilePath:string,basePath:string}>>}
292
+ */
293
+ #configFilePaths = new Map();
294
+
295
+ /**
296
+ * The options to use when loading configuration files.
297
+ * @type {ConfigLoaderOptions}
298
+ */
299
+ #options;
300
+
301
+ /**
302
+ * Creates a new instance.
303
+ * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
304
+ */
305
+ constructor(options) {
306
+ this.#options = options;
307
+ }
308
+
309
+ /**
310
+ * Determines which config file to use. This is determined by seeing if an
311
+ * override config file was specified, and if so, using it; otherwise, as long
312
+ * as override config file is not explicitly set to `false`, it will search
313
+ * upwards from `fromDirectory` for a file named `eslint.config.js`.
314
+ * @param {string} fromDirectory The directory from which to start searching.
315
+ * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
316
+ * the config file.
317
+ */
318
+ async #locateConfigFileToUse(fromDirectory) {
319
+ // check cache first
320
+ if (this.#configFilePaths.has(fromDirectory)) {
321
+ return this.#configFilePaths.get(fromDirectory);
322
+ }
323
+
324
+ const resultPromise = ConfigLoader.locateConfigFileToUse({
325
+ useConfigFile: this.#options.configFile,
326
+ cwd: this.#options.cwd,
327
+ fromDirectory,
328
+ });
329
+
330
+ // ensure `ConfigLoader.locateConfigFileToUse` is called only once for `fromDirectory`
331
+ this.#configFilePaths.set(fromDirectory, resultPromise);
332
+
333
+ // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
334
+ const result = await resultPromise;
335
+
336
+ this.#configFilePaths.set(fromDirectory, result);
337
+
338
+ return result;
339
+ }
340
+
341
+ /**
342
+ * Calculates the config array for this run based on inputs.
343
+ * @param {string} configFilePath The absolute path to the config file to use if not overridden.
344
+ * @param {string} basePath The base path to use for relative paths in the config file.
345
+ * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
346
+ */
347
+ async #calculateConfigArray(configFilePath, basePath) {
348
+ // check for cached version first
349
+ if (this.#configArrays.has(configFilePath)) {
350
+ return this.#configArrays.get(configFilePath);
351
+ }
352
+
353
+ const configsPromise = ConfigLoader.calculateConfigArray(
354
+ configFilePath,
355
+ basePath,
356
+ this.#options,
357
+ );
358
+
359
+ // ensure `ConfigLoader.calculateConfigArray` is called only once for `configFilePath`
360
+ this.#configArrays.set(configFilePath, configsPromise);
361
+
362
+ // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
363
+ const configs = await configsPromise;
364
+
365
+ this.#configArrays.set(configFilePath, configs);
366
+
367
+ return configs;
368
+ }
369
+
370
+ /**
371
+ * Returns the config file path for the given directory or file. This will either use
372
+ * the override config file that was specified in the constructor options or
373
+ * search for a config file from the directory.
374
+ * @param {string} fileOrDirPath The file or directory path to get the config file path for.
375
+ * @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
376
+ * @throws {Error} If `fileOrDirPath` is not a non-empty string.
377
+ * @throws {Error} If `fileOrDirPath` is not an absolute path.
378
+ */
379
+ async findConfigFileForPath(fileOrDirPath) {
380
+ assertValidFilePath(fileOrDirPath);
381
+
382
+ const absoluteDirPath = path.resolve(
383
+ this.#options.cwd,
384
+ path.dirname(fileOrDirPath),
385
+ );
386
+ const { configFilePath } =
387
+ await this.#locateConfigFileToUse(absoluteDirPath);
388
+
389
+ return configFilePath;
390
+ }
391
+
392
+ /**
393
+ * Returns a configuration object for the given file based on the CLI options.
394
+ * This is the same logic used by the ESLint CLI executable to determine
395
+ * configuration for each file it processes.
396
+ * @param {string} filePath The path of the file or directory to retrieve config for.
397
+ * @returns {Promise<ConfigData|undefined>} A configuration object for the file
398
+ * or `undefined` if there is no configuration data for the file.
399
+ * @throws {Error} If no configuration for `filePath` exists.
400
+ */
401
+ async loadConfigArrayForFile(filePath) {
402
+ assertValidFilePath(filePath);
403
+
404
+ debug(`Calculating config for file ${filePath}`);
405
+
406
+ const configFilePath = await this.findConfigFileForPath(filePath);
407
+
408
+ assertConfigurationExists(configFilePath, this.#options);
409
+
410
+ return this.loadConfigArrayForDirectory(filePath);
411
+ }
412
+
413
+ /**
414
+ * Returns a configuration object for the given directory based on the CLI options.
415
+ * This is the same logic used by the ESLint CLI executable to determine
416
+ * configuration for each file it processes.
417
+ * @param {string} dirPath The path of the directory to retrieve config for.
418
+ * @returns {Promise<ConfigData|undefined>} A configuration object for the directory
419
+ * or `undefined` if there is no configuration data for the directory.
420
+ */
421
+ async loadConfigArrayForDirectory(dirPath) {
422
+ assertValidFilePath(dirPath);
423
+
424
+ debug(`Calculating config for directory ${dirPath}`);
425
+
426
+ const absoluteDirPath = path.resolve(
427
+ this.#options.cwd,
428
+ path.dirname(dirPath),
429
+ );
430
+ const { configFilePath, basePath } =
431
+ await this.#locateConfigFileToUse(absoluteDirPath);
432
+
433
+ debug(`Using config file ${configFilePath} and base path ${basePath}`);
434
+ return this.#calculateConfigArray(configFilePath, basePath);
435
+ }
436
+
437
+ /**
438
+ * Returns a configuration array for the given file based on the CLI options.
439
+ * This is a synchronous operation and does not read any files from disk. It's
440
+ * intended to be used in locations where we know the config file has already
441
+ * been loaded and we just need to get the configuration for a file.
442
+ * @param {string} filePath The path of the file to retrieve a config object for.
443
+ * @returns {ConfigData|undefined} A configuration object for the file
444
+ * or `undefined` if there is no configuration data for the file.
445
+ * @throws {Error} If `filePath` is not a non-empty string.
446
+ * @throws {Error} If `filePath` is not an absolute path.
447
+ * @throws {Error} If the config file was not already loaded.
448
+ */
449
+ getCachedConfigArrayForFile(filePath) {
450
+ assertValidFilePath(filePath);
451
+
452
+ debug(`Looking up cached config for ${filePath}`);
453
+
454
+ return this.getCachedConfigArrayForPath(path.dirname(filePath));
455
+ }
456
+
457
+ /**
458
+ * Returns a configuration array for the given directory based on the CLI options.
459
+ * This is a synchronous operation and does not read any files from disk. It's
460
+ * intended to be used in locations where we know the config file has already
461
+ * been loaded and we just need to get the configuration for a file.
462
+ * @param {string} fileOrDirPath The path of the directory to retrieve a config object for.
463
+ * @returns {ConfigData|undefined} A configuration object for the directory
464
+ * or `undefined` if there is no configuration data for the directory.
465
+ * @throws {Error} If `dirPath` is not a non-empty string.
466
+ * @throws {Error} If `dirPath` is not an absolute path.
467
+ * @throws {Error} If the config file was not already loaded.
468
+ */
469
+ getCachedConfigArrayForPath(fileOrDirPath) {
470
+ assertValidFilePath(fileOrDirPath);
471
+
472
+ debug(`Looking up cached config for ${fileOrDirPath}`);
473
+
474
+ const absoluteDirPath = path.resolve(this.#options.cwd, fileOrDirPath);
475
+
476
+ if (!this.#configFilePaths.has(absoluteDirPath)) {
477
+ throw new Error(`Could not find config file for ${fileOrDirPath}`);
478
+ }
479
+
480
+ const configFilePathInfo = this.#configFilePaths.get(absoluteDirPath);
481
+
482
+ if (typeof configFilePathInfo.then === "function") {
483
+ throw new Error(
484
+ `Config file path for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`,
485
+ );
486
+ }
487
+
488
+ const { configFilePath } = configFilePathInfo;
489
+
490
+ const configArray = this.#configArrays.get(configFilePath);
491
+
492
+ if (!configArray || typeof configArray.then === "function") {
493
+ throw new Error(
494
+ `Config array for ${fileOrDirPath} has not yet been calculated or an error occurred during the calculation`,
495
+ );
496
+ }
497
+
498
+ return configArray;
499
+ }
500
+
501
+ /**
502
+ * Used to import the jiti dependency. This method is exposed internally for testing purposes.
503
+ * @returns {Promise<Record<string, unknown>>} A promise that fulfills with a module object
504
+ * or rejects with an error if jiti is not found.
505
+ */
506
+ static loadJiti() {
507
+ return import("jiti");
508
+ }
509
+
510
+ /**
511
+ * Determines which config file to use. This is determined by seeing if an
512
+ * override config file was specified, and if so, using it; otherwise, as long
513
+ * as override config file is not explicitly set to `false`, it will search
514
+ * upwards from `fromDirectory` for a file named `eslint.config.js`.
515
+ * This method is exposed internally for testing purposes.
516
+ * @param {Object} [options] the options object
517
+ * @param {string|false|undefined} options.useConfigFile The path to the config file to use.
518
+ * @param {string} options.cwd Path to a directory that should be considered as the current working directory.
519
+ * @param {string} [options.fromDirectory] The directory from which to start searching. Defaults to `cwd`.
520
+ * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
521
+ * the config file.
522
+ */
523
+ static async locateConfigFileToUse({
524
+ useConfigFile,
525
+ cwd,
526
+ fromDirectory = cwd,
527
+ }) {
528
+ // determine where to load config file from
529
+ let configFilePath;
530
+ let basePath = cwd;
531
+
532
+ if (typeof useConfigFile === "string") {
533
+ debug(`Override config file path is ${useConfigFile}`);
534
+ configFilePath = path.resolve(cwd, useConfigFile);
535
+ basePath = cwd;
536
+ } else if (useConfigFile !== false) {
537
+ debug("Searching for eslint.config.js");
538
+ configFilePath = await findUp(FLAT_CONFIG_FILENAMES, {
539
+ cwd: fromDirectory,
540
+ });
541
+
542
+ if (configFilePath) {
543
+ basePath = path.dirname(configFilePath);
544
+ }
545
+ }
546
+
547
+ return {
548
+ configFilePath,
549
+ basePath,
550
+ };
551
+ }
552
+
553
+ /**
554
+ * Calculates the config array for this run based on inputs.
555
+ * This method is exposed internally for testing purposes.
556
+ * @param {string} configFilePath The absolute path to the config file to use if not overridden.
557
+ * @param {string} basePath The base path to use for relative paths in the config file.
558
+ * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
559
+ * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
560
+ */
561
+ static async calculateConfigArray(configFilePath, basePath, options) {
562
+ const {
563
+ cwd,
564
+ baseConfig,
565
+ ignoreEnabled,
566
+ ignorePatterns,
567
+ overrideConfig,
568
+ hasUnstableNativeNodeJsTSConfigFlag = false,
569
+ defaultConfigs = [],
570
+ } = options;
571
+
572
+ debug(
573
+ `Calculating config array from config file ${configFilePath} and base path ${basePath}`,
574
+ );
575
+
576
+ const configs = new FlatConfigArray(baseConfig || [], {
577
+ basePath,
578
+ shouldIgnore: ignoreEnabled,
579
+ });
580
+
581
+ // load config file
582
+ if (configFilePath) {
583
+ debug(`Loading config file ${configFilePath}`);
584
+ const fileConfig = await loadConfigFile(
585
+ configFilePath,
586
+ hasUnstableNativeNodeJsTSConfigFlag,
587
+ );
588
+
589
+ /*
590
+ * It's possible that a config file could be empty or else
591
+ * have an empty object or array. In this case, we want to
592
+ * warn the user that they have an empty config.
593
+ *
594
+ * An empty CommonJS file exports an empty object while
595
+ * an empty ESM file exports undefined.
596
+ */
597
+
598
+ let emptyConfig = typeof fileConfig === "undefined";
599
+
600
+ debug(
601
+ `Config file ${configFilePath} is ${emptyConfig ? "empty" : "not empty"}`,
602
+ );
603
+
604
+ if (!emptyConfig) {
605
+ if (Array.isArray(fileConfig)) {
606
+ if (fileConfig.length === 0) {
607
+ debug(
608
+ `Config file ${configFilePath} is an empty array`,
609
+ );
610
+ emptyConfig = true;
611
+ } else {
612
+ configs.push(...fileConfig);
613
+ }
614
+ } else {
615
+ if (
616
+ typeof fileConfig === "object" &&
617
+ fileConfig !== null &&
618
+ Object.keys(fileConfig).length === 0
619
+ ) {
620
+ debug(
621
+ `Config file ${configFilePath} is an empty object`,
622
+ );
623
+ emptyConfig = true;
624
+ } else {
625
+ configs.push(fileConfig);
626
+ }
627
+ }
628
+ }
629
+
630
+ if (emptyConfig) {
631
+ globalThis.process?.emitWarning?.(
632
+ `Running ESLint with an empty config (from ${configFilePath}). Please double-check that this is what you want. If you want to run ESLint with an empty config, export [{}] to remove this warning.`,
633
+ "ESLintEmptyConfigWarning",
634
+ );
635
+ }
636
+ }
637
+
638
+ // add in any configured defaults
639
+ configs.push(...defaultConfigs);
640
+
641
+ // append command line ignore patterns
642
+ if (ignorePatterns && ignorePatterns.length > 0) {
643
+ let relativeIgnorePatterns;
644
+
645
+ /*
646
+ * If the config file basePath is different than the cwd, then
647
+ * the ignore patterns won't work correctly. Here, we adjust the
648
+ * ignore pattern to include the correct relative path. Patterns
649
+ * passed as `ignorePatterns` are relative to the cwd, whereas
650
+ * the config file basePath can be an ancestor of the cwd.
651
+ */
652
+ if (basePath === cwd) {
653
+ relativeIgnorePatterns = ignorePatterns;
654
+ } else {
655
+ // relative path must only have Unix-style separators
656
+ const relativeIgnorePath = path
657
+ .relative(basePath, cwd)
658
+ .replace(/\\/gu, "/");
659
+
660
+ relativeIgnorePatterns = ignorePatterns.map(pattern => {
661
+ const negated = pattern.startsWith("!");
662
+ const basePattern = negated ? pattern.slice(1) : pattern;
663
+
664
+ return (
665
+ (negated ? "!" : "") +
666
+ path.posix.join(relativeIgnorePath, basePattern)
667
+ );
668
+ });
669
+ }
670
+
671
+ /*
672
+ * Ignore patterns are added to the end of the config array
673
+ * so they can override default ignores.
674
+ */
675
+ configs.push({
676
+ ignores: relativeIgnorePatterns,
677
+ });
678
+ }
679
+
680
+ if (overrideConfig) {
681
+ if (Array.isArray(overrideConfig)) {
682
+ configs.push(...overrideConfig);
683
+ } else {
684
+ configs.push(overrideConfig);
685
+ }
686
+ }
687
+
688
+ await configs.normalize();
689
+
690
+ return configs;
691
+ }
592
692
  }
593
693
 
594
694
  /**
@@ -596,141 +696,145 @@ class ConfigLoader {
596
696
  * from the current working directory.
597
697
  */
598
698
  class LegacyConfigLoader extends ConfigLoader {
599
-
600
- /**
601
- * The options to use when loading configuration files.
602
- * @type {ConfigLoaderOptions}
603
- */
604
- #options;
605
-
606
- /**
607
- * The cached config file path for this instance.
608
- * @type {Promise<{configFilePath:string,basePath:string}|undefined>}
609
- */
610
- #configFilePath;
611
-
612
- /**
613
- * The cached config array for this instance.
614
- * @type {FlatConfigArray|Promise<FlatConfigArray>}
615
- */
616
- #configArray;
617
-
618
- /**
619
- * Creates a new instance.
620
- * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
621
- */
622
- constructor(options) {
623
- super(options);
624
- this.#options = options;
625
- }
626
-
627
- /**
628
- * Determines which config file to use. This is determined by seeing if an
629
- * override config file was specified, and if so, using it; otherwise, as long
630
- * as override config file is not explicitly set to `false`, it will search
631
- * upwards from the cwd for a file named `eslint.config.js`.
632
- * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
633
- * the config file.
634
- */
635
- #locateConfigFileToUse() {
636
- if (!this.#configFilePath) {
637
- this.#configFilePath = ConfigLoader.locateConfigFileToUse({
638
- useConfigFile: this.#options.configFile,
639
- cwd: this.#options.cwd
640
- });
641
- }
642
-
643
- return this.#configFilePath;
644
- }
645
-
646
- /**
647
- * Calculates the config array for this run based on inputs.
648
- * @param {string} configFilePath The absolute path to the config file to use if not overridden.
649
- * @param {string} basePath The base path to use for relative paths in the config file.
650
- * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
651
- */
652
- async #calculateConfigArray(configFilePath, basePath) {
653
-
654
- // check for cached version first
655
- if (this.#configArray) {
656
- return this.#configArray;
657
- }
658
-
659
- // ensure `ConfigLoader.calculateConfigArray` is called only once
660
- this.#configArray = ConfigLoader.calculateConfigArray(configFilePath, basePath, this.#options);
661
-
662
- // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
663
- this.#configArray = await this.#configArray;
664
-
665
- return this.#configArray;
666
- }
667
-
668
-
669
- /**
670
- * Returns the config file path for the given directory. This will either use
671
- * the override config file that was specified in the constructor options or
672
- * search for a config file from the directory of the file being linted.
673
- * @param {string} dirPath The directory path to get the config file path for.
674
- * @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
675
- * @throws {Error} If `fileOrDirPath` is not a non-empty string.
676
- * @throws {Error} If `fileOrDirPath` is not an absolute path.
677
- */
678
- async findConfigFileForPath(dirPath) {
679
-
680
- assertValidFilePath(dirPath);
681
-
682
- const { configFilePath } = await this.#locateConfigFileToUse();
683
-
684
- return configFilePath;
685
- }
686
-
687
- /**
688
- * Returns a configuration object for the given file based on the CLI options.
689
- * This is the same logic used by the ESLint CLI executable to determine
690
- * configuration for each file it processes.
691
- * @param {string} dirPath The path of the directory to retrieve config for.
692
- * @returns {Promise<ConfigData|undefined>} A configuration object for the file
693
- * or `undefined` if there is no configuration data for the file.
694
- */
695
- async loadConfigArrayForDirectory(dirPath) {
696
-
697
- assertValidFilePath(dirPath);
698
-
699
- debug(`[Legacy]: Calculating config for ${dirPath}`);
700
-
701
- const { configFilePath, basePath } = await this.#locateConfigFileToUse();
702
-
703
- debug(`[Legacy]: Using config file ${configFilePath} and base path ${basePath}`);
704
- return this.#calculateConfigArray(configFilePath, basePath);
705
- }
706
-
707
- /**
708
- * Returns a configuration array for the given directory based on the CLI options.
709
- * This is a synchronous operation and does not read any files from disk. It's
710
- * intended to be used in locations where we know the config file has already
711
- * been loaded and we just need to get the configuration for a file.
712
- * @param {string} dirPath The path of the directory to retrieve a config object for.
713
- * @returns {ConfigData|undefined} A configuration object for the file
714
- * or `undefined` if there is no configuration data for the file.
715
- * @throws {Error} If `dirPath` is not a non-empty string.
716
- * @throws {Error} If `dirPath` is not an absolute path.
717
- * @throws {Error} If the config file was not already loaded.
718
- */
719
- getCachedConfigArrayForPath(dirPath) {
720
- assertValidFilePath(dirPath);
721
-
722
- debug(`[Legacy]: Looking up cached config for ${dirPath}`);
723
-
724
- if (!this.#configArray) {
725
- throw new Error(`Could not find config file for ${dirPath}`);
726
- }
727
-
728
- if (typeof this.#configArray.then === "function") {
729
- throw new Error(`Config array for ${dirPath} has not yet been calculated or an error occurred during the calculation`);
730
- }
731
-
732
- return this.#configArray;
733
- }
699
+ /**
700
+ * The options to use when loading configuration files.
701
+ * @type {ConfigLoaderOptions}
702
+ */
703
+ #options;
704
+
705
+ /**
706
+ * The cached config file path for this instance.
707
+ * @type {Promise<{configFilePath:string,basePath:string}|undefined>}
708
+ */
709
+ #configFilePath;
710
+
711
+ /**
712
+ * The cached config array for this instance.
713
+ * @type {FlatConfigArray|Promise<FlatConfigArray>}
714
+ */
715
+ #configArray;
716
+
717
+ /**
718
+ * Creates a new instance.
719
+ * @param {ConfigLoaderOptions} options The options to use when loading configuration files.
720
+ */
721
+ constructor(options) {
722
+ super(options);
723
+ this.#options = options;
724
+ }
725
+
726
+ /**
727
+ * Determines which config file to use. This is determined by seeing if an
728
+ * override config file was specified, and if so, using it; otherwise, as long
729
+ * as override config file is not explicitly set to `false`, it will search
730
+ * upwards from the cwd for a file named `eslint.config.js`.
731
+ * @returns {Promise<{configFilePath:string|undefined,basePath:string}>} Location information for
732
+ * the config file.
733
+ */
734
+ #locateConfigFileToUse() {
735
+ if (!this.#configFilePath) {
736
+ this.#configFilePath = ConfigLoader.locateConfigFileToUse({
737
+ useConfigFile: this.#options.configFile,
738
+ cwd: this.#options.cwd,
739
+ });
740
+ }
741
+
742
+ return this.#configFilePath;
743
+ }
744
+
745
+ /**
746
+ * Calculates the config array for this run based on inputs.
747
+ * @param {string} configFilePath The absolute path to the config file to use if not overridden.
748
+ * @param {string} basePath The base path to use for relative paths in the config file.
749
+ * @returns {Promise<FlatConfigArray>} The config array for `eslint`.
750
+ */
751
+ async #calculateConfigArray(configFilePath, basePath) {
752
+ // check for cached version first
753
+ if (this.#configArray) {
754
+ return this.#configArray;
755
+ }
756
+
757
+ // ensure `ConfigLoader.calculateConfigArray` is called only once
758
+ this.#configArray = ConfigLoader.calculateConfigArray(
759
+ configFilePath,
760
+ basePath,
761
+ this.#options,
762
+ );
763
+
764
+ // Unwrap the promise. This is primarily for the sync `getCachedConfigArrayForPath` method.
765
+ this.#configArray = await this.#configArray;
766
+
767
+ return this.#configArray;
768
+ }
769
+
770
+ /**
771
+ * Returns the config file path for the given directory. This will either use
772
+ * the override config file that was specified in the constructor options or
773
+ * search for a config file from the directory of the file being linted.
774
+ * @param {string} dirPath The directory path to get the config file path for.
775
+ * @returns {Promise<string|undefined>} The config file path or `undefined` if not found.
776
+ * @throws {Error} If `fileOrDirPath` is not a non-empty string.
777
+ * @throws {Error} If `fileOrDirPath` is not an absolute path.
778
+ */
779
+ async findConfigFileForPath(dirPath) {
780
+ assertValidFilePath(dirPath);
781
+
782
+ const { configFilePath } = await this.#locateConfigFileToUse();
783
+
784
+ return configFilePath;
785
+ }
786
+
787
+ /**
788
+ * Returns a configuration object for the given file based on the CLI options.
789
+ * This is the same logic used by the ESLint CLI executable to determine
790
+ * configuration for each file it processes.
791
+ * @param {string} dirPath The path of the directory to retrieve config for.
792
+ * @returns {Promise<ConfigData|undefined>} A configuration object for the file
793
+ * or `undefined` if there is no configuration data for the file.
794
+ */
795
+ async loadConfigArrayForDirectory(dirPath) {
796
+ assertValidFilePath(dirPath);
797
+
798
+ debug(`[Legacy]: Calculating config for ${dirPath}`);
799
+
800
+ const { configFilePath, basePath } =
801
+ await this.#locateConfigFileToUse();
802
+
803
+ debug(
804
+ `[Legacy]: Using config file ${configFilePath} and base path ${basePath}`,
805
+ );
806
+ return this.#calculateConfigArray(configFilePath, basePath);
807
+ }
808
+
809
+ /**
810
+ * Returns a configuration array for the given directory based on the CLI options.
811
+ * This is a synchronous operation and does not read any files from disk. It's
812
+ * intended to be used in locations where we know the config file has already
813
+ * been loaded and we just need to get the configuration for a file.
814
+ * @param {string} dirPath The path of the directory to retrieve a config object for.
815
+ * @returns {ConfigData|undefined} A configuration object for the file
816
+ * or `undefined` if there is no configuration data for the file.
817
+ * @throws {Error} If `dirPath` is not a non-empty string.
818
+ * @throws {Error} If `dirPath` is not an absolute path.
819
+ * @throws {Error} If the config file was not already loaded.
820
+ */
821
+ getCachedConfigArrayForPath(dirPath) {
822
+ assertValidFilePath(dirPath);
823
+
824
+ debug(`[Legacy]: Looking up cached config for ${dirPath}`);
825
+
826
+ if (!this.#configArray) {
827
+ throw new Error(`Could not find config file for ${dirPath}`);
828
+ }
829
+
830
+ if (typeof this.#configArray.then === "function") {
831
+ throw new Error(
832
+ `Config array for ${dirPath} has not yet been calculated or an error occurred during the calculation`,
833
+ );
834
+ }
835
+
836
+ return this.#configArray;
837
+ }
734
838
  }
735
839
 
736
840
  module.exports = { ConfigLoader, LegacyConfigLoader };