Skip to content

fix(types): fix types of flat configs #3879

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

fix(types): fix types of flat configs #3879

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c51432e
fix(types): fix types of flat configs
CHC383 Jan 14, 2025
2236728
wip
ljharb Jan 14, 2025
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
19 changes: 9 additions & 10 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ const deprecatedRules = filterRules(allRules, (rule) => rule.meta.deprecated);

/** @type {['react']} */
// for legacy config system
const plugins = [
'react',
];
const plugins = ['react'];

// TODO: with TS 4.5+, inline this
const SEVERITY_ERROR = /** @type {2} */ (2);
const SEVERITY_OFF = /** @type {0} */ (0);

/** @typedef {'recommended' | 'all' | 'jsx-runtime'} AvailableFlatConfigs */

const configs = {
recommended: {
plugins,
Expand Down Expand Up @@ -90,21 +90,20 @@ const configs = {
'react/jsx-uses-react': SEVERITY_OFF,
},
},
flat: /** @type {Record<string, ReactFlatConfig>} */ ({
__proto__: null,
}),
flat: /** @type {{ [k in AvailableFlatConfigs]: ReactFlatConfig }} */ ({}),
};

/** @typedef {{ plugins: { react: typeof plugin }, rules: import('eslint').Linter.RulesRecord, languageOptions: { parserOptions: import('eslint').Linter.ParserOptions } }} ReactFlatConfig */
/** @typedef {{plugins: {react: typeof plugin}, rules: import('eslint').Linter.RulesRecord, languageOptions: {parserOptions: import('eslint').Linter.ParserOptions}}} ReactFlatConfig */

/** @type {{ deprecatedRules: typeof deprecatedRules, rules: typeof allRules, configs: typeof configs & { flat: Record<string, ReactFlatConfig> }}} */
/** @type {{deprecatedRules: typeof deprecatedRules, rules: typeof allRules, configs: typeof configs}}} */
const plugin = {
deprecatedRules,
rules: allRules,
configs,
};

Object.assign(configs.flat, {
/** @type {{ [k in AvailableFlatConfigs]: ReactFlatConfig }} */
configs.flat = {
recommended: {
plugins: { react: plugin },
rules: configs.recommended.rules,
Expand All @@ -120,6 +119,6 @@ Object.assign(configs.flat, {
rules: configs['jsx-runtime'].rules,
languageOptions: { parserOptions: configs['jsx-runtime'].parserOptions },
},
});
};

module.exports = plugin;
Loading