Globals

Package plugin-pnp

`@yarnpkg/plugin-pnp`

This plugin adds support for installing packages according to the Plug'n'Play specification.

Install

This plugin is included by default in Yarn.

Namespaces

@yarnpkg/core

Classes

Type aliases

Variables

Functions

Object literals

plugin

Type aliases

CustomPackageData

CustomPackageData: UnboxPromise<ReturnType<typeof extractCustomPackageData>>

ExtractBuildScriptDataRequirements

ExtractBuildScriptDataRequirements: object

Type declaration

manifest: Pick<Manifest, "scripts">
misc: object
- hasBindingGyp: boolean

UnboxPromise

UnboxPromise<T>: T extends Promise<infer U> ? U : never

Type parameters

T: Promise<any>

Variables

Const FORCED_EXTRACT_FILETYPES

FORCED_EXTRACT_FILETYPES: Set<string> = new Set([// Windows can't execute exe files inside zip archives`.exe`,// May be used for some binaries on Linux; https://askubuntu.com/a/174356`.bin`,// The c/c++ compiler can't read files from zip archives`.h`, `.hh`, `.hpp`, `.c`, `.cc`, `.cpp`,// The java runtime can't read files from zip archives`.java`, `.jar`,// Node opens these through dlopen`.node`,])

Const FORCED_UNPLUG_PACKAGES

FORCED_UNPLUG_PACKAGES: Set<string & object> = new Set([// Contains native binariesstructUtils.makeIdent(null, `open`).identHash,structUtils.makeIdent(null, `opn`).identHash,])

Functions

checkAndReportManifestCompatibility

checkAndReportManifestCompatibility(pkg: Package, label: string, __namedParameters: object): boolean

- Defined in packages/plugin-pnp/sources/jsInstallUtils.ts:8
Parameters
- pkg: Package
- label: string
- __namedParameters: object
  - configuration: Configuration
  - report: undefined | null | Report
Returns boolean

checkManifestCompatibility

checkManifestCompatibility(pkg: Package): boolean

- Defined in packages/plugin-pnp/sources/jsInstallUtils.ts:4
Parameters
- pkg: Package
Returns boolean

extractBuildScripts

extractBuildScripts(pkg: Package, requirements: ExtractBuildScriptDataRequirements, dependencyMeta: DependencyMeta, __namedParameters: object): [BuildType, string][]

- Defined in packages/plugin-pnp/sources/jsInstallUtils.ts:24
Parameters
- pkg: Package
- requirements: ExtractBuildScriptDataRequirements
- dependencyMeta: DependencyMeta
- __namedParameters: object
  - configuration: Configuration
  - report: undefined | null | Report
Returns [BuildType, string][]

extractCustomPackageData

extractCustomPackageData(fetchResult: FetchResult): Promise<object>

- Defined in packages/plugin-pnp/sources/PnpLinker.ts:507
Parameters
- fetchResult: FetchResult
Returns Promise<object>

getExtractHint

getExtractHint(fetchResult: FetchResult): boolean

- Defined in packages/plugin-pnp/sources/jsInstallUtils.ts:73
Parameters
- fetchResult: FetchResult
Returns boolean

Const getPnpPath

getPnpPath(project: Project): object

- Defined in packages/plugin-pnp/sources/index.ts:15
Parameters
- project: Project
Returns object
- cjs: string & object
- cjsLegacy: string & object
- esmLoader: string & object

getUnpluggedPath

getUnpluggedPath(locator: Locator, __namedParameters: object): string & object

- Defined in packages/plugin-pnp/sources/pnpUtils.ts:4
Parameters
- locator: Locator
- __namedParameters: object
  - configuration: Configuration
Returns string & object

hasBindingGyp

hasBindingGyp(fetchResult: FetchResult): boolean

- Defined in packages/plugin-pnp/sources/jsInstallUtils.ts:77
Parameters
- fetchResult: FetchResult
Returns boolean

normalizeDirectoryPath

normalizeDirectoryPath(root: PortablePath, folder: PortablePath): string & object

- Defined in packages/plugin-pnp/sources/PnpLinker.ts:494
Parameters
- root: PortablePath
- folder: PortablePath
Returns string & object

populateYarnPaths

populateYarnPaths(project: Project, definePath: function): Promise<void>

- Defined in packages/plugin-pnp/sources/index.ts:52
Parameters
- project: Project
- definePath: function
  - - (path: PortablePath | null): void
    - Parameters
      - path: PortablePath | null
      Returns void
Returns Promise<void>

Const quotePathIfNeeded

quotePathIfNeeded(path: string): string

- Defined in packages/plugin-pnp/sources/index.ts:23
Parameters
- path: string
Returns string

setupScriptEnvironment

setupScriptEnvironment(project: Project, env: object, makePathWrapper: function): Promise<void>

- Defined in packages/plugin-pnp/sources/index.ts:27
Parameters
- project: Project
- env: object
  - [key: string]: string
- makePathWrapper: function
  - - (name: string, argv0: string, args: Array<string>): Promise<void>
    - Parameters
      - name: string
      - argv0: string
      - args: Array<string>
      Returns Promise<void>
Returns Promise<void>

Object literals

Const plugin

plugin: object

commands

commands: UnplugCommand[] = [unplug,]

linkers

linkers: PnpLinker[] = [PnpLinker,]

configuration

configuration: object

nodeLinker

nodeLinker: object

default

default: string = `pnp`

description

description: string = `The linker used for installing Node packages, one of: "pnp", "node-modules"`

type

type: STRING = SettingsType.STRING

pnpDataPath

pnpDataPath: object

default

default: string = `./.pnp.data.json`

description

description: string = `Path of the file where the PnP data (used by the loader) must be written`

type

type: ABSOLUTE_PATH = SettingsType.ABSOLUTE_PATH

pnpEnableEsmLoader

pnpEnableEsmLoader: object

default

default: boolean = false

description

description: string = `If true, Yarn will generate an ESM loader (\`.pnp.loader.mjs\`). If this is not explicitly set Yarn tries to automatically detect whether ESM support is required.`

type

type: BOOLEAN = SettingsType.BOOLEAN

pnpEnableInlining

pnpEnableInlining: object

default

default: boolean = true

description

description: string = `If true, the PnP data will be inlined along with the generated loader`

type

type: BOOLEAN = SettingsType.BOOLEAN

pnpFallbackMode

pnpFallbackMode: object

default

default: string = `dependencies-only`

description

description: string = `If true, the generated PnP loader will follow the top-level fallback rule`

type

type: STRING = SettingsType.STRING

pnpIgnorePatterns

pnpIgnorePatterns: object

default

default: never[] = []

description

description: string = `Array of glob patterns; files matching them will use the classic resolution`

isArray

isArray: true = true

type

type: STRING = SettingsType.STRING

pnpMode

pnpMode: object

default

default: string = `strict`

description

description: string = `If 'strict', generates standard PnP maps. If 'loose', merges them with the n_m resolution.`

type

type: STRING = SettingsType.STRING

pnpShebang

pnpShebang: object

default

default: string = `#!/usr/bin/env node`

description

description: string = `String to prepend to the generated PnP script`

type

type: STRING = SettingsType.STRING

pnpUnpluggedFolder

pnpUnpluggedFolder: object

default

default: string = `./.yarn/unplugged`

description

description: string = `Folder where the unplugged packages must be stored`

type

type: ABSOLUTE_PATH = SettingsType.ABSOLUTE_PATH

hooks

hooks: object

populateYarnPaths

populateYarnPaths: populateYarnPaths

setupScriptEnvironment

setupScriptEnvironment: setupScriptEnvironment

Package plugin-pnp

@yarnpkg/plugin-pnp

Install

Namespaces

Classes

Type aliases

Variables

Functions

Object literals

Type aliases

CustomPackageData

ExtractBuildScriptDataRequirements

Type declaration

manifest: Pick<Manifest, "scripts">

misc: object

hasBindingGyp: boolean

UnboxPromise

Type parameters

T: Promise<any>

Variables

Const FORCED_EXTRACT_FILETYPES

Const FORCED_UNPLUG_PACKAGES

Functions

checkAndReportManifestCompatibility

Parameters

pkg: Package

label: string

__namedParameters: object

configuration: Configuration

report: undefined | null | Report

Returns boolean

checkManifestCompatibility

Parameters

pkg: Package

Returns boolean

extractBuildScripts

Parameters

pkg: Package

requirements: ExtractBuildScriptDataRequirements

dependencyMeta: DependencyMeta

__namedParameters: object

configuration: Configuration

report: undefined | null | Report

Returns [BuildType, string][]

extractCustomPackageData

Parameters

fetchResult: FetchResult

Returns Promise<object>

getExtractHint

Parameters

fetchResult: FetchResult

Returns boolean

Const getPnpPath

Parameters

project: Project

Returns object

cjs: string & object

cjsLegacy: string & object

esmLoader: string & object

getUnpluggedPath

Parameters

locator: Locator

__namedParameters: object

configuration: Configuration

Returns string & object

hasBindingGyp

Parameters

fetchResult: FetchResult

Returns boolean

normalizeDirectoryPath

Parameters

root: PortablePath

folder: PortablePath

Returns string & object

populateYarnPaths

Parameters

project: Project

definePath: function

Parameters

path: PortablePath | null

`@yarnpkg/plugin-pnp`