UNPKG

@redocly/cli

Version:

[@Redocly](https://redocly.com) CLI is your all-in-one OpenAPI utility. It builds, manages, improves, and quality-checks your OpenAPI descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make API g

45 lines (44 loc) 2.19 kB
import type { BundleOutputFormat, Region, Config, RuleSeverity } from '@redocly/openapi-core'; import type { RespectOptions, GenerateArazzoFileOptions } from '@redocly/respect-core'; import type { ArgumentsCamelCase } from 'yargs'; import type { LintOptions } from './commands/lint'; import type { BundleOptions } from './commands/bundle'; import type { JoinOptions } from './commands/join'; import type { LoginOptions, LogoutOptions } from './commands/auth'; import type { PushOptions } from './commands/push'; import type { StatsOptions } from './commands/stats'; import type { SplitOptions } from './commands/split'; import type { PreviewDocsOptions } from './commands/preview-docs'; import type { BuildDocsArgv } from './commands/build-docs/types'; import type { PushOptions as CMSPushOptions } from './reunite/commands/push'; import type { PushStatusOptions } from './reunite/commands/push-status'; import type { PreviewProjectOptions } from './commands/preview-project/types'; import type { TranslationsOptions } from './commands/translations'; import type { EjectOptions } from './commands/eject'; export type Totals = { errors: number; warnings: number; ignored: number; }; export type Entrypoint = { path: string; alias?: string; output?: string; }; export declare const outputExtensions: ReadonlyArray<BundleOutputFormat>; export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined; export declare const regionChoices: ReadonlyArray<Region>; export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | CMSPushOptions | LintOptions | BundleOptions | LoginOptions | LogoutOptions | PreviewDocsOptions | BuildDocsArgv | PushStatusOptions | PreviewProjectOptions | TranslationsOptions | EjectOptions | RespectOptions | GenerateArazzoFileOptions; export type VerifyConfigOptions = { config?: string; 'lint-config'?: RuleSeverity; }; export type Skips = { 'skip-rule'?: string[]; 'skip-decorator'?: string[]; 'skip-preprocessor'?: string[]; }; export type ConfigApis = Pick<Config, 'apis' | 'configFile'>; export type PushArguments = ArgumentsCamelCase<PushOptions & CMSPushOptions & { apis: string[]; }>;