Skip to main content

pnpm

caution
  • pnpm store path
    • 默认会在相同磁盘 - 因为 hardlink 需要相同磁盘
    • 因此想要利用 pnpm 的特性，需要在同一磁盘下 - 容器缓存场景会不太好处理
    • windows 使用 junctions / soft link
  • Typescript 可能检测不到类型，出现类型异常 TypeScript#29808
    • 尝试 "preserveSymlinks": true
info
  • pnpm monorepo docker support #1637
    • monorepo 无法分离单个模块依赖，会包含所有依赖
  • Support workspaces from package.json #2255
    • yarn & pnpm 使用不同的名词描述
  • import npm 项目时，旧的依赖放到 node_modules/.ignored
npm i -g pnpm
# by corepack
# corepack prepare pnpm --activate

# 基本操作同 npm

pnpm install --filter @wener/demo # 选择性安装
pnpm env use --global lts         # 使用 LTS 版本 Node.js

pnpm root # 返回当前 node_modules 路径
pnpm bin  # 返回当前 node_modules/.bin 路径

# store 管理
# ==========
pnpm store status
# pnpm store add <package> # 等同于 pnpm add
pnpm store prune # 移除未引用的包
pnpm store path  # 路径
.npmrc
strict-peer-dependencies = false
auto-install-peers = true
public-hoist-pattern[]=*jest*
  • ~/Library/pnpm
  • NODE_PATH=$HOME/Library/pnpm/global/5/.pnpm/node_modules

配置​

package.json​

package.json
{
  "engines": {
    "node": ">=16",
    "pnpm": ">=7"
  },
  "dependenciesMeta": {
    "button": {
      // 强制注入，而不是软连接 - 适用于依赖基础库版本不同时
      "injected": true
    }
  },
  "peerDependenciesMeta": {
    "bar": {
      // 允许 peer 依赖不存在
      "optional": true
    }
  },
  // 覆盖 publish 配置 - 生成 publish 用的 package.json - 开发时就可以 "main": "src/index.ts"
  "publishConfig": {
    "main": "lib/index.js",
    // types 也可以
    "typings": "lib/index.d.ts",
    // bin, exports, module, browser, esnext, es2015, umd:main, typesVersions, cpu, os
    // 修改 publish 的基础默认 - 默认时当前目录，目录下包含 package.json
    // "directory": "dist",
    // chmod +x - 默认只有 bin 下的可执行
    "executableFiles": ["./dist/shim.js"]
  },

  "pnpm": {
    // 依赖覆盖
    "overrides": {
      "foo": "^1.0.0", // 版本依赖覆盖
      "quux": "npm:@myorg/quux@^1.0.0", // 依赖修改
      "bar@^2.1.0": "3.0.0", // 版本修改
      "qar@1>zoo": "2" // 间接依赖版本修改
    },
    // 扩展依赖的依赖
    // pnpm 和 yarn 维护的扩展库
    // https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts
    "packageExtensions": {
      "react-redux@1": {
        "peerDependencies": {
          "react-dom": "*"
        },
        "optionalDependencies": {},
        "dependencies": {},
        "peerDependenciesMeta": {}
      }
    },
    "peerDependencyRules": {
      "ignoreMissing": ["react"], // 如果 peer 依赖不存在不提示
      "allowedVersions": { "react": "17" } // 允许 peer 依赖版本 - 低版本安装高版本不报错
    },
    // 忽略 依赖 的构建操作 -  preinstall, install, postinstall
    "neverBuiltDependencies": ["fsevents", "level"],
    // 与 neverBuiltDependencies 相反
    "onlyBuiltDependencies": ["fsevents"]
  }
}

.npmrc​

推荐配置
strict-peer-dependencies = false
auto-install-peers = true
全部配置项
hoist=true
# 依赖提升到 node_modules/.pnpm - 隐藏模块目录
# 例如
# hoist-pattern[]=*eslint*
hoist-pattern[]=*

# 依赖提升到 node_modules/
public-hoist-pattern[]=*eslint*
public-hoist-pattern[]=*prettier*

# 允许 node_modules 内模块访问未声明依赖
shamefully-hoist=false

# Windows ~/AppData/Local/pnpm/store
# macOS ~/Library/pnpm/store
# Linux ~/.local/share/pnpm/store
# store-dir

modules-dir=node_modules
# isolated - node_modules/.pnpm
# hoisted - 平坦 node_modules 结构，无 symlink - 同 npm
# pnp - 无 node_modules, 推荐同时设置 symlink=false
node-linker=isolated
symlink=true
enable-modules-dir=true

virtual-store-dir=node_modules/.pnpm
# auto, hardlink, copy, clone
package-import-method=auto
# 分钟 - 默认 7 天
modules-cache-max-age=10080

# 生成 pnpm-lock.yaml
lockfile=true
prefer-frozen-lockfile=true


# highest, time-based, lowest-direct
# time-based 需要 registry-supports-time-field
# https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md#full-metadata-format
resolution-mode=highest
# Verdaccio v5.15.1+
registry-supports-time-field=false


# symlink 到根目录 node_modules 后就不 symlink 到子目录
dedupe-direct-deps=false




# true if node-linker=hoisted
# node_modules/.bin
prefer-symlinked-executables=
verify-store-integrity=true

# https://github.com/yarnpkg/berry/blob/master/packages/yarnpkg-extensions/sources/index.ts
ignore-compatibility-db=false
# 设置 NODE_PATH
extend-node-path=true

# Peer Dependency
# ===============
# 安装 non-optional peer dependencies
auto-install-peers=false
strict-peer-dependencies=true
dedupe-peer-dependents=true
strict-peer-dependencies=false
resolve-peers-from-workspace-root=true

# CLI
# ===
# auto, always, never
color=auto
# no-color
# debug, info, warn, error
loglevel=info
use-beta-cli=false
# pnpm i -> pnpm i -r
recursive-install=true
engine-strict=false
# npm-path

# Build Settings
# ==============
child-concurrency=5
side-effects-cache=true
side-effects-cache-readonly=false
unsafe-perm=false

# Node.js
# =======
use-node-version=
node-version=
# release, rc, nightly, v8-canary
# node-mirror:<releaseDir>=https://nodejs.org/download/<releaseDir>/

# Misc
# ====
use-running-store-server=false
save-prefix=^
tag=latest
# <path to node>/pnpm-global
global-dir=
global-bin-dir=
state-dir=$XDG_STATE_HOME/pnpm
cache-dir=$XDG_CACHE_HOME/pnpm
use-stderr=false
update-notifier=true

# 以下同 npm 配置
registry=https://registry.npmjs.org/
# <scope>:registry
# <URL>:_authToken
# <URL>:tokenHelper
# <URL>:always-auth

# ca=
# cafile=
# cert=
# key=
# strict-ssl

# git-shallow-hosts=['github.com', 'gist.github.com', 'gitlab.com', 'bitbucket.com', 'bitbucket.org']
# local-address
# https-proxy
# proxy
# noproxy
# maxsockets

network-concurrency=16
fetch-retries=2
# fetch-retry-factor,mintimeout,maxtimeout,
# fetch-tomeout

node-linker​

.pnpmfile.cjs​

workspace​

  • 如果版本匹配会默认使用工作空间模块 - npm 常用 *
  • 如果指定版本不匹配则解析失败
  • 使用 workspace: 协议可强制使用工作空间模块
    • 如果 link-workspace-packages 为 false，则只有使用 worksapce: 协议才会 link
pnpm-workspace.yaml
packages:
  - 'apps/*'
  - 'packages/*'

store server​

  • .npmrc 可配置 use-running-store-server=true 使用 store server
# start stop status
# --background
# --network-concurrency
# --protocol=auto
# --store-dir=$HOME/.pnpm-store
# --[no-]lock 锁定文件，避免外部进程修改
# --ignore-stop-requests
# --ignore-upload-requests
pnpm server start --port=5813

Dockerfile​

FROM node:16

RUN curl -f https://get.pnpm.io/v7.1.8.js | node - add --global pnpm

COPY pnpm-lock.yaml ./

# 使用 fetch 使 docker 构建依赖更少
# 正常 install 需要 .npmrc package.json pnpm-lock.yaml .pnpmfile.cjs package.json
RUN pnpm fetch --prod

ADD . ./
RUN pnpm install -r --offline --prod

EXPOSE 8080
CMD [ "node", "server.js" ]

license​

  • @pnpm/license-scanner

Typescript FAQ​

主要是 pnpm symlink 引起问题

Type error: The inferred type of 'trpc' cannot be named without a reference to 'react-query'. This is likely not portable. A type annotation is necessary.​

pnpm-lock.yaml​

Protocol​

  • workspace:
    • link-workspace-packages=false 时必须要明确指定 workspace:
      • 默认 false
    • alias "bar": "workspace:foo@*" - bar 指向 foo
      • publish 会变为 "bar": "npm:foo@1.0.0"
    • 支持相对路径 "foo": "workspace:../foo"
  • file:
    • hard link
    • 会安装依赖
    • pnpm add ./package.tar.gz
  • link:
    • symlink
    • 不会安装依赖
    • pnpm link
    • pnpm add ./some-directory
    • pnpm add https://github.com/indexzero/forever/tarball/v0.5.6
  • npm:
    • alias - `pnpm add lodash@npm:awesome-lodas
  • catalog:
    • catalog: = catalog:default -> catalog
    • catalog:react17 -> catalogs.react17
    • 引用在 pnpm-workspace.yaml 定义的 catalog, catalogs 版本
    • 统一版本管理，方便升级，减少 merge conflict
    • pnpx codemod pnpm/catalog
  • git:
    • pnpm add kevva/is-positive
    • Commit pnpm add kevva/is-positive#97edff6f525f192a3f83cea1944765f769ae2678
    • Branch pnpm add kevva/is-positive#master
    • Branch relative to refs pnpm add zkochan/is-negative#heads/canary
    • Tag pnpm add zkochan/is-negative#2.0.1
    • V prefix tag pnpm add andreineculau/npm-publish-git#v0.0.7
    • semver pnpm add zkochan/is-negative#semver:1.0.0
    • subpath pnpm add RexSkz/test-git-subdir-fetch#path:/packages/simple-react-app
    • git+ssh pnpm add git+ssh://git@github.com:zkochan/is-negative.git#2.0.1
    • git+https pnpm add https://github.com/zkochan/is-negative.git#2.0.1
    • providers pnpm add github:zkochan/is-negative
      • github, gitlab, bitbucket
    • 多个参数 pnpm add RexSkz/test-git-subdir-fetch.git#beta&path:/packages/simple-react-app

packageManager​

.npmrc
# packageManager 名字匹配 pnpm v9.2.0+
# COREPACK_ENABLE_STRICT=0 禁用
package-manager-strict=true # 如果不是 pnpm 则 pnpm 执行会报错

# 版本匹配 v9.2.0
package-manager-strict-version=false
# 自动下载对应版本 v9.7.0
manage-package-manager-versions=false
manage-package-manager-versions=true # v10+

FAQ

  • pnpx -> pnpm dlx
  • pnpm dlx - 下载并执行
  • pnpm create react-app my-app -> pnpm dlx create-react-app my-app
  • pnpm exec 不会下载
    • node_modules/.bin
  • pnpm start -> pnpm run start
  • pnpm test -> pnpm run test

ERR_PNPM_MODIFIED_DEPENDENCY  Packages in the store have been mutated​

pnpm store status 时出现

pnpm install --force # refetch

在使用 nextjs outputStandalone 时，第二次构建出现。

# 临时解决办法 或 不用 outputStandalone
# 删除 nextjs 所在 moudle 即可
rm -rf ./node_modules/.pnpm/*

node_modules 相同包包含多个目录​

grep '^\s*/' pnpm-lock.yaml | sort -u | tr -d ' '

grep '^\s*/' pnpm-lock.yaml | sort -u | tr -d ' ' | grep -E '[0-9.]+_' -C 1
  • e.g.
    • @nestjs/platform-fastify -> fastify@4.15.0
    • fastify@4.17.0
    • 会导致两份 fastify - 导致版本不匹配
    • graphql - Cannot use GraphQLScalarType from another module or realm
  • 带全局状态的不能有多个
    • @mikro-orm/postgresql
    • @mikro-orm/core
  • 以前全局匹配的不能有多个
    • 例如 nestjs 需要匹配依赖
ls -d node_modules/.pnpm/graphql@*
ls -d node_modules/.pnpm/@mikro-orm*

pnpm tsx --experimental-network-imports ./dup.ts
dup.ts
import fs from 'node:fs';
import YAML from 'https://esm.sh/yaml@2.5.0';

let lock = YAML.parse(fs.readFileSync('./pnpm-lock.yaml', 'utf8'));

const deps = Object.entries(lock.packages).map(([id, spec]) => {
  let idx = id.lastIndexOf('@');
  let name = id.slice(0, idx);
  let version = id.slice(idx + 1);
  return { name, version, spec, id };
});

let dups: Record<string, { name: string; version: string; id: string; spec: any }[]> = {};
for (const dep of deps) {
  dups[dep.name] ||= [];
  dups[dep.name].push(dep);
}

let out: string[] = [];

Object.entries(dups).forEach(([k, v]) => {
  if (v.length > 1) {
    out.push(
      `- ${k} - ${v
        .map((v) => v.version)
        .sort()
        .join(', ')}`,
    );
  }
});

console.log(out.join('\n'));
console.log(
  [
    `pkgs: ${Object.keys(lock.packages).length}`,
    `unique pkg: ${Object.keys(dups).length}`,
    `dups: ${Object.values(dups).filter((v) => v.length > 1).length}`,
  ].join(' '),
);

peer deps​

npx install-peerdeps --pnpm <your-package>

npm ci​

pnpm i --frozen-lockfile
CI=true pnpm i

平台参数​

pnpm install --config.platform=linux --config.architecture=x64

Cannot read properties of undefined (reading 'startsWith')​