Settings (.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
.
Values in the .npmrc
files may contain env variables using the ${NAME}
syntax. The env variables may also be specified with default values. Using ${NAME-fallback}
will return fallback
if NAME
isn't set. ${NAME:-fallback}
will return fallback
if NAME
isn't set, or is an empty string.
Impostazioni di inserimento delle dipendenze
hoist
- Predefinito: true
- Tipo: booleano
Quando true
, tutte le dipendenze vengono installate in node_modules/.pnpm/node_modules
. Questo rende le dipendenze non elencate accessibili a tutti i pacchetti all'interno di node_modules
.
hoist-workspace-packages
- Predefinito: true
- Tipo: booleano
When true
, packages from the workspaces are symlinked to either <workspace_root>/node_modules/.pnpm/node_modules
or to <workspace_root>/node_modules
depending on other hoisting settings (hoist-pattern
and public-hoist-pattern
).
hoist-pattern
- Predefinito: ['*']
- Tipo: stringa[]
Indica a pnpm quali pacchetti devono essere installati in node_modules/.pnpm/node_modules
. 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*
You may also exclude patterns from hoisting using !
.
Ad esempio:
hoist-pattern[]=*types*
hoist-pattern[]=!@types/react
public-hoist-pattern
- Default: []
- 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 *
.
You may also exclude patterns from hoisting using !
.
Ad esempio:
public-hoist-pattern[]=*types*
public-hoist-pattern[]=!@types/react
shamefully-hoist
- 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
modules-dir
- Predefinito: node_modules
- Tipo: percorso
La cartella in cui verranno installate le dipendenze (invece di node_modules
).
node-linker
- Predefinito: isolated
- Tipo: isolated, hoisted, pnp
Definisce quale linker dovrebbe essere usato per installare i pacchetti Node.
- isolato - le dipendenze sono collegate simbolicamente da un negozio virtuale a
node_modules/.pnpm
. - hoisted - viene creata una
node_modules
piatta senza collegamenti simbolici. Uguale anode_modules
creato da npm o Yarn Classic. Una delle librerie di Yarn viene utilizzata per l'hoisting, quando viene utilizzata questa impostazione. Motivi legittimi per utilizzare questa impostazione:- I tuoi strumenti non funzionano bene con i collegamenti simbolici. Un progetto React Native molto probabilmente funzionerà solo se utilizzi una
node_modules
issata (hoisted). - Il tuo progetto viene distribuito a un provider di hosting senza server. Alcuni provider senza server (ad esempio, AWS Lambda) non supportano i collegamenti simbolici. Una soluzione alternativa a questo problema consiste nel raggruppare l'applicazione prima della distribuzione.
- Se vuoi pubblicare il tuo pacchetto con
"bundledDependencies"
. - Se stai eseguendo Node.js con l'opzione --preserve-symlinks.
- I tuoi strumenti non funzionano bene con i collegamenti simbolici. Un progetto React Native molto probabilmente funzionerà solo se utilizzi una
- pnp - nessuna cartella
node_modules
. Plug'n'Play è una strategia innovativa per Node che è utilizzata da Yarn Berry. Si consiglia inoltre di impostaresymlink
sufalse
quando si utilizzapnp
come linker.
symlink
- 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
- Predefinito: true
- 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
- 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).
virtual-store-dir-max-length
- Predefinito:
- On Linux/macOS: 120
- On Windows: 60
- Types: number
Sets the maximum allowed length of directory names inside the virtual store directory (node_modules/.pnpm
). You may set this to a lower number if you encounter long path issues on Windows.
package-import-method
- Predefinito: null
- Tipo: auto, hardlink, copy, clone, clone-or copy
Controlla il modo in cui i pacchetti vengono importati dall'archivio (se si desidera disabilitare i collegamenti simbolici all'interno di node_modules
, è necessario modificare l'impostazione del node-linker, non questa).
- 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
- clone-or-copy: prova a clonare i pacchetti dal negozio. Se la clonazione non è supportata, allora torna alla copia
- copy - copia i pacchetti dall'archivio
- clone - clona (alias copy-on-write o link di riferimento) i pacchetti dall'archivio
La clonazione è il modo migliore per scrivere pacchetti in node_modules. È il modo più veloce e più sicuro. Quando viene utilizzata la clonazione, puoi modificare i file nei tuoi node_modules e non verranno modificati nell'archivio centrale indirizzabile al contenuto.
Sfortunatamente, non tutti i file system supportano la clonazione. Si consiglia di utilizzare un file system copy-on-write (CoW) (ad esempio, Btrfs invece di Ext4 su Linux) per la migliore esperienza con pnpm.
modules-cache-max-age
- 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.
dlx-cache-max-age
- Default: 1440 (1 day in minutes)
- Tipo: numero
The time in minutes after which dlx cache expires. After executing a dlx command, pnpm keeps a cache that omits the installation step for subsequent calls to the same dlx command.
Store Settings
store-dir
- Predefinito:
- If the $PNPM_HOME env variable is set, then $PNPM_HOME/store
- If the $XDG_DATA_HOME env variable is set, then $XDG_DATA_HOME/pnpm/store
- On Windows: ~/AppData/Local/pnpm/store
- On macOS: ~/Library/pnpm/store
- On Linux: ~/.local/share/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 disco corrente, l'archivio viene creato al suo interno. Se non c'è nessuna home sul disco, allora l'archivio 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.
verify-store-integrity
- Predefinito: true
- Tipo: Booleano
Per impostazione predefinita, se un file nell'archivio è stato modificato, il contenuto di questo file viene controllato prima di collegarlo al node_modules
di un progetto. Se verify-store-integrity
è impostato su false
, i file nell'archivio indirizzabile ai contenuti non verranno controllati durante l'installazione.
use-running-store-server
Deprecated feature
- Predefinito: false
- Tipo: Booleano
Consente l'installazione solo con un server di archiviazione. Se nessun server di archiviazione è in esecuzione, l'installazione fallirà.
strict-store-pkg-content-check
- Predefinito: true
- Tipo: Booleano
Some registries allow the exact same content to be published under different package names and/or versions. This breaks the validity checks of packages in the store. To avoid errors when verifying the names and versions of such packages in the store, you may set the strict-store-pkg-content-check
setting to false
.
Impostazioni file di blocco
lockfile
- Predefinito: true
- Tipo: Booleano
When set to false
, pnpm won't read or generate a pnpm-lock.yaml
file.
prefer-frozen-lockfile
- Predefinito: true
- Tipo: Booleano
When set to true
and the available pnpm-lock.yaml
satisfies the package.json
dependencies directive, a headless installation is performed. A headless installation skips all dependency resolution as it does not need to modify the lockfile.
lockfile-include-tarball-url
- Predefinito: false
- Tipo: Booleano
Add the full URL to the package's tarball to every entry in pnpm-lock.yaml
.
git-branch-lockfile
- Predefinito: false
- Tipo: Booleano
When set to true
, the generated lockfile name after installation will be named based on the current branch name to completely avoid merge conflicts. For example, if the current branch name is feature-foo
, the corresponding lockfile name will be pnpm-lock.feature-foo.yaml
instead of pnpm-lock.yaml
. It is typically used in conjunction with the command line argument --merge-git-branch-lockfiles
or by setting merge-git-branch-lockfiles-branch-pattern
in the .npmrc
file.
merge-git-branch-lockfiles-branch-pattern
- Default: null
- Type: Array or null
This configuration matches the current branch name to determine whether to merge all git branch lockfile files. By default, you need to manually pass the --merge-git-branch-lockfiles
command line parameter. This configuration allows this process to be automatically completed.
Ad esempio:
merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*
You may also exclude patterns using !
.
peers-suffix-max-length
- Default: 1000
- Tipo: numero
Max length of the peer IDs suffix added to dependency keys in the lockfile. If the suffix is longer, it is replaced with a hash.
Impostazioni di autenticazione e del registro di sistema
registry
- Predefinito: https://registry.npmjs.org/
- Tipo: url
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}
Oppure puoi semplicemente utilizzare direttamente una variabile di ambiente, senza modificare affatto il file .npmrc
:
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
<URL>:tokenHelper
Un token helper è un eseguibile che emette un token di autenticazione. Può essere usato in situazioni in cui authToken non è un valore costante ma è qualcosa che si aggiorna regolarmente, in cui uno script o un altro strumento può usare un token di aggiornamento esistente per ottenere un nuovo token di accesso.
La configurazione per il percorso dell'helper deve essere un percorso assoluto, senza argomenti. Per essere sicuro, è consentito impostare questo valore solo nell'utente .npmrc
. In caso contrario, un progetto potrebbe inserire un valore in .npmrc
locale di un progetto ed eseguire eseguibili arbitrari.
Impostazione di un token helper per il registro predefinito:
tokenHelper=/home/ivan/token-generator
Impostazione di un token helper per il registro specificato:
//registry.corp.com:tokenHelper=/home/ivan/token-generator
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
- Default: 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.
<URL>:cafile
Define the path to a Certificate Authority file to use when accessing the specified registry. Ad esempio:
//registry.npmjs.org/:keyfile=client-cert.pem
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-----"
It is not the path to a certificate file.
<URL>:certfile
Define the path to a certificate file to use when accessing the specified registry. Ad esempio:
//registry.npmjs.org/:certfile=server-cert.pem
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
).
Questa impostazione contiene informazioni sensibili. Non scriverlo in un file .npmrc
locale di cui hai effettuato il commit nel repository.
<URL>:keyfile
Define the path to a client key file to use when accessing the specified registry. Ad esempio:
//registry.npmjs.org/:keyfile=server-key.pem
git-shallow-hosts
- Predefinito: ['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
- Tipo: stringa[]
Durante il recupero delle dipendenze che sono repository Git, se l'host è elencato in questa impostazione, pnpm utilizzerà la clonazione superficiale per recuperare solo il commit necessario, non tutta la cronologia.
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.
Se l'URL del tuo proxy contiene un nome utente e una password, assicurati di codificarli con l'URL. Ad esempio:
https-proxy=https://use%21r:pas%2As@my.proxy:1234/foo
Non codificare i due punti (:
) tra nome utente e password.
http-proxy
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.
local-address
- Predefinito: non definito
- Tipo: Indirizzo IP
L'indirizzo IP dell'interfaccia locale da utilizzare quando si effettuano connessioni al registro npm.
maxsockets
- Predefinito: simultaneità di rete x 3
- Tipo: Numero
Il numero massimo di connessioni da utilizzare per origine (combinazione protocollo/host/porta).
noproxy
- 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
- Predefinito: 60000 (1 minuto)
- Tipo: Numero
Il tempo massimo di attesa per il completamento delle richieste HTTP.
Impostazioni dipendenze peer
auto-install-peers
- Predefinito: true
- Tipo: Booleano
Quando true
, tutte le dipendenze peer non facoltative mancanti vengono installate automaticamente.
Version Conflicts
If there are conflicting version requirements for a peer dependency from different packages, pnpm will not install any version of the conflicting peer dependency automatically. Instead, a warning is printed. For example, if one dependency requires react@^16.0.0
and another requires react@^17.0.0
, these requirements conflict, and no automatic installation will occur.
Conflict Resolution
In case of a version conflict, you'll need to evaluate which version of the peer dependency to install yourself, or update the dependencies to align their peer dependency requirements.
dedupe-peer-dependents
- Predefinito: true
- Tipo: Booleano
Quando questa impostazione è impostata su true
, i pacchetti con dipendenze peer verranno deduplicati dopo la risoluzione peer.
Ad esempio, supponiamo di avere un'area di lavoro con due progetti ed entrambi hanno webpack
nelle loro dipendenze. webpack
ha esbuild
nelle sue dipendenze peer opzionali e uno dei progetti ha esbuild
nelle sue dipendenze. In questo caso, pnpm collegherà due istanze di webpack
alla directory node_modules/.pnpm
: una con esbuild
e un'altra senza:
node_modules
.pnpm
webpack@1.0.0_esbuild@1.0.0
webpack@1.0.0
project1
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0/node_modules/webpack
project2
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0_esbuild@1.0.0/node_modules/webpack
esbuild
Questo ha senso perché webpack
viene utilizzato in due progetti e uno dei progetti non ha esbuild
, quindi i due progetti non possono condividere la stessa istanza di webpack
. Tuttavia, questo non è ciò che la maggior parte degli sviluppatori si aspetta, soprattutto perché in un node_modules
issato, ci sarebbe solo un'istanza di webpack
. Pertanto, ora puoi utilizzare l'impostazione dedupe-peer-dependents
per deduplicare webpack
quando non ha dipendenze peer in conflitto (spiegazione alla fine). In questo caso, se impostiamo dedupe-peer-dependents
su true
, entrambi i progetti utilizzeranno la stessa istanza webpack
, che è quella che ha esbuild
risolti:
node_modules
.pnpm
webpack@1.0.0_esbuild@1.0.0
project1
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0_esbuild@1.0.0/node_modules/webpack
project2
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0_esbuild@1.0.0/node_modules/webpack
esbuild
Cosa sono le dipendenze tra pari in conflitto? Per dipendenze in conflitto tra pari intendiamo uno scenario come il seguente:
node_modules
.pnpm
webpack@1.0.0_react@16.0.0_esbuild@1.0.0
webpack@1.0.0_react@17.0.0
project1
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0/node_modules/webpack
react (v17)
project2
node_modules
webpack -> ../../node_modules/.pnpm/webpack@1.0.0_esbuild@1.0.0/node_modules/webpack
esbuild
react (v16)
In questo caso, non possiamo deduplicare webpack
poiché webpack
ha react
nelle sue dipendenze peer e react
viene risolto da due versioni diverse nel contesto dei due progetti.
strict-peer-dependencies
- Predefinito: false
- Tipo: Booleano
Se abilitato, i comandi falliranno se c'è una dipendenza peer mancante o non valida nell'albero.
resolve-peers-from-workspace-root
- Predefinito: true
- Tipo: Booleano
Se abilitate, le dipendenze del progetto root dell'area di lavoro vengono utilizzate per risolvere le dipendenze peer di qualsiasi progetto nell'area di lavoro. Si tratta di una funzione utile in quanto è possibile installare le tue dipendenze peer solo nella root dello spazio di lavoro e puoi essere sicuro che tutti i progetti nello spazio di lavoro utilizzano le stesse versioni delle dipendenze peer.
Impostazioni CLI
[no-]color
- Predefinito: null
- 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
- 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.
use-beta-cli
- 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
- 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
- Tipo: percorso
La posizione del file binario npm che pnpm usa per alcune azioni, come la pubblicazione.
package-manager-strict
- Predefinito: true
- Tipo: Booleano
If this setting is disabled, pnpm will not fail if a different package manager is specified in the packageManager
field of package.json
. When enabled, only the package name is checked (since pnpm v9.2.0), so you can still run any version of pnpm regardless of the version specified in the packageManager
field.
Alternatively, you can disable this setting by setting the COREPACK_ENABLE_STRICT
environment variable to 0
.
package-manager-strict-version
- Predefinito: false
- Tipo: Booleano
When enabled, pnpm will fail if its version doesn't exactly match the version specified in the packageManager
field of package.json
.
manage-package-manager-versions
- Predefinito: true
- Tipo: Booleano
When enabled, pnpm will automatically download and run the version of pnpm specified in the packageManager
field of package.json
. This is the same field used by Corepack. Esempio:
{
"packageManager": "pnpm@9.3.0"
}
Impostazioni di compilazione
ignore-scripts
- Predefinito: false
- Tipo: Booleano
Non eseguire alcun script definito nel file package.json
del progetto e nelle sue dipendenze.
Questo flag non impedisce l'esecuzione di .pnpmfile.cjs
ignore-dep-scripts
- Predefinito: false
- Tipo: Booleano
Non eseguire alcuno script dei pacchetti installati. Gli script dei progetti vengono eseguiti.
child-concurrency
- Predefinito: 5
- Tipo: Numero
Il numero massimo di processi figlio da allocare contemporaneamente per creare node_modules.
side-effects-cache
- Predefinito: true
- Tipo: Booleano
Utilizza e memorizza i risultati degli hook (pre/post)-installazione.
side-effects-cache-readonly
- Predefinito: false
- Tipo: Booleano
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.
node-options
- Default: NULL
- Tipo: Stringa
Options to pass through to Node.js via the NODE_OPTIONS
environment variable. This does not impact how pnpm itself is executed but it does impact how lifecycle scripts are called.
verify-deps-before-run
- Default:
false
- Type: install, warn, error, prompt, false
This setting allows the checking of the state of dependencies before running scripts. The check runs on pnpm run
and pnpm exec
commands. The following values are supported:
install
- Automatically runs install ifnode_modules
is not up to date.warn
- Prints a warning ifnode_modules
is not up to date.prompt
- Prompts the user for permission to run install ifnode_modules
is not up to date.error
- Throws an error ifnode_modules
is not up to date.false
- Disables dependency checks.
Impostazioni di Node.js
use-node-version
- 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
.
Può essere utilizzato al posto di .nvmrc
e nvm
. Invece del seguente file .nvmrc
:
16.16.0
Usa questo file .npmrc
:
use-node-version=16.16.0
This setting works only in a .npmrc
file that is in the root of your workspace. If you need to specify a custom Node.js for a project in the workspace, use the pnpm.executionEnv.nodeVersion
field of package.json
instead.
node-version
- Predefinito: il valore restituito da node -v, senza il prefisso v
- Tipo: semver
La versione di Node.js da utilizzare quando si controlla l'impostazione engines
di un pacchetto.
Se vuoi impedire ai contributori del tuo progetto di aggiungere nuove dipendenze incompatibili, usa node-version
e engine-strict
in un file .npmrc
alla radice del progetto:
node-version=12.22.0
engine-strict=true
In questo modo, anche se qualcuno sta usando Node.js v16, non sarà in grado di installare una nuova dipendenza che non supporta Node.js v12.22.0.
node-mirror:<releaseDir>
- Predefinito:
https://nodejs.org/download/<releaseDir>/
- Tipo: URL
Imposta l'URL di base per il download di Node.js. The <releaseDir>
portion of this setting can be any directory from https://nodejs.org/download: release
, rc
, nightly
, v8-canary
, etc.
Ecco come configurare pnpm per scaricare Node.js dal mirror Node.js in Cina:
node-mirror:release=https://npmmirror.com/mirrors/node/
node-mirror:rc=https://npmmirror.com/mirrors/node-rc/
node-mirror:nightly=https://npmmirror.com/mirrors/node-nightly/
Impostazioni dell'area di lavoro
link-workspace-packages
- Predefinito: false
- Tipo: true, false, deep
Se è abilitato, i pacchetti disponibili localmente sono collegati a node_modules
invece di essere scaricati dal registro. Questo è molto conveniente in un monorepo. Se hai bisogno che i pacchetti locali siano collegati anche alle dipendenze secondarie, puoi usare l'impostazione deep
.
Altrimenti, i pacchetti vengono scaricati e installati dal registro. Tuttavia, i pacchetti dello spazio di lavoro possono ancora essere collegati utilizzando il protocollo di intervallo workspace:
.
prefer-workspace-packages
- Predefinito: false
- Tipo: Booleano
Se questa opzione è abilitata, i pacchetti locali dello spazio di lavoro sono preferiti rispetto ai pacchetti del registro, anche se è presente una versione più recente del pacchetto nel registro.
Questa impostazione è utile solo se l'area di lavoro non utilizza save-workspace-protocol
.
shared-workspace-lockfile
- Predefinito: true
- Tipo: Booleano
Se questa opzione è abilitata, pnpm crea un unico file pnpm-lock.yaml
nella radice dello spazio di lavoro. Ciò significa anche che tutte le dipendenze dei pacchetti dello spazio di lavoro saranno in una singola cartella node_modules
(e saranno collegate simbolicamente alla loro node_modules
per la risoluzione del modulo di Node).
Vantaggi di questa opzione:
- ogni dipendenza è un elemento singolo
- installazioni più veloci in un monorepo
- meno modifiche nelle revisioni del codice poiché sono tutte in un unico file
Anche se tutte le dipendenze saranno collegate fisicamente nella radice di node_modules
, i pacchetti avranno accesso solo a quelle dipendenze che sono dichiarate nel loro package.json
, quindi la rigidità di pnpm è preservata. Questo è il risultato del suddetto collegamento simbolico.
save-workspace-protocol
- Default: rolling
- Tipo: true, false, rolling
Questa impostazione controlla il modo in cui le dipendenze collegate dall'area di lavoro vengono aggiunte a package.json
.
Se foo@1.0.0
è nell'area di lavoro e si esegue pnpm add foo
in un altro progetto dell'area di lavoro, di seguito è riportato come foo
verrà aggiunto al campo delle dipendenze. L'impostazione save-prefix
influenza anche il modo in cui viene creata la specifica.
save-workspace-protocol | save-prefix | spec |
---|---|---|
false | '' | 1.0.0 |
false | '~' | ~1.0.0 |
false | '^' | ^1.0.0 |
true | '' | workspace:1.0.0 |
true | '~' | workspace:~1.0.0 |
true | '^' | workspace:^1.0.0 |
rolling | '' | workspace:* |
rolling | '~' | workspace:~ |
rolling | '^' | workspace:^ |
include-workspace-root
- Predefinito: false
- Tipo: Booleano
Quando si eseguono comandi ricorsivamente in un'area di lavoro, eseguili anche nel progetto dell'area di lavoro radice.
ignore-workspace-cycles
- Predefinito: false
- Tipo: Booleano
When set to true
, no workspace cycle warnings will be printed.
disallow-workspace-cycles
- Predefinito: false
- Tipo: Booleano
When set to true
, installation will fail if the workspace has cycles.
Altre opzioni
save-prefix
- Predefinito: '^'
- Type: '^', '~', ''
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 foo@2
imposterà la versione di foo
nel package.json
su 2
, indipendentemente dal valore di save-prefix
.
tag
- Default: 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 package@version
specificato dal pnpm tag
se non viene fornito alcun tag esplicito.
global-dir
- Predefinito:
- If the $XDG_DATA_HOME env variable is set, then $XDG_DATA_HOME/pnpm/global
- On Windows: ~/AppData/Local/pnpm/global
- On macOS: ~/Library/pnpm/global
- On Linux: ~/.local/share/pnpm/global
- Tipo: percorso
Specifica una cartella personalizzata per archiviare i pacchetti globali.
global-bin-dir
- Predefinito:
- If the $XDG_DATA_HOME env variable is set, then $XDG_DATA_HOME/pnpm
- On Windows: ~/AppData/Local/pnpm
- On macOS: ~/Library/pnpm
- On Linux: ~/.local/share/pnpm
- Tipo: percorso
Consente di impostare la cartella di destinazione per i file bin dei pacchetti installati globalmente.
state-dir
- Predefinito:
- If the $XDG_STATE_HOME env variable is set, then $XDG_STATE_HOME/pnpm
- On Windows: ~/AppData/Local/pnpm-state
- On macOS: ~/.pnpm-state
- On Linux: ~/.local/state/pnpm
- Tipo: percorso
La cartella in cui pnpm crea il file pnpm-state.json
attualmente utilizzato solo dal controllo aggiornamenti.
cache-dir
- Predefinito:
- If the $XDG_CACHE_HOME env variable is set, then $XDG_CACHE_HOME/pnpm
- On Windows: ~/AppData/Local/pnpm-cache
- On macOS: ~/Library/Caches/pnpm
- On Linux: ~/.cache/pnpm
- Tipo: percorso
The location of the cache (package metadata and dlx).
use-stderr
- Predefinito: false
- Tipo: Booleano
Se true, tutto l'output viene scritto su stderr.
update-notifier
- Predefinito: true
- Tipo: Booleano
Imposta su false
per eliminare la notifica di aggiornamento quando si utilizza una versione precedente di pnpm rispetto all'ultima.
prefer-symlinked-executables
- Predefinito: true, quando node-linker è impostato su hoisted e il sistema è POSIX
- Tipo: Booleano
Crea collegamenti simbolici agli eseguibili in node_modules/.bin
invece di comandi shim. Questa impostazione viene ignorata su Windows, dove funzionano solo i comandi shim.
ignore-compatibility-db
- Predefinito: false
- Tipo: Booleano
Durante l'installazione le dipendenze di alcuni pacchetti vengono automaticamente corrette. Se vuoi disabilitarlo, imposta questa configurazione su false
.
The patches are applied from Yarn's @yarnpkg/extensions
package.
resolution-mode
- Default: highest (was lowest-direct from v8.0.0 to v8.6.12)
- Type: highest, time-based, lowest-direct
Quando resolution-mode
è impostato su time-based
, le dipendenze verranno risolte nel modo seguente:
- Le dipendenze dirette verranno risolte alle versioni più basse. Quindi se c'è
foo@^1.1.0
nelle dipendenze, verrà installato1.1.0
. - Le sottodipendenze verranno risolte dalle versioni pubblicate prima della pubblicazione dell'ultima dipendenza diretta.
Con questa modalità di risoluzione, le installazioni con cache calda sono più veloci. Riduce inoltre la possibilità di dirottamento delle sottodipendenze poiché le sottodipendenze verranno aggiornate solo se vengono aggiornate le dipendenze dirette.
This resolution mode works only with npm's full metadata. Quindi è più lento in alcuni scenari. However, if you use Verdaccio v5.15.1 or newer, you may set the registry-supports-time-field
setting to true
, and it will be really fast.
When resolution-mode
is set to lowest-direct
, direct dependencies will be resolved to their lowest versions.
registry-supports-time-field
- Predefinito: false
- Tipo: Booleano
Impostalo su true
se il registro in uso restituisce il campo "time" nei metadati abbreviati. As of now, only Verdaccio from v5.15.1 supports this.
extend-node-path
- Predefinito: true
- Tipo: Booleano
Quando false
, la NODE_PATH
non è impostata negli shim del comando.
deploy-all-files
- Predefinito: false
- Tipo: Booleano
When deploying a package or installing a local package, all files of the package are copied. By default, if the package has a "files"
field in the package.json
, then only the listed files and directories are copied.
dedupe-direct-deps
- Predefinito: false
- Tipo: Booleano
When set to true
, dependencies that are already symlinked to the root node_modules
directory of the workspace will not be symlinked to subproject node_modules
directories.
dedupe-injected-deps
- Predefinito: true
- Tipo: Booleano
When this setting is enabled, dependencies that are injected will be symlinked from the workspace whenever possible. If the dependent project and the injected dependency reference the same peer dependencies, then it is not necessary to physically copy the injected dependency into the dependent's node_modules
; a symlink is sufficient.