CI/CD / 系统课时

接入代码规范检查

接入代码规范检查

这一课把“代码风格靠自觉”改造成流水线门禁:提交进入构建阶段前,先执行格式检查和静态规则检查。这样能让低成本问题尽早失败,并把开发机上的规范要求变成所有提交都必须通过的自动规则。

学习目标

  • 把格式检查与静态规则检查封装成稳定的项目命令。
  • 在 CI 中让规范检查先于后续构建任务执行。
  • 区分警告、错误和工具配置问题,避免门禁形同虚设。

把规范要求变成项目命令

CI 不应该直接拼一长串临时参数,而应调用仓库里已经定义好的脚本。以 JavaScript 项目为例,可以把 Prettier 用作格式检查,把 ESLint 用作静态规则检查,并要求 ESLint 出现任何 warning 都返回失败。

package.json 中可加入以下脚本配置:

json
{
  "scripts": {
    "format:check": "prettier . --check",
    "lint": "eslint . --max-warnings=0",
    "quality:check": "npm run format:check && npm run lint"
  }
}

这里的 quality:check 是统一入口。开发者本地与 CI 调用同一个命令,能够避免“本地检查一套、流水线检查另一套”的漂移。

在已安装项目依赖的仓库根目录验证:

bash
npm run quality:check --silent >/dev/null && echo "quality gate passed"

预期输出

text
quality gate passed

如果检查失败,&& 后的成功提示不会执行;在 CI 中则应直接执行 npm run quality:check,让它的非零退出码原样传递给任务。

让检查发生在构建之前

规范检查的价值在于尽早失败,因此它应位于依赖安装之后、编译或打包之前。以下 GitHub Actions 片段把检查步骤放进同一个作业,并保留清晰的失败边界:

yaml
name: ci

on:
  push:
  pull_request:

jobs:
  quality:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '22'
          cache: npm
      - run: npm ci
      - run: npm run format:check
      - run: npm run lint

任意检查步骤返回非零退出码,quality 作业都会失败。实际项目可以再让构建作业通过 needs: quality 依赖这个作业,使规范门禁未通过时不进入耗时的编译、测试或镜像构建阶段。

把警告也纳入门禁

只执行 ESLint 但允许无限 warning,会让规则逐渐失去约束力。示例中的 --max-warnings=0 会把 warning 也视为失败,适合团队已经稳定执行规则的仓库。

如果是第一次给存量项目接入检查,不要在 CI 中长期使用 || true、continue-on-error 之类的绕过方式。更稳妥的做法是先修复现有问题,或临时缩小检查范围,并明确完成全量接入的时间点。

验证失败是否能阻断提交

接入后应主动制造一次可控失败,例如故意引入一个 ESLint 禁止的规则问题,然后运行 npm run quality:check。预期现象不是某段固定日志,而是命令返回非零退出码,CI 作业标记为失败;修复代码后再次运行应恢复成功。

真正可靠的规范门禁有三个条件:规则定义在仓库中、开发机和 CI 使用同一入口、失败退出码能够阻断后续任务。满足这三点后,格式与静态检查才从“建议执行”变成了持续集成的一部分。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

接入代码规范检查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通