angular/adev/shared-docs/pipeline/api-gen/rendering/cli-entities.ts
Joey Perrott 3bdead1b2f refactor(docs-infra): migrate api-gen from dev-infra into the repo (#57241)
Move the api-gen pipeline into the shared-docs directory.

PR Close #57241
2024-08-05 17:06:29 +00:00

23 lines
539 B
TypeScript

/** The JSON data file format for CLI reference info. */
export interface CliCommand {
name: string;
command: string;
parentCommand?: CliCommand;
shortDescription: string;
longDescription: string;
deprecated: boolean;
aliases: string[];
options: CliOption[];
subcommands?: CliCommand[];
}
/** The CLI item option info. */
export interface CliOption {
name: string;
type: 'boolean' | 'string' | 'number';
default: string;
description: string;
positional?: number;
aliases?: string[];
deprecated: boolean;
}