设置（pnpm-workspace.yaml）

pnpm 从命令行、环境变量和 pnpm-workspace.yaml 获取其配置。

仅有 auth 和 registry 设置从 .npmrc 文件读取。所有其他设置（如 hoistPattern、nodeLinker、shamefullyHoist 等）必须在 pnpm-workspace.yaml 或全局的 ~/.config/pnpm/config.yaml 中配置。

pnpm config 命令可用于读取和编辑项目与全局配置文件的内容。

相关的配置文件有：

• 每个项目的配置文件：/path/to/my/project/pnpm-workspace.yaml
• Global configuration file

配置文件中的值可以使用 ${NAME} 语法包含环境变量。环境变量也可以指定默认值。使用 ${NAME-fallback} 会在 NAME 未设置时返回 fallback。${NAME:-fallback} 会在 NAME 未设置或为空字符串时返回 fallback。

packages

除设置之外，pnpm-workspace.yaml 还定义了工作区的根，并让你能将目录纳入 / 排除出工作区。如果省略 packages 字段，则只有根包包含在工作区中。

例如：

pnpm-workspace.yaml

packages:
  # specify a package in a direct subdir of the root
  - 'my-app'
  # all packages in direct subdirs of packages/
  - 'packages/*'
  # all packages in subdirs of components/
  - 'components/**'
  # exclude packages that are inside test directories
  - '!**/test/**'

根包始终被纳入，即使使用了自定义位置通配符。

catalogs 也在 pnpm-workspace.yaml 文件中定义。详情见 Catalogs。

pnpm-workspace.yaml

packages:
  - 'packages/*'

catalog:
  chalk: ^4.1.2

catalogs:
  react16:
    react: ^16.7.0
    react-dom: ^16.7.0
  react17:
    react: ^17.10.0
    react-dom: ^17.10.0

packageConfigs

自 v11.0.0 起提供

允许为各个工作区包设置项目专属的配置。这取代了工作区项目专属的 .npmrc 文件。

packageConfigs 可以指定为一个从包名到配置对象的映射：

pnpm-workspace.yaml

packages:
  - "packages/project-1"
  - "packages/project-2"
packageConfigs:
  "project-1":
    saveExact: true
  "project-2":
    savePrefix: "~"

或者作为一个由通配符匹配的规则数组：

pnpm-workspace.yaml

packages:
  - "packages/project-1"
  - "packages/project-2"
packageConfigs:
  - match: ["project-1", "project-2"]
    modulesDir: "node_modules"
    saveExact: true

设置

以下按主题分组列出每个设置。跟随某个设置可阅读其文档，或打开某个分组的完整参考。

依赖解析

Full reference →

• overrides
  • Convergence overrides
  • Overriding peer dependencies
• packageExtensions
• allowedDeprecatedVersions
• update
  • update.ignoreDeps
  • update.changeset
  • update.githubActions
  • update.githubActionsServer
• supportedArchitectures
• ignoredOptionalDependencies
• minimumReleaseAge
• minimumReleaseAgeExclude
• minimumReleaseAgeExcludePrune
• minimumReleaseAgeIgnoreMissingTime
• minimumReleaseAgeStrict
• trustPolicy
• trustPolicyExclude
• trustPolicyIgnoreAfter
• trustLockfile
• blockExoticSubdeps
• registries
• namedRegistries

node_modules 设置

Full reference →

• modulesDir
• nodeLinker
• nodeExperimentalPackageMap
• nodePackageMapType
• symlink
• enableModulesDir
• virtualStoreDir
• virtualStoreDirMaxLength
• virtualStoreOnly
• packageImportMethod
• modulesCacheMaxAge
• dlxCacheMaxAge
• virtualStoreType
• enableGlobalVirtualStore

依赖提升设置

Full reference →

• hoist
• hoistWorkspacePackages
• hoistPattern
• publicHoistPattern
• shamefullyHoist
• hoistingLimits

存储设置

Full reference →

• storeDir
• verifyStoreIntegrity
• useRunningStoreServer
• strictStorePkgContentCheck
• frozenStore

锁文件设置

Full reference →

• lockfile
• preferFrozenLockfile
• lockfileIncludeTarballUrl
• gitBranchLockfile
• mergeGitBranchLockfilesBranchPattern
• peersSuffixMaxLength

网络设置

Full reference →

• httpsProxy
• httpProxy
• noProxy
• localAddress
• maxsockets
• strictSsl

请求设置

Full reference →

• gitShallowHosts
• networkConcurrency
• fetchRetries
• fetchRetryFactor
• fetchRetryMintimeout
• fetchRetryMaxtimeout
• fetchTimeout
• fetchWarnTimeoutMs
• fetchMinSpeedKiBps

对等依赖设置

Full reference →

• autoInstallPeers
  • Version Conflicts
  • Conflict Resolution
• dedupePeerDependents
• dedupePeers
• strictPeerDependencies
• resolvePeersFromWorkspaceRoot
• peerDependencyRules
  • peerDependencyRules.ignoreMissing
  • peerDependencyRules.allowedVersions
  • peerDependencyRules.allowAny

CLI 设置

Full reference →

• no-color
• loglevel
• useBetaCli
• recursiveInstall
• engineStrict
• npmPath
• pmOnFail
• ignoreWorkspaceRootCheck

Node.js 设置

Full reference →

• nodeVersion
• runtimeOnFail
• nodeDownloadMirrors

构建设置

Full reference →

• ignoreScripts
• childConcurrency
• sideEffectsCache
• sideEffectsCacheReadonly
• sideEffectsCache.remote
• unsafePerm
• nodeOptions
• verifyDepsBeforeRun
• strictDepBuilds
• allowBuilds
• dangerouslyAllowAllBuilds

版本策略设置

Full reference →

• versioning.fixed
• versioning.ignore
• versioning.maxBump
• versioning.lanes
• versioning.epics
• versioning.changelog.storage

其他设置

Full reference →

• savePrefix
• tag
• globalDir
• globalBinDir
• npmrcAuthFile
• stateDir
• cacheDir
• useStderr
• updateNotifier
• globalShims
• preferSymlinkedExecutables
• ignoreCompatibilityDb
• resolutionMode
• registrySupportsTimeField
• extendNodePath
  • Why this is needed
  • When to disable
• deployAllFiles
• dedupeDirectDeps
• optimisticRepeatInstall
• requiredScripts
• enablePrePostScripts
• scriptShell
• shellEmulator
• catalogMode
• ci
• catalogPrune

工作区设置

这些设置同样在 pnpm-workspace.yaml 中配置，但与其所属的工作区特性一起文档化。

Full reference →

• linkWorkspacePackages
• injectWorkspacePackages
• dedupeInjectedDeps
• syncInjectedDepsAfterScripts
• preferWorkspacePackages
• sharedWorkspaceLockfile
• saveWorkspaceProtocol
• includeWorkspaceRoot
• ignoreWorkspaceCycles
• disallowWorkspaceCycles
• failIfNoMatch

在其他处文档化的设置

• patchedDependencies
• pnpmfile, globalPnpmfile and ignorePnpmfile
• audit.level, audit.ignore and audit.ignorePrune
• initVersion, initLicense and initAuthorName / initAuthorEmail / initAuthorUrl
• legacyDirFiltering
• 在 .npmrc 中读取的授权设置