feat: export flat configs in configs object (#350)

43081j · web-flow · commit 12a7cdafe314 · 2025-05-27T08:05:22.000+08:00
diff --git a/.changeset/smooth-horses-greet.md b/.changeset/smooth-horses-greet.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+Expose flat configs in `configs` object to allow use of ESLint `extends`
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -4,6 +4,17 @@ import prettierRC from './.prettierrc.js'
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */
 const config = {
+  configEmoji: [
+    ['recommended', '☑️'],
+    ['flat/errors', '❗'],
+    ['flat/recommended', '☑️'],
+    ['flat/typescript', '⌨️'],
+    ['flat/warnings', '🚸'],
+  ],
+  ruleDocTitleFormat: 'prefix-name',
+  ruleDocSectionOptions: false,
+  ignoreConfig: ['stage-0', 'flat/stage-0'],
+  ruleListSplit: 'meta.docs.category',
   postprocess: content =>
     format(content, { ...prettierRC, parser: 'markdown' }),
 }
diff --git a/README.md b/README.md
diff --git a/docs/rules/default.md b/docs/rules/default.md
@@ -1,6 +1,6 @@
 # import-x/default
 
-💼 This rule is enabled in the following configs: ❗ `errors`, ☑️ `recommended`.
+💼 This rule is enabled in the following configs: ❗ `errors`, ❗ `flat/errors`, ☑️ `flat/recommended`, ☑️ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/export.md b/docs/rules/export.md
@@ -1,6 +1,6 @@
 # import-x/export
 
-💼 This rule is enabled in the following configs: ❗ `errors`, ☑️ `recommended`.
+💼 This rule is enabled in the following configs: ❗ `errors`, ❗ `flat/errors`, ☑️ `flat/recommended`, ☑️ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/named.md b/docs/rules/named.md
@@ -1,6 +1,6 @@
 # import-x/named
 
-💼🚫 This rule is enabled in the following configs: ❗ `errors`, ☑️ `recommended`. This rule is _disabled_ in the ⌨️ `typescript` config.
+💼🚫 This rule is enabled in the following configs: ❗ `errors`, ❗ `flat/errors`, ☑️ `flat/recommended`, ☑️ `recommended`. This rule is _disabled_ in the following configs: ⌨️ `flat/typescript`, ⌨️ `typescript`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/namespace.md b/docs/rules/namespace.md
@@ -1,6 +1,6 @@
 # import-x/namespace
 
-💼 This rule is enabled in the following configs: ❗ `errors`, ☑️ `recommended`.
+💼 This rule is enabled in the following configs: ❗ `errors`, ❗ `flat/errors`, ☑️ `flat/recommended`, ☑️ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md
@@ -1,6 +1,6 @@
 # import-x/no-duplicates
 
-⚠️ This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
+⚠️ This rule _warns_ in the following configs: ☑️ `flat/recommended`, 🚸 `flat/warnings`, ☑️ `recommended`, 🚸 `warnings`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/no-named-as-default-member.md b/docs/rules/no-named-as-default-member.md
@@ -1,6 +1,6 @@
 # import-x/no-named-as-default-member
 
-⚠️ This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
+⚠️ This rule _warns_ in the following configs: ☑️ `flat/recommended`, 🚸 `flat/warnings`, ☑️ `recommended`, 🚸 `warnings`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-named-as-default.md b/docs/rules/no-named-as-default.md
@@ -1,6 +1,6 @@
 # import-x/no-named-as-default
 
-⚠️ This rule _warns_ in the following configs: ☑️ `recommended`, 🚸 `warnings`.
+⚠️ This rule _warns_ in the following configs: ☑️ `flat/recommended`, 🚸 `flat/warnings`, ☑️ `recommended`, 🚸 `warnings`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-rename-default.md b/docs/rules/no-rename-default.md
@@ -1,6 +1,6 @@
 # import-x/no-rename-default
 
-⚠️ This rule _warns_ in the 🚸 `warnings` config.
+⚠️ This rule _warns_ in the following configs: 🚸 `flat/warnings`, 🚸 `warnings`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-unresolved.md b/docs/rules/no-unresolved.md
@@ -1,6 +1,6 @@
 # import-x/no-unresolved
 
-💼 This rule is enabled in the following configs: ❗ `errors`, ☑️ `recommended`.
+💼 This rule is enabled in the following configs: ❗ `errors`, ❗ `flat/errors`, ☑️ `flat/recommended`, ☑️ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/package.json b/package.json
@@ -60,7 +60,7 @@
     "release": "clean-pkg-json && changeset publish",
     "test": "node --experimental-vm-modules --no-warnings=ESLintRCWarning node_modules/jest/bin/jest.js",
     "test-compiled": "yarn build && TEST_COMPILED=1 yarn test",
-    "update:eslint-docs": "eslint-doc-generator --rule-doc-title-format prefix-name --rule-doc-section-options false --rule-list-split meta.docs.category --ignore-config stage-0 --config-emoji recommended,☑️",
+    "update:eslint-docs": "eslint-doc-generator",
     "watch": "yarn test --watch"
   },
   "peerDependencies": {
diff --git a/patches/eslint-doc-generator+2.1.2.patch b/patches/eslint-doc-generator+2.1.2.patch
@@ -0,0 +1,17 @@
+diff --git a/node_modules/eslint-doc-generator/dist/lib/option-parsers.js b/node_modules/eslint-doc-generator/dist/lib/option-parsers.js
+index 556ff0d..0361b02 100644
+--- a/node_modules/eslint-doc-generator/dist/lib/option-parsers.js
++++ b/node_modules/eslint-doc-generator/dist/lib/option-parsers.js
+@@ -27,9 +27,9 @@ export function parseConfigEmojiOptions(plugin, configEmoji) {
+         if (plugin.configs?.[config] === undefined) {
+             throw new Error(`Invalid configEmoji option: ${config} config not found.`);
+         }
+-        if (RESERVED_EMOJIS.includes(emoji)) {
+-            throw new Error(`Cannot specify reserved emoji ${EMOJI_CONFIG_ERROR}.`);
+-        }
++        // if (RESERVED_EMOJIS.includes(emoji)) {
++        //     throw new Error(`Cannot specify reserved emoji ${EMOJI_CONFIG_ERROR}.`);
++        // }
+         return [{ config, emoji }];
+     }) || [];
+     // Add default emojis for the common configs for which the user hasn't already specified an emoji.
diff --git a/src/index.ts b/src/index.ts
@@ -131,42 +131,23 @@ const rules = {
   'imports-first': importsFirst,
 } satisfies Record<string, TSESLint.RuleModule<string, readonly unknown[]>>
 
-const configs = {
-  recommended,
-
-  errors,
-  warnings,
-
-  // shhhh... work in progress "secret" rules
-  'stage-0': stage0,
-
-  // useful stuff for folks using various environments
-  react,
-  'react-native': reactNative,
-  electron,
-  typescript,
-} satisfies Record<string, PluginConfig>
-
 // Base Plugin Object
 const plugin_ = {
   meta,
-  configs,
   rules,
   cjsRequire,
   importXResolverCompat,
   createNodeResolver,
 }
 
-const plugin = plugin_ as typeof plugin_ & { flatConfigs: typeof flatConfigs }
-
 // Create flat configs (Only ones that declare plugins and parser options need to be different from the legacy config)
 const createFlatConfig = (
   baseConfig: PluginFlatBaseConfig,
   configName: string,
 ): PluginFlatConfig => ({
   ...baseConfig,
   name: `import-x/${configName}`,
-  plugins: { 'import-x': plugin },
+  plugins: { 'import-x': plugin_ },
 })
 
 const flatConfigs = {
@@ -185,7 +166,38 @@ const flatConfigs = {
   typescript: createFlatConfig(typescriptFlat, 'typescript'),
 } satisfies Record<string, PluginFlatConfig>
 
+const configs = {
+  recommended,
+
+  errors,
+  warnings,
+
+  // shhhh... work in progress "secret" rules
+  'stage-0': stage0,
+
+  // useful stuff for folks using various environments
+  react,
+  'react-native': reactNative,
+  electron,
+  typescript,
+
+  'flat/recommended': flatConfigs.recommended,
+  'flat/errors': flatConfigs.errors,
+  'flat/warnings': flatConfigs.warnings,
+  'flat/stage-0': flatConfigs['stage-0'],
+  'flat/react': flatConfigs.react,
+  'flat/react-native': flatConfigs['react-native'],
+  'flat/electron': flatConfigs.electron,
+  'flat/typescript': flatConfigs.typescript,
+} satisfies Record<string, PluginConfig | PluginFlatConfig>
+
+const plugin = plugin_ as typeof plugin_ & {
+  flatConfigs: typeof flatConfigs
+  configs: typeof configs
+}
+
 plugin.flatConfigs = flatConfigs
+plugin.configs = configs
 
 export default plugin
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-import-x": minor
 +---
++
 +Expose flat configs in `configs` object to allow use of ESLint `extends`