UNPKG

912 BTypeScriptView Raw
1/**
2 * Generates and/or modifies files based on a schematic.
3 */
4export interface Schema {
5 /**
6 * When true, disables interactive input prompts for options with a default.
7 */
8 defaults?: boolean;
9 /**
10 * When true, runs through and reports activity without writing out results.
11 */
12 dryRun?: boolean;
13 /**
14 * When true, forces overwriting of existing files.
15 */
16 force?: boolean;
17 /**
18 * Shows a help message for this command in the console.
19 */
20 help?: HelpUnion;
21 /**
22 * When false, disables interactive input prompts.
23 */
24 interactive?: boolean;
25 /**
26 * The schematic or collection:schematic to generate.
27 */
28 schematic?: string;
29}
30/**
31 * Shows a help message for this command in the console.
32 */
33export declare type HelpUnion = boolean | HelpEnum;
34export declare enum HelpEnum {
35 HelpJson = "JSON",
36 Json = "json"
37}