infra: async plugin importing (#182)

Dimava · Shinigami92 · web-flow · commit b07d842e2f8a · 2023-04-03T22:08:20.000+02:00
Co-authored-by: Shinigami &lt;chrissi92@hotmail.de&gt;
diff --git a/scripts/generate-rule-files/contracts/index.ts b/scripts/generate-rule-files/contracts/index.ts
@@ -2,8 +2,11 @@ import type { Rule } from 'eslint';
 
 export type MaybeArray<T> = T | T[];
 
+export type PluginRules = Record<string, Rule.RuleModule>;
+
 export interface Plugin {
   name: string;
   prefix?: string;
-  rules: Record<string, Rule.RuleModule>;
+  module: string;
+  rules?: PluginRules;
 }
diff --git a/scripts/generate-rule-files/index.ts b/scripts/generate-rule-files/index.ts
@@ -4,10 +4,10 @@ import type { Rule } from 'eslint';
 import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
 import dedent from 'ts-dedent';
-import type { Plugin } from './contracts';
+import type { Plugin, PluginRules } from './contracts';
 import { format } from './src/format';
 import { JsDocBuilder } from './src/js-doc-builder';
-import { PLUGIN_REGISTRY } from './src/plugins-map';
+import { PLUGIN_REGISTRY, loadPlugin } from './src/plugins-map';
 import { RuleFile } from './src/rule-file';
 
 /**
@@ -18,6 +18,12 @@ function generateRuleIndexFile(
   { rules, name }: Plugin,
   failedRules: string[],
 ): void {
+  if (!rules) {
+    throw new Error(
+      `Plugin ${name} doesn't have any rules. Did you forget to load them?`,
+    );
+  }
+
   const generatedRules: string[] = Object.keys(rules).filter(
     (ruleName) => !failedRules.includes(ruleName),
   );
@@ -82,7 +88,14 @@ async function generateRulesFiles(
 ): Promise<{ failedRules: string[] }> {
   const failedRules: string[] = [];
 
-  const rules: Array<[string, Rule.RuleModule]> = Object.entries(plugin.rules);
+  const pluginRules: PluginRules | undefined = plugin.rules;
+  if (!pluginRules) {
+    throw new Error(
+      `Plugin ${plugin.name} doesn't have any rules. Did you forget to load them?`,
+    );
+  }
+
+  const rules: Array<[string, Rule.RuleModule]> = Object.entries(pluginRules);
   for (const [ruleName, rule] of rules) {
     logger.logUpdate(logger.colors.yellow(`  Generating > ${ruleName}`));
 
@@ -138,20 +151,23 @@ export async function run(options: RunOptions = {}): Promise<void> {
   const wantedPlugins: string[] = plugins ?? Object.keys(PLUGIN_REGISTRY);
 
   for (const pluginName of wantedPlugins) {
-    const plugin: Plugin = PLUGIN_REGISTRY[pluginName]!;
-
+    const plugin: Plugin | undefined = PLUGIN_REGISTRY[pluginName];
     if (!plugin) {
       throw new Error(`Plugin ${pluginName} doesn't exist.`);
     }
 
     logger.info(`Generating ${plugin.name} rules.`);
+    logger.logUpdate(
+      logger.colors.yellow(`  Loading plugin > ${plugin.module}`),
+    );
+    const loadedPlugin: Plugin = await loadPlugin(plugin);
 
     const pluginDir: string = createPluginDirectory(
       pluginName,
       targetDirectory,
     );
-    const { failedRules } = await generateRulesFiles(plugin, pluginDir);
+    const { failedRules } = await generateRulesFiles(loadedPlugin, pluginDir);
 
-    generateRuleIndexFile(pluginDir, plugin, failedRules);
+    generateRuleIndexFile(pluginDir, loadedPlugin, failedRules);
   }
 }
diff --git a/scripts/generate-rule-files/src/plugins-map.ts b/scripts/generate-rule-files/src/plugins-map.ts
@@ -1,117 +1,97 @@
-import * as eslintPluginGraphQl from '@graphql-eslint/eslint-plugin';
-import * as eslint from 'eslint';
-import * as eslintPluginDeprecation from 'eslint-plugin-deprecation';
-// @ts-expect-error
-import eslintPluginEslintComments from 'eslint-plugin-eslint-comments';
-// @ts-expect-error
-import * as eslintPluginImport from 'eslint-plugin-import';
-// @ts-expect-error
-import eslintPluginJSDoc from 'eslint-plugin-jsdoc';
-import eslintPluginJsonc from 'eslint-plugin-jsonc';
-import * as eslintPluginMdx from 'eslint-plugin-mdx';
-// @ts-expect-error
-import eslintPluginPromise from 'eslint-plugin-promise';
-// @ts-expect-error
-import eslintPluginNode from 'eslint-plugin-node';
-// @ts-expect-error
-import eslintPluginN from 'eslint-plugin-n';
-import * as eslintPluginSonarJS from 'eslint-plugin-sonarjs';
-// @ts-expect-error
-import eslintPluginSpellcheck from 'eslint-plugin-spellcheck';
-// @ts-expect-error
-import eslintPluginUnicorn from 'eslint-plugin-unicorn';
-// @ts-expect-error
-import eslintPluginVue from 'eslint-plugin-vue';
-// @ts-expect-error
-import eslintPluginVuePug from 'eslint-plugin-vue-pug';
-// @ts-expect-error
-import eslintPluginVueI18n from '@intlify/eslint-plugin-vue-i18n';
-import eslintPluginTypeScript from '@typescript-eslint/eslint-plugin';
-import type { Plugin } from '../contracts';
+import type { Plugin, PluginRules } from '../contracts';
 
 /**
  * Map of plugins for which the script will generate rule files.
  */
 export const PLUGIN_REGISTRY: Readonly<Record<string, Plugin>> = {
   deprecation: {
     name: 'Deprecation',
-    rules:
-      // @ts-expect-error: throw error when plugin successfully updated their type defs
-      eslintPluginDeprecation.rules as Plugin['rules'],
+    module: 'eslint-plugin-deprecation',
   },
   eslint: {
     name: 'Eslint',
-    rules: Object.fromEntries(new eslint.Linter().getRules().entries()),
+    module: 'eslint',
   },
   'typescript-eslint': {
     name: 'TypeScript',
     prefix: '@typescript-eslint',
-    rules: (eslintPluginTypeScript as unknown as Plugin).rules,
+    module: '@typescript-eslint/eslint-plugin',
   },
   import: {
     name: 'Import',
-    rules: (eslintPluginImport as Plugin).rules,
+    module: 'eslint-plugin-import',
   },
   'eslint-comments': {
     name: 'EslintComments',
-    rules: (eslintPluginEslintComments as Plugin).rules,
+    module: 'eslint-plugin-eslint-comments',
   },
   'graphql-eslint': {
     name: 'GraphQL',
     prefix: '@graphql-eslint',
-    rules: eslintPluginGraphQl.rules as Plugin['rules'],
+    module: '@graphql-eslint/eslint-plugin',
   },
   jsdoc: {
     name: 'JSDoc',
     prefix: 'jsdoc',
-    rules: (eslintPluginJSDoc as Plugin).rules,
+    module: 'eslint-plugin-jsdoc',
   },
   jsonc: {
     name: 'Jsonc',
-    rules:
-      // @ts-expect-error: throw error when plugin successfully updated their type defs
-      eslintPluginJsonc.rules as Plugin['rules'],
+    module: 'eslint-plugin-jsonc',
   },
   mdx: {
     name: 'Mdx',
-    rules: eslintPluginMdx.rules,
+    module: 'eslint-plugin-mdx',
   },
   n: {
     name: 'N',
-    rules: (eslintPluginN as Plugin).rules,
+    module: 'eslint-plugin-n',
   },
   node: {
     name: 'Node',
-    rules: (eslintPluginNode as Plugin).rules,
+    module: 'eslint-plugin-node',
   },
   promise: {
     name: 'Promise',
-    rules: (eslintPluginPromise as Plugin).rules,
+    module: 'eslint-plugin-promise',
   },
   sonarjs: {
     name: 'SonarJS',
     prefix: 'sonarjs',
-    rules: eslintPluginSonarJS.rules,
+    module: 'eslint-plugin-sonarjs',
   },
   spellcheck: {
     name: 'Spellcheck',
-    rules: (eslintPluginSpellcheck as Plugin).rules,
+    module: 'eslint-plugin-spellcheck',
   },
   unicorn: {
     name: 'Unicorn',
-    rules: (eslintPluginUnicorn as Plugin).rules,
+    module: 'eslint-plugin-unicorn',
   },
   vue: {
     name: 'Vue',
-    rules: (eslintPluginVue as Plugin).rules,
+    module: 'eslint-plugin-vue',
   },
   'vue-i18n': {
     name: 'VueI18n',
     prefix: '@intlify/vue-i18n',
-    rules: (eslintPluginVueI18n as Plugin).rules,
+    module: '@intlify/eslint-plugin-vue-i18n',
   },
   'vue-pug': {
     name: 'VuePug',
-    rules: (eslintPluginVuePug as Plugin).rules,
+    module: 'eslint-plugin-vue-pug',
   },
 } as const;
+
+export async function loadPlugin(plugin: Plugin): Promise<Plugin> {
+  const mod: any = await import(plugin.module);
+  const rules: PluginRules =
+    plugin.module === 'eslint'
+      ? Object.fromEntries(
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+          new mod.Linter().getRules().entries(),
+        )
+      : // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        mod.rules ?? mod.default.rules;
+  return { ...plugin, rules };
+}
diff --git a/tests/generate-rule-files.test.ts b/tests/generate-rule-files.test.ts
@@ -42,7 +42,11 @@ describe('Rule File', () => {
     } as Rule.RuleModule;
 
     const ruleFile: RuleFile = new RuleFile(
-      { name: 'my-plugin', rules: {} },
+      {
+        name: 'my-plugin',
+        module: 'my-module/my-plugin',
+        rules: {},
+      },
       'my-plugin',
       'my-rule',
       rule,
@@ -67,7 +71,11 @@ describe('Rule File', () => {
     } as Rule.RuleModule;
 
     const ruleFile: RuleFile = new RuleFile(
-      { name: 'my-plugin', rules: {} },
+      {
+        name: 'my-plugin',
+        module: 'my-module/my-plugin',
+        rules: {},
+      },
       'my-plugin',
       'my-rule',
       rule,
@@ -93,7 +101,11 @@ describe('Rule File', () => {
     } as Rule.RuleModule;
 
     const ruleFile: RuleFile = new RuleFile(
-      { name: 'my-plugin', rules: {} },
+      {
+        name: 'my-plugin',
+        module: 'my-module/my-plugin',
+        rules: {},
+      },
       'my-plugin',
       'my-rule',
       rule,
@@ -117,7 +129,11 @@ describe('Rule File', () => {
     } as Rule.RuleModule;
 
     const ruleFile: RuleFile = new RuleFile(
-      { name: 'my-plugin', rules: {} },
+      {
+        name: 'my-plugin',
+        module: 'my-module/my-plugin',
+        rules: {},
+      },
       'my-plugin',
       'my-rule',
       rule,
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "target": "ES2020",
+    "module": "ES2020",
     "moduleResolution": "Node",
     "rootDir": ".",
     "strict": true,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"compilerOptions": {`
`3`	`3`	`"target": "ES2020",`
	`4`	`+ "module": "ES2020",`
`4`	`5`	`"moduleResolution": "Node",`
`5`	`6`	`"rootDir": ".",`
`6`	`7`	`"strict": true,`