feat: improve types support

Author: coderwyd

scripts/typegen.ts

@@ -49,8 +49,14 @@ const configs = await combine(
   vue(),
 )
 
-const dts = await flatConfigsToRulesDTS(configs, {
+const configNames = configs.map(i => i.name).filter(Boolean) as string[]
+
+let dts = await flatConfigsToRulesDTS(configs, {
   includeAugmentation: false,
 })
 
+dts = `
+type ConfigNames = ${configNames.map(i => `'${i}'`).join(' | ')}
+${dts}`
+
 await fs.writeFile('src/types/typegen.d.ts', dts)

src/index.ts

@@ -38,6 +38,7 @@ import {
   hasVue,
 } from './env'
 import type { Awaitable, OptionsConfig, TypedFlatConfigItem } from './types'
+import type { Linter } from 'eslint'
 
 const flatConfigProps: (keyof TypedFlatConfigItem)[] = [
   'name',
@@ -64,14 +65,16 @@ export const defaultPluginRenaming = {
  *
  * @param {OptionsConfig & TypedFlatConfigItem} options
  *  The options for generating the ESLint configurations.
- * @param {Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]} userConfigs
+ * @param {Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | Linter.FlatConfig[]>[]} userConfigs
  *  The user configurations to be merged with the generated configurations.
  * @returns {Promise<TypedFlatConfigItem[]>}
  *  The merged ESLint configurations.
  */
 export async function defineConfig(
   options: OptionsConfig & TypedFlatConfigItem = {},
-  ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]>[]
+  ...userConfigs: Awaitable<
+    TypedFlatConfigItem | TypedFlatConfigItem[] | Linter.FlatConfig[]
+  >[]
 ): Promise<TypedFlatConfigItem[]> {
   const {
     autoRenamePlugins = true,

src/types/rule.ts

@@ -1,27 +1,22 @@
 import type { Linter } from 'eslint'
-import type { RuleOptions } from './typegen'
+import type { ConfigNames, RuleOptions } from './typegen'
 import type { BuiltInParserName, LiteralUnion, RequiredOptions } from 'prettier'
 
 export type Rules = RuleOptions
 
-export type TypedFlatConfigItem = Omit<Linter.FlatConfig, 'plugins'> & {
-  /**
-   * Custom name of each config item
-   */
-  name?: string
+export type { ConfigNames }
 
+export type TypedFlatConfigItem = Omit<
+  Linter.FlatConfig<Linter.RulesRecord & Rules>,
+  'plugins'
+> & {
   // Relax plugins type limitation, as most of the plugins did not have correct type info yet.
   /**
    * An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
    *
    * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
    */
   plugins?: Record<string, any>
-
-  /**
-   * An object containing a name-value mapping of rules to use.
-   */
-  rules?: Linter.RulesRecord & Rules
 }
 
 type PrettierCustomParser = 'toml'