Settings (.npmrc)

pnpm obtiene su configuración de la línea de comandos, las variables de entorno y los archivos .npmrc.

El comando pnpm 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 una lista con formato INI de parámetros clave = 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 si NAME no está configurado. El uso ${NAME:-fallback} devolverá fallback si NAME no está configurado o es un text vacio.

Configuración de elevación de dependencia

hoist

• Por defecto: true
• Tipo: boolean

Cuando es true, todas las dependencias se elevan a node_modules/.pnpm/node_modules. Esto hace que dependencias no listadas sean accesibles a todos los paquetes dentro de node_modules.

hoist-workspace-packages

• Por defecto: true
• Tipo: 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

• Por defecto: ['*']
• Tipo: string[]

Le dice a pnpm qué paquetes deben elevarse a 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*

También puede excluir patrones de la elevación utilizando !.

Por ejemplo:

hoist-pattern[]=*types*
hoist-pattern[]=!@types/react

public-hoist-pattern

• Predeterminado: ['*eslint*', '*prettier*']
• Tipo: string[]

A diferencia de hoist-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: Establecer shamefully-hoist a true es lo mismo que configurar public-hoist-pattern a *.

También puede excluir patrones de la elevación utilizando !.

Por ejemplo:

public-hoist-pattern[]=*types*
public-hoist-pattern[]=!@types/react

shamefully-hoist

• Por defecto: false
• Tipo: Boolean

De forma predeterminada, pnpm crea un semiestricto node_modules, lo que significa que las dependencias tienen acceso a las dependencias no declaradas, pero los módulos fuera de node_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 de node_modules, puede establecer esto en true para elevarlas por usted.

Configuración de Node-Modules

modules-dir

• Por defecto: node_modules
• Tipo: path

El directorio en el que se instalarán las dependencias (en lugar de node_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 el node_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:
  1. 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.
  2. 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.
  3. Si desea publicar su paquete con "bundledDependencies".
  4. Si está ejecutando Node.js con el indicador --preserve-symlinks.
• pnp - no node_modules. Plug'n'Play es una estrategia innovadora para Node que es utilizada por Yarn Berry. Se recomienda establecer también la configuración symlink en false cuando se usa pnp como su enlazador.

symlink

• Por defecto: true
• Tipo: Boolean

Cuando symlink se establece en false, pnpm crea un directorio de tienda virtual sin ningún enlace simbólico. Es una configuración útil junto con node-linker=pnp.

enable-modules-dir

• Por defecto: true
• Tipo: Boolean

Cuando false, 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 ejemplo C:\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).

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

• Por defecto: 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 de node_modules, entonces debe cambiar la configuración node-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.

dlx-cache-max-age

• Default: 1440 (1 day in minutes)
• Tipo: Número

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
  • Si se establece la variable de entorno $PNPM_HOME, entonces $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.

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 la node_modules. Si verify-store-integrity está establecido en false, los archivos del almacén direccionable por el contenido no se comprobarán durante la instalación.

use-running-store-server

danger

Deprecated feature

• 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á.

strict-store-pkg-content-check

Added in: v9.4.0

• Por defecto: true
• Tipo: 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

• Por defecto: true
• Tipo: Boolean

Cuando se establece en false, pnpm no leerá ni generará un archivo pnpm-lock.yaml.

prefer-frozen-lockfile

• Por defecto: true
• Tipo: Boolean

Cuando se establece en true y el pnpm-lock.yaml disponible cumple con la directiva de dependencias package.json, se realiza una instalación autónoma. Una instalación sin cabeza omite toda la resolución de dependencia ya que no necesita modificar el archivo de bloqueo.

lockfile-include-tarball-url

• Por defecto: false
• Tipo: Boolean

Agrega la URL completa al tarball del paquete a cada entrada en pnpm-lock.yaml.

git-branch-lockfile

• Por defecto: false
• Tipo: 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
• Tipo: Número

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.

Registro & Configuración de autenticación

registry

• Predeterminado: https://registry.npmjs.org/
• Tipo: url

La URL base del registro del paquete npm (barra inclinada final incluida).

<scope>:registry

El registro npm que se debe usar para los paquetes del ámbito especificado. Para ejemplo, configuración @babel:registry=https://example.com/packages/npm/ hará cumplir eso cuando use Pnpm Agregar @babel/núcleo, o cualquier @babel Ámbito paquete, el paquete se recuperará de https://example.com/packages/npm en lugar del registro predeterminado.

<URL>:_authToken

Defina la señal de portadora de autenticación que se debe utilizar al acceder al registro especificado. Por ejemplo:

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

También puede utilizar una variable de entorno. 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

Un token de ayuda es un ejecutable que genera un token de autenticación. Esto se puede usar en situaciones en las que authToken no es un valor constante sino algo que se actualiza regularmente, donde un script u otra herramienta puede usar un token de actualización existente para obtener un nuevo token de acceso.

La configuración de la ruta al asistente debe ser una ruta absoluta, sin argumentos. Para mayor seguridad, solo se permite establecer este valor en el usuario .npmrc. De lo contrario, un proyecto podría colocar un valor en el .npmrc local de un proyecto y ejecutar ejecutables arbitrarios.

Configuración de un token de ayuda para el registro predeterminado:

tokenHelper=/home/ivan/token-generator

Configuración de un token de ayuda para el registro predeterminado:

//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ón strict-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ón ca, 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.

<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

• Por defecto: 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-----"

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

• Por defecto: 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 no keyfile option).

Esta configuración contiene información confidencial. No lo escriba en un archivo local .npmrc asignado al repositorio.

<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

• 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 entorno HTTPS_PROXY, https_proxy, HTTP_PROXY o http_proxy, utilizarán sus valores en su lugar.

Si su URL de proxy contiene un nombre de usuario y una contraseña, asegúrese de codificarlos como URL. Por ejemplo:

https-proxy=https://use%21r:pas%2As@my.proxy:1234/foo

No codifique los dos puntos (:) entre el nombre de usuario y la contraseña.

http-proxy

proxy

• Por defecto: 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
• Selecciona Número

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ón ca.

network-concurrency

• Por defecto: 16
• Tipo: Número

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
• Tipo: Número

El factor exponencial para el retroceso de reintento.

fetch-retry-mintimeout

• Default: 10000 (10 seconds)
• Tipo: Número

El tiempo de espera mínimo (base) para reintentar solicitudes.

fetch-retry-maxtimeout

• Predeterminado: 60000 (1 minuto)
• Tipo: Número

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)
• Tipo: Número

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

Cuando true, 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 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

• Por defecto: true
• Tipo: Boolean

Cuando esta configuración se establece en true, los paquetes con dependencias del mismo nivel se deduplicarán después de la resolución del mismo nivel.

Por ejemplo, supongamos que tenemos un espacio de trabajo con dos proyectos y ambos tienen webpack en sus dependencias. Paquete web tiene esbuild en sus dependencias opcionales del mismo nivel, y uno de los proyectos tiene esbuild en sus dependencias. En este caso, pnpm vinculará dos instancias de webpack al directorio node_modules/.pnpm: una con esbuild y otra sin él:

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

Esto tiene sentido porque webpack se usa en dos proyectos y uno de los proyectos no tiene esbuild, por lo que los dos proyectos no pueden compartir la misma instancia de webpack. Sin embargo, esto no es lo que la mayoría de los desarrolladores esperan, especialmente porque en un node_moduleselevado, solo habría una instancia de webpack. Por lo tanto, ahora puede usar la configuración dedupe-peer-dependents para deduplicar webpack cuando no tenga dependencias de pares en conflicto (explicación al final). En este caso, si establecemos dedupe-peer-dependents a true, ambos proyectos utilizarán la misma instancia webpack que es la que tiene esbuild resuelta:

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

¿Qué son las dependencias conflictivas del mismo nivel? Por dependencias del mismo nivel en conflicto nos referimos a un escenario como el siguiente:

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)

En este caso, no podemos deduplicar Paquete web como Paquete web tiene reaccionar en sus dependencias del mismo nivel y reaccionar se resuelve a partir de dos versiones diferentes en el contexto de los dos proyectos.

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

• Por defecto: 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 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

• 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 its engines field.

npm-path

• Tipo: path

The location of the npm binary that pnpm uses for some actions, like publishing.

package-manager-strict

• Por defecto: true
• Tipo: 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

• Por defecto: false
• Tipo: 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

• Por defecto: false
• Tipo: 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

• Por defecto: false
• Tipo: Boolean

No ejecuta ningún sript definido en el proyecto package.json y sus dependencias.

note

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, ELSE true
• 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-options

• Default: NULL
• Tipo: 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

• 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 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

La versión de Node.js que se usará al verificar la configuración de engines de un paquete.

Si desea evitar que los colaboradores de su proyecto agreguen nuevas dependencias incompatibles, use node-version y engine-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. 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

• Por defecto: false
• Tipo: true, false, deep

Si está habilitado, los paquetes disponibles localmente se vinculan a node_modules en lugar de descargarse del registro. Esto es muy conveniente en un monorepo. Si necesita que los paquetes locales también se vinculen a las subdependencias, usar la configuración deep.

De lo contrario, los paquetes se descargan e instalan desde el registro. Sin embargo, los paquetes de espacios de trabajo aún se pueden vincular mediante el protocolo de espacio de trabajo: rangos.

prefer-workspace-packages

• Por defecto: false
• Tipo: Boolean

Si está habilitado, se prefieren los paquetes locales del espacio de trabajo a los paquetes del registro, incluso si hay una versión más nueva del paquete el registro.

Esta configuración solo es útil si el espacio de trabajo no usa save-workspace-protocol.

shared-workspace-lockfile

• Por defecto: true
• Tipo: Boolean

Si está habilitado, pnpm crea un solo archivo pnpm-lock.yaml en la raíz del espacio de trabajo. Esto también significa que todas las dependencias de los paquetes de espacio de trabajo estarán en un solo node_modules (y se vincularán a su carpeta del paquete node_modules para la resolución del módulo de Node).

Ventajas de esta opción:

• 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

note

Aunque todas las dependencias estarán vinculadas a la raíz node_modules, los paquetes tendrán acceso solo a aquellas dependencias que se declaran en su paquete.json, por lo que se conserva la rigurosidad de pnpm. Este es el resultado de la vinculación simbólica antes mencionada.

save-workspace-protocol

• Por defecto: rolling
• Tipo: true, false, rolling

Esta configuración controla cómo se agregan las dependencias que están vinculadas desde el espacio de trabajo a package.json.

Si foo@1.0.0 está en el espacio de trabajo y ejecuta pnpm 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ón save-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

• Por defecto: false
• Tipo: Boolean

Cuando se establece en true, no se imprimirán advertencias de ciclo de espacio de trabajo.

disallow-workspace-cycles

• Por defecto: false
• Tipo: Boolean

When set to true, installation will fail if the workspace has cycles.

Otros ajustes

save-prefix

• Por defecto: '^'
• Type: '^', '~', ''

Configure cómo las versiones de los paquetes instalados en un archivo package.json obtienen prefijos.

Por ejemplo, si un paquete tiene la versión 1.2.3, su versión predeterminada se establece en ^1.2.3, lo que permite actualizaciones menores para ese paquete, pero después de pnpm 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 de foo en package.json a 2, independientemente del valor de save-prefix.

tag

• Por defecto: latest
• Tipo: String

Si agrega un paquete con pnpm 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 al package@version especificado por el comando pnpm 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 archivo pnpm-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 cache (package metadata and dlx).

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 en false 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, cuando node-linker se establece en hoisted y el sistema es POSIX
• Tipo: Boolean

Cree enlaces simbólicos a ejecutables en node_modules/.bin en lugar de shims de comando. Esta configuración se ignora en Windows, donde solo funcionan las correcciones de compatibilidad de comandos.

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 en 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

Cuando el resolution-mode se establece en time-based, las dependencias se resolverán de la siguiente manera:

1. 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.
2. 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.

Cuando resolution-mode se establece en lowest-direct, las dependencias directas se resolverán a sus versiones más bajas.

registry-supports-time-field

• Por defecto: false
• Tipo: Boolean

Establezca esta opción en true Si el registro que está utilizando devuelve el campo "time" en los metadatos abreviados. As of now, only Verdaccio from v5.15.1 supports this.

extend-node-path

• Por defecto: true
• Tipo: Boolean

Cuando false, la variable de entorno NODE_PATH no se establece en el comando shims.

deploy-all-files

• Por defecto: false
• Tipo: Boolean

Al implementar un paquete o instalar un paquete local, se copian todos los archivos del paquete. De forma predeterminada, si el paquete tiene un campo "files" en el paquete.json, solo se copian los archivos y directorios listados.

dedupe-direct-deps

• Por defecto: false
• Tipo: Boolean

Cuando se establece en true, las dependencias que ya están vinculadas al directorio raíz node_modules del espacio de trabajo no se vincularán a los directorios del subproyecto node_modules.

dedupe-injected-deps

• Por defecto: true
• Tipo: 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.