feat: add PredefinedConfig for flat config (#146)

eslint-types · Oct 27, 2022 · 00a0647 · 00a0647
1 parent 4f5d47e
commit 00a0647
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/flat-config/index.d.ts b/src/flat-config/index.d.ts
@@ -1,5 +1,6 @@
 import type { ESLint, Linter } from 'eslint';
 import type { Rules } from '../rules';
+import type { LiteralUnion } from '../utility-types';
 import type { LanguageOptions } from './language-options';
 import type { LinterOptions } from './linter-options';
 
@@ -56,3 +57,14 @@ export interface FlatESLintConfig {
    */
   rules?: Rules;
 }
+
+/**
+ * Predefined configurations.
+ *
+ * @see [Using predefined configurations](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-predefined-configurations)
+ */
+export type PredefinedConfig = LiteralUnion<
+  'eslint:recommended' | 'eslint:all'
+>;
+
+export type FlatESLintConfigs = Array<FlatESLintConfig | PredefinedConfig>;
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -1,5 +1,5 @@
 import type { ESLintConfig } from './config';
-import type { FlatESLintConfig } from './flat-config';
+import type { FlatESLintConfigs } from './flat-config';
 
 /**
  * Define an ESLint config.
@@ -17,4 +17,4 @@ export function defineConfig(config: ESLintConfig): ESLintConfig;
  * @param config Flat ESLint config.
  * @returns Flat ESLint config.
  */
-export function defineConfig(config: FlatESLintConfig[]): FlatESLintConfig[];
+export function defineConfig(config: FlatESLintConfigs[]): FlatESLintConfigs[];