Pular para o conteúdo principal
Versão: 7.x

.npmrc

O pnpm obtém sua configuração da linha de comando, variáveis de ambiente e arquivos .npmrc.

O comando pnpm config pode ser usado para atualizar e editar o conteúdo dos arquivos user e global .npmrc.

Os quatro arquivos relevantes são:

  • arquivo de configuração por projeto (/path/to/my/project/.npmrc)
  • arquivo de configuração por área de trabalho (o diretório que contém o arquivo pnpm-workspace.yaml)
  • arquivo de configuração por usuário (~/.npmrc)
  • arquivo de configuração global (/etc/npmrc)

Todos os arquivos .npmrc são listas formatadas em INI de parâmetros chave = valor.

Configurações de elevação de dependência​

hoist​

  • Valor padrão: false
  • Tipo: Boolean

When true, all dependencies are hoisted to node_modules/.pnpm. This makes unlisted dependencies accessible to all packages inside node_modules.

hoist-pattern​

  • Valor padrão: false
  • Tipo: Boolean

Tells pnpm which packages should be hoisted to node_modules/.pnpm. By default, all packages are hoisted - however, if you know that only some flawed packages have phantom dependencies, you can use this option to exclusively hoist the phantom dependencies (recommended).

For instance:

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

public-hoist-pattern​

  • Padrão: ['*eslint*', '*mais bonito*']
  • Tipo: Boolean

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. Hoisting to the root modules directory means that application code will have access to phantom dependencies, even if they modify the resolution strategy improperly.

This setting is useful when dealing with some flawed pluggable tools that don't resolve dependencies properly.

For instance:

public-hoist-pattern[]=*plugin*

Note: Setting shamefully-hoist to true is the same as setting public-hoist-pattern to *.

shamefully-hoist​

  • Padrão: low
  • Tipo: Boolean

By default, pnpm creates a semistrict node_modules, meaning dependencies have access to undeclared dependencies but modules outside of node_modules do not. With this layout, most of the packages in the ecosystem work with no issues. 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.

Configurações de Módulos Node​

store-dir​

  • Padrão:
    • Se a variável env $XDG_DATA_HOME estiver definida, então $XDG_DATA_HOME/pnpm/store
    • No Windows: ~/AppData/Local/pnpm/store
    • No macOS: ~/Library/pnpm/store
    • No Linux: ~/.local/share/pnpm/store
  • Tipo: caminho

The location where all the packages are saved on the disk.

The store should be always on the same disk on which installation is happening, so there will be one store per disk. Se houver um diretório inicial no disco atual, o armazenamento será criado dentro dele. Se não houver home no disco,, o armazenamento será criado na raiz do sistema de arquivos. For example, if installation is happening on a filesystem mounted at /mnt, then the store will be created at /mnt/.pnpm-store. The same goes for Windows systems.

It is possible to set a store from a different disk but in that case pnpm will copy packages from the store instead of hard-linking them, as hard links are only possible on the same filesystem.

modules-dir​

  • Padrão: node_modules
  • Tipo: caminho

The directory in which dependencies will be installed (instead of node_modules).

node-linker​

  • Padrão: isolated
  • Tipo: isolated, hoisted, pnp

Defines what linker should be used for installing Node packages.

  • isolated - as dependências são vinculadas a partir de uma loja virtual em node_modules/.pnpm.
  • hoisted - um node_modules limpo sem links simbólicos é criado. O mesmo que node_modules criado por npm ou Yarn Classic. Razões legítimas para usar esta configuração:
    1. Suas ferramentas não funcionam bem com links simbólicos. Um Projeto Native reagirá muito provavelmente só funcionará se você usar um hoisted node_modules.
    2. Seu projeto é implantado em um provedor de hospedagem sem servidor. Alguns provedores sem servidor (por exemplo, AWS Lambda) não oferecem suporte a links simbólicos. Uma solução alternativa para esse problema é agrupar seu aplicativo antes da implantação.
    3. Se você deseja publicar seu pacote com "bundledDependencies".
    4. Se você estiver executando o Node.js com o parâmetro --preserve-symlinks.
  • pnp - sem node_modules. Plug'n'Play é uma estratégia inovadora para Node que é utilizada pelo Yarn Berry. Recomenda-se também definir a configuração symlink para false ao usar pnp como seu vinculador.
  • Valor padrão: false
  • Tipo: 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​

  • Valor padrão: false
  • Tipo: 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​

  • Padrão: node_modules/.pnpm
  • Tipo: caminho

The directory with links to the store. All direct and indirect dependencies of the project are linked into this directory.

This is a useful setting that can solve issues with long paths on 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. This will make stacktraces cleaner as paths to dependencies will be one directory higher.

NOTE: the virtual store cannot be shared between several projects. Every project should have its own virtual store (except for in workspaces where the root is shared).

package-import-method​

  • Padrão: auto
  • Type: auto, hardlink, copy, clone, clone-or-copy

Controls the way packages are imported from the store.

  • auto - tente clonar pacotes da loja. Se a clonagem não for suportada, então os pacotes hardlink da loja. Se nem a clonagem nem a vinculação forem possíveis, volte a copiar
  • hardlink - pacotes de links rígidos da loja
  • clone-or-copy - tenta clonar pacotes a partir da store. Se a clonagem não é suportada, então volte para copia comum
  • copy - copia pacotes da loja
  • clone - pacotes clone (também conhecido como copy-on-write ou link de referência) da loja

modules-cache-max-age​

  • Padrão: 10080 (7 dias em minutos)
  • Tipo: número

The time in minutes after which orphan packages from the modules directory should be removed. pnpm keeps a cache of packages in the modules directory. This boosts installation speed when switching branches or downgrading dependencies.

Configurações do arquivo de bloqueio​

lockfile​

  • Valor padrão: false
  • Tipo: Boolean

When set to false, pnpm won't read or generate a pnpm-lock.yaml file.

prefer-frozen-lockfile​

  • Valor padrão: false
  • Tipo: 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.

Configurações de Autenticação & Registro​

registry​

The base URL of the npm package registry (trailing slash included).

<escopo>: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 exemplo:

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

You may also use an environment variable. Por exemplo:

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

<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

<URL>:always-auth​

  • Padrão: low
  • Tipo: Boolean

Force pnpm to always require authentication (even for GET requests) when accessing the specified registry. Por exemplo:

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

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

Configurações de Requisição​

ca​

  • Padrão: O certificado CA do npm
  • Tipo: String, Array ou null

The Certificate Authority signing certificate that is trusted for SSL connections to the registry. Values should be in PEM format (AKA "Base-64 encoded X.509 (.CER)"). Por exemplo:

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

Set to null to only allow known registrars, or to a specific CA cert to trust only that specific signing authority.

Multiple CAs can be trusted by specifying an array of certificates:

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

See also the strict-ssl config.

cafile​

  • Padrão: null
  • Tipo: caminho

A path to a file containing one or multiple Certificate Authority signing certificates. 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.

cert​

  • Padrão: null
  • Tipo: String

A client certificate to pass when accessing the registry. Values should be in PEM format (AKA "Base-64 encoded X.509 (.CER)"). Por exemplo:

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

It is not the path to a certificate file (and there is no certfile option).

key​

  • Padrão: null
  • Tipo: String

A client key to pass when accessing the registry. Values should be in PEM format (AKA "Base-64 encoded X.509 (.CER)"). Por exemplo:

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).

Essa configuração contém informações confidenciais. Não o grave em um arquivo local .npmrc confirmado no repositório.

git-shallow-hosts​

  • Padrão: ['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
  • Tipo: Boolean

Ao buscar dependências que são repositórios Git, se o host estiver listado nesta configuração, o pnpm usará clonagem superficial para buscar apenas o commit necessário, não todo o histórico.

https-proxy​

  • Padrão: null
  • Tipo: url

A proxy to use for outgoing HTTPS requests. If the HTTPS_PROXY, https_proxy, HTTP_PROXY or http_proxy environment variables are set, their values will be used instead.

local-address​

  • Default: undefined
  • Type: IP Address

The IP address of the local interface to use when making connections to the npm registry.

proxy​

  • Padrão: null
  • Tipo: url

A proxy to use for outgoing http requests. If the HTTP_PROXY or http_proxy environment variables are set, proxy settings will be honored by the underlying request library.

maxsockets​

  • Default: network-concurrency x 3
  • Tipo: Number

The maximum number of connections to use per origin (protocol/host/port combination).

noproxy​

  • Padrão: null
  • Tipo: String

A comma-separated string of domain extensions that a proxy should not be used for.

strict-ssl​

  • Valor padrão: false
  • Tipo: Boolean

Whether or not to do SSL key validation when making requests to the registry via HTTPS.

See also the ca option.

network-concurrency​

  • Default: 16
  • Tipo: Number

Controls the maximum number of HTTP(S) requests to process simultaneously.

fetch-retries​

  • Default: 2
  • Tipo: Number

How many times to retry if pnpm fails to fetch from the registry.

fetch-retry-factor​

  • Default: 10
  • Tipo: Number

The exponential factor for retry backoff.

fetch-retry-mintimeout​

  • Default: 10000 (10 seconds)
  • Tipo: Number

The minimum (base) timeout for retrying requests.

fetch-retry-maxtimeout​

  • Default: 60000 (1 minute)
  • Tipo: Number

The maximum fallback timeout to ensure the retry factor does not make requests too long.

fetch-timeout​

  • Default: 60000 (1 minute)
  • Tipo: Number

The maximum amount of time to wait for HTTP requests to complete.

Configurações de dependência de pares​

auto-install-peers​

  • Padrão: low
  • Tipo: Boolean

When true, any missing non-optional peer dependencies are automatically installed.

strict-peer-dependencies​

  • Valor padrão: false
  • Tipo: Boolean

If this is enabled, commands will fail if there is a missing or invalid peer dependency in the tree.

Configurações da CLI​

[no-]color​

  • Padrão: auto
  • Type: auto, always, never

Controls colors in the output.

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

  • Padrão: low
  • 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​

  • Valor padrão: false
  • 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​

  • Padrão: low
  • 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: caminho

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

Build Settings​

child-concurrency​

  • Default: 5
  • Tipo: Number

The maximum number of child processes to allocate simultaneously to build node_modules.

side-effects-cache​

  • Valor padrão: false
  • Tipo: Boolean

Use and cache the results of (pre/post)install hooks.

side-effects-cache-readonly​

  • Padrão: low
  • 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.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.

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

This way, even if someone is using Node.js v16, they will not be able to install a new dependency that doesn't support Node.js v12.22.0.

node-mirror:<releaseDir>​

  • Default: https://nodejs.org/download/<releaseDir>/
  • Type: URL

Sets the base URL for downloading Node.js. The <releaseDir> portion of this setting can be any directory from https://nodejs.org/download: release, rc, nightly, v8-canary, etc.

Here is how pnpm may be configured to download Node.js from Node.js mirror in 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/

Workspace Settings​

  • Valor padrão: false
  • Tipo: 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​

  • Padrão: low
  • 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 use save-workspace-protocol.

shared-workspace-lockfile​

  • Valor padrão: false
  • Tipo: 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:

  • every dependency is a singleton
  • faster installations in a monorepo
  • fewer changes in code reviews as they are all in one file
note

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​

  • Valor padrão: false
  • Tipo: true, false, rolling

Essa configuração controla como as dependências vinculadas do workspace são adicionadas ao package.json.

Se foo@1.0.0 estiver no workspace e você executar pnpm add foo em outro projeto do workspace, veja abaixo como foo será adicionado ao campo de dependências. A configuração save-prefix também influencia como a especificação é criada.

save-workspace-protocolsave-prefixspec
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​

Added in: v7.4.0

  • Padrão: low
  • Tipo: Boolean

Ao executar comandos recursivamente em um workspace, também executa no projeto do workspace raiz.

Other Settings​

use-running-store-server​

  • Padrão: low
  • Tipo: Boolean

Only allows installation with a store server. If no store server is running, installation will fail.

save-prefix​

  • Default: '^'
  • Tipo: String

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.

This setting is ignored when the added package has a range specified. 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
  • Tipo: 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​

  • Padrão:
    • Se a variável de ambiente $XDG_DATA_HOME estiver definida, então $XDG_DATA_HOME/pnpm/store
    • No Windows: ~/AppData/Local/pnpm/global
    • No macOS: ~/Library/pnpm/store
    • No Linux: ~/.local/share/pnpm/store
  • Tipo: caminho

Specify a custom directory to store global packages.

global-bin-dir​

Allows to set the target directory for the bin files of globally installed packages.

state-dir​

  • Padrão:
    • Se a variável de ambiente $XDG_STATE_HOME estiver definida, então $XDG_STATE_HOME/pnpm
    • No Windows: ~/AppData/Local/pnpm-state
    • No macOS: ~/.pnpm-state
    • No Linux: ~/.local/state/pnpm
  • Tipo: caminho

The directory where pnpm creates the pnpm-state.json file that is currently used only by the update checker.

cache-dir​

  • Padrão:
    • Se a variável de ambiente $XDG_CACHE_HOME estiver definida, então $XDG_CACHE_HOME/pnpm
    • No Windows: ~/AppData/Local/pnpm-cache
    • No macOS: ~/Library/Caches/pnpm
    • No Linux: ~/.cache/pnpm
  • Tipo: caminho

The location of the package metadata cache.

use-stderr​

  • Padrão: low
  • Tipo: Boolean

When true, all the output is written to stderr.

update-notifier​

  • Valor padrão: false
  • Tipo: Boolean

Set to false to suppress the update notification when using an older version of pnpm than the latest.