Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SdkCommand<Context>

Type parameters

  • Context: BaseContext

Hierarchy

  • Command
    • SdkCommand

Properties

Methods

Properties

cwd

cwd: string = Option.String(`--cwd`, process.cwd(), {description: `The directory to run the command in`,})

integrations

integrations: string[] = Option.Rest()

verbose

verbose: boolean = Option.Boolean(`-v,--verbose`, false, {description: `Print all skipped dependencies`,})

Static paths

paths: never[][] = [Command.Default,]

Static usage

usage: object = Command.Usage({description: `generate editor SDKs and settings`,details: `This command generates a new directory, \`.yarn/sdks\`, which includes the base SDKs.When used without arguments, it:- throws an error on non-pnpified projects- updates all existing SDKs and editor settings on already-pnpified projectsThe optional integrations arguments are a set of supported integrations, or the keyword \`base\`.- When \`base\` is used, only the base SDKs will be generated. This is useful for when an editor is not yet supported and you plan to manage the settings yourself.- When a set of integrations is used (e.g. \`vscode\`, \`vim\`, ...), the base SDKs will be installed plus all the settings relevant to the corresponding environments (for example on VSCode it would set \`typescript.tsdk\`).The supported integrations at this time are: ${[...SUPPORTED_INTEGRATIONS.keys()].map(integration => `\`${integration}\``).join(`, `)}.**Note:** This command always updates the already-installed SDKs and editor settings, no matter which arguments are passed.For more details on Editor SDKs, please consult the dedicated page from our website: https://yarnpkg.com/getting-started/editor-sdks.`,examples: [[`Generate the base SDKs`,`$0 base`,], [`Generate the base SDKs and editor settings for supported editors`,`$0 vscode vim`,], [`Update all generated SDKs and editor settings`,`$0`,]],})

Type declaration

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc