Skip to content

Commit

Permalink
doc: Update bun.md jaywcjlove#671
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Jun 24, 2024
1 parent deeed5e commit aadb7e6
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 31 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ Quick Reference
[Yarn](./docs/yarn.md)<!--rehype:style=background: rgb(33 136 182);-->
[nvm](./docs/nvm.md)<!--rehype:style=background: rgb(132 132 132);-->
[pnpm](./docs/pnpm.md)<!--rehype:style=background: rgb(191 133 0);-->
[Bun](./docs/bun.md)<!--rehype:style=background: rgb(157 49 81);-->
<!--rehype:class=home-card-->

## 工具
Expand Down
13 changes: 13 additions & 0 deletions assets/bun.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 113 additions & 31 deletions docs/bun.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,20 @@ curl -fsSL https://bun.sh/install | bash
```

### Bun 与 npm/Yarn 命令比较
<!--rehype:wrap-class=col-span-2 row-span-3-->

npm/Yarn | Bun | 说明
:- | :- | :-
`npm install`, `yarn add` | `bun add` | 安装依赖
`npm init`, `yarn init` | `bun init` | 创建 `package.json` 文件
`npm install -g`, `yarn global add` | `bun global add` | 全局安装包
`npm run`, `yarn run` | `bun run` | 运行脚本
`npm uninstall`, `yarn remove` | `bun remove` | 移除包
`npm update`, `yarn upgrade` | `bun upgrade` | 更新包
`npm cache clean`, `yarn cache clean` | `bun cache clean` | 清理缓存目录
npm | Yarn | Bun | 说明
:- | :- | :- | :-
`npm install` | `yarn add` | `bun add` | 安装依赖
`npm init` | `yarn init` | `bun init` | 创建 `package.json` 文件
`npm install -g` | `yarn global add` | `bun global add` | 全局安装包
`npm run` | `yarn run` | `bun run` | 运行脚本
`npm uninstall` | `yarn remove` | `bun remove` | 移除包
`npm update` | `yarn upgrade` | `bun upgrade` | 更新包
`npm cache clean` | `yarn cache clean` | `bun cache clean` | 清理缓存目录
<!--rehype:className=left-align-->

参考备忘清单: [npm](./npm.md)[yarn](./yaml.md)[pnpm](./pnpm.md)

### 创建项目

Expand All @@ -36,40 +40,30 @@ bun create <template> <project-name>
bun create react my-react-app
```

### 安装依赖

```bash
bun add <package>
```

选项:

```bash
--dev, -D # 安装到 devDependencies
--global, -g # 全局安装包
--exact, -E # 将包安装为精确版本
--tilde, -T # 安装有相同次要版本的包的最新版本
```

### 移除依赖
### 查看已安装包

```bash
bun remove <package>
bun ls
```

### 更新依赖
### 安装依赖
<!--rehype:wrap-class=row-span-2-->

```bash
bun upgrade
bun add <package>
```

选项:

```bash
--latest # 更新到最新版本
--dev, -D # 安装到 devDependencies
--global, -g # 全局安装包
--exact, -E # 将包安装为精确版本
--tilde, -T # 安装有相同次要版本的包的最新版本
```

### 运行脚本
<!--rehype:wrap-class=row-span-3-->

`package.json` 中定义脚本:

Expand All @@ -92,10 +86,22 @@ bun run <script>
bun run start
```

### 查看已安装包
### 移除依赖

```bash
bun ls
bun remove <package>
```

### 更新依赖

```bash
bun upgrade
```

选项:

```bash
--latest # 更新到最新版本
```

### 清理缓存
Expand Down Expand Up @@ -125,10 +131,86 @@ bun test # 运行测试
bun completions # 生成 shell 补全脚本
```

包管理器
---

### bin 目录的路径

要打印本地项目的 `bin` 目录的路径

```bash
bun pm bin
# /path/to/current/pro/node_modules/.bin
```

全局 bin 目录

```bash
bun pm bin -g
# <$HOME>/.bun/bin
```

### 打印依赖项

```bash
bun pm ls --all
# /path/to/project node_modules (135)
# ├── @eslint-community/[email protected]
# ├── @eslint-community/[email protected]
# ├── @eslint/[email protected]
# ├── @eslint/[email protected]
# ├── ...
```

打印所有已安装的依赖项,包括 `n` 阶依赖项。

### 打印已安装及已解决依赖项

```bash
bun pm ls
# /path/to/project node_modules (135)
# ├── [email protected]
# ├── [email protected]
# ├── [email protected]
# ├── [email protected]
# └── [email protected]
```

打印当前项目中已安装依赖项及其已解决版本的列表,不包括其依赖项

### 全局模块缓存的路径

```bash
bun pm cache
```

要打印 Bun 的全局模块缓存的路径

### 清除全局模块缓存

```bash
bun pm cache rm
```

### 列出全局安装

列出所有全局安装的软件包:

```bash
bun pm ls -g
```

列出所有全局安装的软件包,包括 n 阶依赖项:

```bash
bun pm ls -g --all
```

示例
---

### 安装包
<!--rehype:wrap-class=row-span-2-->

```bash
# 将包添加到 dependencies
Expand Down

0 comments on commit aadb7e6

Please sign in to comment.