@yarnpkg/cli

Index

Classes

• BaseCommand
• WorkspaceRequiredError

Functions

• getCli
• getDynamicLibs
• getPluginConfiguration
• openWorkspace
• runExit

Type Aliases

• CommandContext
• YarnCli

Variables

• pluginCommands

Functions

getCli

• getCli(__namedParameters?: { cwd?: PortablePath; pluginConfiguration?: PluginConfiguration }): Promise<Cli<CommandContext> & { defaultContext: { cwd: PortablePath; plugins: PluginConfiguration; quiet: boolean; stderr: WriteStream & {}; stdin: ReadStream & {}; stdout: WriteStream & {} } }>

• Parameters

  • __namedParameters: { cwd?: PortablePath; pluginConfiguration?: PluginConfiguration } = {}

  Returns Promise<Cli<CommandContext> & { defaultContext: { cwd: PortablePath; plugins: PluginConfiguration; quiet: boolean; stderr: WriteStream & {}; stdin: ReadStream & {}; stdout: WriteStream & {} } }>

getDynamicLibs

• getDynamicLibs(): Map<string, any>

• Returns Map<string, any>

getPluginConfiguration

• getPluginConfiguration(): PluginConfiguration

• Returns PluginConfiguration

openWorkspace

• openWorkspace(configuration: Configuration, cwd: PortablePath): Promise<Workspace>

• Parameters

  • configuration: Configuration

  • cwd: PortablePath

  Returns Promise<Workspace>

runExit

• runExit(argv: string[], __namedParameters: { cwd: PortablePath; pluginConfiguration: PluginConfiguration; selfPath: null | PortablePath }): Promise<void>

• Parameters

  • argv: string[]

  • __namedParameters: { cwd: PortablePath; pluginConfiguration: PluginConfiguration; selfPath: null | PortablePath }

  Returns Promise<void>

Type Aliases

CommandContext

CommandContext: { colorDepth: number; cwd: PortablePath; env: Record<string, string | undefined>; plugins: PluginConfiguration; quiet: boolean; stderr: Writable; stdin: Readable; stdout: Writable }

Type declaration

• colorDepth: number

• cwd: PortablePath

• env: Record<string, string | undefined>

• plugins: PluginConfiguration

• quiet: boolean

• stderr: Writable

• stdin: Readable

• stdout: Writable

YarnCli

YarnCli: ReturnType<typeof getBaseCli>

Variables

constpluginCommands

pluginCommands: Map<string, string[]> = ...