.npmrc
pnpm obtiene su configuración de la línea de comandos, las variables de entorno y los archivos.npmrc
.
El comandopnpm config
se puede usar para actualizar y editar el contenido de los archivos de usuario y.npmrc
globales.
Los cuatro archivos relevantes son:
- archivo de configuración por proyecto (
/ruta/a/mi/proyecto/.npmrc
) - archivo de configuración por espacio de trabajo (el directorio que contiene el archivo
pnpm-workspace.yaml
) - archivo de configuración por usuario (
~/.npmrc
) - archivo de configuración por usuario (
/etc/npmrc
)
Todos los archivos.npmrc
son unalista con formato INI de parámetrosclave = valor
.
Los valores en los archivos.npmrc
pueden contener variables env usando la sintaxis${NAME}
. Las variables env también se pueden especificar con valores predeterminados. El uso${NAME-fallback}
devolveráfallback
siNAME
no está configurado. El uso${NAME:-fallback}
devolveráfallback
siNAME
no está configurado o es un text vacio.
Configuración de elevación de dependencia
hoist
- Por defecto:true
- Tipo:boolean
Cuando estrue
, todas las dependencias se elevan anode_modules/.pnpm/node_modules
. Esto hace que dependencias no listadas sean accesibles a todos los paquetes dentro denode_modules
.
hoist-workspace-packages
Added in: v8.14.0
- Por defecto:false
- Tipo:boolean
Whentrue
, 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
andpublic-hoist-pattern
).
hoist-pattern
- Por defecto:['*']
- Tipo:string[]
Le dice a pnpm qué paquetes deben elevarse anode_modules/.pnpm/node_modules
. De predeterminada, todos los paquetes se elevan; sin embargo, si sabe que solo algunos paquetes tienen dependencias fantasmas, puede usar esta opción para elevar las dependencias fantasmas (recomendado).
Por ejemplo:
hoist-pattern[]=*eslint*
hoist-pattern[]=*babel*
You may also exclude patterns from hoisting using!
.
Por ejemplo:
hoist-pattern[]=*types*
hoist-pattern[]=!@types/react
public-hoist-pattern
- Predeterminado:['*eslint*', '*prettier*']
- Tipo:string[]
A diferencia dehoist-pattern
, que eleva las dependencias a un directorio de módulos ocultos dentro de la tienda virtual,public-hoist-pattern
eleva las dependencias que hacen coincidir el patrón con el directorio de módulos raíz. Elevar al directorio de módulos raíz significa que el código de la aplicación tendrá acceso a las dependencias fantasma, incluso si modifican la estrategia de resolución de manera incorrecta.
Esta configuración es útil cuando se trata de algunas herramientas conectables defectuosas que resuelven las dependencias correctamente.
Por ejemplo:
public-hoist-pattern[]=*plugin*
Nota: Establecershamefully-hoist
atrue
es lo mismo que configurarpublic-hoist-pattern
a*
.
You may also exclude patterns from hoisting using!
.
Por ejemplo:
public-hoist-pattern[]=*types*
public-hoist-pattern[]=!@types/react
shamefully-hoist
- Por defecto:false
- Tipo:Boolean
De forma predeterminada, pnpm crea un semiestrictonode_modules
, lo que significa que las dependencias tienen acceso a las dependencias no declaradas, pero los módulos fuera denode_modules
no. Con este diseño, la mayoría de los paquetes del ecosistema funcionan sin problemas. Sin embargo, si algunas herramientas solo funcionan cuando las dependencias elevadas están en la raíz denode_modules
, puede establecer esto entrue
para elevarlas por usted.
Configuración de Node-Modules
store-dir
- Por defecto
- If the$PNPM_HOME env variable is set, then$PNPM_HOME/store
- Si se establece la variable de entorno$XDG_DATA_HOME, entonces$XDG_DATA_HOME/pnpm/store
- En Windows:~/AppData/Local/pnpm/store
- En macOS:~/Library/pnpm/store
- En Linux:~/.local/share/pnpm/store
- Tipo:path
La ubicación donde se guardan todos los paquetes en el disco.
El almacenamiento debe estar siempre en el mismo disco en el que se realiza la instalación, Así que habrá un almacenamiento por disco. Si hay un directorio de inicio en el disco actual, el almacenamiento se crea dentro de él. Si no hay un hogar en el disco,, entonces el almacenamiento se crea en la raíz del sistema de archivos. Por, si la instalación se realiza en un sistema de archivos montado en/mnt
, entonces el almacenamiento se creará en/mnt/.pnpm-store
. Lo mismo ocurre con los sistemas Windows.
Es posible configurar un almacenamiento desde un disco diferente, pero en ese caso, pnpm copiará los paquetes del almacenamiento en lugar de vincularlos, ya que los enlaces físicos son posibles en el mismo sistema de archivos.
modules-dir
- Por defecto:node_modules
- Tipo:path
El directorio en el que se instalarán las dependencias (en lugar denode_modules
).
node-linker
- Por defecto:aislado
- Tipo:aislado,elevado,pnp
Define qué enlazador debe usarse para instalar paquetes de Node.
- aisladas - las dependencias están vinculadas desde una tienda virtual en
node_modules/.pnpm
. - elevado - se crea un plano
node_modules
sin enlaces simbólicos. Igual que elnode_modules
creado por npm o Yarn Classic. Una de las bibliotecas de Yarn se usa para elevar, cuando se usa esta configuración. Razones legítimas para usar esta configuración:- Su herramienta no funciona bien con enlaces simbólicos. Lo más probable es que un proyecto React Native solo funcione si usa un
node_modules
elevado. - Su proyecto se implementa en un proveedor de alojamiento sin servidor. Algunos proveedores sin servidor (por ejemplo, AWS Lambda) no admiten enlaces simbólicos. Una solución alternativa para este problema es empaquetar la aplicación antes del despliegue.
- Si desea publicar su paquete con
"bundledDependencies"
. - Si está ejecutando Node.js con el indicador--preserve-symlinks.
- Su herramienta no funciona bien con enlaces simbólicos. Lo más probable es que un proyecto React Native solo funcione si usa un
- pnp - no
node_modules
. Plug'n'Play es una estrategia innovadora para Node que esutilizada por Yarn Berry. Se recomienda establecer también la configuraciónsymlink
enfalse
cuando se usapnp
como su enlazador.
symlink
- Por defecto:true
- Tipo:Boolean
Cuandosymlink
se establece enfalse
, pnpm crea un directorio de tienda virtual sin ningún enlace simbólico. Es una configuración útil junto connode-linker=pnp
.
enable-modules-dir
- Por defecto:true
- Tipo:Boolean
Cuandofalse
, pnpm no escribirá ningún archivo en el directorio de módulos (node_modules
). This is useful for when the modules directory is mounted with filesystem in userspace (FUSE). There is an experimental CLI that allows you to mount a modules directory with FUSE:@pnpm/mount-modules.
virtual-store-dir
- Default:node_modules/.pnpm
- Types:path
El directorio con enlaces a la tienda. Todas las dependencias directas e indirectas del proyecto están vinculadas a este directorio.
Esta es una configuración útil que puede resolver problemas con rutas largas en Windows. Si tienes algunas dependencias con rutas muy largas, puede seleccionar un almacenamiento virtual en la raíz de su unidad (por ejemploC:\my-project-store
).
O puede configurar el almacenamiento virtual en.pnpm
y agregarla a.gitignore
. Este hará que los seguimientos de pila sean más limpios, ya que las rutas a las dependencias estarán un directorio más arriba.
NOTA: el almacenamiento virtual no se puede compartir entre varios proyectos. Cada proyecto debe tener su propio alamcenamiento virtual (excepto en los espacios de trabajo donde se comparte la raíz).
package-import-method
- Default:auto
- Tipo:auto,hardlink,copy,clone,clone-or-copy
Controla la forma en que los paquetes se importan desde el almacenamiento (si desea deshabilitar los enlaces simbólicos dentro denode_modules
, entonces debe cambiar la configuraciónnode-linker, no esta).
- auto - intente clonar paquetes del almacenamiento. Si no se admite la clonación entonces vincula los paquetes del almacenamiento. Si ni la clonación ni la vinculación son posibles, vuelva a copiar
- hardlink - intente clonar paquetes del almacenamiento
- clone-or-copy - intente clonar paquetes del almacenamiento. Si no se admite la clonación, vuelva a copiar
- copy - intente clonar paquetes del almacenamiento
- clone - clonar (también conocido como copia en escritura o enlace de referencia) paquetes del almacenamiento
La clonación es la mejor manera de escribir paquetes en node_modules. Es la forma más rápida y segura. Cuando se usa la clonación, puede editar archivos en sus node_modules y no se modificarán en el almacenamiento central de contenido direccionable.
Desafortunadamente, no todos los sistemas de archivos admiten la clonación. Recomendamos utilizar un sistema de archivos de copia en escritura (CoW) (por ejemplo, Btrfs en lugar de Ext4 en Linux) para obtener la mejor experiencia con pnpm.
modules-cache-max-age
- Predeterminado:10080 (7 días en minutos)
- Tipo:Número
El tiempo en minutos después del cual se deben eliminar los paquetes huérfanos del directorio de módulos. pnpm mantiene un caché de paquetes en el directorio de módulos. Esto aumenta la velocidad de instalación al cambiar de o degradar dependencias.
Configuración de Lockfile
lockfile
- Por defecto:true
- Tipo:Boolean
When set tofalse
, pnpm won't read or generate apnpm-lock.yaml
file.
prefer-frozen-lockfile
- Por defecto:true
- Tipo:Boolean
When set totrue
and the availablepnpm-lock.yaml
satisfies thepackage.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
- Por defecto:false
- Tipo:Boolean
Add the full URL to the package's tarball to every entry inpnpm-lock.yaml
.
git-branch-lockfile
- Por defecto:false
- Tipo:Boolean
When set totrue
, 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 isfeature-foo
, the corresponding lockfile name will bepnpm-lock.feature-foo.yaml
instead ofpnpm-lock.yaml
. It is typically used in conjunction with the command line argument--merge-git-branch-lockfiles
or by settingmerge-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.
Por ejemplo:
merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*
You may also exclude patterns using!
.
Registro & Configuración de autenticación
registry
- Predeterminado:https://registry.npmjs.org/
- Tipo:url
The base URL of the npm package registry (trailing slash included).
<scope>:registry
The npm registry that should be used for packages of the specified scope. For example, setting@babel:registry=https://example.com/packages/npm/
will enforce that when you usepnpm add @babel/core
, or any@babel
scoped package, the package will be fetched fromhttps://example.com/packages/npm
instead of the default registry.
<URL>:_authToken
Define the authentication bearer token to use when accessing the specified registry. Por ejemplo:
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
You may also use an environment variable. Por ejemplo:
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
O simplemente puede usar una variable de entorno directamente, sin cambiar.npmrc
en absoluto:
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
<URL>:tokenHelper
A token helper is an executable which outputs an auth token. This can be used in situations where the authToken is not a constant value but is something that refreshes regularly, where a script or other tool can use an existing refresh token to obtain a new access token.
The configuration for the path to the helper must be an absolute path, with no arguments. In order to be secure, it is only permitted to set this value in the user.npmrc
. Otherwise a project could place a value in a project's local.npmrc
and run arbitrary executables.
Setting a token helper for the default registry:
tokenHelper=/home/ivan/token-generator
Setting a token helper for the specified registry:
//registry.corp.com:tokenHelper=/home/ivan/token-generator
Ajustes de Solicitud
ca
- Valor predeterminado:El certificado CA de npm
- Tipo:Cadena, Arreglo o nulo
El certificado de firma de la autoridad de certificación en el que se confía para las conexiones SSL con el registro. Los valores deben estar en formato PEM (también conocido como "X.509 codificado en Base-64 (.CER)"). Por ejemplo:
ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
Se establece en nulo para permitir sólo a los registradores conocidos, o a un certificado de CA específico para confiar en sólo la autorización de firma específica.
Se puede confiar en varias CA especificando una arreglo de certificados:
ca[]="..."
ca[]="..."
Consulte también la configuraciónstrict-ssl
.
cafile
- Default:null
- Tipo:path
Una ruta a un archivo que contiene uno o varios certificados de firma de autoridad de certificación. Similar a la configuraciónca
, pero permite múltiples CA, así como que la información de CA se almacene en un archivo en lugar de especificarse a través de CLI.
cert
- Default:null
- Tipo:String
Un certificado de cliente para pasar al acceder al registro. Los valores deben estar en formato PEM (también conocido como "X.509 codificado en Base-64 (.CER)"). Por ejemplo:
cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
No es la ruta a un archivo de certificado (y no existe la opcióncertfile
).
key
- Default:null
- Tipo:String
Una clave de cliente para pasar al acceder al registro. Los valores deben estar en formato PEM (también conocido como "X.509 codificado en Base-64 (.CER)"). Por ejemplo:
key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
It is not the path to a key file (and there is nokeyfile
option).
Esta configuración contiene información confidencial. No lo escriba en un archivo local.npmrc
asignado al repositorio.
git-shallow-hosts
- Valor predeterminado:['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
- Tipo:string[]
Al obtener dependencias que son repositorios de Git, si el host aparece en esta configuración, pnpm usará una clonación superficial para obtener solo la confirmación necesaria, no todo el historial.
https-proxy
- Default:null
- Tipo:url
Un proxy para usar con solicitudes HTTPS salientes. Si se establecen las variables de entornoHTTPS_PROXY
,https_proxy
,HTTP_PROXY
ohttp_proxy
, utilizarán sus valores en su lugar.
If your proxy URL contains a username and password, make sure to URL-encode them. Por ejemplo:
https-proxy=https://use%21r:pas%2As@my.proxy:1234/foo
Do not encode the colon (:
) between the username and password.
http-proxy
proxy
- Default:null
- Tipo:url
Un proxy para usar con solicitudes http salientes. Si se establecen las variables de entorno HTTP_PROXY o http_proxy, la biblioteca de solicitud subyacente respetará la configuración del proxy.
local-address
- Predeterminado:indefinido
- Tipo:Dirección IP
La dirección IP de la interfaz local que se usará al realizar conexiones con el registro npm.
maxsockets
- Predeterminado:network-concurrency x 3
- Type:Number
El número máximo de conexiones a usar por origen (combinación de protocolo/host/puerto).
noproxy
- Default:null
- Tipo:String
Una cadena de extensiones de dominio separadas por comas para las que no se debe usar un proxy.
strict-ssl
- Por defecto:true
- Tipo:Boolean
Si realizar o no la validación de la clave SSL al realizar solicitudes al registro a través de HTTPS.
Ver también la opciónca
.
network-concurrency
- Por defecto:16
- Type:Number
Controla el número máximo de solicitudes HTTP(S) para procesar simultáneamente.
fetch-retries
- Por defecto:2
- Type:Number
Cuántas veces se debe volver a intentar si pnpm no se obtiene del registro.
fetch-retry-factor
- Default:10
- Type:Number
El factor exponencial para el retroceso de reintento.
fetch-retry-mintimeout
- Default:10000 (10 seconds)
- Type:Number
El tiempo de espera mínimo (base) para reintentar solicitudes.
fetch-retry-maxtimeout
- Predeterminado:60000 (1 minuto)
- Type:Number
El tiempo de espera de reserva máximo para garantizar que el factor de reintento no haga que las solicitudes sean demasiado largas.
fetch-timeout
- Predeterminado:60000 (1 minuto)
- Type:Number
La cantidad máxima de tiempo de espera para que se completen las solicitudes HTTP.
Peer Dependency Settings
auto-install-peers
- Por defecto:true
- Tipo:Boolean
Cuandotrue
, las dependencias del mismo nivel no opcionales que faltan se instalan automáticamente.
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 requiresreact@^16.0.0
and another requiresreact@^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
- Por defecto:true
- Tipo:Boolean
When this setting is set totrue
, packages with peer dependencies will be deduplicated after peers resolution.
For instance, let's say we have a workspace with two projects and both of them havewebpack
in their dependencies.webpack
hasesbuild
in its optional peer dependencies, and one of the projects hasesbuild
in its dependencies. In this case, pnpm will link two instances ofwebpack
to thenode_modules/.pnpm
directory: one withesbuild
and another one without it:
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
This makes sense becausewebpack
is used in two projects, and one of the projects doesn't haveesbuild
, so the two projects cannot share the same instance ofwebpack
. However, this is not what most developers expect, especially since in a hoistednode_modules
, there would only be one instance ofwebpack
. Therefore, you may now use thededupe-peer-dependents
setting to deduplicatewebpack
when it has no conflicting peer dependencies (explanation at the end). In this case, if we setdedupe-peer-dependents
totrue
, both projects will use the samewebpack
instance, which is the one that hasesbuild
resolved:
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
What are conflicting peer dependencies? By conflicting peer dependencies we mean a scenario like the following one:
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 this case, we cannot dedupewebpack
aswebpack
hasreact
in its peer dependencies andreact
is resolved from two different versions in the context of the two projects.
strict-peer-dependencies
- Por defecto:false
- Tipo:Boolean
Si está habilitado, los comandos fallarán si falta una dependencia del par o no es válida en el árbol.
resolve-peers-from-workspace-root
- Por defecto:true
- Tipo:Boolean
Cuando está habilitado, las dependencias del proyecto del espacio de trabajo raíz se utilizan para resolver las dependencias de pares de cualquier proyecto en el espacio de trabajo. Es una característica útil, ya que puede instalar las dependencias del mismo nivel solo en la raíz del área de trabajo y puede estar seguro de que todos los proyectos del área de trabajo utilizan las mismas versiones de las dependencias del mismo nivel.
Configuración de CLI
[no-]color
- Default:auto
- Tipo:auto,siempre,nunca
Controla los colores en la salida.
- auto - output uses colors when the standard output is a terminal or TTY.
- always - ignore the difference between terminals and pipes. You’ll rarely want this; in most scenarios, if you want color codes in your redirected output, you can instead pass a
--color
flag to the pnpm command to force it to use color codes. The default setting is almost always what you’ll want. - never - turns off colors. This is the setting used by
--no-color
.
loglevel
- Default:info
- Type:debug,info,warn,error
Any logs at or higher than the given level will be shown. You can instead pass--silent
to turn off all output logs.
use-beta-cli
- Por defecto:false
- Tipo:Boolean
Experimental option that enables beta features of the CLI. This means that you may get some changes to the CLI functionality that are breaking changes, or potentially bugs.
recursive-install
- Por defecto:true
- Tipo:Boolean
If this is enabled, the primary behaviour ofpnpm install
becomes that ofpnpm install -r
, meaning the install is performed on all workspace or subdirectory packages.
Else,pnpm install
will exclusively build the package in the current directory.
engine-strict
- Por defecto:false
- Tipo:Boolean
If this is enabled, pnpm will not install any package that claims to not be compatible with the current Node version.
Regardless of this configuration, installation will always fail if a project (not a dependency) specifies an incompatible version in itsengines
field.
npm-path
- Tipo:path
The location of the npm binary that pnpm uses for some actions, like publishing.
Configuración de compilación
ignore-scripts
- Por defecto:false
- Tipo:Boolean
Do not execute any scripts defined in the projectpackage.json
and its dependencies.
Esta bandera no impide la ejecución de.pnpmfile.cjs
ignore-dep-scripts
- Por defecto:false
- Tipo:Boolean
Do not execute any scripts of the installed packages. Scripts of the projects are executed.
child-concurrency
- Default:5
- Type:Number
The maximum number of child processes to allocate simultaneously to build node_modules.
side-effects-cache
- Por defecto:true
- Tipo:Boolean
Use and cache the results of (pre/post)install hooks.
side-effects-cache-readonly
- Por defecto:false
- Tipo:Boolean
Only use the side effects cache if present, do not create it for new packages.
unsafe-perm
- Default:false IF running as root, ELSEtrue
- Tipo:Boolean
Set to true to enable UID/GID switching when running package scripts. If set explicitly to false, then installing as a non-root user will fail.
Node.js Settings
use-node-version
- Predeterminado:indefinido
- Type:semver
Specifies which exact Node.js version should be used for the project's runtime. pnpm will automatically install the specified version of Node.js and use it for runningpnpm run
commands or thepnpm node
command.
This may be used instead of.nvmrc
andnvm
. Instead of the following.nvmrc
file:
16.16.0
Use this.npmrc
file:
use-node-version=16.16.0
node-version
- Default: the value returned bynode -v, without the v prefix
- Type:semver
La versión de Node.js que se usará al verificar la configuración deengines
de un paquete.
Si desea evitar que los colaboradores de su proyecto agreguen nuevas dependencias incompatibles, usenode-version
yengine-strict
en un archivo.npmrc
en la raíz del proyecto:
node-version=12.22.0
engine-strict=true
De esta manera, incluso si alguien usa Node.js v16, no podrá instalar una nueva dependencia que no admita Node.js v12.22.0.
node-mirror:<releaseDir>
- Default:
https://nodejs.org/download/<releaseDir>/
- Type:URL
Establece la URL base para descargar Node.js. La parte<releaseDir>
de esta configuración puede ser cualquier directorio desdehttps://nodejs.org/download:release
,rc
,nightly
,v8-canary
, etc.
Así es como se puede configurar pnpm para descargar Node.js desde el espejo de Node.js en China:
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/
Configuración del espacio de trabajo
link-workspace-packages
- Por defecto:true
- Tipo:true,false,deep
If this is enabled, locally available packages are linked tonode_modules
instead of being downloaded from the registry. This is very convenient in a monorepo. Si necesita que los paquetes locales también se vinculen a las subdependencias, usar la configuracióndeep
.
Else, packages are downloaded and installed from the registry. However, workspace packages can still be linked by using theworkspace:
range protocol.
prefer-workspace-packages
- Por defecto:false
- Tipo:Boolean
If this is enabled, local packages from the workspace are preferred over packages from the registry, even if there is a newer version of the package in the registry.
This setting is only useful if the workspace doesn't usesave-workspace-protocol
.
shared-workspace-lockfile
- Por defecto:true
- Tipo:Boolean
If this is enabled, pnpm creates a singlepnpm-lock.yaml
file in the root of the workspace. This also means that all dependencies of workspace packages will be in a singlenode_modules
(and get symlinked to their packagenode_modules
folder for Node's module resolution).
Advantages of this option:
- cada dependencia es un singleton
- instalaciones más rápidas en un monorepo
- menos cambios en las revisiones de código, ya que están todos en un solo archivo
Even though all the dependencies will be hard linked into the rootnode_modules
, packages will have access only to those dependencies that are declared in theirpackage.json
, so pnpm's strictness is preserved. This is a result of the aforementioned symbolic linking.
save-workspace-protocol
- Default:rolling
- Tipo:true,false,rolling
Esta configuración controla cómo se agregan las dependencias que están vinculadas desde el espacio de trabajo apackage.json
.
Sifoo@1.0.0
está en el espacio de trabajo y ejecutapnpm add foo
en otro proyecto del espacio de trabajo, a continuación se muestra cómo se agregaráfoo
al campo de dependencias. La configuraciónsave-prefix
también influye en cómo se crea la especificación.
save-workspace-protocol | save-prefix | especificaciones |
---|---|---|
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
- Por defecto:false
- Tipo:Boolean
Al ejecutar comandos recursivamente en un espacio de trabajo, ejecútelos también en el proyecto del espacio de trabajo raíz.
ignore-workspace-cycles
Added in: v8.1.0
- Por defecto:false
- Tipo:Boolean
When set totrue
, no workspace cycle warnings will be printed.
disallow-workspace-cycles
Added in: v8.9.0
- Por defecto:false
- Tipo:Boolean
When set totrue
, installation will fail if the workspace has cycles.
Otros ajustes
use-running-store-server
- Por defecto:false
- Tipo:Boolean
Solo permite la instalación con un servidor de almacenamiento. Si no se está ejecutando ningún servidor de almacenamiento, instalación fallará.
save-prefix
- Por defecto:'^'
- Type:'^','~',''
Configure cómo las versiones de los paquetes instalados en un archivopackage.json
obtienen prefijos.
Por ejemplo, si un paquete tiene la versión1.2.3
, su versión predeterminada se establece en^1.2.3
, lo que permite actualizaciones menores para ese paquete, pero después depnpm config establece save-prefix='~'
se configuraría en~ 1.2.3
, lo que solo permite actualizaciones de parches.
Esta configuración se ignora cuando el paquete agregado tiene un rango especificado. Por ejemplo,pnpm add foo@2
configurará la versión defoo
enpackage.json
a2
, independientemente del valor desave-prefix
.
tag
- Por defecto:latest
- Tipo:String
Si agrega un paquete conpnpm add
y no proporciona una versión específica, instalará el paquete en la versión registrada bajo la etiqueta de esta configuración.
Esto también establece la etiqueta que se agrega alpackage@version
especificado por el comandopnpm tag
si no se proporciona una etiqueta explícita.
global-dir
- Por defecto
- Si se establece la variable de entorno$XDG_DATA_HOME, entonces$XDG_DATA_HOME/pnpm/global
- En Windows:~/AppData/Local/pnpm/global
- En macOS:~/Library/pnpm/global
- En Linux:~/.local/share/pnpm/global
- Tipo:path
Especifique un directorio personalizado para almacenar paquetes globales.
global-bin-dir
- Por defecto
- Si se establece la variable de entorno$XDG_DATA_HOME, entonces$XDG_DATA_HOME/pnpm
- En Windows:~/AppData/Local/pnpm
- En macOS:~/Library/pnpm
- En Linux:~/.local/share/pnpm
- Tipo:path
Permite establecer el directorio de destino para los archivos bin de los paquetes instalados globalmente.
state-dir
- Por defecto
- Si se establece la variable de entorno$XDG_STATE_HOME, entonces$XDG_STATE_HOME/pnpm
- En Windows:~/AppData/Local/pnpm-state
- En macOS:~/.pnpm-state
- En Linux:~/.local/state/pnpm
- Tipo:path
El directorio donde pnpm crea el archivopnpm-state.json
que actualmente solo usa el verificador de actualizaciones.
cache-dir
- Por defecto
- Si se establece la variable de entorno$XDG_CACHE_HOME, entonces$XDG_CACHE_HOME/pnpm
- On Windows:~/AppData/Local/pnpm-cache
- On macOS:~/Library/Caches/pnpm
- On Linux:~/.cache/pnpm
- Tipo:path
The location of the package metadata cache.
use-stderr
- Por defecto:false
- Tipo:Boolean
Cuando es verdadero, toda la salida se escribe en stderr.
update-notifier
- Por defecto:true
- Tipo:Boolean
Establézcalo enfalse
para suprimir la notificación de actualización cuando utilice una versión anterior de pnpm que la última.
prefer-symlinked-executables
- Valor predeterminado:true, cuandonode-linker se establece enhoisted y el sistema es POSIX
- Tipo:Boolean
Cree enlaces simbólicos a ejecutables ennode_modules/.bin
en lugar de shims de comando. Esta configuración se ignora en Windows, donde solo funcionan las correcciones de compatibilidad de comandos.
verify-store-integrity
- Por defecto:true
- Tipo:Boolean
De forma predeterminada, si se ha modificado un archivo del almacenamiento, se comprueba el contenido de este archivo antes de vincularlo a lanode_modules
. Siverify-store-integrity
está establecido enfalse
, los archivos del almacén direccionable por el contenido no se comprobarán durante la instalación.
ignore-compatibility-db
- Por defecto:false
- Tipo:Boolean
Durante la instalación, las dependencias de algunos paquetes se parchean automáticamente. Si desea deshabilitar esto, establezca esta configuración enfalse
.
Los parches se aplican desde el paquete@yarnpkg/extensions
de Yarn.
resolution-mode
- Default:highest (waslowest-direct from v8.0.0 to v8.6.12)
- Type:highest,time-based,lowest-direct
Cuando elresolution-mode
se establece entime-based
, las dependencias se resolverán de la siguiente manera:
- Las dependencias directas se resolverán a sus versiones más bajas. Entonces, si hay
foo@^1.1.0
en las dependencias, se instalará1.1.0
. - Las subdependencias se resolverán a partir de versiones que se publicaron antes de que se publicara la última dependencia directa.
Con este modo de resolución, las instalaciones con caché caliente son más rápidas. También reduce la posibilidad de secuestro de subdependencias, ya que las subdependencias se actualizarán solo si se actualizan las dependencias directas.
Este modo de resolución solo funciona conmetadatos completosde npm. Por lo tanto, es más lento en algunos escenarios. Sin embargo, si usaVerdaccio v5.15.1 o más reciente, puede establecer la configuraciónregistry-supports-time-field
entrue
, y será realmente rápido.
Whenresolution-mode
is set tolowest-direct
, direct dependencies will be resolved to their lowest versions.
registry-supports-time-field
- Por defecto:false
- Tipo:Boolean
Establezca esta opción entrue
Si el registro que está utilizando devuelve el campo "time" en los metadatos abreviados. A partir de ahora, soloVerdaccio de v5.15.1 soporta esto.
extend-node-path
- Por defecto:true
- Tipo:Boolean
Whenfalse
, theNODE_PATH
environment variable is not set in the command shims.
deploy-all-files
- Por defecto:false
- Tipo:Boolean
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 thepackage.json
, then only the listed files and directories are copied.