--- name: 代码规范技能 description: 当用户要求重构、审查或编写代码时,请参考此规范。 metadata: gitea-flow: true --- ## 功能 - 自动同步最新的代码规范 - 自动检查代码是否符合规范 - 自动修复代码 ## 代码规范 在 references 目录下 ## 命令 ### 同步最新代码规范 ```bash npx gitea-flow ai-review --sync ``` ### 审查一个文件 ```bash npx gitea-flow ai-review -b main --head develop -f $CODE_PATH -v 1 ``` - `$CODE_PATH`:需要检查的文件路径 - `-b main`:指定基准分支 - `-h develop`:指定目标分支 - `-v 1`:打印过程 ### 审查一个Commit ```bash npx gitea-flow ai-review -b main --head develop --commits $COMMIT_ID -v 1 ``` - `$COMMIT_ID`:需要检查的Commit ID,可以是多个空格隔开 - `-b main`:指定基准分支 - `-h develop`:指定目标分支 - `-v 1`:打印过程 ### 审查两个分支的差异代码 ```bash npx gitea-flow ai-review -b main --head develop -v 1 ``` - `-b main`:指定基准分支 - `-h develop`:指定目标分支 - `-v 1`:打印过程 ## 使用场景 ### 当用户要求审查代码时 首先需要同步最新的代码规范,然后用户有没有指定审查的文件路径,如果有则审查文件,否则审查两个分支的差异代码。 ### 当用户要求审查Commit时 首先需要同步最新的代码规范,然后用户有没有指定审查的Commit ID,如果有则审查Commit,否则审查两个分支的差异代码。 ### 当用户要求根据代码规范重构代码时 首先需要同步最新的代码规范,然后审查两个分支的差异代码,然后根据审查结果重构代码。 ### 当用户要求编写代码时 首先需要同步最新的代码规范即可。 ## 使用条件 当用户要求重构、审查或编写代码时,请参考此规范,每次调用工具前都同步一下最新规范。