@tsed/cli 6.6.3 → 7.0.0-alpha.2

package/lib/esm/services/mappers/mapDefaultTemplateOptions.js

@@ -0,0 +1,30 @@
+import { inject, ProjectPackageJson } from "@tsed/cli-core";
+import { normalizePath } from "@tsed/normalize-path";
+import { ProjectConvention } from "../../interfaces/ProjectConvention.js";
+import { OutputFilePathPipe } from "../../pipes/OutputFilePathPipe.js";
+import { SymbolNamePipe } from "../../pipes/SymbolNamePipe.js";
+export function mapDefaultTemplateOptions(opts) {
+    const classNamePipe = inject(SymbolNamePipe);
+    const outputFilePathPipe = inject(OutputFilePathPipe);
+    const projectPackageJson = inject(ProjectPackageJson);
+    const { name = "" } = opts;
+    let { type = "" } = opts;
+    type = type.toLowerCase();
+    if (opts.name === "prisma" && opts.name) {
+        type = "prisma.service";
+    }
+    const symbolName = opts.symbolName || classNamePipe.transform({ name, type, format: ProjectConvention.DEFAULT });
+    const symbolPath = opts.symbolPath ||
+        normalizePath(outputFilePathPipe.transform({
+            name,
+            type,
+            subDir: opts.directory
+        }));
+    return {
+        ...projectPackageJson.fillWithPreferences(opts),
+        type,
+        symbolName,
+        symbolPath,
+        symbolPathBasename: opts.symbolPathBasename || normalizePath(classNamePipe.transform({ name, type }))
+    };
+}

package/lib/esm/templates/asyncFactory.template.js

@@ -0,0 +1,38 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { camelCase, pascalCase } from "change-case";
+export default defineTemplate({
+    id: "async.factory",
+    label: "Async Factory",
+    fileName: "{{symbolName}}.factory?",
+    outputDir: "{{srcDir}}/services",
+    render(symbolName) {
+        const camelName = camelCase(symbolName);
+        const optName = pascalCase(symbolName + "Options");
+        return `import {injectable} from "@tsed/di";
+
+interface ${optName} {
+  
+}
+    
+declare global {
+  namespace TsED {
+    interface Configuration extends Record<string, any> {
+      ${camelName}: Options;
+    }
+  }
+}    
+
+export const ${symbolName} = injectable(Symbol.for("${symbolName}"))
+  .factory(async () => {
+    const myConstant = constant<${optName}>("${camelName}");
+    
+    // do something async
+    await Promise.resolve();
+    
+    return {};
+  })
+  .token();
+  
+export type {{symbolName}} = typeof ${symbolName};`;
+    }
+});

package/lib/esm/templates/barrels.template.js

@@ -0,0 +1,22 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { $alter } from "@tsed/hooks";
+export default defineTemplate({
+    id: "barrels",
+    label: "Barrels",
+    description: "Create barrels files (index.ts) to simplify imports.",
+    fileName: ".barrels",
+    ext: "json",
+    outputDir: ".",
+    preserveCase: true,
+    prompts() {
+        return [];
+    },
+    render(_, data) {
+        const barrels = $alter("$alterBarrels", {
+            directory: ["./src/controllers/rest", data.swagger || (data.oidc && "./src/controllers/pages")].filter(Boolean),
+            exclude: ["**/__mock__", "**/__mocks__", "**/*.spec.ts"],
+            delete: true
+        });
+        return JSON.stringify(barrels, null, 2);
+    }
+});

package/lib/esm/templates/command.template.js

@@ -0,0 +1,56 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { kebabCase } from "change-case";
+export default defineTemplate({
+    id: "command",
+    label: "Command",
+    fileName: "{{symbolName}}.command",
+    outputDir: "{{srcDir}}/bin/commands",
+    render(symbolName) {
+        const symbolParamName = kebabCase(symbolName);
+        return `import {Command, CommandProvider, QuestionOptions} from "@tsed/cli-core";
+
+export interface ${symbolName}Context {
+}
+
+@Command({
+  name: "${symbolParamName}",
+  description: "Command description",
+  args: {
+  },
+  options: {
+  },
+  allowUnknownOption: false
+})
+export class ${symbolName} implements CommandProvider {
+  /**
+   *  Ask questions with Inquirer. Return an empty array or don't implement the method to skip this step
+   */
+  async $prompt(initialOptions: Partial<${symbolName}Context>): Promise<QuestionOptions> {
+    return [];
+  }
+
+  /**
+   * This method is called after the $prompt to create / map inputs to a proper context for the next step
+   */
+  $mapContext(ctx: Partial<${symbolName}Context>): ${symbolName}Context {
+    return {
+      ...ctx
+      // map something, based on ctx
+    };
+  }
+  /**
+   *  This step run your tasks with Listr module
+   */
+  async $exec(ctx: ${symbolName}Context): Promise<any> {
+    return [
+      {
+        title: "Do something",
+        task: () => {
+          console.log('HELLO')
+        }
+      }
+    ];
+  }
+}`;
+    }
+});

package/lib/esm/templates/config.template.js

@@ -0,0 +1,27 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "config",
+    label: "Config",
+    description: "Create a new config file",
+    outputDir: "{{srcDir}}/config",
+    fileName: "config",
+    hidden: true,
+    preserveCase: true,
+    render() {
+        return `import {readFileSync} from "node:fs";
+import loggerConfig from "./logger/index.js";
+
+const pkg = JSON.parse(readFileSync("./package.json", {encoding: "utf8"}));
+/**
+ * This is the shared configuration for the application
+ */
+export const config: Partial<TsED.Configuration> = {
+  version: pkg.version,
+  ajv: {
+    returnsCoercedValues: true
+  },
+  logger: loggerConfig
+};
+`;
+    }
+});

package/lib/esm/templates/controller.template.js

@@ -0,0 +1,45 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+import { RoutePipe } from "../pipes/index.js";
+import { CliProjectService } from "../services/CliProjectService.js";
+import { inject } from "@tsed/di";
+export default defineTemplate({
+    id: "controller",
+    label: "Controller",
+    fileName: "{{symbolName}}.controller",
+    outputDir: "{{srcDir}}/controllers",
+    prompts: (data) => [
+        {
+            type: "list",
+            name: "directory",
+            message: "Which directory?",
+            when(state) {
+                return !!(["controller"].includes(state.type || data.type) || data.directory);
+            },
+            choices: inject(CliProjectService).getDirectories("controllers")
+        },
+        {
+            type: "input",
+            name: "route",
+            message: "Which route?",
+            when(state) {
+                return !!(["controller"].includes(state.type || data.type) || data.route);
+            },
+            default: (state) => {
+                return inject(RoutePipe).transform(data.getName(state));
+            }
+        }
+    ],
+    render(symbolName, data) {
+        const route = inject(RoutePipe).transform(data.route);
+        return `import {Controller} from "@tsed/di";
+import {Get} from "@tsed/schema";
+
+@Controller("${route}")
+export class ${symbolName} {
+  @Get("/")
+  get() {
+    return "hello";
+  }
+}`;
+    }
+});

package/lib/esm/templates/decorator.template.js

@@ -0,0 +1,182 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "decorator",
+    label: "Decorator",
+    fileName: "{{symbolName}}",
+    outputDir: "{{srcDir}}/decorators",
+    prompts: (data) => [
+        {
+            type: "list",
+            name: "templateType",
+            message: "What kind of decorator do you want to create?",
+            when(state) {
+                return !!(["decorator"].includes(state.type || data.type) || data.templateType);
+            },
+            choices: [
+                { name: "Class Decorator", value: "class" },
+                { name: "Generic Decorator (class, property)", value: "generic" },
+                { name: "Method Decorator", value: "method" },
+                { name: "Parameter Decorator", value: "param" },
+                { name: "Property Decorator", value: "property" },
+                { name: "Property Decorator (with @Property)", value: "prop" },
+                { name: "Parameters Decorator", value: "parameters" },
+                { name: "Endpoint Decorator", value: "endpoint" },
+                { name: "Middleware Decorator", value: "middleware" }
+            ],
+            default: "class"
+        }
+    ],
+    render(symbolName, data) {
+        const type = data.templateType || "class";
+        switch (type) {
+            case "class":
+                return `
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): ClassDecorator {
+  return (target: any): any => {
+    return class extends target {
+      constructor(...args: any[]) {
+        super(...args);
+      }
+    };
+  };
+}
+`;
+            case "generic":
+                return `import {DecoratorTypes, UnsupportedDecoratorType, decoratorTypeOf} from "@tsed/core";
+
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): any {
+  return (...args: DecoratorParameters): any => {
+    switch(decoratorTypeOf(args)) {
+      case DecoratorTypes.CLASS:
+      case DecoratorTypes.PROP:
+        console.log("do something")
+        break;
+
+      default:
+        throw new UnsupportedDecoratorType(${symbolName}, args);
+    }
+  };
+}
+`;
+            case "method":
+                return `
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): MethodDecorator {
+  return (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<any>): TypedPropertyDescriptor<any> | void => {
+    console.log("do something");
+    return descriptor;
+  };
+}
+`;
+            case "param":
+                return `import {ParamTypes, useDecorators} from "@tsed/core";
+import {UsePipe} from "@tsed/platform-params";
+
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): ParameterDecorator {
+  return useDecorators(
+    UsePipe(${symbolName}Pipe),
+    ParamTypes("${symbolName.toLowerCase()}")
+  );
+}
+`;
+            case "property":
+                return `
+export function ${symbolName}(): PropertyDecorator {
+  return (target: Object, propertyKey: string | symbol): void => {
+    console.log("do something");
+  };
+}
+`;
+            case "prop":
+                return `import {useDecorators} from "@tsed/core";
+import {Property} from "@tsed/schema";
+
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options = {}): PropertyDecorator {
+  return useDecorators(
+    Property()
+  );
+}
+`;
+            case "parameters":
+                return `
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): ParameterDecorator {
+  return (target: Object, propertyKey: string | symbol, parameterIndex: number): void => {
+    console.log("do something");
+  };
+}
+`;
+            case "endpoint":
+                return `import {useDecorators} from "@tsed/core";
+import {Get} from "@tsed/schema";
+
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options = {}): MethodDecorator {
+  return useDecorators(
+    Get("/")
+  );
+}
+`;
+            case "middleware":
+                return `import {Context} from "@tsed/platform-params";
+import {Middleware, MiddlewareMethods} from "@tsed/platform-middlewares";
+import {Next} from "@tsed/common";
+
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options = {}): ClassDecorator {
+  return (target: any) => {
+    @Middleware()
+    class ${symbolName}Middleware implements MiddlewareMethods {
+      use(@Context() ctx: Context, @Next() next: Next) {
+        // do something
+        return next();
+      }
+    }
+
+    return target;
+  };
+}
+`;
+            default:
+                return `
+export interface ${symbolName}Options {
+
+}
+
+export function ${symbolName}(options: ${symbolName}Options): any {
+  return (...args: any[]): any => {
+    console.log("do something");
+  };
+}
+`;
+        }
+    }
+});

package/lib/esm/templates/docker-compose.template.js

@@ -0,0 +1,25 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "docker-compose.yml",
+    label: "Docker Compose",
+    description: "Create a docker-compose.yml file.",
+    fileName: "docker-compose",
+    outputDir: ".",
+    ext: "yml",
+    preserveCase: true,
+    render(_, data) {
+        return `services:
+  server:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      args:
+        - http_proxy
+        - https_proxy
+        - no_proxy
+    image: ${data.projectName}/server:latest
+    ports:
+      - "8081:8081"
+`;
+    }
+});

package/lib/esm/templates/dockerfile.template.js

@@ -0,0 +1,236 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+function dockerHeader() {
+    return `###############################################################################
+###############################################################################
+##                      _______ _____ ______ _____                           ##
+##                     |__   __/ ____|  ____|  __ \\                          ##
+##                        | | | (___ | |__  | |  | |                         ##
+##                        | |  \\___ \\|  __| | |  | |                         ##
+##                        | |  ____) | |____| |__| |                         ##
+##                        |_| |_____/|______|_____/                          ##
+##                                                                           ##
+## description     : Dockerfile for TsED Application                         ##
+## author          : TsED team                                               ##
+## date            : 2023-12-11                                              ##
+## version         : 3.0                                                     ##
+##                                                                           ##
+###############################################################################
+###############################################################################
+`;
+}
+function dockerDevTools() {
+    return `RUN apk update && apk add build-base git curl
+RUN npm install -g pm2
+`;
+}
+function dockerBody() {
+    return `COPY . .
+
+EXPOSE 8081
+ENV PORT 8081
+ENV NODE_ENV production`;
+}
+defineTemplate({
+    id: "dockerfile.yarn",
+    label: "Dockerfile",
+    fileName: "Dockerfile",
+    outputDir: ".",
+    ext: null,
+    preserveCase: true,
+    render() {
+        return `${dockerHeader()}
+
+ARG NODE_VERSION=20.11.0
+
+FROM node:\${NODE_VERSION}-alpine AS build
+WORKDIR /opt
+
+COPY package.json yarn.lock tsconfig.json tsconfig.base.json tsconfig.node.json tsconfig.spec.json .barrels.json .swcrc ./
+
+RUN yarn install --pure-lockfile
+
+COPY ./src ./src
+
+RUN yarn build
+
+FROM node:\${NODE_VERSION}-alpine AS runtime
+ENV WORKDIR /opt
+WORKDIR $WORKDIR
+
+${dockerDevTools()}
+
+COPY --from=build /opt .
+
+RUN yarn install --pure-lockfile --production
+
+${dockerBody()}
+
+CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
+`;
+    }
+});
+defineTemplate({
+    id: "dockerfile.yarn_berry",
+    label: "Dockerfile",
+    fileName: "Dockerfile",
+    outputDir: ".",
+    ext: null,
+    preserveCase: true,
+    render() {
+        return `${dockerHeader()}
+
+ARG NODE_VERSION=20.11.0
+
+FROM node:\${NODE_VERSION}-alpine AS build
+WORKDIR /opt
+
+COPY package.json yarn.lock tsconfig.json tsconfig.base.json tsconfig.node.json tsconfig.spec.json .barrels.json .swcrc ./
+
+RUN yarn set version berry
+RUN yarn install --immutable
+
+COPY ./src ./src
+
+RUN yarn build
+
+FROM node:\${NODE_VERSION}-alpine AS runtime
+ENV WORKDIR /opt
+WORKDIR $WORKDIR
+
+${dockerDevTools()}
+
+COPY --from=build /opt .
+
+RUN yarn set version berry
+RUN yarn install --immutable
+## RUN yarn workspaces focus --all --production
+
+${dockerBody()}
+
+CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
+`;
+    }
+});
+defineTemplate({
+    id: "dockerfile.npm",
+    label: "Dockerfile",
+    fileName: "Dockerfile",
+    outputDir: ".",
+    ext: null,
+    preserveCase: true,
+    render() {
+        return `${dockerHeader()}
+
+ARG NODE_VERSION=20.11.0
+
+FROM node:\${NODE_VERSION}-alpine AS build
+WORKDIR /opt
+
+COPY package.json package-lock.json tsconfig.json tsconfig.base.json tsconfig.node.json tsconfig.spec.json .barrels.json .swcrc ./
+
+RUN npm ci
+
+COPY ./src ./src
+
+RUN npm run build
+
+FROM node:\${NODE_VERSION}-alpine AS runtime
+ENV WORKDIR /opt
+WORKDIR $WORKDIR
+
+${dockerDevTools()}
+
+COPY --from=build /opt .
+
+RUN npm ci --omit=dev --ignore-scripts
+
+${dockerBody()}
+
+CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]`;
+    }
+});
+defineTemplate({
+    id: "dockerfile.pnpm",
+    label: "Dockerfile",
+    fileName: "Dockerfile",
+    outputDir: ".",
+    ext: null,
+    preserveCase: true,
+    render() {
+        return `${dockerHeader()}
+
+ARG NODE_VERSION=20.11.0
+
+FROM node:\${NODE_VERSION}-alpine AS build
+WORKDIR /opt
+
+COPY package.json pnpm-lock.yaml tsconfig.json tsconfig.base.json tsconfig.node.json tsconfig.spec.json .barrels.json .swcrc ./
+
+RUN pnpm install --frozen-lockfile
+
+COPY ./src ./src
+
+RUN pnpm run build
+
+FROM node:\${NODE_VERSION}-alpine AS runtime
+ENV WORKDIR /opt
+WORKDIR $WORKDIR
+
+${dockerDevTools()}
+
+COPY --from=build /opt .
+
+RUN pnpm install --frozen-lockfile --prod
+
+${dockerBody()}
+
+CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production"]
+`;
+    }
+});
+defineTemplate({
+    id: "dockerfile.bun",
+    label: "Dockerfile",
+    fileName: "Dockerfile",
+    outputDir: ".",
+    ext: null,
+    preserveCase: true,
+    render() {
+        return `
+ARG BUN_VERSION=1
+
+FROM oven/bun:\${BUN_VERSION} AS base
+WORKDIR /opt
+
+FROM base AS install
+RUN mkdir -p /temp/dev
+COPY package.json bun.lockb /temp/dev/
+RUN cd /temp/dev && bun install --frozen-lockfile
+
+# install with --production (exclude devDependencies)
+RUN mkdir -p /temp/prod
+COPY package.json bun.lockb /temp/prod/
+RUN cd /temp/prod && bun install --frozen-lockfile --production
+
+# copy node_modules from temp directory
+# then copy all (non-ignored) project files into the image
+FROM base AS prerelease
+COPY --from=install /temp/dev/node_modules node_modules
+COPY . .
+
+RUN bun run build
+
+# copy production dependencies and source code into final image
+FROM base AS release
+COPY --from=install /temp/prod/node_modules node_modules
+COPY --from=prerelease /opt/dist/index.js .
+COPY --from=prerelease /opt/package.json .
+
+USER bun
+
+${dockerBody()}
+
+CMD ["pm2-runtime", "start", "processes.config.cjs", "--env", "production", "--interpreter", "~/.bun/bin/bun"]
+`;
+    }
+});

package/lib/esm/templates/exception-filter.template.js

@@ -0,0 +1,19 @@
+import { defineTemplate } from "../utils/defineTemplate.js";
+export default defineTemplate({
+    id: "exception-filter",
+    label: "Exception Filter",
+    fileName: "{{symbolName}}.exception-filter",
+    outputDir: "{{srcDir}}/filters",
+    render(symbolName) {
+        return `import {BaseContext} from "@tsed/di";
+import {Catch, ExceptionFilterMethods} from "@tsed/platform-exceptions";
+
+@Catch(Error)
+export class ${symbolName} implements ExceptionFilterMethods {
+   catch(exception: Exception, ctx: BaseContext) {
+
+   }
+}
+`;
+    }
+});