From deeed5ec0bdeacacda3145c16c30b00db5816586 Mon Sep 17 00:00:00 2001
From: h7ml <h7ml@qq.com>
Date: Tue, 25 Jun 2024 04:20:29 +0800
Subject: [PATCH] feat: add bun (#671)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Create a Bun备忘清单 in markdown format to document the common commands
for the Bun package manager, comparing it to npm and Yarn. This includes
installation, project creation, dependency management, script execution,
and cache handling.
---
 docs/bun.md | 180 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 180 insertions(+)
 create mode 100644 docs/bun.md

diff --git a/docs/bun.md b/docs/bun.md
new file mode 100644
index 0000000..14e5d21
--- /dev/null
+++ b/docs/bun.md
@@ -0,0 +1,180 @@
+Bun 备忘清单
+===
+
+这是一份 [`Bun`](https://bun.sh/) 软件包管理器备忘单，其中列出了 `Bun` 常用命令使用清单
+
+入门
+---
+
+### 安装 Bun
+
+```bash
+curl -fsSL https://bun.sh/install | bash
+```
+
+### Bun 与 npm/Yarn 命令比较
+
+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` | 清理缓存目录
+
+### 创建项目
+
+```bash
+bun create <template> <project-name>
+```
+
+示例:
+
+```bash
+bun create react my-react-app
+```
+
+### 安装依赖
+
+```bash
+bun add <package>
+```
+
+选项:
+
+```bash
+--dev, -D # 安装到 devDependencies
+--global, -g # 全局安装包
+--exact, -E # 将包安装为精确版本
+--tilde, -T # 安装有相同次要版本的包的最新版本
+```
+
+### 移除依赖
+
+```bash
+bun remove <package>
+```
+
+### 更新依赖
+
+```bash
+bun upgrade
+```
+
+选项:
+
+```bash
+--latest # 更新到最新版本
+```
+
+### 运行脚本
+
+在 `package.json` 中定义脚本:
+
+```json
+"scripts": {
+  "start": "node index.js",
+  "test": "jest"
+}
+```
+
+运行脚本:
+
+```bash
+bun run <script>
+```
+
+例如:
+
+```bash
+bun run start
+```
+
+### 查看已安装包
+
+```bash
+bun ls
+```
+
+### 清理缓存
+
+```bash
+bun cache clean
+```
+
+### 安装全局包
+
+```bash
+bun global add <package>
+```
+
+### 移除全局包
+
+```bash
+bun global remove <package>
+```
+
+### Bun 提供的其他命令
+
+```bash
+bun bunfile # 管理 Bunfile
+bun dev # 运行开发服务器
+bun test # 运行测试
+bun completions # 生成 shell 补全脚本
+```
+
+示例
+---
+
+### 安装包
+
+```bash
+# 将包添加到 dependencies
+$ bun add <package>
+# 将包添加到 devDependencies
+$ bun add -D <package>
+# 将包安装为精确版本
+$ bun add -E <package>
+# 全局安装包
+$ bun global add <package>
+```
+
+### 移除包
+
+```bash
+$ bun remove <package>
+```
+
+从所有类型的依赖项中删除包
+
+### 查看包
+
+```bash
+# 列出已安装的软件包
+$ bun ls
+```
+
+### 清除缓存
+
+```bash
+$ bun cache clean
+```
+
+清理缓存目录
+
+### 运行脚本
+
+```bash
+$ bun run <script>
+```
+
+在 `package.json` 中定义的脚本将被执行
+
+另见
+---
+
+- [Bun 官方文档](https://bun.sh/docs)
+- [Bun GitHub 仓库](https://github.com/oven-sh/bun)
+- [Bun 快速上手](https://bun.sh/docs/quickstart)