Pular para o conteúdo principal
Versão: Next

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

Os valores nos arquivos .npmrc podem conter variáveis env usando a sintaxe ${NAME}. As variáveis env também podem ser especificadas com valores padrão. Usar ${NAME-fallback} retornará fallback se NAME não estiver definido. ${NAME:-fallback} retornará fallback se NAME não estiver definido ou for uma string vazia.

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

hoist​

  • Valor padrão: false
  • Tipo: Boolean

Quando true, todas as dependências são elevadas para node_modules/.pnpm/node_modules. Isso torna as dependências não listadas acessíveis a todos os pacotes dentro da node_modules.

hoist-pattern​

  • Valor padrão: false
  • Tipo: Boolean

Diz ao pnpm quais pacotes devem ser elevados para a node_modules/.pnpm/node_modules. Por padrão, todos os pacotes são elevados, contudo, se você sabe que apenas alguns pacotes falhos têm dependências fantasmas, você pode usar esta opção para elevar especificamente as dependências fantasmas (recomendado).

Por exemplo:

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

Você também pode excluir padrões de serem elevados usando !.

Por exemplo:

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

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.

Por exemplo:

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

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

shamefully-hoist​

  • Padrão: low
  • Tipo: Boolean

Por padrão, o pnpm cria uma node_modules semi estrita, o que significa que as dependências têm acesso a dependências não declaradas, mas os módulos fora da node_modules não tem. Com esse layout, a maioria dos pacotes no ecossistema funciona sem problemas. No entanto, se alguma ferramenta só funciona quando as dependências elevadas estiverem na raiz da node_modules, você pode definir essa opção como true para elevar elas para você.

Configurações de Módulos Node​

store-dir​

  • Padrão:
    • Se a variável $PNPM_HOME existir, então $PNPM_HOME/store
    • Se a variável $XDG_DATA_HOME existir, 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

O local onde todos os pacotes são salvos no disco.

A store deve estar sempre no mesmo disco em que a instalação está acontecendo, para exista uma store por disco. Se houver um diretório home no disco atual, então a store será criado dentro dele. Se não houver algum diretório home no disco, a store será criada a partir da raiz do sistema de arquivos. Por exemplo, se a instalação está acontecendo em um sistema de arquivos montado em /mnt, então a store será criada em /mnt/.pnpm-store. O mesmo acontece para os sistemas windows.

É possível definir uma store a partir de um disco diferente, mas nesse caso o pnpm vai copiar os pacotes da store ao invés de fazer um hard-linking deles, pois hard links só são possíveis no mesmo sistema de arquivos.

modules-dir​

  • Padrão: node_modules
  • Tipo: caminho

O diretório que as dependências serão instaladas (ao invés de node_modules).

node-linker​

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

Define qual linker deve ser usado para instalar os pacotes do Node.

  • 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. Uma das bibliotecas do Yarn é usada para fazer o hoisting quando essa configuração é usada. 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: true
  • Tipo: Boolean

Quando o symlink é configurado para false, o pnpm cria o diretório virtual da store sem symlinks. It is a useful setting together with node-linker=pnp.

enable-modules-dir​

  • Valor padrão: true
  • 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 (if you want to disable symlinks inside node_modules, then you need to change the node-linker setting, not this one).

  • 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

Cloning is the best way to write packages to node_modules. It is the fastest way and safest way. When cloning is used, you may edit files in your node_modules and they will not be modified in the central content-addressable store.

Unfortunately, not all file systems support cloning. We recommend using a copy-on-write (CoW) file system (for instance, Btrfs instead of Ext4 on Linux) for the best experience with pnpm.

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​

  • Padrão: true
  • Tipo: Boolean

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

prefer-frozen-lockfile​

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

lockfile-include-tarball-url​

  • Padrão: low
  • Tipo: Boolean

Add the full URL to the package's tarball to every entry in pnpm-lock.yaml.

git-branch-lockfile​

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

merge-git-branch-lockfiles-branch-pattern[]=main
merge-git-branch-lockfiles-branch-pattern[]=release*

You may also exclude patterns using !.

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}

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

Configurações de Requisição​

ca​

  • Default: The npm CA certificate
  • Type: String, Array or 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​

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

  • Default: null
  • Type: 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​

  • Default: null
  • Type: 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).

This setting contains sensitive information. Don't write it to a local .npmrc file committed to the repository.

git-shallow-hosts​

  • Default: ['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
  • Tipo: Boolean

When fetching dependencies that are Git repositories, if the host is listed in this setting, pnpm will use shallow cloning to fetch only the needed commit, not all the history.

https-proxy​

  • Default: null
  • Type: 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.

If your proxy URL contains a username and password, make sure to URL-encode them. Por exemplo:

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

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.

local-address​

  • Default: undefined
  • Type: IP Address

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

maxsockets​

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

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

noproxy​

  • Default: null
  • Type: 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​

  • Valor padrão: false
  • Tipo: Boolean

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

dedupe-peer-dependents​

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

  • Padrão: low
  • Tipo: Boolean

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

resolve-peers-from-workspace-root​

  • Valor padrão: false
  • Tipo: Boolean

When enabled, dependencies of the root workspace project are used to resolve peer dependencies of any projects in the workspace. It is a useful feature as you can install your peer dependencies only in the root of the workspace, and you can be sure that all projects in the workspace use the same versions of the peer dependencies.

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.

Configurações de compilação​

ignore-scripts​

  • Padrão: low
  • Tipo: Boolean

Do not execute any scripts defined in the project package.json and its dependencies.

nota

This flag does not prevent the execution of .pnpmfile.cjs

ignore-dep-scripts​

  • Padrão: low
  • Tipo: Boolean

Do not execute any scripts of the installed packages. Scripts of the projects are executed.

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.

Configurações do Node.js​

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

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/

Configurações da Workspace (Área de Trabalho)​

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

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

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

  • Padrão: low
  • Tipo: Boolean

When executing commands recursively in a workspace, execute them on the root workspace project as well.

ignore-workspace-cycles​

Added in: v8.1.0

  • Padrão: low
  • Tipo: Boolean

When set to true, no workspace cycle warnings will be printed.

disallow-workspace-cycles​

Added in: v8.9.0

  • Padrão: low
  • Tipo: Boolean

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

Outras configurações​

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: '^'
  • 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.

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

  • Padrão:
    • If the $XDG_DATA_HOME env variable is set, then $XDG_DATA_HOME/pnpm/global
    • On Windows: ~/AppData/Local/pnpm/global
    • On macOS: ~/Library/pnpm/global
    • On Linux: ~/.local/share/pnpm/global
  • Tipo: caminho

Specify a custom directory to store global packages.

global-bin-dir​

  • Padrão:
    • If the $XDG_DATA_HOME env variable is set, then $XDG_DATA_HOME/pnpm
    • On Windows: ~/AppData/Local/pnpm
    • On macOS: ~/Library/pnpm
    • On Linux: ~/.local/share/pnpm
  • Tipo: caminho

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

state-dir​

  • Padrão:
    • If the $XDG_STATE_HOME env variable is set, then $XDG_STATE_HOME/pnpm
    • On Windows: ~/AppData/Local/pnpm-state
    • On macOS: ~/.pnpm-state
    • On Linux: ~/.local/state/pnpm
  • Tipo: caminho

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

cache-dir​

  • Padrão:
    • If the $XDG_CACHE_HOME env variable is set, then $XDG_CACHE_HOME/pnpm
    • On Windows: ~/AppData/Local/pnpm-cache
    • On macOS: ~/Library/Caches/pnpm
    • On Linux: ~/.cache/pnpm
  • Tipo: 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.

prefer-symlinked-executables​

  • Default: true, when node-linker is set to hoisted and the system is POSIX
  • Tipo: Boolean

Create symlinks to executables in node_modules/.bin instead of command shims. This setting is ignored on Windows, where only command shims work.

verify-store-integrity​

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

ignore-compatibility-db​

  • Padrão: low
  • Tipo: Boolean

During installation the dependencies of some packages are automatically patched. 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:

  1. Direct dependencies will be resolved to their lowest versions. So if there is foo@^1.1.0 in the dependencies, then 1.1.0 will be installed.
  2. Subdependencies will be resolved from versions that were published before the last direct dependency was published.

With this resolution mode installations with warm cache are faster. It also reduces the chance of subdependency hijacking as subdependencies will be updated only if direct dependencies are updated.

This resolution mode works only with npm's full metadata. So it is slower in some scenarios. 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​

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

  • Valor padrão: false
  • Tipo: Boolean

When false, the NODE_PATH environment variable is not set in the command shims.

deploy-all-files​

  • Padrão: low
  • Tipo: Boolean

When deploying a package or installing a local package, all files of the package are copied. By default, if the package has a "files" field in the package.json, then only the listed files and directories are copied.

dedupe-direct-deps​

Added in: v8.1.0

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