From 6ebfe24921e32e83848093364f6b394a34564145 Mon Sep 17 00:00:00 2001 From: lanyuanxiaoyao Date: Tue, 9 Jun 2026 14:30:27 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=20lint/format=20?= =?UTF-8?q?=E5=BC=80=E5=8F=91=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DEVELOPMENT.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 3bcb7b7..63eb5b9 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -47,6 +47,24 @@ bun src/cli.ts help init # 查看 init 命令帮助 bun src/cli.ts version # 查看版本号 ``` +### 代码质量 + +项目使用 oxlint 进行静态分析,oxfmt 进行代码格式化,提交时通过 husky + lint-staged 自动检查。 + +```bash +bun lint # 静态分析所有文件 +bun format # 格式化所有文件(写回) +bun format:check # 检查格式不写回(CI 用) +bun check # 一键 lint + 格式检查 +``` + +**配置文件:** + +- `.oxlintrc.json` — oxlint 规则配置(correctness + suspicious 全开,style 选开) +- `.oxfmtrc.json` — oxfmt 格式设置(双引号、分号、尾逗号、2 空格缩进、100 行宽、LF 换行) + +**pre-commit hook:** 提交时自动对 staged 文件运行 lint 和格式化,lint 失败会阻止提交。 + ## CLI 交互架构 ### 子命令