UNPKG

2.46 kBTypeScriptView Raw
1import { CommandHelpFormatterDeps as BaseCommandHelpFormatterDeps, CommandHelpSchema as BaseCommandHelpSchema, CommandSchemaHelpFormatter as BaseCommandSchemaHelpFormatter, CommandStringHelpFormatter as BaseCommandStringHelpFormatter, NamespaceHelpFormatterDeps as BaseNamespaceHelpFormatterDeps, NamespaceSchemaHelpFormatter as BaseNamespaceSchemaHelpFormatter, NamespaceStringHelpFormatter as BaseNamespaceStringHelpFormatter } from '@ionic/cli-framework';
2import { CommandMetadata, CommandMetadataInput, CommandMetadataOption, HydratedCommandMetadata, ICommand, INamespace } from '../definitions';
3export interface NamespaceHelpFormatterDeps extends BaseNamespaceHelpFormatterDeps<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
4 readonly inProject: boolean;
5 readonly version: string;
6}
7export interface CommandHelpFormatterDeps extends BaseCommandHelpFormatterDeps<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
8}
9export declare class NamespaceStringHelpFormatter extends BaseNamespaceStringHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
10 protected readonly inProject: boolean;
11 protected readonly version: string;
12 constructor({ version, inProject, ...rest }: NamespaceHelpFormatterDeps);
13 formatHeader(): Promise<string>;
14 formatIonicHeader(): Promise<string>;
15 getGlobalOptions(): Promise<string[]>;
16 formatCommands(): Promise<string>;
17}
18export declare class CommandStringHelpFormatter extends BaseCommandStringHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
19 constructor(options: CommandHelpFormatterDeps);
20 formatOptions(): Promise<string>;
21 formatBeforeOptionSummary(opt: CommandMetadataOption): Promise<string>;
22}
23export declare class NamespaceSchemaHelpFormatter extends BaseNamespaceSchemaHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
24 formatCommand(cmd: HydratedCommandMetadata): Promise<CommandHelpSchema>;
25}
26export interface CommandHelpSchema extends BaseCommandHelpSchema {
27 type: string;
28}
29export declare class CommandSchemaHelpFormatter extends BaseCommandSchemaHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
30 formatCommand(cmd: CommandMetadata | HydratedCommandMetadata): Promise<CommandHelpSchema>;
31}