Globals

Package plugin-essentials

`@yarnpkg/plugin-essentials`

This plugin adds support for various commands deemed essential to a package manager (yarn add, yarn remove, ...).

Install

This plugin is included by default in Yarn.

Namespaces

@yarnpkg/core

Enumerations

Classes

Interfaces

Hooks

Type aliases

Variables

Object literals

Type aliases

Algorithm

Algorithm: function

Type declaration

- (project: Project, patterns: Array<string>, opts: object): Promise<Array<Promise<PackageUpdate>>>
- Parameters
  - project: Project
  - patterns: Array<string>
  - opts: object
    - fetchOptions: FetchOptions
    - fetcher: Fetcher
    - resolveOptions: ResolveOptions
    - resolver: Resolver
  Returns Promise<Array<Promise<PackageUpdate>>>

BuildAndSavePluginsSpec

BuildAndSavePluginsSpec: object

Type declaration

context: CommandContext
noMinify: boolean

DedupeOptions

DedupeOptions: object

Type declaration

cache: Cache
patterns: Array<string>
report: Report
strategy: Strategy

ExtendedDefinition

ExtendedDefinition: ClipanionDefinition & object

FetchDescriptorFromOptions

FetchDescriptorFromOptions: object & object | object

NullableSuggestion

NullableSuggestion: object

Type declaration

descriptor: Descriptor | null
name: string
reason: string

PackageUpdate

PackageUpdate: object

Type declaration

currentPackage: Package
descriptor: Descriptor
resolvedPackage: Package
updatedPackage: Package

PrepareSpec

PrepareSpec: object

Type declaration

branch: string
context: CommandContext
force: boolean
repository: string

Results

Results: object

Type declaration

rejections: Array<Error>
suggestions: Array<NullableSuggestion>

Suggestion

Suggestion: object

Type declaration

descriptor: Descriptor
name: string
reason: string

Variables

Const ERROR_CODE_DOC_REGEXP

ERROR_CODE_DOC_REGEXP: RegExp = /## (?<code>YN[0-9]{4}) - `(?<name>[A-Z_]+)`\n\n(?<details>(?:.(?!##))+)/gs

Const MERGE_CONFLICT_START

MERGE_CONFLICT_START: "<<<<<<<" = `<<<<<<<`

Const PR_REGEXP

PR_REGEXP: RegExp = /^[0-9]+$/

Const REMOTE_REGISTRY

REMOTE_REGISTRY: "https://raw.githubusercontent.com/yarnpkg/berry/master/plugins.yml" = `https://raw.githubusercontent.com/yarnpkg/berry/master/plugins.yml`

Const SIMPLE_SEMVER

SIMPLE_SEMVER: RegExp = /^([\^~]?)[0-9]+(?:\.[0-9]+){0,2}(?:-\S+)?$/

Const WORKSPACE_PROTOCOL

WORKSPACE_PROTOCOL: "workspace:" = `workspace:`

Const acceptedStrategies

acceptedStrategies: Set<HIGHEST> = new Set(Object.values(Strategy))

Functions

applyModifier

applyModifier(descriptor: Descriptor, modifier: Modifier): Descriptor

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:93
Parameters
- descriptor: Descriptor
- modifier: Modifier
Returns Descriptor

autofixMergeConflicts

autofixMergeConflicts(configuration: Configuration, immutable: boolean): Promise<boolean>

- Defined in packages/plugin-essentials/sources/commands/install.ts:348
Parameters
- configuration: Configuration
- immutable: boolean
Returns Promise<boolean>

buildAndSavePlugin

buildAndSavePlugin(pluginSpec: string, __namedParameters: object, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/plugin/import/sources.ts:97
Parameters
- pluginSpec: string
- __namedParameters: object
  - context: object
    - colorDepth: number
    - cwd: PortablePath
    - env: Record<string, string | undefined>
    - plugins: PluginConfiguration
    - quiet: boolean
    - stderr: Writable
    - stdin: Readable
    - stdout: Writable
  - noMinify: boolean
- __namedParameters: object
  - project: Project
  - report: Report
  - target: string & object
Returns Promise<void>

Const buildWorkflow

buildWorkflow(__namedParameters: object, target: PortablePath): string[][]

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:34
Parameters
- __namedParameters: object
  - noMinify: boolean
  - plugins: string[]
- target: PortablePath
Returns string[][]

Const buildWorkflow

buildWorkflow(__namedParameters: object, target: PortablePath): string[][]

- Defined in packages/plugin-essentials/sources/commands/plugin/import/sources.ts:12
Parameters
- __namedParameters: object
  - noMinify: boolean
  - pluginName: string
- target: PortablePath
Returns string[][]

Const cloneWorkflow

cloneWorkflow(__namedParameters: object, target: PortablePath): string[][]

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:21
Parameters
- __namedParameters: object
  - branch: string
  - repository: string
- target: PortablePath
Returns string[][]

dedupe

dedupe(project: Project, __namedParameters: object): Promise<number>

- Defined in packages/plugin-essentials/sources/dedupeUtils.ts:148
Parameters
- project: Project
- __namedParameters: object
  - cache: Cache
  - patterns: string[]
  - report: Report
  - strategy: HIGHEST
Returns Promise<number>

explainPeerRequirements

explainPeerRequirements(peerRequirementsHash: string, project: Project, opts: object): Promise<0 | 1>

- Defined in packages/plugin-essentials/sources/commands/explain/peerRequirements.ts:97
Parameters
- peerRequirementsHash: string
- project: Project
- opts: object
  - stdout: Writable
Returns Promise<0 | 1>

extractDescriptorFromPath

extractDescriptorFromPath(path: PortablePath, __namedParameters: object): Promise<Descriptor>

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:168
Parameters
- path: PortablePath
- __namedParameters: object
  - cwd: string & object
  - workspace: Workspace
Returns Promise<Descriptor>

extractRangeModifier

extractRangeModifier(range: string, __namedParameters: object): string

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:87
Parameters
- range: string
- __namedParameters: object
  - project: Project
Returns string

fetchDescriptorFrom

fetchDescriptorFrom(ident: Ident, range: string, __namedParameters: object): Promise<null | Descriptor>

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:364
Parameters
- ident: Ident
- range: string
- __namedParameters: object
  - cache: Cache
  - modifier: undefined | CARET | TILDE | EXACT
  - preserveModifier: string | false | true
  - project: Project
  - workspace: Workspace
Returns Promise<null | Descriptor>

findProjectDescriptors

findProjectDescriptors(ident: Ident, __namedParameters: object): Promise<Map<string & object, object>>

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:119
Parameters
- ident: Ident
- __namedParameters: object
  - project: Project
  - target: Target
Returns Promise<Map<string & object, object>>

getAvailablePlugins

getAvailablePlugins(configuration: Configuration, version: string | null): Promise<object>

- Defined in packages/plugin-essentials/sources/commands/plugin/list.ts:8
Parameters
- configuration: Configuration
- version: string | null
Returns Promise<object>

getBranchRef

getBranchRef(branch: string): string

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:13
Parameters
- branch: string
Returns string

getCodeName

getCodeName(code: string): string

- Defined in packages/plugin-essentials/sources/commands/explain.ts:8
Parameters
- code: string
Returns string

getErrorCodeDetails

getErrorCodeDetails(configuration: Configuration): Promise<Map<string, string>>

- Defined in packages/plugin-essentials/sources/commands/explain.ts:14
Parameters
- configuration: Configuration
Returns Promise<Map<string, string>>

getModifier

getModifier(flags: object, project: Project): Modifier

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:75
Parameters
- flags: object
  - caret: boolean
  - exact: boolean
  - tilde: boolean
- project: Project
Returns Modifier

getSuggestedDescriptors

getSuggestedDescriptors(request: Descriptor, __namedParameters: object): Promise<Results>

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:207
Parameters
- request: Descriptor
- __namedParameters: object
  - cache: Cache
  - fixed: boolean
  - maxResults: number
  - modifier: Modifier
  - project: Project
  - strategies: Strategy[]
  - target: Target
  - workspace: Workspace
Returns Promise<Results>

makeTemporaryCache

makeTemporaryCache<T>(cb: function): Promise<T>

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:424
Type parameters
- T
Parameters
- cb: function
  - - (cache: Cache): Promise<T>
    - Parameters
      - cache: Cache
      Returns Promise<T>
Returns Promise<T>

makeWorkspaceDescriptor

makeWorkspaceDescriptor(workspace: Workspace, modifier: Modifier): Descriptor

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:115
Parameters
- workspace: Workspace
- modifier: Modifier
Returns Descriptor

prepareRepo

prepareRepo(spec: PrepareSpec, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:160
Parameters
- spec: PrepareSpec
- __namedParameters: object
  - configuration: Configuration
  - report: Report
  - target: string & object
Returns Promise<void>

resolveRange

resolveRange(configuration: Configuration, request: string): Promise<string>

- Defined in packages/plugin-essentials/sources/commands/set/version.ts:157
Parameters
- configuration: Configuration
- request: string
Returns Promise<string>

resolveTag

resolveTag(configuration: Configuration, request: "stable" | "canary"): Promise<string>

- Defined in packages/plugin-essentials/sources/commands/set/version.ts:168
Parameters
- configuration: Configuration
- request: "stable" | "canary"
Returns Promise<string>

runWorkflow

runWorkflow(workflow: Array<Array<string>>, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:123
Parameters
- workflow: Array<Array<string>>
- __namedParameters: object
  - configuration: Configuration
  - context: object
    - colorDepth: number
    - cwd: PortablePath
    - env: Record<string, string | undefined>
    - plugins: PluginConfiguration
    - quiet: boolean
    - stderr: Writable
    - stdin: Readable
    - stdout: Writable
  - target: string & object
Returns Promise<void>

savePlugin

savePlugin(pluginSpec: string, pluginBuffer: Buffer, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/plugin/import.ts:124
Parameters
- pluginSpec: string
- pluginBuffer: Buffer
- __namedParameters: object
  - checksum: boolean
  - project: Project
  - report: Report
Returns Promise<void>

setVersion

setVersion(configuration: Configuration, bundleVersion: string | null, fetchBuffer: function, __namedParameters: object): Promise<object>

- Defined in packages/plugin-essentials/sources/commands/set/version.ts:176
Parameters
- configuration: Configuration
- bundleVersion: string | null
- fetchBuffer: function
  - - (): Promise<Buffer>
    - Returns Promise<Buffer>
- __namedParameters: object
  - report: Report
  - useYarnPath: undefined | false | true
Returns Promise<object>

suggestTargetList

suggestTargetList(workspace: Workspace, ident: Ident, __namedParameters: object): (REGULAR | DEVELOPMENT | PEER)[]

- Defined in packages/plugin-essentials/sources/commands/add.ts:333
Parameters
- workspace: Workspace
- ident: Ident
- __namedParameters: object
  - dev: boolean
  - optional: boolean
  - peer: boolean
  - preferDev: boolean
Returns (REGULAR | DEVELOPMENT | PEER)[]

toWorkspaceModifier

toWorkspaceModifier(modifier: Modifier): WorkspaceModifier

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:102
Parameters
- modifier: Modifier
Returns WorkspaceModifier

updatePlugins

updatePlugins(context: BuildAndSavePluginsSpec, version: string, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:187
Parameters
- context: BuildAndSavePluginsSpec
- version: string
- __namedParameters: object
  - project: Project
  - report: Report
  - target: string & object
Returns Promise<void>

Const updateWorkflow

updateWorkflow(__namedParameters: object): string[][]

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:28
Parameters
- __namedParameters: object
  - branch: string
Returns string[][]

whyRecursive

whyRecursive(project: Project, identHash: IdentHash, __namedParameters: object): object

- Defined in packages/plugin-essentials/sources/commands/why.ts:107
Parameters
- project: Project
- identHash: IdentHash
- __namedParameters: object
  - configuration: Configuration
  - peers: boolean
Returns object
- Optional children?: Array<TreeNode> | TreeMap
- Optional label?: undefined | string
- Optional value?: formatUtils.Tuple

whySimple

whySimple(project: Project, identHash: IdentHash, __namedParameters: object): object

- Defined in packages/plugin-essentials/sources/commands/why.ts:64
Parameters
- project: Project
- identHash: IdentHash
- __namedParameters: object
  - configuration: Configuration
  - peers: boolean
Returns object
- Optional children?: Array<TreeNode> | TreeMap
- Optional label?: undefined | string
- Optional value?: formatUtils.Tuple

Object literals

Const DEDUPE_ALGORITHMS

DEDUPE_ALGORITHMS: object

highest

highest(project: Project, patterns: string[], __namedParameters: object): Promise<Promise<object>[]>

- Defined in packages/plugin-essentials/sources/dedupeUtils.ts:33
Parameters
- project: Project
- patterns: string[]
- __namedParameters: object
  - fetchOptions: object & object
  - fetcher: Fetcher
  - resolveOptions: object & object
  - resolver: Resolver
Returns Promise<Promise<object>[]>

Const plugin

plugin: object

commands

commands: (ClipanionCommand | EntryCommand | NodeCommand | RunIndexCommand)[] = [CacheCleanCommand,ConfigGetCommand,ConfigSetCommand,ConfigUnsetCommand,SetResolutionCommand,SetVersionSourcesCommand,SetVersionCommand,WorkspacesListCommand,ClipanionCommand,HelpCommand,EntryCommand,VersionCommand,AddCommand,BinCommand,ConfigCommand,DedupeCommand,ExecCommand,ExplainPeerRequirementsCommand,ExplainCommand,InfoCommand,YarnCommand,LinkCommand,UnlinkCommand,NodeCommand,PluginCheckCommand,PluginImportSourcesCommand,PluginImportCommand,PluginRemoveCommand,PluginListCommand,PluginRuntimeCommand,RebuildCommand,RemoveCommand,RunIndexCommand,RunCommand,UpCommand,WhyCommand,WorkspaceCommand,]

configuration

configuration: object

defaultSemverRangePrefix

defaultSemverRangePrefix: object

default

default: Modifier = suggestUtils.Modifier.CARET

description

description: string = `The default save prefix: '^', '~' or ''`

type

type: STRING = SettingsType.STRING

values

values: string[] = [`^`, `~`, ``]

enableImmutableInstalls

enableImmutableInstalls: object

default

default: boolean = isCI

description

description: string = `If true (the default on CI), prevents the install command from modifying the lockfile`

type

type: BOOLEAN = SettingsType.BOOLEAN

preferReuse

preferReuse: object

default

default: boolean = false

description

description: string = `If true, \`yarn add\` will attempt to reuse the most common dependency range in other workspaces.`

type

type: BOOLEAN = SettingsType.BOOLEAN

Package plugin-essentials

@yarnpkg/plugin-essentials

Install

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Algorithm

Type declaration

Parameters

project: Project

patterns: Array<string>

opts: object

fetchOptions: FetchOptions

fetcher: Fetcher

resolveOptions: ResolveOptions

resolver: Resolver

Returns Promise<Array<Promise<PackageUpdate>>>

BuildAndSavePluginsSpec

Type declaration

context: CommandContext

noMinify: boolean

DedupeOptions

Type declaration

cache: Cache

patterns: Array<string>

report: Report

strategy: Strategy

ExtendedDefinition

FetchDescriptorFromOptions

NullableSuggestion

Type declaration

descriptor: Descriptor | null

name: string

reason: string

PackageUpdate

Type declaration

currentPackage: Package

descriptor: Descriptor

resolvedPackage: Package

updatedPackage: Package

PrepareSpec

Type declaration

branch: string

context: CommandContext

force: boolean

repository: string

Results

Type declaration

rejections: Array<Error>

suggestions: Array<NullableSuggestion>

Suggestion

Type declaration

descriptor: Descriptor

name: string

reason: string

Tags

Type declaration

latest: Record<string, string>

tags: Array<string>

Variables

Const ERROR_CODE_DOC_REGEXP

Const MERGE_CONFLICT_START

Const PR_REGEXP

Const REMOTE_REGISTRY

Const SIMPLE_SEMVER

Const WORKSPACE_PROTOCOL

Const acceptedStrategies

Functions

applyModifier

Parameters

descriptor: Descriptor

modifier: Modifier

Returns Descriptor

autofixMergeConflicts

`@yarnpkg/plugin-essentials`