@ionic/cli-utils/lib/help.d.ts

Ionic CLI Utils

import { CommandHelpSchema as BaseCommandHelpSchema, CommandSchemaHelpFormatter as BaseCommandSchemaHelpFormatter, CommandStringHelpFormatter as BaseCommandStringHelpFormatter, NamespaceHelpFormatterDeps as BaseNamespaceHelpFormatterDeps, NamespaceSchemaHelpFormatter as BaseNamespaceSchemaHelpFormatter, NamespaceStringHelpFormatter as BaseNamespaceStringHelpFormatter } from '@ionic/cli-framework';
import { CommandMetadata, CommandMetadataInput, CommandMetadataOption, HydratedCommandMetadata, ICommand, INamespace, NamespaceMetadata } from '../definitions';
export declare function isCommandVisible(cmd: HydratedCommandMetadata): Promise<boolean>;
export declare function isOptionVisible(opt: CommandMetadataOption): boolean;
export interface NamespaceHelpFormatterDeps extends BaseNamespaceHelpFormatterDeps<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
    readonly inProject: boolean;
    readonly version: string;
}
export declare class NamespaceStringHelpFormatter extends BaseNamespaceStringHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
    protected readonly inProject: boolean;
    protected readonly version: string;
    constructor({ version, inProject, ...rest }: NamespaceHelpFormatterDeps);
    formatHeader(): Promise<string>;
    formatIonicHeader(): Promise<string>;
    formatBeforeNamespaceSummary(meta: NamespaceMetadata): Promise<string>;
    formatBeforeSummary(): Promise<string>;
    formatBeforeCommandSummary(cmd: HydratedCommandMetadata): Promise<string>;
    getExtraOptions(): Promise<string[]>;
    formatCommands(): Promise<string>;
    filterCommandCallback(cmd: HydratedCommandMetadata): Promise<boolean>;
}
export declare class CommandStringHelpFormatter extends BaseCommandStringHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
    formatOptions(): Promise<string>;
    filterOptionCallback(opt: CommandMetadataOption): Promise<boolean>;
    formatBeforeSummary(): Promise<string>;
    formatBeforeOptionSummary(opt: CommandMetadataOption): Promise<string>;
}
export declare class NamespaceSchemaHelpFormatter extends BaseNamespaceSchemaHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
    filterCommandCallback(cmd: HydratedCommandMetadata): Promise<boolean>;
    formatCommand(cmd: HydratedCommandMetadata): Promise<CommandHelpSchema>;
}
export interface CommandHelpSchema extends BaseCommandHelpSchema {
    type: string;
}
export declare class CommandSchemaHelpFormatter extends BaseCommandSchemaHelpFormatter<ICommand, INamespace, CommandMetadata, CommandMetadataInput, CommandMetadataOption> {
    formatCommand(cmd: CommandMetadata | HydratedCommandMetadata): Promise<CommandHelpSchema>;
    filterOptionCallback(opt: CommandMetadataOption): Promise<boolean>;
}