本项目集成了 eslint 、prettier 和 husky 对代码格式进行格式校验
代码校验
使用 eslint 进行校验
1 | pnpm run lint |
代码格式化
使用 prettier 自动格式化代码
1 | pnpm run format |
代码提交
代码提交时需要按照commitlint来对提交信息进行格式化
- type:commit 的类型;
- feat:新功能、新特性;
- fix: 修改 bug;
- perf:更改代码,以提高性能;
- refactor:代码重构(重构,在不影响代码内部行为、功能下的代码修改);
- docs:文档修改;
- style:代码格式修改, 注意不是 css 修改(例如分号修改);
- test:测试用例新增、修改;
- build:影响项目构建或依赖项修改;
- revert:恢复上一次提交;
- ci:持续集成相关文件修改;
- chore:其他修改(不在上述类型中的修改);
- release:发布新版本;
- workflow:工作流相关文件修改。
1 | # 示例1 |