refactor: update all plugins according to the new CLI api

Author: Romakita

commitlint.config.js

@@ -1 +1,6 @@
-export default {extends: ["@commitlint/config-conventional"]};
+export default {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "header-max-length": [2, "always", 200]
+  }
+};

package.json

@@ -61,7 +61,7 @@
     "handlebars": "^4.7.8",
     "handlebars-helpers": "^0.10.0",
     "inquirer": "^9.3.7",
-    "inquirer-autocomplete-prompt": "^3.0.1",
+    "inquirer-autocomplete-prompt": "3.0.1",
     "js-yaml": "^4.1.0",
     "lerna": "^8.1.8",
     "listr2": "^8.2.4",
@@ -82,6 +82,7 @@
     "@tsed/markdown-it-symbols": "3.20.8",
     "@tsed/monorepo-utils": "2.3.12",
     "@tsed/ts-doc": "^4.1.0",
+    "@types/inquirer-autocomplete-prompt": "3.0.3",
     "@types/node": "22.7.4",
     "@typescript-eslint/eslint-plugin": "8.7.0",
     "@typescript-eslint/parser": "8.7.0",

packages/cli-plugin-eslint/src/hooks/EslintInitHook.ts

@@ -1,101 +1,53 @@
-import {type InitCmdContext, RootRendererService} from "@tsed/cli";
-import {inject, Injectable, OnExec, OnPostInstall, PackageManagersModule, ProjectPackageJson} from "@tsed/cli-core";
+import {type CliCommandHooks, type InitCmdContext, render, type RenderDataContext, type RenderOptions} from "@tsed/cli";
+import {PackageManagersModule, ProjectPackageJson, type Task} from "@tsed/cli-core";
+import {inject, injectable} from "@tsed/di";
 
 import {TEMPLATE_DIR} from "../utils/templateDir.js";
 
-@Injectable()
-export class EslintInitHook {
-  protected packageJson = inject(ProjectPackageJson);
-  protected packageManagers = inject(PackageManagersModule);
-  protected rootRenderer = inject(RootRendererService);
-
-  @OnExec("init")
-  onExec(ctx: InitCmdContext) {
-    if (!ctx.eslint) {
-      return [];
+export class EslintInitHook implements CliCommandHooks {
+  $alterRenderFiles(
+    files: (string | RenderOptions)[],
+    data: RenderDataContext
+  ): (string | RenderOptions)[] | Promise<(string | RenderOptions)[]> {
+    if (!data.eslint) {
+      return files;
     }
 
     return [
-      {
-        title: "Generate files for eslint",
-        task: (ctx: any) => {
-          return this.rootRenderer.renderAll(
-            [
-              "eslint.config.mjs.hbs",
-              ctx.lintstaged && ".husky/_/.gitignore.hbs",
-              ctx.lintstaged && ".husky/_/husky.sh.hbs",
-              ctx.lintstaged && ".husky/.gitignore.hbs",
-              ctx.lintstaged && ".husky/post-commit.hbs",
-              ctx.lintstaged && ".husky/pre-commit.hbs",
-              ctx.lintstaged && ".lintstagedrc.json.hbs",
-              ctx.prettier && ".prettierignore.hbs",
-              ctx.prettier && ".prettierrc.hbs"
-            ],
-            ctx,
-            {
-              templateDir: `${TEMPLATE_DIR}/init`
-            }
-          );
-        }
-      },
-      {
-        title: "Add dependencies",
-        task: () => {
-          this.addScripts(ctx);
-          this.addDependencies(ctx);
-          this.addDevDependencies(ctx);
-        }
-      }
-    ];
+      ...files,
+      ...[
+        data.lintstaged && ".husky/_/.gitignore",
+        data.lintstaged && ".husky/_/husky.sh",
+        data.lintstaged && ".husky/.gitignore",
+        data.lintstaged && ".husky/post-commit",
+        data.lintstaged && ".husky/pre-commit",
+        data.lintstaged && ".lintstagedrc.json",
+        data.prettier && ".prettierignore",
+        data.prettier && ".prettierrc"
+      ]
+        .filter(Boolean)
+        .map((path) => {
+          return {
+            path,
+            templateDir: `${TEMPLATE_DIR}/init`
+          };
+        })
+    ] as (string | RenderOptions)[];
   }
 
-  @OnPostInstall("init")
-  onPostInstall(ctx: InitCmdContext) {
-    return [
-      {
-        title: "Add husky prepare task",
-        skip: !ctx.lintstaged,
-        task: async () => {
-          this.packageJson
-            .refresh()
-            .addScripts({
-              prepare: "is-ci || husky install"
-            })
-            .write();
-
-          await this.packageManagers.runScript("prepare");
-        }
-      },
-      {
-        title: "Run linter",
-        task: () => {
-          return this.packageManagers.runScript("test:lint:fix", {
-            ignoreError: true
-          });
-        }
-      }
-    ];
-  }
-
-  addScripts(ctx: InitCmdContext) {
-    this.packageJson.addScripts({
+  $alterPackageJson(packageJson: ProjectPackageJson, data: RenderDataContext): ProjectPackageJson | Promise<ProjectPackageJson> {
+    packageJson.addScripts({
       "test:lint": "eslint",
       "test:lint:fix": "eslint --fix"
     });
 
-    if (ctx.prettier) {
-      this.packageJson.addScripts({
+    if (data.prettier) {
+      packageJson.addScripts({
         prettier: "prettier '**/*.{json,md,yml,yaml}' --write"
       });
     }
-  }
-
-  addDependencies(ctx: InitCmdContext) {
-    this.packageJson.addDependencies({}, ctx);
-  }
 
-  addDevDependencies(ctx: InitCmdContext) {
-    this.packageJson.addDevDependencies(
+    packageJson.addDevDependencies(
       {
         "@typescript-eslint/parser": "latest",
         "@typescript-eslint/eslint-plugin": "latest",
@@ -105,36 +57,82 @@ export class EslintInitHook {
         "eslint-plugin-simple-import-sort": "latest",
         globals: "latest"
       },
-      ctx
+      data
     );
 
-    if (ctx.lintstaged) {
-      this.packageJson.addDevDependencies(
+    if (data.lintstaged) {
+      packageJson.addDevDependencies(
         {
           "is-ci": "latest",
           husky: "latest",
           "lint-staged": "latest"
         },
-        ctx
+        data
       );
     }
 
-    if (ctx.vitest) {
-      this.packageJson.addDevDependencies(
+    if (data.vitest) {
+      packageJson.addDevDependencies(
         {
           "eslint-plugin-vitest": "latest"
         },
-        ctx
+        data
       );
     }
 
-    if (ctx.prettier) {
-      this.packageJson.addDevDependencies(
+    if (data.prettier) {
+      packageJson.addDevDependencies(
         {
           prettier: "latest"
         },
-        ctx
+        data
       );
     }
+
+    return packageJson;
+  }
+
+  $alterInitPostInstallTasks(tasks: Task[], data: InitCmdContext): Task[] | Promise<Task[]> {
+    const packageJson = inject(ProjectPackageJson);
+    const packageManagers = inject(PackageManagersModule);
+
+    return [
+      ...tasks,
+      {
+        title: "Add eslint configuration",
+        task: () => {
+          render("eslint.config", {
+            ...data,
+            name: "eslint.config"
+          });
+        }
+      },
+      {
+        title: "Add husky prepare task",
+        skip: !data.lintstaged,
+        task: async () => {
+          packageJson
+            .refresh()
+            .addScripts({
+              prepare: "is-ci || husky install"
+            })
+            .write();
+
+          return packageManagers.runScript("prepare", {
+            ignoreError: true
+          });
+        }
+      },
+      {
+        title: "Run linter",
+        task: () => {
+          return packageManagers.runScript("test:lint:fix", {
+            ignoreError: true
+          });
+        }
+      }
+    ];
   }
 }
+
+injectable(EslintInitHook);

packages/cli-plugin-eslint/src/index.ts

@@ -1,5 +1,6 @@
-import {CliPluginEslintModule} from "./CliPluginEslintModule.js";
+import "./templates/eslint.template.js";
 
+import {CliPluginEslintModule} from "./CliPluginEslintModule.js";
 export * from "./utils/templateDir.js";
 
 export default CliPluginEslintModule;

…int/templates/init/eslint.config.mjs.hbs …-eslint/src/templates/eslint.template.tspackages/cli-plugin-eslint/templates/init/eslint.config.mjs.hbs renamed to packages/cli-plugin-eslint/src/templates/eslint.template.ts packages/cli-plugin-eslint/templates/init/eslint.config.mjs.hbs renamed to packages/cli-plugin-eslint/src/templates/eslint.template.ts

@@ -1,9 +1,39 @@
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import typescriptParser from "@typescript-eslint/parser";
-{{#if prettier}}import pluginPrettierRecommended from "eslint-plugin-prettier/recommended";
-{{/if}}import pluginSimpleImportSort from "eslint-plugin-simple-import-sort";
-{{#if vitest}}import vitest from "eslint-plugin-vitest";
-{{/if}}import globals from "globals";
+import {defineTemplate, type RenderDataContext} from "@tsed/cli";
+
+function vitest() {
+  return `
+  {
+    files: ["**/*.spec.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"], // or any other pattern
+    plugins: {
+      vitest
+    },
+    rules: {
+      ...vitest.configs.recommended.rules, // you can also use vitest.configs.all.rules to enable all rules
+      "vitest/consistent-test-it": ["error", {fn: "it", withinDescribe: "it"}],
+      "vitest/no-alias-methods": "error"
+    }
+  },`;
+}
+
+export default defineTemplate({
+  id: "eslint.config",
+  label: "ESLint configuration",
+  hidden: true,
+  fileName: "eslint.config",
+  outputDir: ".",
+  preserveCase: true,
+  ext: "mjs",
+
+  render(_, data: RenderDataContext) {
+    const imports = [
+      'import typescriptEslint from "@typescript-eslint/eslint-plugin";',
+      data.prettier ? 'import pluginPrettierRecommended from "eslint-plugin-prettier/recommended";' : "",
+      'import pluginSimpleImportSort from "eslint-plugin-simple-import-sort";',
+      data.vitest ? 'import vitest from "eslint-plugin-vitest";' : "",
+      'import globals from "globals";'
+    ];
+
+    return `${imports.filter(Boolean).join("\n")}
 
 export default [
   {
@@ -36,18 +66,7 @@ export default [
       "@typescript-eslint/no-explicit-any": 0,
       "@typescript-eslint/no-non-null-assertion": 0
     }
-  },{{#if vitest}}
-  {
-    files: ["**/*.spec.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"], // or any other pattern
-    plugins: {
-      vitest
-    },
-    rules: {
-      ...vitest.configs.recommended.rules, // you can also use vitest.configs.all.rules to enable all rules
-      "vitest/consistent-test-it": ["error", {fn: "it", withinDescribe: "it"}],
-      "vitest/no-alias-methods": "error"
-    }
-  },{{/if}}
+  },${data.vitest ? vitest() : ""}
   {
     files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
     languageOptions: {
@@ -60,6 +79,13 @@ export default [
       "simple-import-sort/imports": "error",
       "simple-import-sort/exports": "error"
     }
-  }{{#if prettier}},
-  pluginPrettierRecommended{{/if}}
+  }${
+    data.prettier
+      ? `,
+  pluginPrettierRecommended`
+      : ""
+  }
 ];
+`;
+  }
+});