feat!: sxzz preset return Composer

Author: sxzz

eslint.config.ts

@@ -1,4 +1,3 @@
-// import { sxzz } from './dist/index.js'
 import { sxzz } from './src/index'
 
 export default sxzz(

package.json

@@ -54,6 +54,7 @@
     "@eslint/markdown": "catalog:plugins",
     "eslint-config-flat-gitignore": "catalog:plugins",
     "eslint-config-prettier": "catalog:plugins",
+    "eslint-flat-config-utils": "catalog:",
     "eslint-plugin-antfu": "catalog:plugins",
     "eslint-plugin-command": "catalog:plugins",
     "eslint-plugin-de-morgan": "catalog:plugins",

pnpm-lock.yaml

@@ -4,6 +4,7 @@ overrides:
 catalog:
   '@eslint/js': ^9.21.0
   eslint: ^9.21.0
+  eslint-flat-config-utils: ^2.0.1
   globals: ^16.0.0
   local-pkg: ^1.1.1
 

pnpm-workspace.yaml

@@ -4,17 +4,24 @@ import { builtinRules } from 'eslint/use-at-your-own-risk'
 import pico from 'picocolors'
 import { sxzz } from '../src/presets'
 
-const dts = await flatConfigsToRulesDTS(
-  await sxzz(
-    [
-      {
-        plugins: { '': { rules: Object.fromEntries(builtinRules) } },
-      },
-    ],
-    { vue: true, unocss: true, pnpm: true },
-  ),
-  { includeAugmentation: false, exportTypeName: 'Rules' },
+const configs = await sxzz(
+  [
+    {
+      plugins: { '': { rules: Object.fromEntries(builtinRules) } },
+    },
+  ],
+  { vue: true, unocss: true, pnpm: true },
 )
+let dts = await flatConfigsToRulesDTS(configs, {
+  includeAugmentation: false,
+  exportTypeName: 'Rules',
+})
+
+const configNames = configs.map((i) => i.name).filter(Boolean) as string[]
+dts += `
+// Names of all the configs
+export type ConfigNames = ${configNames.map((i) => `'${i}'`).join(' | ')}
+`
 
 await writeFile('src/typegen.ts', dts)
 

scripts/typegen.ts

@@ -1,3 +1,4 @@
+import { FlatConfigComposer, type Awaitable } from 'eslint-flat-config-utils'
 import {
   command,
   comments,
@@ -24,6 +25,7 @@ import {
   yml,
 } from './configs'
 import { hasUnocss, hasVue } from './env'
+import type { ConfigNames } from './typegen'
 import type { Config } from './types'
 
 /** Ignore common files and include javascript support */
@@ -74,7 +76,7 @@ export const presetAll = async (): Promise<Config[]> => [
 ]
 
 /** `@sxzz`'s preset. */
-export async function sxzz(
+export function sxzz(
   config: Config | Config[] = [],
   {
     command: enableCommand = true,
@@ -96,29 +98,31 @@ export async function sxzz(
     command: boolean
     pnpm: boolean
   }> = {},
-): Promise<Config[]> {
-  const configs: Config[] = [...presetBasic(), ...yml(), ...presetJsonc()]
+): FlatConfigComposer<Config, ConfigNames> {
+  const configs: Awaitable<Config[]>[] = [presetBasic(), yml(), presetJsonc()]
   if (enableVue) {
-    configs.push(...vue())
+    configs.push(vue())
   }
   if (enableMarkdown) {
-    configs.push(...markdown())
+    configs.push(markdown())
   }
   if (enableUnocss) {
-    configs.push(...(await unocss()))
+    configs.push(unocss())
   }
   if (enablePrettier) {
-    configs.push(...prettier())
+    configs.push(prettier())
   }
   if (enableCommand) {
-    configs.push(...command())
+    configs.push(command())
   }
   if (enablePnpm) {
-    configs.push(...(await pnpm()))
+    configs.push(pnpm())
   }
   if (Object.keys(config).length > 0) {
-    configs.push(...(Array.isArray(config) ? config : [config]))
+    configs.push(Array.isArray(config) ? config : [config])
   }
-  configs.push(...specialCases())
-  return configs
+  configs.push(specialCases())
+
+  const composer = new FlatConfigComposer<Config, ConfigNames>(...configs)
+  return composer
 }

src/presets.ts

@@ -1,4 +1,15 @@
 import type { Rules } from './typegen'
 import type { Linter } from 'eslint'
 
-export type Config = Linter.Config<Linter.RulesRecord & Rules>
+export type Config = Omit<
+  Linter.Config<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>
+}