CliService

@tsed/cli-core

Usage

import { CliService } from "@tsed/cli-core";

See /packages/cli-core/src/services/CliService.ts.

Overview

class CliService {
    readonly reinstallAfterRun: boolean;
    readonly program: Command;
    protected pkg: Record<string, any>;
    protected hooks: CliHooks;
    protected projectPkg: ProjectPackageJson;
    protected packageManagers: PackageManagersModule;
    protected promptRunner: PromptRunner;
    
    parseArgs(argv: string[]): Promise<void>;
    runLifecycle(cmdName: string, data: CommandData | undefined, $ctx: DIContext): Promise<Promise<void>>;
    exec(cmdName: string, data: any, $ctx: DIContext): Promise<void>;
    prompt(cmdName: string, data: CommandData | undefined, $ctx: DIContext): Promise<CommandData>;
    getTasks(cmdName: string, data: any): Promise<Task[]>;
    getPostInstallTasks(cmdName: string, data: any): Promise<Task<any>[]>;
    createCommand(metadata: CommandMetadata): any;
    load(): void;
    
    
    
}

readonly reinstallAfterRun

readonly reinstallAfterRun: boolean;

readonly program

readonly program: Command;

protected pkg

protected pkg: Record<string, any>;

protected hooks

protected hooks: CliHooks;

protected projectPkg

protected projectPkg: ProjectPackageJson;

protected packageManagers

protected packageManagers: PackageManagersModule;

protected promptRunner

protected promptRunner: PromptRunner;

parseArgs

parseArgs(argv: string[]): Promise<void>;

Parse process.argv and runLifecycle action

runLifecycle

runLifecycle(cmdName: string, data: CommandData | undefined, $ctx: DIContext): Promise<Promise<void>>;

Run lifecycle

exec

exec(cmdName: string, data: any, $ctx: DIContext): Promise<void>;

prompt

prompt(cmdName: string, data: CommandData | undefined, $ctx: DIContext): Promise<CommandData>;

Run prompt for a given command

getTasks

getTasks(cmdName: string, data: any): Promise<Task[]>;

Run lifecycle

getPostInstallTasks

getPostInstallTasks(cmdName: string, data: any): Promise<Task<any>[]>;

createCommand

createCommand(metadata: CommandMetadata): any;

load

load(): void;