Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit 00a0647

Browse files
authored
feat: add PredefinedConfig for flat config (#146)
1 parent 4f5d47e commit 00a0647

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

src/flat-config/index.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { ESLint, Linter } from 'eslint';
22
import type { Rules } from '../rules';
3+
import type { LiteralUnion } from '../utility-types';
34
import type { LanguageOptions } from './language-options';
45
import type { LinterOptions } from './linter-options';
56

@@ -56,3 +57,14 @@ export interface FlatESLintConfig {
5657
*/
5758
rules?: Rules;
5859
}
60+
61+
/**
62+
* Predefined configurations.
63+
*
64+
* @see [Using predefined configurations](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-predefined-configurations)
65+
*/
66+
export type PredefinedConfig = LiteralUnion<
67+
'eslint:recommended' | 'eslint:all'
68+
>;
69+
70+
export type FlatESLintConfigs = Array<FlatESLintConfig | PredefinedConfig>;

src/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { ESLintConfig } from './config';
2-
import type { FlatESLintConfig } from './flat-config';
2+
import type { FlatESLintConfigs } from './flat-config';
33

44
/**
55
* Define an ESLint config.
@@ -17,4 +17,4 @@ export function defineConfig(config: ESLintConfig): ESLintConfig;
1717
* @param config Flat ESLint config.
1818
* @returns Flat ESLint config.
1919
*/
20-
export function defineConfig(config: FlatESLintConfig[]): FlatESLintConfig[];
20+
export function defineConfig(config: FlatESLintConfigs[]): FlatESLintConfigs[];

0 commit comments

Comments
 (0)