Passa al contenuto principale
Version: 6.x

.npmrc

pnpm ottiene la sua configurazione da linea di comando, variabili d'ambiente e file .npmrc.

Il comando pnpm config può essere usato per aggiornare e modificare il contenuto del file .npmrc utente e globale.

I quattro file rilevanti sono:

  • file di configurazione per progetto (/percorso/del/mio/progetto/.npmrc)
  • file di configurazione per area di lavoro (la directory che contiene il file pnpm-workspace.yaml)
  • file di configurazione per utente (~/.npmrc)
  • file di configurazione globale (/etc/npmrc)

Tutti i file .npmrc sono un elenco in formato INI di parametri chiave = valore.

Impostazioni di inserimento delle dipendenze

hoist

Aggiunto nella versione: v4.0.0

  • Predefinito: true
  • Tipo: booleano

Quando true, tutte le dipendenze vengono installate in node_modules/.pnpm. Questo rende le dipendenze non elencate accessibili a tutti i pacchetti all'interno di node_modules.

hoist-pattern

Aggiunto nella versione: v4.0.0

  • Predefinito: ['*']
  • Tipo: stringa[]

Indica a pnpm quali pacchetti devono essere installati in node_modules/.pnpm. Per impostazione predefinita, tutti i pacchetti sono installati - tuttavia, se sai che solo alcuni pacchetti difettosi hanno dipendenze fantasma, è possibile utilizzare questa opzione per installare esclusivamente le dipendenze fantasma (raccomandato).

Ad esempio:

hoist-pattern[]=*eslint*
hoist-pattern[]=*babel*

public-hoist-pattern

Aggiunto nella versione: v5.2.0

  • Predefinito: ['*types*', '*eslint*', '@prettier/plugin-*', '*prettier-plugin-*']
  • Tipo: stringa[]

A differenza di hoist-pattern, che installa le dipendenze in una cartella dei moduli nascosti all'interno dell'archivio virtuale, public-hoist-pattern installa le dipendenze che corrispondono al modello nella cartella dei moduli radice. Installare nella cartella radice dei moduli significa che il codice dell'applicazione avrà accesso alle dipendenze fantasma, anche se modificano la strategia di risoluzione in modo improprio.

Questa impostazione è utile quando si ha a che fare con alcuni strumenti collegabili difettosi che non risolvere correttamente le dipendenze.

Ad esempio:

public-hoist-pattern[]=*plugin*

Nota: Impostare shamefully-hoist a true è lo stesso dell'impostazione public-hoist-pattern a *.

shamefully-hoist

Aggiunto in: v1.34.0 come shamefully-flatten, rinominato in v4.0.0

  • Predefinito: false
  • Tipo: Booleano

Per impostazione predefinita, pnpm crea un node_modules semi-rigoroso, il che significa che le dipendenze hanno accesso alle dipendenze non dichiarate ma i moduli al di fuori di node_modules no. Con questo layout, la maggior parte dei pacchetti nell'ecosistema funzionano senza problemi. Tuttavia, se alcuni strumenti funzionano solo quando le dipendenze installate si trovano nella radice di node_modules, puoi impostarlo su true in modo da installarle per te.

Impostazioni Node-Modules

store-dir

Aggiunto nella versione: v4.2.0 come store

  • Predefinito: ~/.pnpm-store
  • Tipo: percorso

La posizione in cui tutti i pacchetti vengono salvati sul disco.

L'archivio dovrebbe essere sempre sullo stesso disco su cui sta avvenendo l'installazione, quindi ci sarà un archivio per disco. Se è presente una directory home sul corrente, l'archivio viene creato in <home dir>/.pnpm-store. Se non c'è nessuna home sul disco, allora il negozio viene creato alla radice del filesystem. Ad esempio, se l'installazione avviene su un file system montato a /mnt, allora l'archivio viene creato in /mnt/.pnpm-store. Lo stesso vale per i sistemi Windows.

È possibile impostare un archivio da un disco diverso, ma in tal caso pnpm copierà i pacchetti dallo store invece di collegarli, poiché i collegamenti fisici sono possibili solo sullo stesso filesystem.

modules-dir

Aggiunto nella versione: v4.14.0

  • Predefinito: node_modules
  • Tipo: percorso

La cartella in cui verranno installate le dipendenze (invece di node_modules).

node-linker

Aggiunto nella versione: v5.9.0

  • Predefinito: non definito
  • Tipo: undefined, pnp

Definisce quale linker dovrebbe essere usato per installare i pacchetti Node. Per impostazione predefinita, pnpm crea una cartella dei moduli collegati, ma è supportata anche la strategia di compilazione e risoluzione. Plug'n'Play è una strategia innovativa per Node che è utilizzata da Yarn.

Si consiglia inoltre di impostare symlink su false quando si utilizza pnp come linker.

Aggiunto nella versione: v5.9.0

  • Predefinito: true
  • Tipo: Booleano

Quando symlink è impostato su false, pnpm crea una cartella dell'archivio virtuale senza alcun collegamento simbolico. È un'impostazione utile insieme a node-linker=pnp.

enable-modules-dir

Aggiunto nella versione: v5.15.0

  • Predefinito: false
  • Tipo: Booleano

Quando false, pnpm non scriverà alcun file nella cartella dei moduli (node_modules). Questo è utile quando la cartella dei moduli è montata con filesystem nello spazio utente (FUSE). Esiste una CLI sperimentale che consente di montare una cartella dei moduli con FUSE: @pnpm/mount-modules.

virtual-store-dir

Aggiunto nella versione: v4.1.0

  • Predefinito: node_modules/.pnpm
  • Tipi: percorso

La cartella con i collegamenti all'archivio. Tutte le dipendenze dirette e indirette del progetto sono collegate in questa cartella.

Questa è un'impostazione utile che può risolvere problemi con percorsi lunghi su Windows. Se hai alcune dipendenze con percorsi molto lunghi, puoi selezionare un archivio virtuale nella radice del tuo disco (ad esempio C:\my-project-store).

Oppure puoi impostare l'archivio virtuale su .pnpm e aggiungerlo a .gitignore. Questo renderà gli stacktrace più puliti poiché i percorsi delle dipendenze saranno di una cartella più in alto.

NOTA: l'archivio virtuale non può essere condiviso tra più progetti. Ogni progetto dovrebbe avere un proprio archivio virtuale (tranne negli spazi di lavoro dove è condivisa la radice).

package-import-method

Aggiunto nella versione: v1.25.0

  • Predefinito: auto
  • Tipo: auto, hardlink, copy, clone

Controlla il modo in cui i pacchetti vengono importati dall'archivio.

  • auto - prova a clonare i pacchetti dall'archivio. Se la clonazione non è supportata collega i pacchetti dall'archivio. Se né la clonazione né il collegamento è possibile, esegue la copia
  • hardlink - collega fisicamente i pacchetti dall'archivio
  • copy - copia i pacchetti dall'archivio
  • clone - clona (alias copy-on-write o link di riferimento) i pacchetti dall'archivio

modules-cache-max-age

Aggiunto nella versione: v6.0.0

  • Predefinito: 10080 (7 giorni in minuti)
  • Tipo: numero

Il tempo in minuti dopo il quale i pacchetti orfani dalla cartella dei moduli devono essere rimossi. pnpm mantiene una cache dei pacchetti nella cartella dei moduli. Questa velocità di installazione aumenta quando si cambia ramo o si retrocedono delle dipendenze.

Impostazioni file di blocco

lockfile

Aggiunto nella versione: v1.32.0 come shrinkwrap

  • Predefinito: true
  • Tipo: Booleano

Se impostato su false, pnpm non leggerà né genererà un file pnpm-lock.yaml.

prefer-frozen-lockfile

Aggiunto nella versione: v1.37.1 come prefer-frozen-shrinkwrap

  • Predefinito: true (dalla v1.38.0)
  • Tipo: Booleano

Quando è impostato su true e il pnpm-lock.yaml disponibile soddisfa il package.json, viene eseguita un'installazione headless. Un'installazione headless salta la risoluzione di tutte le dipendenze in quanto non ha bisogno per modificare il file di blocco.

Impostazioni di autenticazione e del registro di sistema

registry

L'URL di base del registro del pacchetto npm (barra finale inclusa).

<scope>:registry

Il registro npm da utilizzare per i pacchetti dell'ambito specificato. Per esempio, impostando @babel:registry=https://esempio.com/packages/npm/ farà rispettare che quando usi pnpm add @babel/core, o qualsiasi pacchetto @babel con ambito, il pacchetto verrà recuperato da https://esempio.com/packages/npm invece del registro predefinito.

<URL>:_authToken

Definisci il token del portatore di autenticazione da utilizzare quando si accede al registro. Ad esempio:

//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 

Puoi anche usare una variabile d'ambiente. Ad esempio:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

<URL>:always-auth

  • Predefinito: false
  • Tipo: Booleano

Forza pnpm a richiedere sempre l'autenticazione (anche per le richieste GET) quando accede al registro specificato. Ad esempio:

@babel:registry=https://gitlab.com/api/v4/packages/npm/
//gitlab.com/api/v4/packages/npm/:always-auth=true

registry=https://registry.npmjs.org/
//registry.npmjs.org/:always-auth=true

Impostazioni richiesta

ca

  • Predefinito: Il certificato CA di npm
  • Tipo: Stringa, Array o null

Il certificato di firma dell'autorità di certificazione considerato attendibile per le connessioni SSL al registro. I valori devono essere in formato PEM (ovvero "X.509 codificato in base-64 (.CER)"). Ad esempio:

ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

Imposta a null per consentire solo ai registrar noti o un certificato CA specifico di considerare attendibile solo quella specifica autorità di firma.

È possibile considerare attendibili più CA specificando una serie di certificati:

ca[]="..."
ca[]="..."

Vedi anche la configurazione strict-ssl.

cafile

  • Predefinito: null
  • Tipo: percorso

Un percorso a un file contenente una o più autorità di certificazione che firmano certificati. Simile all'impostazione ca, ma permette più CA, così come per le informazioni CA da memorizzare in un file invece di essere specificato tramite CLI.

cert

  • Predefinito: null
  • Tipo: Stringa

Un certificato client da passare quando si accede al registro. I valori devono essere in formato PEM (ovvero "X.509 codificato in base-64 (.CER)"). Ad esempio:

cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

Non è il percorso di un file di certificato (e non c'è nessuna opzione certfile).

https-proxy

  • Predefinito: null
  • Tipo: url

Un proxy da utilizzare per le richieste HTTPS in uscita. Se sono impostate le variabili di ambiente HTTPS_PROXY, https_proxy, HTTP_PROXY o http_proxy, verranno utilizzati i relativi valori.

key

  • Predefinito: null
  • Tipo: Stringa

Una chiave client da passare quando si accede al registro. I valori devono essere in formato PEM (ovvero "X.509 codificato in base-64 (.CER)"). Ad esempio:

key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

Non è il percorso di un file di chiave (e non c'è nessuna opzione keyfile).

local-address

  • Predefinito: non definito
  • Tipo: Indirizzo IP

L'indirizzo IP dell'interfaccia locale da utilizzare quando si effettuano connessioni al registro npm.

proxy

  • Predefinito: null
  • Tipo: url

Un proxy da utilizzare per le richieste http in uscita. Se le variabili di ambiente HTTP_PROXY o http_proxy sono impostate, le impostazioni del proxy saranno onorate dalla libreria di richiesta sottostante.

noproxy

Aggiunto nella versione: v5.18.8

  • Predefinito: null
  • Tipo: Stringa

Una stringa di estensioni di dominio separate da virgole per le quali non dovrebbe essere utilizzato un proxy.

strict-ssl

  • Predefinito: true
  • Tipo: Booleano

Se eseguire o meno la convalida della chiave SSL quando si effettuano richieste al registro tramite HTTPS.

Vedi anche l'opzione ca.

network-concurrency

  • Predefinito: 16
  • Tipo: Numero

Controlla il numero massimo di richieste HTTP(S) da elaborare contemporaneamente.

fetch-retries

  • Predefinito: 2
  • Tipo: Numero

Quante volte riprovare se pnpm non riesce a recuperare dal registro.

fetch-retry-factor

  • Predefinito: 10
  • Tipo: Numero

Il fattore esponenziale per i tentativi di backoff.

fetch-retry-mintimeout

  • Predefinito: 10000 (10 secondi)
  • Tipo: Numero

Il timeout minimo (di base) per ritentare le richieste.

fetch-retry-maxtimeout

  • Predefinito: 60000 (1 minuto)
  • Tipo: Numero

Il timeout di fallback massimo per garantire che il fattore di ripetizione non esegua richieste troppo lunghe.

fetch-timeout

Aggiunto nella versione: v6.2.0

  • Predefinito: 60000 (1 minuto)
  • Tipo: Numero

Il tempo massimo di attesa per il completamento delle richieste HTTP.

Impostazioni CLI

[no-]color

Aggiunto nella versione: v4.1.0

  • Predefinito: auto
  • Tipo: auto, always, never

Controlla i colori nell'output.

  • auto - l'output utilizza i colori quando l'output standard è un terminale o TTY.
  • always - ignora la differenza tra terminali e pipe. Raramente lo vorrai; nella maggior parte degli scenari, se si desidera i codici colore nell'output reindirizzato, è invece possibile passare un flag --color al comando pnpm per forzarlo a utilizzare i codici colore. L'impostazione predefinita è quasi sempre quella che vorrai.
  • never - disattiva i colori. Questa è l'impostazione utilizzata da --no-color.

loglevel

Aggiunto in: v4.13.0

  • Predefinito: info
  • Tipo: debug, info, warn, error

Verranno visualizzati tutti i registri pari o superiori al livello indicato. Puoi invece passare --silent per disattivare tutti i registri di output.

strict-peer-dependencies

Aggiunto nella versione: v2.15.0

  • Predefinito: false
  • Tipo: Booleano

Se abilitato, i comandi falliranno se c'è una dipendenza peer mancante o non valida nell'albero.

use-beta-cli

Aggiunto in: v3.6.0

  • Predefinito: false
  • Tipo: Booleano

Opzione sperimentale che abilita le funzionalità beta della CLI. Ciò significa che è possibile ottenere alcune modifiche alla funzionalità CLI che possono essere modifiche non retrocompatibili, o potenzialmente bug.

recursive-install

Aggiunto nella versione: v5.4.0

  • Predefinito: true
  • Tipo: Booleano

Se questa opzione è abilitata, il comportamento principale di pnpm install diventa quello di pnpm install -r, il che significa che l'installazione viene eseguita su tutto lo spazio di lavoro o sui pacchetti delle sottocartelle.

Altrimenti, pnpm install creerà esclusivamente il pacchetto nella cartella corrente.

engine-strict

  • Predefinito: false
  • Tipo: Booleano

Se è abilitato, pnpm non installerà alcun pacchetto che affermi di non essere compatibile con la versione corrente di Node.

Indipendentemente da questa configurazione, l'installazione fallirà sempre se un progetto (non una dipendenza) specifica una versione incompatibile nel suo campo engine.

npm-path

Aggiunto nella versione: v4.8.0

  • Tipo: percorso

La posizione del file binario npm che pnpm usa per alcune azioni, come la pubblicazione.

Impostazioni di compilazione

child-concurrency

  • Predefinito: 5
  • Tipo: Numero

Il numero massimo di processi figlio da allocare contemporaneamente per creare node_modules.

side-effects-cache

Aggiunto nella versione: v1.31.0

  • Predefinito: false
  • Tipo: Booleano
  • Stabilità: Sperimentale

Utilizza e memorizza i risultati degli hook (pre/post)-installazione.

side-effects-cache-readonly

Aggiunto nella versione: v1.31.0

  • Predefinito: false
  • Tipo: Booleano
  • Stabilità: Sperimentale

Usa solo la cache degli effetti collaterali se presente, non crearla per nuovi pacchetti.

unsafe-perm

  • Predefinito: false SE in esecuzione come root, ALTRIMENTI true
  • Tipo: Booleano

Imposta a true per abilitare la commutazione UID/GID durante l'esecuzione di script di pacchetto. Se impostato esplicitamente su false, l'installazione come utente non root avrà esito negativo.

Altre opzioni

use-running-store-server

Aggiunto nella versione: v2.5.0

  • Predefinito: false
  • Tipo: Booleano

Consente l'installazione solo con un server di archiviazione. Se nessun server di archiviazione è in esecuzione, l'installazione fallirà.

save-prefix

  • Predefinito: '^'
  • Tipo: Stringa

Configura come le versioni dei pacchetti installati in un file package.json vengono prefissati.

Ad esempio, se un pacchetto ha la versione 1.2.3, per impostazione predefinita la sua versione è impostata su ^1.2.3 che consente aggiornamenti minori per quel pacchetto, ma dopo pnpm config set save-prefix='~' sarebbe impostato su ~1.2.3 che consente solo aggiornamenti di patch.

Questa impostazione viene ignorata quando il pacchetto aggiunto ha un intervallo specificato. Ad esempio, pnpm add [email protected] imposterà la versione di foo nel package.json su 2, indipendentemente dal valore di save-prefix.

tag

  • Predefinito: latest
  • Tipo: Stringa

Se esegui pnpm add con un pacchetto e non fornisci una versione specifica, allora installerà il pacchetto alla versione registrata sotto il tag da questa impostazione.

Questo imposta anche il tag che viene aggiunto a [email protected] specificato dal pnpm tag se non viene fornito alcun tag esplicito.

global-dir

Aggiunto nella versione: v4.2.0

  • Predefinito: <path to node>/pnpm-global
  • Tipo: percorso

Specifica una cartella personalizzata per archiviare i pacchetti globali.

global-bin-dir

Aggiunto nella versione: v6.15.0

Consente di impostare la cartella di destinazione per i file bin dei pacchetti installati globalmente.

state-dir

Aggiunto nella versione: v6.10.0

  • Predefinito: $XDG_STATE_HOME/pnpm
  • Tipo: percorso

La cartella in cui pnpm crea il file pnpm-state.json attualmente utilizzato solo dal controllo aggiornamenti.

cache-dir

Aggiunto nella versione: v6.10.0

  • Predefinito: $XDG_CACHE_HOME/pnpm
  • Tipo: percorso

La posizione della cache dei metadati del pacchetto.

use-node-version

Aggiunto nella versione: v6.5.0

  • Predefinito: non definito
  • Tipo: semver

Specifica quale versione esatta di Node.js deve essere utilizzata per il runtime del progetto. pnpm installerà automaticamente la versione specificata di Node.js e la utilizzerà per eseguire i comandi pnpm run o per il comando pnpm node.

use-stderr

Aggiunto nella versione: v6.5.0

  • Predefinito: false
  • Tipo: Booleano

Se true, tutto l'output viene scritto su stderr.

extend-node-path

Aggiunto nella versione: v6.16.0

  • Predefinito: true
  • Tipo: Booleano

Quando false, la NODE_PATH non è impostata negli shim del comando. Si consiglia di impostare questa impostazione su false se si riceve l'errore successivo, durante l'esecuzione dei comandi:

La linea di input è troppo lunga. La sintassi del comando non è corretta.