DefineTemplateOptions

@tsed/cli

Usage

import { DefineTemplateOptions } from "@tsed/cli/src/utils/defineTemplate";

See /packages/cli/src/utils/defineTemplate.ts.

Overview

type DefineTemplateOptions = {
    id: string;
    label: string;
    description?: string;
    outputDir: string;
    type?: string;
    fileName?: string;
    ext?: string | null;
    hidden?: boolean;
    preserveCase?: boolean;
    preserveDirectory?: boolean;
    schema?: JsonSchema;
    render(symbolName: string, data: GenerateCmdContext): Promise<string | undefined | TemplateRenderReturnType> | string | undefined | TemplateRenderReturnType;
    prompts?(data: GenerateCmdContext): PromptQuestion[] | Promise<PromptQuestion[]>;
    hooks?: ProviderOpts["hooks"];
};

id

id: string;

label

label: string;

description

description?: string;

outputDir

outputDir: string;

type

type?: string;

fileName

fileName?: string;

The file name format without the extension.

ext

ext?: string | null;

The file extension. Default to ts Don't include the dot (.) in the extension.

hidden

hidden?: boolean;

If true the template will be hidden in the list of available templates during the generate command.

preserveCase

preserveCase?: boolean;

If true the file name won't be altered (e.g. MyService will always be MyService.ts) If false the file name will be transformed depending on the project style (e.g. MyService could be my-service.ts).

preserveDirectory

preserveDirectory?: boolean;

If true the directory structure will be preserved when generating the file.

schema

schema?: JsonSchema;

Optional Ts.ED Schema describing template-specific arguments (exclude global fields like type and name). Can be provided as a JsonSchema builder result (from @tsed/schema DSL) or any object exposing toJSON() to JSON Schema.

render

render(symbolName: string, data: GenerateCmdContext): Promise<string | undefined | TemplateRenderReturnType> | string | undefined | TemplateRenderReturnType;

prompts

prompts?(data: GenerateCmdContext): PromptQuestion[] | Promise<PromptQuestion[]>;

hooks

hooks?: ProviderOpts["hooks"];