Skip to content

docs(contribution): more information about bun installing and autocorrect #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jinzhongjia merged 1 commit into from
Feb 7, 2025
Merged

docs(contribution): more information about bun installing and autocorrect #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,17 @@
- 合并到上游仓库，并由 github action 自动构建

```sh
bun i // 安装依赖
bun dev // 启动热更开发服务
bun format // 运行 prettier 格式化程序
bun format // 运行 prettier, zig fmt 和 autocorrect 格式化程序
bun run build // 构建产物
bun run preview // 运行预览
```

注意：本文档所使用的构建工具为 [bunjs](https://bun.sh/)，在提交时请勿将其他 nodejs 的包管理工具的额外配置文件添加到仓库中。
> [!NOTE]
> 请自行安装 `bun` （建议也安装 `autocorrect`，并且在提交前运行 `bun format`）

> [!NOTE]
> 本文档所使用的构建工具为 [bunjs](https://bun.sh/)，在提交时请勿将其他 nodejs 的包管理工具的额外配置文件添加到仓库中。

> 如需要更新依赖，请参照此处 [Lockfile](https://bun.sh/docs/install/lockfile) 先设置 git 使用 bun 来 diff 文件！
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"scripts": {
"format": "prettier --write . && zig fmt . --exclude zig-out",
"format": "prettier --write . && zig fmt . --exclude zig-out && autocorrect --fix",
"dev": "vitepress dev course",
"build": "vitepress build course",
"preview": "vitepress preview course",
Expand Down