From 57edded9da338e13a236e0d179b393cb8dd3c53b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=89=E5=92=B2=E6=99=BA=E5=AD=90=20=28Kevin=29?= Date: Sun, 30 Oct 2022 00:50:26 +0800 Subject: [PATCH] feat: add override of defining one item of flat config (#148) Co-authored-by: Shinigami --- src/flat-config/index.d.ts | 5 +++-- src/index.d.ts | 12 +++++++++++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/flat-config/index.d.ts b/src/flat-config/index.d.ts index 970d0a00..b7ed013b 100644 --- a/src/flat-config/index.d.ts +++ b/src/flat-config/index.d.ts @@ -9,7 +9,7 @@ import type { LinterOptions } from './linter-options'; * * @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new) */ -export interface FlatESLintConfig { +export interface FlatESLintConfigItem { /** * An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files. * @@ -67,4 +67,5 @@ export type PredefinedConfig = LiteralUnion< 'eslint:recommended' | 'eslint:all' >; -export type FlatESLintConfigs = Array; +export type FlatESLintConfig = FlatESLintConfigItem | PredefinedConfig; +export type FlatESLintConfigs = Array; diff --git a/src/index.d.ts b/src/index.d.ts index 60ed1684..e9f2f81a 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -1,5 +1,5 @@ import type { ESLintConfig } from './config'; -import type { FlatESLintConfigs } from './flat-config'; +import type { FlatESLintConfig, FlatESLintConfigs } from './flat-config'; /** * Define an ESLint config. @@ -9,6 +9,16 @@ import type { FlatESLintConfigs } from './flat-config'; */ export function defineConfig(config: ESLintConfig): ESLintConfig; +/** + * Define an item of Flat ESLint config. + * + * @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new) + * + * @param config an item of Flat ESLint config. + * @returns an item of Flat ESLint config. + */ +export function defineConfig(config: FlatESLintConfig): FlatESLintConfig; + /** * Define a flat ESLint config. *