代码规范和格式化
如何在 IndieShow 项目中配置和使用 ESLint、Prettier 和 Git Hooks,实现代码质量检测、自动格式化和提交规范,提升团队协作效率和代码可维护性
代码规范和格式化
本指南将帮助你理解和配置 IndieShow 项目的代码规范、格式化工具和提交规范。良好的代码规范可以提高代码质量,减少错误,并使团队协作更加顺畅。
ESLint 配置
ESLint 用于检查代码质量和编码风格。
1. 基础配置
项目使用 @antfu/eslint-config 作为基础配置:
2. 自定义规则
在 .eslintrc.json 中可以添加自定义规则:
3. 忽略文件
创建 .eslintignore 文件来忽略特定文件:
Git Hooks
项目使用 simple-git-hooks 和 lint-staged 在提交代码时进行检查。
1. simple-git-hooks 配置
在 package.json 中配置:
2. 脚本命令
在 package.json 中的脚本命令:
提交规范
项目使用 commitlint 规范提交信息。
1. 提交格式
2. 类型说明
feat: 新功能fix: 修复问题docs: 文档修改style: 代码格式修改refactor: 代码重构perf: 性能优化test: 测试相关chore: 构建过程或辅助工具的变动
3. 示例
使用方法
1. 代码检查
2. VS Code 集成
在 settings.json 中添加: