CommandProvider

@tsed/cli-core

Usage

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

See /packages/cli-core/src/interfaces/CommandProvider.ts.

Overview

interface CommandProvider<Ctx = any> {
    $prompt?(initialOptions: Partial<Ctx>): PromptQuestion[] | Promise<PromptQuestion[]>;
    $mapContext?(ctx: Partial<Ctx>): Ctx;
    $exec(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
    $postInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
    $afterPostInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
}

$prompt

$prompt?(initialOptions: Partial<Ctx>): PromptQuestion[] | Promise<PromptQuestion[]>;

Hook to create the main prompt for the command. Refer to {@link PromptQuestion} for supported question attributes.

$mapContext

$mapContext?(ctx: Partial<Ctx>): Ctx;

Hook to map options

$exec

$exec(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;

Run a command

$postInstall

$postInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;

Run commands after the npm/yarn install

$afterPostInstall

$afterPostInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;