Globals

Package plugin-workspace-tools

`@yarnpkg/plugin-workspace-tools`

This plugin adds support for various workspace-related commands.

Install

yarn plugin import workspace-tools

Commands

yarn workspaces foreach

Classes

Type aliases

GetPrefixOptions

Functions

Object literals

plugin

Type aliases

GetPrefixOptions

GetPrefixOptions: object

Type declaration

commandIndex: number
configuration: Configuration
verbose: boolean

Functions

createStream

createStream(report: Report, __namedParameters: object): []

- Defined in packages/plugin-workspace-tools/sources/commands/foreach.ts:345
Parameters
- report: Report
- __namedParameters: object
  - interlaced: boolean
  - prefix: null | string
Returns []

getPrefix

getPrefix(workspace: Workspace, __namedParameters: object): null | string

- Defined in packages/plugin-workspace-tools/sources/commands/foreach.ts:378
Parameters
- workspace: Workspace
- __namedParameters: object
  - commandIndex: number
  - configuration: Configuration
  - verbose: boolean
Returns null | string

Const getWorkspaceChildrenRecursive

getWorkspaceChildrenRecursive(rootWorkspace: Workspace, project: Project): Array<Workspace>

- Defined in packages/plugin-workspace-tools/sources/commands/foreach.ts:20
Retrieves all the child workspaces of a given root workspace recursively

Parameters
- rootWorkspace: Workspace
  
  root workspace
- project: Project
  
  project
Returns Array<Workspace>

all the child workspaces

Const getWorkspaceDependenciesRecursive

getWorkspaceDependenciesRecursive(rootWorkspace: Workspace, project: Project): Set<Workspace>

- Defined in packages/plugin-workspace-tools/sources/commands/foreach.ts:39
Find workspaces marked as dependencies/devDependencies of the current workspace recursively.

Parameters
- rootWorkspace: Workspace
  
  root workspace
- project: Project
  
  project
Returns Set<Workspace>

all the workspaces marked as dependencies

Package plugin-workspace-tools

@yarnpkg/plugin-workspace-tools

Install

Commands

Classes

Type aliases

Functions

Object literals

Type aliases

GetPrefixOptions

Type declaration

commandIndex: number

configuration: Configuration

verbose: boolean

Functions

createStream

Parameters

report: Report

__namedParameters: object

interlaced: boolean

prefix: null | string

Returns []

getPrefix

Parameters

workspace: Workspace

__namedParameters: object

commandIndex: number

configuration: Configuration

verbose: boolean

Returns null | string

Const getWorkspaceChildrenRecursive

Parameters

rootWorkspace: Workspace

project: Project

Returns Array<Workspace>

Const getWorkspaceDependenciesRecursive

Parameters

rootWorkspace: Workspace

project: Project

Returns Set<Workspace>

Object literals

Const plugin

commands

`@yarnpkg/plugin-workspace-tools`