/
IPartialCommandDefinition.ts
46 lines (41 loc) · 1.35 KB
/
IPartialCommandDefinition.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { ICommandExampleDefinition } from "./ICommandExampleDefinition";
import { ICommandOptionDefinition } from "./option/ICommandOptionDefinition";
/**
* Interface that allows CLIs to override properties on command definitions.
*/
export interface IPartialCommandDefinition {
/**
* The description - keep group descriptions "small" and include lengthier descriptions for "commands".
* @type {string}
* @memberof IPartialCommandDefinition
*/
description?: string;
/**
* A shorter (~one line) description of your command
* @type {string}
* @memberof IPartialCommandDefinition
*/
summary?: string;
/**
* The set of examples displayed in the help for this command.
* @type {ICommandExampleDefinition[]}
* @memberof IPartialCommandDefinition
*/
examples?: ICommandExampleDefinition[];
/**
* The options to be exposed on the command.
* @type {ICommandOptionDefinition[]}
* @memberof IPartialCommandDefinition
*/
options?: ICommandOptionDefinition[];
}