如何在Karate API测试项目中强制执行gherkin-lint规范？

1. 基础安装与配置 #

先确保项目支持npm（无npm配置的话，执行npm init -y初始化），然后安装gherkin-lint：

npm install gherkin-lint --save-dev

在项目根目录创建.gherkin-lintrc配置文件，根据团队规范定义强制执行的规则：

{
  "rules": {
    "no-empty-file": "error",
    "feature-description": "error",
    "scenario-description": "error",
    "no-duplicate-steps": "error",
    "no-trailing-spaces": "error",
    "indentation": ["error", 2]
  }
}

创建.gherkin-lintignore文件，忽略无需检查的目录/文件：

node_modules/
target/

2. 本地开发阶段强制执行 #

（1）添加npm脚本

在package.json中加入lint脚本，方便手动触发检查：

"scripts": {
  "lint:gherkin": "gherkin-lint features/**/*.feature"
}

执行npm run lint:gherkin即可扫描所有.feature文件。

（2）Git提交钩子强制检查

用husky在代码提交前自动执行lint，不通过则阻止提交：

# 安装husky
npm install husky --save-dev
# 启用git钩子
npx husky install
# 添加pre-commit钩子
npx husky add .husky/pre-commit "npm run lint:gherkin"

3. CI/CD流水线强制执行 #

在CI/CD流程中加入lint检查，确保远程仓库的代码都符合规范。以GitHub Actions为例，创建.github/workflows/gherkin-lint.yml：

name: Gherkin Lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install
      - run: npm run lint:gherkin

每次推送代码或发起PR时，流水线会自动执行gherkin-lint，检查不通过则终止流程，阻止代码合并。

4. 与Karate测试集成 #

让lint检查通过后再执行Karate测试，避免不符合规范的用例运行：

"scripts": {
  "pretest": "npm run lint:gherkin",
  "test": "karate test features/**/*.feature"
}

执行npm run test时，会先完成lint检查，不通过则直接终止测试流程。

5. 自定义规则（可选） #

如果默认规则满足不了团队需求，可编写自定义规则。在项目根目录创建rules/文件夹，编写自定义规则文件（如custom-no-hardcoded-url.js），然后在.gherkin-lintrc中配置：

{
  "customRulesDir": "./rules",
  "rules": {
    "custom-no-hardcoded-url": "error"
  }
}

内容的提问来源于stack exchange，提问作者rc22