Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginDlSourcesCommand

Hierarchy

Properties

branch

branch: string = Option.String(`--branch`, `master`, {description: `The branch of the repository that should be cloned`,})

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

force

force: boolean = Option.Boolean(`-f,--force`, false, {description: `Always clone the repository instead of trying to fetch the latest commits`,})

installPath

installPath: undefined | string = Option.String(`--path`, {description: `The path where the repository should be cloned to`,})

name

name: string = Option.String()

noMinify

noMinify: boolean = Option.Boolean(`--no-minify`, false, {description: `Build a plugin for development (debugging) - non-minified and non-mangled`,})

repository

repository: string = Option.String(`--repository`, `https://github.com/yarnpkg/berry.git`, {description: `The repository that should be cloned`,})

Static paths

paths: string[][] = [[`plugin`, `import`, `from`, `sources`],]

Static usage

usage: Usage = Command.Usage({category: `Plugin-related commands`,description: `build a plugin from sources`,details: `This command clones the Yarn repository into a temporary folder, builds the specified contrib plugin and updates the configuration to reference it in further CLI invocations.The plugins can be referenced by their short name if sourced from the official Yarn repository.`,examples: [[`Build and activate the "@yarnpkg/plugin-exec" plugin`,`$0 plugin import from sources @yarnpkg/plugin-exec`,], [`Build and activate the "@yarnpkg/plugin-exec" plugin (shorthand)`,`$0 plugin import from sources exec`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc