@shopify/cli-kit
Version:
A set of utilities, interfaces, and models that are common across all the platform features
58 lines (57 loc) • 2.22 kB
TypeScript
import { Command } from '@oclif/core';
import { OutputFlags, Input, ParserOutput, FlagInput, OutputArgs } from '@oclif/core/parser';
export type ArgOutput = OutputArgs<any>;
export type FlagOutput = OutputFlags<any>;
declare abstract class BaseCommand extends Command {
static baseFlags: FlagInput<{}>;
static descriptionWithoutMarkdown(): string | undefined;
static analyticsNameOverride(): string | undefined;
static analyticsStopCommand(): string | undefined;
catch(error: Error & {
skipOclifErrorHandling: boolean;
}): Promise<void>;
protected init(): Promise<unknown>;
protected showNpmFlagWarning(): void;
protected exitWithTimestampWhenEnvVariablePresent(): void;
protected parse<TFlags extends FlagOutput & {
path?: string;
verbose?: boolean;
}, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(options?: Input<TFlags, TGlobalFlags, TArgs>, argv?: string[]): Promise<ParserOutput<TFlags, TGlobalFlags, TArgs> & {
argv: string[];
}>;
protected environmentsFilename(): string | undefined;
protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
private resultWithEnvironment;
/**
* Tries to load an environment to forward to the command. If no environment
* is specified it will try to load a default environment.
*/
private loadEnvironmentForCommand;
}
export declare function addFromParsedFlags(flags: {
path?: string;
verbose?: boolean;
}): Promise<void>;
/**
* Strips the defaults from configured flags. For example, if flags contains:
*
* ```
* someFlag: Flags.boolean({
* description: 'some flag',
* default: false
* })
* ```
*
* it becomes:
*
* ```
* someFlag: Flags.boolean({
* description: 'some flag'
* })
* ```
*
* If we parse using this configuration, the only specified flags will be those
* the user actually passed on the command line.
*/
export declare function noDefaultsOptions<TFlags extends FlagOutput, TGlobalFlags extends FlagOutput, TArgs extends ArgOutput>(options: Input<TFlags, TGlobalFlags, TArgs> | undefined): Input<TFlags, TGlobalFlags, TArgs> | undefined;
export default BaseCommand;