.pnpmfile.cjs

pnpm ti consente di agganciarti direttamente al processo di installazione tramite funzioni speciali (hook). Gli hook possono essere dichiarati in un file chiamato .pnpmfile.cjs.

Per impostazione predefinita, .pnpmfile.cjs dovrebbe trovarsi nella stessa cartella del file di blocco. Ad esempio, in uno spazio di lavoro con un file di blocco .pnpmfile.cjs dovrebbe trovarsi nella radice del 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	Ti permette di mutare il package.json di una dipendenza
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>

Consente di modificare package.json di una dipendenza dopo l'analisi e prima della risoluzione. Queste mutazioni non vengono salvate nel filesystem, tuttavia, interessano ciò viene risolto nel file di blocco e quindi ciò che viene installato.

Nota che dovrai eliminare pnpm-lock.yaml se hai già risolto la dipendenza che desideri modificare.

tip

Se hai bisogno di modifiche al file package.json salvate nel filesystem, devi usare il comando pnpm patch e patchare il file package.json. Questo potrebbe essere utile se vuoi rimuovere il campo bin di una dipendenza, ad esempio.

Argomenti

• pkg - Il manifesto del pacchetto. La risposta dal registro o il contenuto di package.json.
• contesto - Oggetto contesto per il passaggio. Il metodo #log(msg) consente di utilizzare un registro di debug per il passaggio.

Utilizzo

Esempio .pnpmfile.cjs (cambia le dipendenze di una dipendenza):

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

Rimozione del campo scripts da una dipendenza del manifesto tramite readPackage sarà impedirà a pnpm di costruire la dipendenza. Quando si crea una dipendenza, pnpm legge il package.json del pacchetto dall'archivio del pacchetto, che non è interessato dall'hook. Per ignorare la compilazione di un pacchetto, utilizzare il campo pnpm.neverBuiltDependencies.

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

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

Argomenti

• lockfile - L'oggetto risoluzioni lockfile serializzato su pnpm-lock.yaml.
• contesto - Oggetto contesto per il passaggio. Il metodo #log(msg) consente di utilizzare un registro di debug per il passaggio.

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

• Predefinito: false
• Tipo: Booleano

.pnpmfile.cjs verrà ignorato. Utile insieme a --ignore-script quando si si desidera assicurarsi che nessuno script venga eseguito durante l'installazione.

pnpmfile

• Predefinito: .pnpmfile.cjs
• Tipo: percorso
• Esempio: .pnpm/.pnpmfile.cjs

La posizione del file pnpm locale.

global-pnpmfile

• Predefinito: null
• Tipo: percorso
• Esempio: ~/.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.