从 npm install 迁移到 bun install

在 GitHub 上编辑

bun install 是一个 Node.js 兼容的 npm 客户端，旨在成为 npm 的超快速替代品。

我们投入了大量工作，以确保从 npm install 迁移到 bun install 的路径尽可能简单，就像运行 bun install 而不是 npm install 一样。

专为 Node.js & Bun 设计: bun install 安装一个 Node.js 兼容的 node_modules 文件夹。您可以将其替代 npm install 用于 Node.js 项目，无需任何代码更改，也无需使用 Bun 的运行时。
自动将 package-lock.json 转换为 bun 的 bun.lock lockfile 格式，保留您现有的已解析依赖版本，无需您进行任何手动操作。您可以偷偷地在工作中使用 bun install 代替 npm install 而不被任何人注意到。
.npmrc 兼容: bun install 从 npm 的 .npmrc 读取 npm 注册表配置，因此您可以为 npm 和 Bun 使用相同的配置。
硬链接: 在 Windows 和 Linux 上，bun install 使用硬链接来节省磁盘空间和安装时间。

# It only takes one command to migrate
bun i

# To add dependencies:
bun i @types/bun

# To add devDependencies:
bun i -d @types/bun

# To remove a dependency:
bun rm @types/bun

更快地运行 package.json 脚本

从 package.json 运行脚本，从 node_modules/.bin 运行可执行文件（有点像 npx），以及 JavaScript/TypeScript 文件（就像 node 一样） - 所有这些都来自一个简单的命令。

NPM	Bun
`npm run <script>`	`bun <script>`
`npm exec <bin>`	`bun <bin>`
`node <file>`	`bun <file>`
`npx <package>`	`bunx <package>`

当您使用 bun run <executable> 时，它将选择本地安装的可执行文件

# Run a package.json script:
bun my-script
bun run my-script

# Run an executable in node_modules/.bin:
bun my-executable # such as tsc, esbuild, etc.
bun run my-executable

# Run a JavaScript/TypeScript file:
bun ./index.ts

工作区？是的。

bun install 支持工作区，类似于 npm，但功能更多。

在 package.json 中，您可以将 "workspaces" 设置为相对路径数组。

package.json
{
  "name": "my-app",
  "workspaces": ["packages/*", "apps/*"]
}

按工作区名称过滤脚本

在 Bun 中，--filter 标志接受 glob 模式，并将为所有 name 与模式匹配的工作区包并发运行命令，同时遵循依赖顺序。

bun --filter 'lib-*' my-script
# instead of:
# npm run --workspace lib-foo --workspace lib-bar my-script

更新依赖

要更新依赖，您可以使用 bun update <package>。这会将依赖更新到满足 package.json 中指定的 semver 范围的最新版本。

# Update a single dependency
bun update @types/bun

# Update all dependencies
bun update

# Ignore semver, update to the latest version
bun update @types/bun --latest

# Update a dependency to a specific version
bun update @types/bun@1.2.5

# Update all dependencies to the latest versions
bun update --latest

查看过时的依赖

要查看过时的依赖，请运行 bun outdated。这类似于 npm outdated，但输出更简洁。

bun outdated
┌────────────────────────────────────────┬─────────┬────────┬────────┐
│ Package                                │ Current │ Update │ Latest │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @types/bun (dev)                       │ 1.1.6   │ 1.1.10 │ 1.1.10 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @types/react (dev)                     │ 18.3.3  │ 18.3.8 │ 18.3.8 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @typescript-eslint/eslint-plugin (dev) │ 7.16.1  │ 7.18.0 │ 8.6.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @typescript-eslint/parser (dev)        │ 7.16.1  │ 7.18.0 │ 8.6.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ @vscode/debugadapter (dev)             │ 1.66.0  │ 1.67.0 │ 1.67.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ esbuild (dev)                          │ 0.21.5  │ 0.21.5 │ 0.24.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ eslint (dev)                           │ 9.7.0   │ 9.11.0 │ 9.11.0 │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ mitata (dev)                           │ 0.1.11  │ 0.1.14 │ 1.0.2  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ prettier-plugin-organize-imports (dev) │ 4.0.0   │ 4.1.0  │ 4.1.0  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ source-map-js (dev)                    │ 1.2.0   │ 1.2.1  │ 1.2.1  │
├────────────────────────────────────────┼─────────┼────────┼────────┤
│ typescript (dev)                       │ 5.5.3   │ 5.6.2  │ 5.6.2  │
└────────────────────────────────────────┴─────────┴────────┴────────┘

列出已安装的包

要列出已安装的包，您可以使用 bun pm ls。这将列出使用 Bun 的 lockfile 作为真理来源安装在 node_modules 文件夹中的所有包。您可以传递 -a 标志以列出所有已安装的包，包括传递依赖。

# List top-level installed packages:
bun pm ls
my-pkg node_modules (781)
├── @types/node@20.16.5
├── @types/react@18.3.8
├── @types/react-dom@18.3.0
├── eslint@8.57.1
├── eslint-config-next@14.2.8

# List all installed packages:
bun pm ls -a
my-pkg node_modules
├── @alloc/quick-lru@5.2.0
├── @isaacs/cliui@8.0.2
│   └── strip-ansi@7.1.0
│       └── ansi-regex@6.1.0
├── @jridgewell/gen-mapping@0.3.5
├── @jridgewell/resolve-uri@3.1.2
...

创建包 tarball

要创建包 tarball，您可以使用 bun pm pack。这将在当前目录中创建包的 tarball。

# Create a tarball
bun pm pack

Total files: 46
Shasum: 2ee19b6f0c6b001358449ca0eadead703f326216
Integrity: sha512-ZV0lzWTEkGAMz[...]Gl4f8lA9sl97g==
Unpacked size: 0.41MB
Packed size: 117.50KB

Shebang

如果包在 #!/usr/bin/env node shebang 中引用了 node，则 bun run 默认会遵守它并使用系统的 node 可执行文件。您可以通过将 --bun 传递给 bun run 来强制它使用 Bun 的 node。

当您将 --bun 传递给 bun run 时，我们会创建一个指向本地安装的 Bun 可执行文件（名为 "node"）的符号链接，并将其添加到您的 PATH 中，以供脚本执行期间使用。

# Force using Bun's runtime instead of node
bun --bun my-script

# This also works:
bun run --bun my-script

全局安装

您可以使用 bun i -g <package> 全局安装包。默认情况下，这将安装到您主目录中的 .bun/install/global/node_modules 文件夹中。

# Install a package globally
bun i -g eslint

# Run a globally-installed package without the `bun run` prefix
eslint --init