Skip to content

fix(eslint-plugin-react-hooks): improve TypeScript types for flat configs #36061

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

Open
MorikawaSouma wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −6
Open

fix(eslint-plugin-react-hooks): improve TypeScript types for flat configs #36061

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions packages/eslint-plugin-react-hooks/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,20 @@ const recommendedLatestRuleConfigs: Linter.RulesRecord = {
const plugins = ['react-hooks'];

type ReactHooksFlatConfig = {
plugins: {react: any};
plugins: {'react-hooks': typeof plugin};
rules: Linter.RulesRecord;
};

type FlatConfigs = {
recommended: ReactHooksFlatConfig;
'recommended-latest': ReactHooksFlatConfig;
};

// We need to declare the type explicitly because `flat` is populated after
// `plugin` is defined (due to the circular reference: plugin.configs.flat
// needs to reference plugin itself).
let flatConfigs: FlatConfigs;

const configs = {
recommended: {
plugins,
Expand All @@ -71,9 +81,8 @@ const configs = {
plugins,
rules: recommendedLatestRuleConfigs,
},
flat: {} as {
recommended: ReactHooksFlatConfig;
'recommended-latest': ReactHooksFlatConfig;
get flat(): FlatConfigs {
return flatConfigs;
},
};

Expand All @@ -86,7 +95,8 @@ const plugin = {
configs,
};

Object.assign(configs.flat, {
// Initialize flat configs after plugin is defined to allow self-reference
flatConfigs = {
'recommended-latest': {
plugins: {'react-hooks': plugin},
rules: configs['recommended-latest'].rules,
Expand All @@ -95,6 +105,6 @@ Object.assign(configs.flat, {
plugins: {'react-hooks': plugin},
rules: configs.recommended.rules,
},
});
};

export default plugin;