{"id":45169863,"url":"https://github.com/qualimetry/vscode-gherkin-plugin","last_synced_at":"2026-06-12T00:01:01.811Z","repository":{"id":339533093,"uuid":"1158851952","full_name":"Qualimetry/vscode-gherkin-plugin","owner":"Qualimetry","description":"Real-time static analysis for Cucumber Gherkin .feature files - structure, design, style, and correctness rules powered by the Qualimetry analysis engine.","archived":false,"fork":false,"pushed_at":"2026-06-11T11:42:53.000Z","size":505,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-11T13:23:30.561Z","etag":null,"topics":["cucumber","feature-files","gherkin","gherkin-language","language-server","linter","static-analyser","static-analysis","testing","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://qualimetry.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Qualimetry.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-16T01:58:42.000Z","updated_at":"2026-06-11T11:42:58.000Z","dependencies_parsed_at":"2026-02-20T10:18:23.726Z","dependency_job_id":null,"html_url":"https://github.com/Qualimetry/vscode-gherkin-plugin","commit_stats":null,"previous_names":["qualimetry/vscode-gherkin-plugin"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/Qualimetry/vscode-gherkin-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qualimetry%2Fvscode-gherkin-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qualimetry%2Fvscode-gherkin-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qualimetry%2Fvscode-gherkin-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qualimetry%2Fvscode-gherkin-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Qualimetry","download_url":"https://codeload.github.com/Qualimetry/vscode-gherkin-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qualimetry%2Fvscode-gherkin-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34222709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cucumber","feature-files","gherkin","gherkin-language","language-server","linter","static-analyser","static-analysis","testing","vscode","vscode-extension"],"created_at":"2026-02-20T08:03:40.298Z","updated_at":"2026-06-12T00:01:01.793Z","avatar_url":"https://github.com/Qualimetry.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Qualimetry Gherkin Analyzer - VS Code Plugin\n\n[![CI](https://github.com/Qualimetry/vscode-gherkin-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/Qualimetry/vscode-gherkin-plugin/actions/workflows/ci.yml)\n\nA VS Code extension that provides real-time static analysis for Cucumber Gherkin `.feature` files as you edit.\n\nPowered by the same analysis engine as the [Qualimetry Gherkin Analyzer for SonarQube](https://github.com/Qualimetry/sonarqube-gherkin-plugin) and the [Qualimetry Gherkin Analyzer for IntelliJ](https://github.com/Qualimetry/intellij-gherkin-plugin).\n\n## Features\n\n- **83 analysis rules** covering structure, design, style, tags, variables, spelling, and more.\n- **Real-time diagnostics** — issues appear as you type, with squiggly underlines and Problems panel entries.\n- **Cross-file analysis** — checks for unique Feature names, unique Scenario names, and consistent Gherkin language across all `.feature` files in the workspace.\n- **Configurable severity** — override the default severity of any rule.\n- **Per-rule properties** — tune thresholds (e.g. max scenario count, indentation size) per rule.\n- **TextMate syntax highlighting** — Gherkin keywords, tags, variables, and strings are highlighted out of the box.\n\n## Rule categories\n\n| Category | Examples |\n|----------|----------|\n| Structure | Feature/scenario/step required, naming conventions |\n| Design | Step ordering, single When, background best practices |\n| Style \u0026 Convention | Indentation, trailing whitespace, line endings, spelling |\n| Tags | Naming patterns, placement, duplicates, restrictions |\n| Variables \u0026 Data | Unused variables, Examples column coverage |\n| Step Patterns | Given/When/Then patterns, unknown step types |\n| Comments \u0026 Markers | TODO, FIXME, comment patterns |\n| Structural Integrity | Outline placeholders, Examples required, blank lines |\n| Configurable Thresholds | Max scenarios, max steps, max tags, max lines |\n\n## Installation\n\n### From GitHub Releases\n\nDownload the latest `.vsix` from [GitHub Releases](https://github.com/Qualimetry/vscode-gherkin-plugin/releases), then install via **Extensions: Install from VSIX...** (Command Palette).\n\n### Manual Install (VSIX)\n\n1. Download or build the `.vsix` file (see [Building from Source](#building-from-source)).\n2. In VS Code, open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`) and run **Extensions: Install from VSIX...**\n3. Select the `.vsix` file and reload when prompted.\n\n## Requirements\n\n- **Java 17+** - The analyzer runs on a Java-based language server. Java is auto-detected from `JAVA_HOME` or `PATH`. If Java is not found automatically, set the path in your VS Code settings:\n\n  ```json\n  {\n    \"gherkinAnalyzer.java.home\": \"C:\\\\path\\\\to\\\\java17\"\n  }\n  ```\n\n## Configuration\n\nAll settings are under the `gherkinAnalyzer` namespace:\n\n| Setting | Type | Default | Description |\n|---|---|---|---|\n| `gherkinAnalyzer.enabled` | boolean | `true` | Enable/disable the analyzer. |\n| `gherkinAnalyzer.java.home` | string | `\"\"` | Path to a Java 17+ installation. When empty, the extension searches `JAVA_HOME` and `PATH`. |\n| `gherkinAnalyzer.rules` | object | *(full default)* | Per-rule configuration. List rules to override or replace the default set (see below). |\n| `gherkinAnalyzer.rulesReplaceDefaults` | boolean | `false` | When `true`, only the rules listed in `gherkinAnalyzer.rules` run (e.g. after Import from SonarQube). When `false`, listed rules are overrides and unlisted rules use the extension default profile. |\n\n### How to customize rules\n\nYou can either **override** a few rules on top of the default profile, or **replace** the active set entirely (e.g. after importing from SonarQube).\n\n- **Override mode** (default) – Set `gherkinAnalyzer.rulesReplaceDefaults` to `false` or omit it. Add only the rule IDs you want to change (e.g. severity or `enabled`); all other rules use the extension default. You do **not** need to list all rules.\n- **Replace mode** – Set `gherkinAnalyzer.rulesReplaceDefaults` to `true`. Only the rules listed in `gherkinAnalyzer.rules` run. Use this when you have imported a profile from SonarQube or maintain your own full list.\n- **Full default** – Omit `gherkinAnalyzer.rules` or set it to `{}` with `rulesReplaceDefaults` false to use the built-in default profile (53 rules active).\n- **After an upgrade** – Entries for removed or renamed rules are ignored; you can delete them to tidy up.\n\nEach rule can have `enabled`, `severity` (`blocker` \\| `critical` \\| `major` \\| `minor` \\| `info`), and rule-specific properties (e.g. `maxLength`, `maxScenarios`).\n\n### Example `settings.json`\n\n```json\n{\n  \"gherkinAnalyzer.enabled\": true,\n  \"gherkinAnalyzer.java.home\": \"\",\n  \"gherkinAnalyzer.rulesReplaceDefaults\": false,\n  \"gherkinAnalyzer.rules\": {\n    \"consistent-indentation\": {\n      \"enabled\": true,\n      \"severity\": \"minor\",\n      \"indentation\": \"4\"\n    },\n    \"feature-description-recommended\": {\n      \"enabled\": false\n    }\n  }\n}\n```\n\n### Aligning with a SonarQube quality profile\n\nUse the command **Gherkin: Import rules from SonarQube** (Command Palette). Enter your SonarQube server URL, the Gherkin quality profile name or key, and a token if required. The extension fetches the profile's active rules and severities and writes them to `gherkinAnalyzer.rules` and sets `gherkinAnalyzer.rulesReplaceDefaults` to `true`, so only those rules run (matching your SonarQube profile).\n\nThe last-used URL and profile are remembered (in the extension's global state, not in settings), and the token (if provided) is stored securely in VS Code's secret storage. After a first successful import, the extension automatically re-syncs rules from the same server and profile each time it starts, so profile changes in SonarQube propagate without a manual re-import. Set `gherkinAnalyzer.sonar.autoSyncOnStartup` to `false` to disable this. To switch back to the extension default and only override a few rules, set `gherkinAnalyzer.rulesReplaceDefaults` to `false`.\n\n## Also available\n\nThe same analysis engine powers plugins for other platforms:\n\n- **[SonarQube plugin](https://github.com/Qualimetry/sonarqube-gherkin-plugin)** — enforce quality gates in CI/CD pipelines.\n- **[IntelliJ plugin](https://github.com/Qualimetry/intellij-gherkin-plugin)** — real-time analysis in JetBrains IDEs and Qodana CI/CD.\n\nRule keys and severities align across all three tools so findings are directly comparable.\n\n## Building from Source\n\n### Prerequisites\n\n- JDK 17+ and Maven 3.6.1+\n- Node.js and npm\n\n### Build Steps\n\n1. **Build the Java modules** (shared analyzer + LSP server):\n\n   ```bash\n   mvn clean package\n   ```\n\n2. **Build the VS Code client**:\n\n   ```bash\n   cd vscode-client\n   npm install\n   npm run compile\n   ```\n\n3. **Package as VSIX**:\n\n   ```bash\n   cd vscode-client\n   npx vsce package\n   ```\n\n   This produces a `.vsix` file in the `vscode-client/` directory.\n\n## Contributing\n\nIssues 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.\n\n## License\n\nThis extension is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n\nCopyright 2026 SHAZAM Analytics Ltd\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualimetry%2Fvscode-gherkin-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualimetry%2Fvscode-gherkin-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualimetry%2Fvscode-gherkin-plugin/lists"}