nestjs-starter-rest-api如何用Husky+Commitlint+SonarCloud打造规范化开发工作流

nestjs-starter-rest-api如何用HuskyCommitlintSonarCloud打造规范化开发工作流【免费下载链接】nestjs-starter-rest-apiNestJS Starter Kit. Monolithic Backend. REST API.项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-starter-rest-apinestjs-starter-rest-api 是一款基于 NestJS 的单体 REST API 启动套件Starter Kit。项目除业务代码外还内置了Husky Commitlint SonarCloud三件套搭配 lint-staged 与 CI 工作流让「写代码 → 提交 → 推送 → 质量门禁」全程自动运转。本文带你快速看懂这套规范化开发工作流的每一道关卡并学会如何在自己的项目中复用。 三件套如何分工先建立一个整体认知三个工具分别把守在开发流程的三个位置层层递进。工具把关位置核心职责Husky本地 Git 钩子在提交瞬间自动触发检查拦截问题代码Commitlint提交信息校验强制遵循 Conventional Commits 规范SonarCloud云端 CI 质量门禁静态扫描、测试覆盖率、质量评分本地两道关卡负责「快」云端关卡负责「全」共同保证进入主干的代码既规范又健康。 快速上手克隆仓库即可自动装好钩子git clone https://gitcode.com/gh_mirrors/ne/nestjs-starter-rest-api cd nestjs-starter-rest-api npm install注意最后一步package.json中声明了prepare: husky install执行npm install时会自动完成 Husky 钩子安装无需任何手动配置。同时pre-commit: lint-staged把提交前的代码检查也一并接好了。 第一道关卡Husky 在提交瞬间拦截问题Husky 通过.husky/目录下的两个钩子脚本介入 Git 流程.husky/pre-commit提交前执行npm run pre-commit由 lint-staged 接管。它只检查本次暂存的.ts文件并执行eslint --fix自动修复——改动越多等待越短体验友好。.husky/commit-msg提交信息写完后执行commitlint --edit对提交信息做规范校验不符合直接拒绝提交。这意味着代码格式问题在你敲下回车时就被修好了垃圾提交根本进不了仓库历史。✍️ 第二道关卡Commitlint 让提交信息统一「说话」项目的commitlint.config.js只有一行配置继承commitlint/config-conventional预设。也就是说提交信息必须符合Conventional Commits规范type(scope): subject常用 type 速查表Type含义示例feat新功能feat(auth): add jwt refresh tokenfix修复缺陷fix(user): prevent duplicate registrationdocs仅文档变更docs(readme): update quick startrefactor重构不加功能、不修缺陷refactor(acl): extract rule checktest补充或修正测试test(article): cover pagination casechore其他杂项不改 src/testchore(deps): bump nestjs to v11对比感受一下✅ 合规feat(article): add pagination to list endpoint❌ 会被拦截update some code、FIX BUG提交历史的可读性直接决定协作效率规范的提交信息还能用于自动生成 Changelog。更完整的书写约定scope 用法、Body/Footer、Breaking Change 等见项目根目录的CONTRIBUTING.md。☁️ 第三道关卡SonarCloud 云端质量门禁代码提交到远端后SonarCloud 接管「全局体检」。关键配置都在sonar-project.properties里sonar.projectKey/sonar.organization在 SonarCloud 平台上标识项目sonar.sourcessrc只分析src目录测试文件**/*.spec.ts被排除sonar.javascript.lcov.reportPathscoverage/lcov.info读取 Jest 产出的覆盖率数据sonar.testExecutionReportPathstest-report.xml读取测试执行报告这里有个巧妙设计package.json的 jest 配置中testResultsProcessor指向jest-sonar-reporter跑测试的同时自动生成 SonarCloud 需要的test-report.xml一份数据两用。云端流程由.github/workflows/sonarqube-workflow.yml驱动步骤非常清晰npm ci安装依赖npm run test:cov跑单测并产出覆盖率调用 SonarCloud 官方 Action 执行扫描并回传质量门禁结果另有build-workflow.yml推送/PR 时执行构建与tests-workflow.yml执行测试三者组合成完整的 CI 防线。❓ 常见问题FAQ钩子不生效怎么办Husky 钩子在npm install时通过prepare脚本安装。如果.husky目录缺失或未生效重新执行一次npm install即可。紧急情况下如何跳过检查git commit --no-verify可以跳过 Husky 钩子。但请仅用于极端场景——绕过本地检查的代码仍会在 SonarCloud 质量门禁处暴露问题。质量门禁Quality Gate失败了看哪里到 SonarCloud 平台对应项目仪表盘查看新增的代码异味、安全热点与覆盖率缺口修复后重新触发扫描即可。✅ 总结这套工作流的精髓在于「把规范变成自动化」pre-commit 钩子lint-staged ESLint 只检查并自动修复本次改动的文件commit-msg 钩子Commitlint 强制 Conventional Commits 提交格式SonarCloud 云端门禁覆盖率、测试报告与静态扫描一网通查。相关文件.husky/、commitlint.config.js、sonar-project.properties、.github/workflows/sonarqube-workflow.yml都可以直接借鉴到自己的 NestJS 项目中十几分钟即可复制出一套同样规范的开发工作流。【免费下载链接】nestjs-starter-rest-apiNestJS Starter Kit. Monolithic Backend. REST API.项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-starter-rest-api创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考