.pnpmfile.cjs

pnpm ti consente di agganciarti direttamente al processo di installazione tramite funzioni speciali (hook). Hooks can be declared in a file called .pnpmfile.cjs.

By default, .pnpmfile.cjs should be located in the same directory as the lockfile. For instance, in a workspace with a shared lockfile, .pnpmfile.cjs should be in the root of the monorepo.

Hooks

TL;DR

Funzione hook	Processo	Utilizzi
hooks.readPackage(pkg, context): pkg	Chiamato dopo che pnpm ha analizzato il manifesto del pacchetto della dipendenza	Allows you to mutate a dependency's package.json
hooks.afterAllResolved(lockfile, context): lockfile	Chiamato dopo che le dipendenze sono state risolte.	Consente di modificare il file di blocco.

hooks.readPackage(pkg, context): pkg | Promise<pkg>

Allows you to mutate a dependency's package.json after parsing and prior to resolution. Queste mutazioni non vengono salvate nel filesystem, tuttavia, interessano ciò viene risolto nel file di blocco e quindi ciò che viene installato.

Note that you will need to delete the pnpm-lock.yaml if you have already resolved the dependency you want to modify.

tip

If you need changes to package.json saved to the filesystem, you need to use the pnpm patch command and patch the package.json file. This might be useful if you want to remove the bin field of a dependency for instance.

Argomenti

• pkg - The manifest of the package. Either the response from the registry or the package.json content.
• context - Context object for the step. Method #log(msg) allows you to use a debug log for the step.

Utilizzo

Example .pnpmfile.cjs (changes the dependencies of a dependency):

function readPackage(pkg, context) {
  // Override the manifest of foo@1.x after downloading it from the registry
  if (pkg.name === 'foo' && pkg.version.startsWith('1.')) {
    // Replace bar@x.x.x with bar@2.0.0
    pkg.dependencies = {
      ...pkg.dependencies,
      bar: '^2.0.0'
    }
    context.log('bar@1 => bar@2 in dependencies of foo')
  }
  
  // This will change any packages using baz@x.x.x to use baz@1.2.3
  if (pkg.dependencies.baz) {
    pkg.dependencies.baz = '1.2.3';
  }
  
  return pkg
}

module.exports = {
  hooks: {
    readPackage
  }
}

Limitazioni conosciute

Removing the scripts field from a dependency's manifest via readPackage will not prevent pnpm from building the dependency. When building a dependency, pnpm reads the package.json of the package from the package's archive, which is not affected by the hook. In order to ignore a package's build, use the pnpm.neverBuiltDependencies field.

hooks.afterAllResolved(lockfile, context): lockfile | Promise<lockfile>

Consente di modificare l'output del file di blocco prima che venga serializzato.

Argomenti

• lockfile - The lockfile resolutions object that is serialized to pnpm-lock.yaml.
• context - Context object for the step. Method #log(msg) allows you to use a debug log for the step.

Esempio di utilizzo

.pnpmfile.cjs

function afterAllResolved(lockfile, context) {
  // ...
  return lockfile
}

module.exports = {
  hooks: {
    afterAllResolved
  }
}

Limitazioni note

Non ce ne sono: tutto ciò che può essere fatto con il file di blocco può essere modificato tramite questa funzione e puoi persino estendere la funzionalità del file di blocco.

Configurazione correlata

ignore-pnpmfile

• Default: false
• Type: Boolean

.pnpmfile.cjs will be ignored. Useful together with --ignore-scripts when you want to make sure that no script gets executed during install.

pnpmfile

• Default: .pnpmfile.cjs
• Type: path
• Example: .pnpm/.pnpmfile.cjs

La posizione del file pnpm locale.

global-pnpmfile

• Default: null
• Type: path
• Example: ~/.pnpm/global_pnpmfile.cjs

La posizione di un file pnpm globale. Un file pnpm globale viene utilizzato da tutti i progetti durante l'installazione.

note

Si consiglia di utilizzare file pnpm locali. Usa un pnpmfile globale solo se usi pnpm su progetti che non usano pnpm come gestore di pacchetti principale.