Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add override of defining one item of flat config #148

Merged
merged 2 commits into from Oct 29, 2022
Merged

feat: add override of defining one item of flat config #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d05fc8
feat: add override of defining one item of flat config
sxzz Oct 29, 2022
4c11163
Fix typo
Shinigami92 Oct 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/flat-config/index.d.ts
View file
Open in desktop
Expand Up @@ -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.
*
Expand Down Expand Up @@ -67,4 +67,5 @@ export type PredefinedConfig = LiteralUnion<
'eslint:recommended' | 'eslint:all'
>;

export type FlatESLintConfigs = Array<FlatESLintConfig | PredefinedConfig>;
export type FlatESLintConfig = FlatESLintConfigItem | PredefinedConfig;
export type FlatESLintConfigs = Array<FlatESLintConfig>;
12 changes: 11 additions & 1 deletion src/index.d.ts
View file
Open in desktop
@@ -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.
Expand All @@ -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.
*
Expand Down