Settings (.npmrc)
pnpm gets its configuration from the command line, environment variables, and
.npmrc
files.
The pnpm config
command can be used to update and edit the contents of the
user and global .npmrc
files.
Los cuatro archivos relevantes son:
- per-project configuration file (
/path/to/my/project/.npmrc
) - per-workspace configuration file (the directory that contains the
pnpm-workspace.yaml
file) - per-user configuration file (
~/.npmrc
) - global configuration file (
/etc/npmrc
)
All .npmrc
files are an INI-formatted list of key = value
parameters.
Values in the .npmrc
files may contain env variables using the ${NAME}
syntax. Las variables env también se pueden especificar con valores predeterminados. 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.
Configuración de elevación de dependencia
hoist
- Default: true
- Type: boolean
When true
, all dependencies are hoisted to node_modules/.pnpm/node_modules
. This makes
unlisted dependencies accessible to all packages inside node_modules
.
hoist-workspace-packages
- Default: true
- Type: boolean
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
- Default: ['*']
- Type: string[]
Tells pnpm which packages should be hoisted to node_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
- Default: ['*eslint*', '*prettier*']
- Type: string[]
Unlike hoist-pattern
, which hoists dependencies to a hidden modules directory
inside the virtual store, public-hoist-pattern
hoists dependencies matching
the pattern to the root modules directory. 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*
Note: Setting shamefully-hoist
to true
is the same as setting
public-hoist-pattern
to *
.
You may also exclude patterns from hoisting using !
.
Por ejemplo:
public-hoist-pattern[]=*types*
public-hoist-pattern[]=!@types/react
shamefully-hoist
- Default: false
- Type: Boolean
By default, pnpm creates a semistrict node_modules
, meaning dependencies have
access to undeclared dependencies but modules outside of node_modules
do not.
Con este diseño, la mayoría de los paquetes del ecosistema funcionan sin problemas.
However, if some tooling only works when the hoisted dependencies are in the
root of node_modules
, you can set this to true
to hoist them for you.
Configuración de Node-Modules
modules-dir
- Default: node_modules
- Type: path
The directory in which dependencies will be installed (instead of
node_modules
).
node-linker
- Default: isolated
- Type: isolated, hoisted, pnp
Define qué enlazador debe usarse para instalar paquetes de Node.
- isolated - dependencies are symlinked from a virtual store at
node_modules/.pnpm
. - hoisted - a flat
node_modules
without symlinks is created. Same as thenode_modules
created by npm or 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. A React Native project will most probably only work if you use a hoisted
node_modules
. - 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.
- If you want to publish your package with
"bundledDependencies"
. - If you are running Node.js with the --preserve-symlinks flag.
- Su herramienta no funciona bien con enlaces simbólicos. A React Native project will most probably only work if you use a hoisted
- pnp - no
node_modules
. Plug'n'Play is an innovative strategy for Node that is used by Yarn Berry. It is recommended to also setsymlink
setting tofalse
when usingpnp
as your linker.
symlink
- Default: true
- Type: Boolean
When symlink
is set to false
, pnpm creates a virtual store directory without
any symlinks. It is a useful setting together with node-linker=pnp
.
enable-modules-dir
- Default: true
- Type: Boolean
When false
, pnpm will not write any files to the modules directory
(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. If
you have some dependencies with very long paths, you can select a virtual store
in the root of your drive (for instance C:\my-project-store
).
Or you can set the virtual store to .pnpm
and add it to .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.
NOTE: the virtual store cannot be shared between several projects. Cada proyecto debe tener su propio alamcenamiento virtual (excepto en los espacios de trabajo donde se comparte la raíz).
virtual-store-dir-max-length
Added in: v9.1.0
- Default: 120
- 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
- Default: auto
- Type: auto, hardlink, copy, clone, clone-or-copy
Controls the way packages are imported from the store (if you want to disable symlinks inside node_modules
, then you need to change the node-linker setting, not this one).
- auto - try to clone packages from the store. 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 - hard link packages from the store
- clone-or-copy - try to clone packages from the store. Si no se admite la clonación, vuelva a copiar
- copy - copy packages from the store
- clone - clone (AKA copy-on-write or reference link) packages from the store
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
- Default: 10080 (7 days in minutes)
- Type: number
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.
dlx-cache-max-age
- Default: 1440 (1 day in minutes)
- Type: number
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
- Por defecto
- 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
- Type: 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. For
example, if installation is happening on a filesystem mounted at /mnt
,
then the store will be created at /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.
verify-store-integrity
- Default: true
- Type: Boolean
By default, if a file in the store has been modified, the content of this file is checked before linking it to a project's node_modules
. If verify-store-integrity
is set to false
, files in the content-addressable store will not be checked during installation.
use-running-store-server
Deprecated feature
- Default: false
- Type: Boolean
Solo permite la instalación con un servidor de almacenamiento. Si no se está ejecutando ningún servidor de almacenamiento, instalación fallará.
strict-store-pkg-content-check
Added in: v9.4.0
- Default: true
- Type: Boolean
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
.
Configuración de Lockfile
lockfile
- Default: true
- Type: Boolean
When set to false
, pnpm won't read or generate a pnpm-lock.yaml
file.
prefer-frozen-lockfile
- Default: true
- Type: Boolean
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
- Default: false
- Type: Boolean
Add the full URL to the package's tarball to every entry in pnpm-lock.yaml
.
git-branch-lockfile
- Default: false
- Type: Boolean
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.
Por ejemplo:
merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*
You may also exclude patterns using !
.
peers-suffix-max-length
Added in: v9.3.0
- Default: 1000
- Type: number
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.
Registry & Authentication Settings
registry
- Default: https://registry.npmjs.org/
- Type: 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 use pnpm add @babel/core
, or any @babel
scoped
package, the package will be fetched from https://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}
Or you may just use an environment variable directly, without changing .npmrc
at all:
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
- Default: The npm CA certificate
- Type: String, Array or null
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[]="..."
See also the strict-ssl
config.
cafile
- Default: null
- Type: path
Una ruta a un archivo que contiene uno o varios certificados de firma de autoridad de certificación. Similar to the ca
setting, but allows for multiple CAs, as well
as for the CA information to be stored in a file instead of being specified via
CLI.
<URL>:cafile
Define the path to a Certificate Authority file to use when accessing the specified registry. Por ejemplo:
//registry.npmjs.org/:keyfile=client-cert.pem
cert
- Default: null
- Type: 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-----"
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. Por ejemplo:
//registry.npmjs.org/:certfile=server-cert.pem
key
- Default: null
- Type: 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 no keyfile
option).
Esta configuración contiene información confidencial. Don't write it to a local .npmrc
file committed to the repository.
<URL>:keyfile
Define the path to a client key file to use when accessing the specified registry. Por ejemplo:
//registry.npmjs.org/:keyfile=server-key.pem
git-shallow-hosts
- Default: ['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
- Type: 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
- Type: url
Un proxy para usar con solicitudes HTTPS salientes. If the HTTPS_PROXY
, https_proxy
,
HTTP_PROXY
or http_proxy
environment variables are set, their values will be
used instead.
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
- Type: 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
- Default: undefined
- Type: IP Address
La dirección IP de la interfaz local que se usará al realizar conexiones con el registro npm.
maxsockets
- Default: 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
- Type: String
Una cadena de extensiones de dominio separadas por comas para las que no se debe usar un proxy.
strict-ssl
- Default: true
- Type: Boolean
Si realizar o no la validación de la clave SSL al realizar solicitudes al registro a través de HTTPS.
See also the ca
option.
network-concurrency
- Default: 16
- Type: Number
Controla el número máximo de solicitudes HTTP(S) para procesar simultáneamente.
fetch-retries
- Default: 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
- Default: 60000 (1 minute)
- 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
- Default: 60000 (1 minute)
- Type: Number
La cantidad máxima de tiempo de espera para que se completen las solicitudes HTTP.
Peer Dependency Settings
auto-install-peers
- Default: true
- Type: Boolean
When true
, any missing non-optional peer dependencies are automatically installed.
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
- Default: true
- Type: Boolean
When this setting is set to true
, 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 have webpack
in their dependencies. webpack
has esbuild
in its optional peer dependencies, and one of the projects has esbuild
in its dependencies. In this case, pnpm will link two instances of webpack
to the node_modules/.pnpm
directory: one with esbuild
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 because webpack
is used in two projects, and one of the projects doesn't have esbuild
, so the two projects cannot share the same instance of webpack
. However, this is not what most developers expect, especially since in a hoisted node_modules
, there would only be one instance of webpack
. Therefore, you may now use the dedupe-peer-dependents
setting to deduplicate webpack
when it has no conflicting peer dependencies (explanation at the end). In this case, if we set dedupe-peer-dependents
to true
, both projects will use the same webpack
instance, which is the one that has esbuild
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 dedupe webpack
as webpack
has react
in its peer dependencies and react
is resolved from two different versions in the context of the two projects.
strict-peer-dependencies
- Default: false
- Type: 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
- Default: true
- Type: 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
- Type: auto, always, never
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
- Default: false
- Type: 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
- Default: true
- Type: Boolean
If this is enabled, the primary behaviour of pnpm install
becomes that of
pnpm 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
- Default: false
- Type: 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 its engines
field.
npm-path
- Type: path
The location of the npm binary that pnpm uses for some actions, like publishing.
package-manager-strict
- Default: true
- Type: Boolean
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
Added in: v9.2.0
- Default: false
- Type: Boolean
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
Added in: v9.7.0
- Default: false
- Type: Boolean
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. Ejemplo:
{
"packageManager": "pnpm@9.3.0"
}
Configuración de compilación
ignore-scripts
- Default: false
- Type: Boolean
Do not execute any scripts defined in the project package.json
and its
dependencies.
This flag does not prevent the execution of .pnpmfile.cjs
ignore-dep-scripts
- Default: false
- Type: 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
- Default: true
- Type: Boolean
Use and cache the results of (pre/post)install hooks.
side-effects-cache-readonly
- Default: false
- Type: Boolean
Only use the side effects cache if present, do not create it for new packages.
unsafe-perm
- Default: false IF running as root, ELSE true
- Type: 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-options
- Default: NULL
- Type: String
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.
Node.js Settings
use-node-version
- Default: undefined
- 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
running pnpm run
commands or the pnpm node
command.
This may be used instead of .nvmrc
and nvm
. Instead of the following .nvmrc
file:
16.16.0
Use this .npmrc
file:
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
- Default: the value returned by node -v, without the v prefix
- Type: semver
The Node.js version to use when checking a package's engines
setting.
If you want to prevent contributors of your project from adding new incompatible dependencies, use node-version
and engine-strict
in a .npmrc
file at the root of the project:
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. The <releaseDir>
portion of this setting can be any directory from https://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
- Default: false
- Type: true, false, deep
If this is enabled, locally available packages are linked to node_modules
instead of being downloaded from the registry. This is very convenient in a
monorepo. If you need local packages to also be linked to subdependencies, you
can use the deep
setting.
Else, packages are downloaded and installed from the registry. However,
workspace packages can still be linked by using the workspace:
range protocol.
prefer-workspace-packages
- Default: false
- Type: 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 use
save-workspace-protocol
.
shared-workspace-lockfile
- Default: true
- Type: Boolean
If this is enabled, pnpm creates a single pnpm-lock.yaml
file in the root of
the workspace. This also means that all dependencies of workspace packages will
be in a single node_modules
(and get symlinked to their package node_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 root
node_modules
, packages will have access only to those dependencies
that are declared in their package.json
, so pnpm's strictness is preserved.
This is a result of the aforementioned symbolic linking.
save-workspace-protocol
- Default: rolling
- Type: true, false, rolling
This setting controls how dependencies that are linked from the workspace are added to package.json
.
If foo@1.0.0
is in the workspace and you run pnpm add foo
in another project of the workspace, below is how foo
will be added to the dependencies field. The save-prefix
setting also influences how the spec is created.
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
- Default: false
- Type: 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
- Default: false
- Type: Boolean
When set to true
, no workspace cycle warnings will be printed.
disallow-workspace-cycles
- Default: false
- Type: Boolean
When set to true
, installation will fail if the workspace has cycles.
Otros ajustes
save-prefix
- Default: '^'
- Type: '^', '~', ''
Configure how versions of packages installed to a package.json
file get
prefixed.
For example, if a package has version 1.2.3
, by default its version is set to
^1.2.3
which allows minor upgrades for that package, but after
pnpm config set save-prefix='~'
it would be set to ~1.2.3
which only allows
patch upgrades.
Esta configuración se ignora cuando el paquete agregado tiene un rango especificado. For
instance, pnpm add foo@2
will set the version of foo
in package.json
to
2
, regardless of the value of save-prefix
.
tag
- Default: latest
- Type: String
If you pnpm add
a package and you don't provide a specific version, then it
will install the package at the version registered under the tag from this
setting.
This also sets the tag that is added to the package@version
specified by the
pnpm tag
command if no explicit tag is given.
global-dir
- Por defecto
- 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
- Type: path
Especifique un directorio personalizado para almacenar paquetes globales.
global-bin-dir
- Por defecto
- 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
- Type: path
Permite establecer el directorio de destino para los archivos bin de los paquetes instalados globalmente.
state-dir
- Por defecto
- 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
- Type: path
The directory where pnpm creates the pnpm-state.json
file that is currently used only by the update checker.
cache-dir
- Por defecto
- 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
- Type: path
The location of the cache (package metadata and dlx).
use-stderr
- Default: false
- Type: Boolean
Cuando es verdadero, toda la salida se escribe en stderr.
update-notifier
- Default: true
- Type: Boolean
Set to false
to suppress the update notification when using an older version of pnpm than the latest.
prefer-symlinked-executables
- Default: true, when node-linker is set to hoisted and the system is POSIX
- Type: Boolean
Create symlinks to executables in node_modules/.bin
instead of command shims. Esta configuración se ignora en Windows, donde solo funcionan las correcciones de compatibilidad de comandos.
ignore-compatibility-db
- Default: false
- Type: Boolean
Durante la instalación, las dependencias de algunos paquetes se parchean automáticamente. If you want to disable this, set this config to 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
When resolution-mode
is set to time-based
, dependencies will be resolved the following way:
- Las dependencias directas se resolverán a sus versiones más bajas. So if there is
foo@^1.1.0
in the dependencies, then1.1.0
will be installed. - 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.
This resolution mode works only with npm's full metadata. Por lo tanto, es más lento en algunos escenarios. 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
- Default: false
- Type: Boolean
Set this to true
if the registry that you are using returns the "time" field in the abbreviated metadata. As of now, only Verdaccio from v5.15.1 supports this.
extend-node-path
- Default: true
- Type: Boolean
When false
, the NODE_PATH
environment variable is not set in the command shims.
deploy-all-files
- Default: false
- Type: 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 the package.json
, then only the listed files and directories are copied.
dedupe-direct-deps
- Default: false
- Type: Boolean
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
- Default: true
- Type: Boolean
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.