Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkspacesListCommand

Hierarchy

Properties

cwd

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

json

json: boolean = Option.Boolean(`--json`, false, {description: `Format the output as an NDJSON stream`,})

noPrivate

noPrivate: undefined | false | true = Option.Boolean(`--no-private`, {description: `Exclude workspaces that have the private field set to true`,})

recursive

recursive: boolean = Option.Boolean(`-R,--recursive`, false, {description: `Find packages via dependencies/devDependencies instead of using the workspaces field`,})

since

since: undefined | string | false | true = Option.String(`--since`, {description: `Only include workspaces that have been changed since the specified ref.`,tolerateBoolean: true,})

verbose

verbose: boolean = Option.Boolean(`-v,--verbose`, false, {description: `Also return the cross-dependencies between workspaces`,})

Static paths

paths: string[][] = [[`workspaces`, `list`],]

Static usage

usage: Usage = Command.Usage({category: `Workspace-related commands`,description: `list all available workspaces`,details: `This command will print the list of all workspaces in the project.- If \`--since\` is set, Yarn will only list workspaces that have been modified since the specified ref. By default Yarn will use the refs specified by the \`changesetBaseRefs\` configuration option.- If \`-R,--recursive\` is set, Yarn will find workspaces to run the command on by recursively evaluating \`dependencies\` and \`devDependencies\` fields, instead of looking at the \`workspaces\` fields.- If \`--no-private\` is set, Yarn will not list any workspaces that have the \`private\` field set to \`true\`.- If both the \`-v,--verbose\` and \`--json\` options are set, Yarn will also return the cross-dependencies between each workspaces (useful when you wish to automatically generate Buck / Bazel rules).`,})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc