feat: types export, close #19 (#21)

Author: antfu

scripts/generate-plugin-dts.ts

@@ -124,12 +124,12 @@ export type ${pascalCase(ruleName)}RuleOptions = ${ruleOptionTypeValue};
 
     const documentation: Rule.RuleMetaData['docs'] = meta.docs ?? {};
 
-    ruleDeclarations.push(`/**
-     * ${documentation.description}
-     *
-     * @see [${ruleName}](${documentation.url})
-     */
-    "${pluginPrefix}/${ruleName}": ${pascalCase(ruleName)}RuleOptions;`);
+    ruleDeclarations.push(` /**
+   * ${documentation.description}
+   *
+   * @see [${ruleName}](${documentation.url})
+   */
+  "${pluginPrefix}/${ruleName}": ${pascalCase(ruleName)}RuleOptions;`);
   }
 
   const hasPluginParsers = await stat(join(workspaceDirectory, 'parsers.d.ts'))
@@ -149,44 +149,54 @@ export type ${pascalCase(ruleName)}RuleOptions = ${ruleOptionTypeValue};
     .catch(() => false);
 
   await writeFile(
-    join(workspaceDirectory, 'index.d.ts'),
+    join(workspaceDirectory, 'types.d.ts'),
     `${ruleOptionImports.join('\n')}
-${hasPluginParsers ? `import type { Parsers } "./parsers";` : ''}${
+${hasPluginParsers ? `export type { Parsers } "./parsers";` : ''}${
       hasPluginParserOptions
-        ? `import type { ParserOptions } "./parser-options";`
+        ? `export type { ParserOptions } "./parser-options";`
         : ''
-    }${hasPluginSettings ? `import type { Settings } "./settings";` : ''}
+    }${hasPluginSettings ? `export type { Settings } "./settings";` : ''}
 
-declare module "eslint-define-config" {
-  export interface CustomExtends {
-    ${pluginConfigs
-      .map((config) => `"plugin:${pluginPrefix}/${config}": void;`)
-      .join('\n')}
-  }
+export interface Extends {
+  ${pluginConfigs
+    .map((config) => `"plugin:${pluginPrefix}/${config}": void;`)
+    .join('\n')}
+}
 
-  export interface CustomPlugins {
-    "${pluginPrefix}": void;
-  }
+export interface Plugins {
+  "${pluginPrefix}": void;
+}
 
-  export interface CustomRuleOptions {
-    ${ruleDeclarations.join('\n')}
-  }
+export interface RuleOptions {
+${ruleDeclarations.join('\n')}
+}
+`,
+    {
+      encoding: 'utf8',
+      flag: 'w',
+    },
+  );
 
-  ${
-    hasPluginParsers ? 'export interface CustomParsers extends Parsers {};' : ''
-  }
+  const imports = [
+    'Extends',
+    'Plugins',
+    'RuleOptions',
+    hasPluginParsers ? 'Parsers' : '',
+    hasPluginParserOptions ? 'ParserOptions' : '',
+    hasPluginSettings ? 'Settings' : '',
+  ].filter(Boolean);
 
-  ${
-    hasPluginParserOptions
-      ? 'export interface CustomParserOptions extends ParserOptions {};'
-      : ''
-  }
+  await writeFile(
+    join(workspaceDirectory, 'index.d.ts'),
+    `import type { ${imports.join(', ')} } from "./types";
 
-  ${
-    hasPluginSettings
-      ? 'export interface CustomSettings extends Settings {};'
-      : ''
-  }
+declare module 'eslint-define-config' {
+${imports
+  .map(
+    (importName) =>
+      `  export interface Custom${importName} extends ${importName} {}`,
+  )
+  .join('\n')}
 }
 `,
     {

types/deprecation/index.d.ts

@@ -1,20 +1,7 @@
-import type { DeprecationRuleOptions } from './rules/deprecation';
+import type { Extends, Plugins, RuleOptions } from './types';
 
 declare module 'eslint-define-config' {
-  export interface CustomExtends {
-    'plugin:deprecation/recommended': void;
-  }
-
-  export interface CustomPlugins {
-    deprecation: void;
-  }
-
-  export interface CustomRuleOptions {
-    /**
-     * Do not use deprecated APIs.
-     *
-     * @see [deprecation](https://github.com/gund/eslint-plugin-deprecation)
-     */
-    'deprecation/deprecation': DeprecationRuleOptions;
-  }
+  export interface CustomExtends extends Extends {}
+  export interface CustomPlugins extends Plugins {}
+  export interface CustomRuleOptions extends RuleOptions {}
 }

types/deprecation/package.json

@@ -27,6 +27,9 @@
     ".": {
       "types": "./index.d.ts"
     },
+    "./types": {
+      "types": "./types.d.ts"
+    },
     "./package.json": "./package.json"
   }
 }

types/deprecation/types.d.ts

@@ -0,0 +1,18 @@
+import type { DeprecationRuleOptions } from './rules/deprecation';
+
+export interface Extends {
+  'plugin:deprecation/recommended': void;
+}
+
+export interface Plugins {
+  deprecation: void;
+}
+
+export interface RuleOptions {
+  /**
+   * Do not use deprecated APIs.
+   *
+   * @see [deprecation](https://github.com/gund/eslint-plugin-deprecation)
+   */
+  'deprecation/deprecation': DeprecationRuleOptions;
+}