@tsed/cli-plugin-jest 6.6.3 → 7.0.0-alpha.1

package/lib/types/CliPluginJestModule.d.ts

@@ -1,3 +1,4 @@
+import "./templates/index.js";
 import { RuntimesModule } from "@tsed/cli";
 import { ProjectPackageJson } from "@tsed/cli-core";
 export declare class CliPluginJestModule {

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

@@ -1,7 +1,6 @@
-import { type GenerateCmdContext, SrcRendererService } from "@tsed/cli";
-import { type Tasks } from "@tsed/cli-core";
-export declare class JestGenerateHook {
-    srcRenderService: SrcRendererService;
-    onGenerateExec(ctx: GenerateCmdContext): Tasks;
-    private mapOptions;
+import { type AlterGenerateTasks, CliProjectService, type GenerateCmdContext } from "@tsed/cli";
+import { type Task, type Tasks } from "@tsed/cli-core";
+export declare class JestGenerateHook implements AlterGenerateTasks {
+    protected projectService: CliProjectService;
+    $alterGenerateTasks(tasks: Task[], data: GenerateCmdContext): Tasks;
 }

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

@@ -1,10 +1,5 @@
-import { RootRendererService } from "@tsed/cli";
-import { ProjectPackageJson } from "@tsed/cli-core";
-export declare class JestInitHook {
-    protected packageJson: ProjectPackageJson;
-    protected rootRenderer: RootRendererService;
-    onInitExec(): {
-        title: string;
-        task: (ctx: any) => import("rxjs").Observable<unknown>;
-    }[];
+import { type AlterInitSubTasks, type InitCmdContext } from "@tsed/cli";
+import type { Task } from "@tsed/cli-core";
+export declare class JestInitHook implements AlterInitSubTasks {
+    $alterInitSubTasks(tasks: Task[], data: InitCmdContext): Task[];
 }

package/lib/types/index.d.ts

@@ -1,3 +1,3 @@
 import { CliPluginJestModule } from "./CliPluginJestModule.js";
-export * from "./utils/templateDir.js";
+export * from "./templates/index.js";
 export default CliPluginJestModule;

package/lib/types/templates/controller.integration.template.d.ts

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

package/lib/types/templates/decorator.class.spec.template.d.ts

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

package/lib/types/templates/decorator.endpoint.spec.template.d.ts

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

package/lib/types/templates/decorator.method.spec.template.d.ts

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

package/lib/types/templates/decorator.param.spec.template.d.ts

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

package/lib/types/templates/decorator.parameter.spec.template.d.ts

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

package/lib/types/templates/decorator.prop.spec.template.d.ts

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

package/lib/types/templates/decorator.property.spec.template.d.ts

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

package/lib/types/templates/generic.spec.template.d.ts

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

package/lib/types/templates/index.d.ts

@@ -0,0 +1,11 @@
+import "./decorator.class.spec.template.js";
+import "./decorator.endpoint.spec.template.js";
+import "./decorator.method.spec.template.js";
+import "./decorator.param.spec.template.js";
+import "./decorator.parameter.spec.template.js";
+import "./decorator.prop.spec.template.js";
+import "./decorator.property.spec.template.js";
+import "./controller.integration.template.js";
+import "./generic.spec.template.js";
+import "./jest.config.template.js";
+import "./server.integration.template.js";

package/lib/types/templates/jest.config.template.d.ts

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

package/lib/types/templates/server.integration.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-jest",
   "description": "Ts.ED CLI plugin. Add Jest support",
-  "version": "6.6.3",
+  "version": "7.0.0-alpha.1",
   "type": "module",
   "main": "./lib/esm/index.js",
   "source": "./src/index.ts",
@@ -22,9 +22,9 @@
     "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.1",
+    "@tsed/cli-core": "7.0.0-alpha.1",
+    "@tsed/typescript": "7.0.0-alpha.1",
     "cross-env": "7.0.3",
     "typescript": "5.6.2",
     "vitest": "3.2.4"
@@ -39,5 +39,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed-cli/tree/master/packages/cli-plugin-jest",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "alpha"
+  }
 }

package/src/CliPluginJestModule.ts

@@ -0,0 +1,39 @@
+// Import templates to register them with the DI container
+import "./templates/index.js";
+
+import {RuntimesModule} from "@tsed/cli";
+import {inject, Module, OnAdd, ProjectPackageJson} from "@tsed/cli-core";
+
+import {JestGenerateHook} from "./hooks/JestGenerateHook.js";
+import {JestInitHook} from "./hooks/JestInitHook.js";
+
+@Module({
+  imports: [JestInitHook, JestGenerateHook]
+})
+export class CliPluginJestModule {
+  protected runtimes = inject(RuntimesModule);
+  protected packageJson = inject(ProjectPackageJson);
+
+  @OnAdd("@tsed/cli-plugin-jest")
+  install() {
+    this.addScripts();
+    this.addDevDependencies();
+  }
+
+  addScripts() {
+    const runtime = this.runtimes.get();
+
+    this.packageJson.addScripts({
+      "test:unit": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
+      "test:coverage": `${runtime.run("test:unit")} `
+    });
+  }
+
+  addDevDependencies() {
+    this.packageJson.addDevDependencies({
+      "@types/jest": "latest",
+      "@swc/jest": "latest",
+      jest: "latest"
+    });
+  }
+}

package/src/hooks/JestGenerateHook.ts

@@ -0,0 +1,44 @@
+import {type AlterGenerateTasks, CliProjectService, type GenerateCmdContext, render} from "@tsed/cli";
+import {inject, type Task, type Tasks} from "@tsed/cli-core";
+import {injectable} from "@tsed/di";
+
+export class JestGenerateHook implements AlterGenerateTasks {
+  protected projectService = inject(CliProjectService);
+
+  $alterGenerateTasks(tasks: Task[], data: GenerateCmdContext): Tasks {
+    const {symbolPath} = data;
+
+    return [
+      ...tasks,
+      {
+        title: `Generate ${data.type} spec file to '${symbolPath}.spec.ts'`,
+        enabled() {
+          return !(data.type === "server" || data.type.includes(":dataSource") || data.type.includes(":connection"));
+        },
+        task: () => {
+          let specTemplateType = [data.type, data.templateType, "spec"].filter(Boolean).join(".");
+          specTemplateType = this.projectService.templates.get(specTemplateType) ? specTemplateType : "generic.spec";
+
+          render(specTemplateType, {
+            ...data,
+            symbolPath: data.symbolPath + ".spec"
+          });
+        }
+      },
+      {
+        title: `Generate ${data.type} integration file '${symbolPath}.integration.spec.ts'`,
+        enabled() {
+          return ["controller", "server"].includes(data.type);
+        },
+        task: () => {
+          render(data.type + ".integration", {
+            ...data,
+            symbolPath: data.symbolPath + ".integration.spec"
+          });
+        }
+      }
+    ];
+  }
+}
+
+injectable(JestGenerateHook);

package/src/hooks/JestInitHook.ts

@@ -0,0 +1,22 @@
+import {type AlterInitSubTasks, type InitCmdContext, render} from "@tsed/cli";
+import type {Task} from "@tsed/cli-core";
+import {injectable} from "@tsed/di";
+
+export class JestInitHook implements AlterInitSubTasks {
+  $alterInitSubTasks(tasks: Task[], data: InitCmdContext) {
+    return [
+      ...tasks,
+      {
+        title: "Create jest configuration",
+        enabled: () => !!data.jest,
+        task: () => {
+          render("jest.config", {
+            symbolName: "jest.config"
+          });
+        }
+      }
+    ];
+  }
+}
+
+injectable(JestInitHook);

package/src/index.ts

@@ -0,0 +1,5 @@
+import {CliPluginJestModule} from "./CliPluginJestModule.js";
+
+export * from "./templates/index.js";
+
+export default CliPluginJestModule;

package/src/templates/controller.integration.template.ts

@@ -0,0 +1,38 @@
+import {CliProjectService, defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+import {inject} from "@tsed/cli-core";
+
+export default defineTemplate({
+  id: "controller.integration",
+  label: "Generic Integration Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    const projectService = inject(CliProjectService);
+    const relativePath = projectService.getRelativePath(`${data.symbolPath}.integration.spec.ts`);
+    const serverName = projectService.getServerFileName();
+
+    return `import { PlatformTest } from "@tsed/platform-http/testing";
+import SuperTest from "supertest";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+import { Server } from "${relativePath}/${serverName}.js";
+
+describe("${symbolName}", () => {
+  beforeAll(PlatformTest.bootstrap(Server, {
+    mount: {
+      "/": [${symbolName}]
+    }
+  }));
+  afterAll(PlatformTest.reset);
+
+  it("should call GET ${data.route}", async () => {
+     const request = SuperTest(PlatformTest.callback());
+     const response = await request.get("${data.route}").expect(200);
+
+     expect(response.text).toEqual("hello");
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.class.spec.template.ts

@@ -0,0 +1,25 @@
+import {defineTemplate} from "@tsed/cli";
+import type {GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.class.spec",
+  label: "Class Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should do something", () => {
+    @${symbolName}({})
+    class Test {
+    }
+
+    expect(typeof ${symbolName}).toBe("function")
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.endpoint.spec.template.ts

@@ -0,0 +1,28 @@
+import {defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.endpoint.spec",
+  label: "Endpoint Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { Store } from "@tsed/core";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should store options", () => {
+    class Test {
+      @${symbolName}({options: "options"})
+      method(param: string) {}
+    }
+
+    const store = Store.fromMethod(Test, "method");
+
+    expect(store.get(${symbolName})).toEqual({options: "options"});
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.method.spec.template.ts

@@ -0,0 +1,26 @@
+import {defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.method.spec",
+  label: "Method Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should do something", () => {
+    class Test {
+      @${symbolName}({})
+      method(){}
+    }
+
+    expect(typeof ${symbolName}).toBe("function")
+    expect(typeof ${symbolName}()).toBe("function")
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.param.spec.template.ts

@@ -0,0 +1,28 @@
+import type {GenerateCmdContext} from "@tsed/cli";
+import {defineTemplate} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.param.spec",
+  label: "Parameter Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { Store } from "@tsed/core";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should store options", () => {
+    class Test {
+      method(@${symbolName}({options: "options"}) param: string){}
+    }
+
+    const store = Store.from(Test, "method", 0)
+
+    expect(store.get(${symbolName})).toEqual({options: "options"});
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.parameter.spec.template.ts

@@ -0,0 +1,26 @@
+import type {GenerateCmdContext} from "@tsed/cli";
+import {defineTemplate} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.parameter.spec",
+  label: "Parameters Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should do something", () => {
+    class Test {
+      method(@${symbolName}({}) param: string){}
+    }
+
+    expect(typeof ${symbolName}).toBe("function")
+    expect(typeof ${symbolName}()).toBe("function")
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.prop.spec.template.ts

@@ -0,0 +1,28 @@
+import {defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.prop.spec",
+  label: "Property Decorator with @Property Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { Store } from "@tsed/core";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should store options", () => {
+    class Test {
+      @${symbolName}({options: "options"})
+      property: string;
+    }
+
+    const store = Store.from(Test, "property");
+
+    expect(store.get(${symbolName})).toEqual({options: "options"});
+  });
+});
+`;
+  }
+});

package/src/templates/decorator.property.spec.template.ts

@@ -0,0 +1,27 @@
+import {defineTemplate} from "@tsed/cli";
+import type {GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "decorator.property.spec",
+  label: "Property Decorator Test",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  it("should do something", () => {
+    class Test {
+      @${symbolName}({})
+      property: string;
+    }
+
+    expect(typeof ${symbolName}).toBe("function")
+    expect(typeof ${symbolName}()).toBe("function")
+  });
+});
+`;
+  }
+});

package/src/templates/generic.spec.template.ts

@@ -0,0 +1,27 @@
+import {defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "generic.spec",
+  label: "Generic Spec",
+  fileName: "{{symbolName}}.spec",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { PlatformTest, inject } from "@tsed/platform-http/testing";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  beforeEach(PlatformTest.create);
+  afterEach(PlatformTest.reset);
+
+  it("should do something", () => {
+    const instance = inject(${symbolName});
+    // const instance = PlatformTest.invoke<${symbolName}>(${symbolName}); // get fresh instance
+
+    expect(instance).toBeInstanceOf(${symbolName});
+  });
+});
+`;
+  }
+});

package/src/templates/index.ts

@@ -0,0 +1,12 @@
+// Import all templates to register them with the DI container
+import "./decorator.class.spec.template.js";
+import "./decorator.endpoint.spec.template.js";
+import "./decorator.method.spec.template.js";
+import "./decorator.param.spec.template.js";
+import "./decorator.parameter.spec.template.js";
+import "./decorator.prop.spec.template.js";
+import "./decorator.property.spec.template.js";
+import "./controller.integration.template.js";
+import "./generic.spec.template.js";
+import "./jest.config.template.js";
+import "./server.integration.template.js";

package/{templates/init/jest.config.mjs.hbs → src/templates/jest.config.template.ts}

@@ -1,4 +1,16 @@
-// For a detailed explanation regarding each configuration property, visit:
+import {defineTemplate} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "jest.config",
+  label: "Jest Config",
+  fileName: "jest.config",
+  ext: "mjs",
+  outputDir: ".",
+  hidden: true,
+  preserveCase: true,
+
+  render() {
+    return `// For a detailed explanation regarding each configuration property, visit:
 // https://jestjs.io/docs/en/configuration.html
 
 /** @type {import('jest').Config} */
@@ -38,7 +50,7 @@ export default {
   testMatch: ["**/src/**/__tests__/**/*.[jt]s?(x)", "**/src/**/?(*.)+(spec|test).[tj]s?(x)"],
   // A map from regular expressions to paths to transformers
   transform: {
-    "^.+\\.(j|t)sx?$": [
+    "^.+\\\\.(j|t)sx?$": [
       "@swc/jest",
       {
         jsc: {
@@ -64,8 +76,11 @@ export default {
     ]
   },
   moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1"
+    "^(\\\\.{1,2}/.*)\\\\.js$": "$1"
   },
   testPathIgnorePatterns: ["/node_modules/", "/dist/"],
   transformIgnorePatterns: ["/node_modules/(?!(module-name|another-module)/)"]
 };
+`;
+  }
+});

package/src/templates/server.integration.template.ts

@@ -0,0 +1,32 @@
+import {defineTemplate, type GenerateCmdContext} from "@tsed/cli";
+
+export default defineTemplate({
+  id: "server.integration",
+  label: "Server Integration Test",
+  outputDir: "{{srcDir}}",
+  hidden: true,
+
+  render(symbolName: string, data: GenerateCmdContext) {
+    return `import { PlatformTest } from "@tsed/platform-http/testing";
+import SuperTest from "supertest";
+import { ${symbolName} } from "./${data.symbolPathBasename}.js";
+
+describe("${symbolName}", () => {
+  beforeAll(PlatformTest.bootstrap(${symbolName}));
+  afterAll(PlatformTest.reset);
+
+  it("should call GET ${data.route}", async () => {
+     const request = SuperTest(PlatformTest.callback());
+     const response = await request.get("${data.route}").expect(404);
+
+     expect(response.body).toEqual({
+       errors: [],
+       message: 'Resource "/rest" not found',
+       name: "NOT_FOUND",
+       status: 404,
+     });
+  });
+});
+`;
+  }
+});

package/tsconfig.esm.json

@@ -0,0 +1,27 @@
+{
+  "extends": "@tsed/typescript/tsconfig.node.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declarationDir": "./lib/types",
+    "declaration": true,
+    "composite": true,
+    "noEmit": false,
+    "sourceMap": false
+  },
+  "include": ["src", "src/**/*.json"],
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "**/__mock__/**",
+    "webpack.config.js"
+  ]
+}

package/vitest.config.mts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import {presets} from "@tsed/vitest/presets";
+import {defineConfig} from "vitest/config";
+
+export default defineConfig(
+  {
+    ...presets,
+    test: {
+      ...presets.test,
+      coverage: {
+        ...presets.test.coverage,
+        thresholds: {
+          statements: 0,
+          branches: 0,
+          functions: 0,
+          lines: 0
+        }
+      }
+    }
+  }
+);

package/lib/esm/utils/templateDir.js

@@ -1,2 +0,0 @@
-import { getTemplateDirectory } from "@tsed/cli-core";
-export const TEMPLATE_DIR = getTemplateDirectory(import.meta.dirname);

package/lib/types/utils/templateDir.d.ts

@@ -1 +0,0 @@
-export declare const TEMPLATE_DIR: string;