diff --git a/SKILL.md b/SKILL.md index 776a219..a7fcb3c 100644 --- a/SKILL.md +++ b/SKILL.md @@ -1,5 +1,5 @@ --- -name: 代码规范技能 +name: code-review description: 当用户要求重构、审查或编写代码时,请参考此规范。 metadata: spaceflow: true @@ -7,26 +7,26 @@ metadata: ## 功能 -- 自动同步最新的代码规范 -- 自动检查代码是否符合规范 -- 自动修复代码 - -## 代码规范 - -在 references 目录下 +- 检查代码是否符合规范 ## 命令 ### 同步最新代码规范 ```bash -npx spaceflow install +pnpm spaceflow install +``` + +### 审查当前未提交的代码 + +```bash +pnpm spaceflow review ``` ### 审查一个文件 ```bash -npx spaceflow review -b main --head develop -f $CODE_PATH +pnpm spaceflow review -b main --head develop -f $CODE_PATH ``` - `$CODE_PATH`:需要检查的文件路径 @@ -36,7 +36,7 @@ npx spaceflow review -b main --head develop -f $CODE_PATH ### 审查一个Commit ```bash -npx spaceflow review -b main --head develop --commits $COMMIT_ID +pnpm spaceflow review -b main --head develop --commits $COMMIT_ID ``` - `$COMMIT_ID`:需要检查的Commit ID,可以是多个空格隔开 @@ -46,7 +46,7 @@ npx spaceflow review -b main --head develop --commits $COMMIT_ID ### 审查两个分支的差异代码 ```bash -npx spaceflow review -b main --head develop +pnpm spaceflow review -b main --head develop ``` - `-b main`:指定基准分支 @@ -54,6 +54,10 @@ npx spaceflow review -b main --head develop ## 使用场景 +### 当用户要求审查当前代码 + +首先需要同步最新的代码规范,然后直接执行上面的命令。 + ### 当用户要求审查代码时 首先需要同步最新的代码规范,然后用户有没有指定审查的文件路径,如果有则审查文件,否则审查两个分支的差异代码。