UNPKG

1.32 kBTypeScriptView Raw
1import { AbstractCommand } from '../Command/AbstractCommand';
2export declare type CliCommandType = Partial<{
3 token: string;
4 commandLine: string;
5 Command: typeof AbstractCommand;
6 examples: string[];
7 action: string;
8 args: {
9 name: string;
10 required: boolean;
11 }[];
12 config: CliCommandConfigType;
13}>;
14export declare type CliCommandConfigType = Partial<{
15 description: string;
16 examples: string[];
17 options: CliCommandOptionsType;
18}>;
19export declare type CliCommandOptionsType = Partial<{
20 [option: string]: CliCommandOptionType;
21}>;
22export declare type CliCommandOptionType = Partial<{
23 alias: string;
24 value: string;
25 description: string;
26 defaultTo: any;
27 required: boolean;
28}>;
29export declare type CliProgramType = Partial<{
30 program: string;
31 config: CliProgramConfigType;
32}>;
33export declare type ParsedCommandType = {
34 args: {
35 required: boolean;
36 name: string;
37 }[];
38 token: string;
39};
40export declare type ProcessedProgramType = {
41 program: string;
42 examples: string[];
43 commands: ProcessedCommandsType;
44};
45export declare type ProcessedCommandsType = {
46 [command: string]: CliCommandType;
47};
48export declare type CliProgramConfigType = Partial<{
49 examples: string[];
50 commands: CliCommandType[];
51}>;