@tsed/cli-plugin-eslint 6.6.3 → 7.0.0-alpha.2

package/lib/esm/CliPluginEslintModule.js

@@ -1,11 +1,5 @@
-import { __decorate } from "tslib";
-import { Module } from "@tsed/cli-core";
+import { injectable } from "@tsed/di";
 import { EslintInitHook } from "./hooks/EslintInitHook.js";
-let CliPluginEslintModule = class CliPluginEslintModule {
-};
-CliPluginEslintModule = __decorate([
-    Module({
-        imports: [EslintInitHook]
-    })
-], CliPluginEslintModule);
-export { CliPluginEslintModule };
+export class CliPluginEslintModule {
+}
+injectable(CliPluginEslintModule).imports([EslintInitHook]);

package/lib/esm/hooks/EslintInitHook.js

@@ -1,87 +1,44 @@
-import { __decorate, __metadata } from "tslib";
-import { RootRendererService } from "@tsed/cli";
-import { inject, Injectable, OnExec, OnPostInstall, PackageManagersModule, ProjectPackageJson } from "@tsed/cli-core";
+import { render } from "@tsed/cli";
+import { PackageManagersModule, ProjectPackageJson } from "@tsed/cli-core";
+import { inject, injectable } from "@tsed/di";
 import { TEMPLATE_DIR } from "../utils/templateDir.js";
-let EslintInitHook = class EslintInitHook {
-    constructor() {
-        this.packageJson = inject(ProjectPackageJson);
-        this.packageManagers = inject(PackageManagersModule);
-        this.rootRenderer = inject(RootRendererService);
-    }
-    onExec(ctx) {
-        if (!ctx.eslint) {
-            return [];
+export class EslintInitHook {
+    $alterRenderFiles(files, data) {
+        if (!data.eslint) {
+            return files;
         }
         return [
-            {
-                title: "Generate files for eslint",
-                task: (ctx) => {
-                    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);
-                }
-            }
-        ];
-    }
-    onPostInstall(ctx) {
-        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
-                    });
-                }
-            }
+            ...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 {
+                    id: "/" + path,
+                    from: `${TEMPLATE_DIR}/init`
+                };
+            })
         ];
     }
-    addScripts(ctx) {
-        this.packageJson.addScripts({
+    $alterPackageJson(packageJson, data) {
+        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) {
-        this.packageJson.addDependencies({}, ctx);
-    }
-    addDevDependencies(ctx) {
-        this.packageJson.addDevDependencies({
+        packageJson.addDevDependencies({
             "@typescript-eslint/parser": "latest",
             "@typescript-eslint/eslint-plugin": "latest",
             eslint: "latest",
@@ -89,39 +46,64 @@ let EslintInitHook = class EslintInitHook {
             "eslint-plugin-prettier": "latest",
             "eslint-plugin-simple-import-sort": "latest",
             globals: "latest"
-        }, ctx);
-        if (ctx.lintstaged) {
-            this.packageJson.addDevDependencies({
+        }, data);
+        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, data) {
+        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
+                    });
+                }
+            }
+        ];
     }
-};
-__decorate([
-    OnExec("init"),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", void 0)
-], EslintInitHook.prototype, "onExec", null);
-__decorate([
-    OnPostInstall("init"),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", void 0)
-], EslintInitHook.prototype, "onPostInstall", null);
-EslintInitHook = __decorate([
-    Injectable()
-], EslintInitHook);
-export { EslintInitHook };
+}
+injectable(EslintInitHook);

package/lib/esm/index.js

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

package/{templates/init/eslint.config.mjs.hbs → lib/esm/templates/eslint.template.js}

@@ -1,9 +1,35 @@
-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 } 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) {
+        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 +62,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 +75,11 @@ export default [
       "simple-import-sort/imports": "error",
       "simple-import-sort/exports": "error"
     }
-  }{{#if prettier}},
-  pluginPrettierRecommended{{/if}}
+  }${data.prettier
+            ? `,
+  pluginPrettierRecommended`
+            : ""}
 ];
+`;
+    }
+});

package/lib/types/hooks/EslintInitHook.d.ts

@@ -1,26 +1,10 @@
-import { type InitCmdContext, RootRendererService } from "@tsed/cli";
-import { PackageManagersModule, ProjectPackageJson } from "@tsed/cli-core";
-export declare class EslintInitHook {
-    protected packageJson: ProjectPackageJson;
-    protected packageManagers: PackageManagersModule;
-    protected rootRenderer: RootRendererService;
-    onExec(ctx: InitCmdContext): ({
-        title: string;
-        task: (ctx: any) => import("rxjs").Observable<unknown>;
-    } | {
-        title: string;
-        task: () => void;
+import { type CliCommandHooks, type InitCmdContext, type RenderDataContext } from "@tsed/cli";
+import { ProjectPackageJson, type Task } from "@tsed/cli-core";
+export declare class EslintInitHook implements CliCommandHooks {
+    $alterRenderFiles(files: string[], data: RenderDataContext): (string | {
+        id: string;
+        from: string;
     })[];
-    onPostInstall(ctx: InitCmdContext): ({
-        title: string;
-        skip: boolean;
-        task: () => Promise<void>;
-    } | {
-        title: string;
-        task: () => import("rxjs").Observable<unknown>;
-        skip?: undefined;
-    })[];
-    addScripts(ctx: InitCmdContext): void;
-    addDependencies(ctx: InitCmdContext): void;
-    addDevDependencies(ctx: InitCmdContext): void;
+    $alterPackageJson(packageJson: ProjectPackageJson, data: RenderDataContext): ProjectPackageJson | Promise<ProjectPackageJson>;
+    $alterInitPostInstallTasks(tasks: Task[], data: InitCmdContext): Task[] | Promise<Task[]>;
 }

package/lib/types/index.d.ts

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

package/lib/types/templates/eslint.template.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@tsed/cli").DefineTemplateOptions;
+export default _default;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tsed/cli-plugin-eslint",
   "description": "Ts.ED CLI plugin. Add EsLint support",
-  "version": "6.6.3",
+  "version": "7.0.0-alpha.2",
   "type": "module",
   "main": "./lib/esm/index.js",
   "source": "./src/index.ts",
@@ -17,12 +17,14 @@
   },
   "scripts": {
     "build": "yarn build:ts",
-    "build:ts": "tsc --build tsconfig.esm.json"
+    "build:ts": "tsc --build tsconfig.esm.json",
+    "/test": "vitest run",
+    "/test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
   },
   "devDependencies": {
-    "@tsed/cli": "6.6.3",
-    "@tsed/cli-core": "6.6.3",
-    "@tsed/typescript": "6.6.3",
+    "@tsed/cli": "7.0.0-alpha.2",
+    "@tsed/cli-core": "7.0.0-alpha.2",
+    "@tsed/typescript": "7.0.0-alpha.2",
     "cross-env": "7.0.3",
     "typescript": "5.6.2",
     "vitest": "3.2.4"
@@ -37,5 +39,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed-cli/tree/master/packages/cli-plugin-eslint",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "alpha"
+  }
 }

package/templates/init/.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+  "**/*.{ts,js}": ["eslint --fix"],
+  "**/*.{ts,js,json,md,yml,yaml}": ["prettier --write"]
+}

package/templates/init/.husky/.gitignore.hbs

@@ -1 +0,0 @@
-_

package/templates/init/.husky/_/.gitignore.hbs

@@ -1 +0,0 @@
-*

package/templates/init/.husky/_/husky.sh.hbs

@@ -1,31 +0,0 @@
-#!/bin/sh
-if [ -z "$husky_skip_init" ]; then
-  debug () {
-    if [ "$HUSKY_DEBUG" = "1" ]; then
-      echo "husky (debug) - $1"
-    fi
-  }
-
-  readonly hook_name="$(basename "$0")"
-  debug "starting $hook_name..."
-
-  if [ "$HUSKY" = "0" ]; then
-    debug "HUSKY env variable is set to 0, skipping hook"
-    exit 0
-  fi
-
-  if [ -f ~/.huskyrc ]; then
-    debug "sourcing ~/.huskyrc"
-    . ~/.huskyrc
-  fi
-
-  export readonly husky_skip_init=1
-  sh -e "$0" "$@"
-  exitCode="$?"
-
-  if [ $exitCode != 0 ]; then
-    echo "husky - $hook_name hook exited with code $exitCode (error)"
-  fi
-
-  exit $exitCode
-fi

package/templates/init/.lintstagedrc.json.hbs

@@ -1,4 +0,0 @@
-{ {{#if prettier}}
-  "**/*.{ts,js}": ["eslint --fix"],{{/if}}
-  "**/*.{ts,js,json,md,yml,yaml}": ["prettier --write"]
-}