Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Type aliases

Suggestion

Suggestion: object

Type declaration

Suggestion

Suggestion: object

Type declaration

Variables

Const pluginCommands

pluginCommands: Map<string, string[][]> = new Map([[`constraints`, [[`constraints`, `query`],[`constraints`, `source`],[`constraints`],]],[`interactive-tools`, [[`upgrade-interactive`],]],[`stage`, [[`stage`],]],[`version`, [[`version`, `apply`],[`version`, `check`],[`version`],]],[`workspace-tools`, [[`workspaces`, `foreach`],[`workspace`],]],])

Functions

applyModifier

applyModifier

extractDescriptorFromPath

extractDescriptorFromPath

extractRangeModifier

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

extractRangeModifier

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

fetchDescriptorFrom

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

fetchDescriptorFrom

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

findProjectDescriptors

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

findProjectDescriptors

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

getAvailablePlugins

  • getAvailablePlugins(configuration: Configuration): Promise<object>

getModifier

getModifier

getSuggestedDescriptors

  • getSuggestedDescriptors(request: Descriptor, __namedParameters: object): Promise<(object | object)[]>

getSuggestedDescriptors

  • getSuggestedDescriptors(request: Descriptor, __namedParameters: object): Promise<(object | object)[]>

setVersion

  • setVersion(project: Project, bundleVersion: string | null, bundleBuffer: Buffer, __namedParameters: object): Promise<void>

Object literals

Const plugin

plugin: object

commands

commands: (ClipanionCommand | EntryCommand | NodeCommand | RemoveCommand | RunCommand | RunCommand | UpCommand | WorkspaceCommand)[] = [cleanCache,getConfig,setConfig,setResolutionPolicy,setVersionFromSources,setVersionPolicy,listWorkspaces,clipanionEntry,helpEntry,runEntry,versionEntry,add,bin,config,install,link,node,pluginImport,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

Generated using TypeDoc