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.

Enumerations

Type aliases

ClipanionDefinition

ClipanionDefinition: ReturnType<Cli["definitions"]>[number]

DedupeAlgorithm

DedupeAlgorithm: function

Type declaration

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

DedupePromise

DedupePromise: Promise<object | null>

DedupeSpec

DedupeSpec: object

Type declaration

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

ExtendedDefinition

ExtendedDefinition: ClipanionDefinition & object

FetchReleasesOptions

FetchReleasesOptions: object

Type declaration

includePrereleases: boolean

NullableSuggestion

NullableSuggestion: object

Type declaration

descriptor: Descriptor | null
name: string
reason: string

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 MERGE_CONFLICT_ANCESTOR

MERGE_CONFLICT_ANCESTOR: "|||||||" = `|||||||`

Const MERGE_CONFLICT_END

MERGE_CONFLICT_END: ">>>>>>>" = `>>>>>>>`

Const MERGE_CONFLICT_SEP

MERGE_CONFLICT_SEP: "=======" = `=======`

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 acceptedStrategies

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

Functions

Const BUILD_WORKFLOW

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

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

Const BUILD_WORKFLOW

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

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

Const CLONE_WORKFLOW

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

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

Const UPDATE_WORKFLOW

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

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

applyModifier

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

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

autofixMergeConflicts

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

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

convertMapsToObjects

convertMapsToObjects(arg: unknown): unknown

- Defined in packages/plugin-essentials/sources/commands/config/get.ts:96
Converts Maps to Objects recursively.

Parameters
- arg: unknown
Returns unknown

dedupe

dedupe(__namedParameters: object): Promise<number>

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

extractDescriptorFromPath

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

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:143
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:79
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:328
Parameters
- ident: Ident
- range: string
- __namedParameters: object
  - cache: Cache
  - 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:94
Parameters
- ident: Ident
- __namedParameters: object
  - project: Project
  - target: Target
Returns Promise<Map<string & object, object>>

getAvailablePlugins

getAvailablePlugins(configuration: Configuration): Promise<object>

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

getBranchRef

getBranchRef(branch: string): string

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

getModifier

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

- Defined in packages/plugin-essentials/sources/suggestUtils.ts:67
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:182
Parameters
- request: Descriptor
- __namedParameters: object
  - cache: Cache
  - maxResults: number
  - modifier: Modifier
  - project: Project
  - strategies: Strategy[]
  - target: Target
  - workspace: Workspace
Returns Promise<Results>

getVariants

getVariants(file: string): string[]

- Defined in packages/plugin-essentials/sources/commands/install.ts:340
Parameters
- file: string
Returns string[]

makeTemporaryCache

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

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

prepareRepo

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

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

runWorkflow

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

- Defined in packages/plugin-essentials/sources/commands/set/version/sources.ts:102
Parameters
- workflow: Array<Array<string>>
- __namedParameters: object
  - configuration: Configuration
  - context: object
    - cwd: PortablePath
    - 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:98
Parameters
- pluginSpec: string
- pluginBuffer: Buffer
- __namedParameters: object
  - project: Project
  - report: Report
Returns Promise<void>

setVersion

setVersion(configuration: Configuration, bundleVersion: string | null, bundleBuffer: Buffer, __namedParameters: object): Promise<void>

- Defined in packages/plugin-essentials/sources/commands/set/version.ts:77
Parameters
- configuration: Configuration
- bundleVersion: string | null
- bundleBuffer: Buffer
- __namedParameters: object
  - report: Report
Returns Promise<void>

suggestTarget

suggestTarget(workspace: Workspace, ident: Ident, __namedParameters: object): REGULAR | DEVELOPMENT | PEER

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

whyRecursive

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

- Defined in packages/plugin-essentials/sources/commands/why.ts:104
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:61
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<null | object>[]>

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

Const plugin

plugin: object

commands

commands: (ClipanionCommand | EntryCommand | DedupeCommand | NodeCommand | RunCommand | WorkspaceCommand)[] = [cleanCache,getConfig,setConfig,setResolutionPolicy,setVersionFromSources,setVersionPolicy,listWorkspaces,clipanionEntry,helpEntry,runEntry,versionEntry,add,bin,config,dedupe,exec,info,install,link,node,pluginImportSources,pluginImport,pluginRemove,pluginList,pluginRuntime,rebuild,remove,runIndex,run,up,why,workspace,]

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

enableImmutableInstalls

enableImmutableInstalls: object

default

default: boolean = false

description

description: string = `If true, prevents the install command from modifying the lockfile`

type

type: BOOLEAN = SettingsType.BOOLEAN

Package plugin-essentials

@yarnpkg/plugin-essentials

Install

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ClipanionDefinition

DedupeAlgorithm

Type declaration

Parameters

project: Project

patterns: Array<string>

opts: object

fetchOptions: FetchOptions

fetcher: Fetcher

resolveOptions: ResolveOptions

resolver: Resolver

Returns Promise<Array<DedupePromise>>

DedupePromise

DedupeSpec

Type declaration

cache: Cache

patterns: Array<string>

project: Project

report: Report

strategy: Strategy

ExtendedDefinition

FetchReleasesOptions

Type declaration

includePrereleases: boolean

NullableSuggestion

Type declaration

descriptor: Descriptor | null

name: string

reason: string

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

Variables

Const MERGE_CONFLICT_ANCESTOR

Const MERGE_CONFLICT_END

Const MERGE_CONFLICT_SEP

Const MERGE_CONFLICT_START

Const PR_REGEXP

Const REMOTE_REGISTRY

Const SIMPLE_SEMVER

Const acceptedStrategies

Functions

Const BUILD_WORKFLOW

Parameters

__namedParameters: object

noMinify: boolean

plugins: string[]

target: PortablePath

Returns string[][]

Const BUILD_WORKFLOW

Parameters

__namedParameters: object

noMinify: boolean

pluginName: string

target: PortablePath

Returns string[][]

Const CLONE_WORKFLOW

`@yarnpkg/plugin-essentials`