A SonarQube plugin that provides comprehensive static analysis of Cucumber Gherkin .feature files in your CI/CD quality gate.
Powered by the same analysis engine as the Qualimetry Gherkin Analyzer for VS Code and the Qualimetry Gherkin Analyzer for IntelliJ.
- 83 analysis rules covering structure, design, style, tags, variables, spelling, and more.
- Default quality profile — 53 rules active out of the box, with 30 opt-in rules for team-specific conventions.
- Customizable — enable/disable rules, change severity, and set rule parameters per quality profile.
- SonarCloud compatible — works with both SonarQube Server and SonarCloud.
| Category | Examples |
|---|---|
| Structure | Feature/scenario/step required, naming conventions |
| Design | Step ordering, single When, background best practices |
| Style & Convention | Indentation, trailing whitespace, line endings, spelling |
| Tags | Naming patterns, placement, duplicates, restrictions |
| Variables & Data | Unused variables, Examples column coverage |
| Step Patterns | Given/When/Then patterns, unknown step types |
| Comments & Markers | TODO, FIXME, comment patterns |
| Structural Integrity | Outline placeholders, Examples required, blank lines |
| Configurable Thresholds | Max scenarios, max steps, max tags, max lines |
| SonarQube Server Version | Compatible? | Notes |
|---|---|---|
| 9.9 LTA | No | Plugin API too old. |
| 10.x | No | Plugin API too old. |
| 2025.1 LTA | Yes | Minimum supported version (API 11.1.0). |
| 2025.2+ | Yes | |
| 2026.1 LTA | Yes | Current LTA release. |
| Future releases | Yes | Forward-compatible via SonarQube's API stability guarantees. |
Also compatible with SonarCloud.
- Copy
qualimetry-gherkin-plugin-<version>.jarto theextensions/plugins/directory of your SonarQube Server installation. - Restart SonarQube Server.
- The "Qualimetry Gherkin" quality profile is automatically created as the default profile for the
gherkinlanguage.
The built-in "Qualimetry Gherkin" quality profile activates 53 rules out of 83 by default. The remaining 30 rules are opt-in and can be activated per project based on team conventions. You can customize the profile (enable/disable rules, change severity, set rule parameters) in SonarQube under Quality Profiles.
The same analysis engine powers editor extensions for real-time feedback:
- VS Code extension — catch issues as you type, before you commit.
- IntelliJ plugin — real-time analysis in JetBrains IDEs and Qodana CI/CD.
Rule keys and severities align across all three tools so findings are directly comparable.
Requires JDK 17+ and Maven 3.6.1+.
mvn clean packageThe packaged plugin JAR is produced at gherkin-plugin/target/qualimetry-gherkin-plugin-<version>.jar.
To run the full test suite with verification:
mvn clean verify| Requirement | Version |
|---|---|
| JDK (to compile) | 17+ |
| Maven | 3.6.1+ |
| Operating system | Any (Windows, macOS, Linux) |
The CI workflow runs on every push and pull request to main: it builds and runs tests on Java 17, and uploads the plugin JAR as an artifact. A GitHub Release (tag + release notes + JAR) is created only when a commit message starts with release: (e.g. release: 1.2.0). For other pushes, only the build and tests run; no release is created.
Issues and feature requests are welcome. This project does not accept pull requests, commits, or other code contributions from third parties; the repository is maintained by the Qualimetry team only.
This plugin is licensed under the Apache License, Version 2.0.
Copyright 2026 SHAZAM Analytics Ltd