\n\nProvides Gherkin diagnostics, completion, formatting, and step-definition navigation for\neditors that support the Language Server Protocol (LSP).\n\nThis project is a hard fork of\n[`cucumber/language-server`](https://github.com/cucumber/language-server), originally\ndeveloped by Cucumber Ltd and contributors. It is distributed under the MIT License.\nThis fork is maintained by CrewLM and focuses on Gherkin/Carmen Python Behave\nworkflows.\n\n## Features\n\nThis is a focused fork of the Cucumber language server. It defaults to:\n\n- all `**/*.feature` files in the editor workspace\n- all Python step definitions matching `**/steps/**/*.py`\n\n## Install\n\nRun the server directly with `npx` or `bunx`:\n\n```console\nnpx @crewlm/gherkin-lsp --stdio\nbunx @crewlm/gherkin-lsp --stdio\n```\n\nThe executable exposed by the package is `gherkin-lsp`.\n\n## CLI check\n\nCheck one feature file from a Carmen `carmusr` checkout:\n\n```console\ngherkin-lsp check gherkin_features/PAIRING_BASE/trip.feature\n```\n\nFor the standard Carmen layout, the command infers the `carmusr` root from the feature\npath and loads step definitions from:\n\n```text\nlib/python/carmtest/behave/steps/**/*.py\n```\n\nOverride discovery when needed:\n\n```console\ngherkin-lsp check path/to/file.feature \\\n --root /path/to/carmusr \\\n --steps 'lib/python/carmtest/behave/steps/**/*.py' \\\n --format text \\\n --fail-on error\n```\n\nOptions:\n\n- `--root ` overrides the inferred `carmusr` root.\n- `--steps ` overrides the default step-definition location. Relative\n paths are resolved from the inferred or explicit root.\n- `--format text|json` defaults to `text`.\n- `--fail-on error|warning` defaults to `error`; undefined steps are warnings.\n\n### Settings\n\nThe LSP client can provide settings to the server, but the server provides zero-config\ndefaults if the client does not provide them.\n\nFor layouts like this:\n\n```text\ncarmusr/\n gherkin_features/**/*.feature\n lib/python/carmtest/behave/steps/**/*.py\n```\n\nthe default `**/*.feature` and `**/steps/**/*.py` globs work when the workspace root is\n`carmusr`.\n\nIf the editor workspace root is somewhere else, point the server at the steps directory\nexplicitly:\n\n```console\nGHERKIN_LSP_STEPS=/path/to/carmusr/lib/python/carmtest/behave/steps npx @crewlm/gherkin-lsp --stdio\n```\n\n`GHERKIN_LSP_STEPS` also accepts a glob:\n\n```console\nGHERKIN_LSP_STEPS=/path/to/carmusr/lib/python/carmtest/behave/steps/**/*.py npx @crewlm/gherkin-lsp --stdio\n```\n\nThe server retrieves `cucumber.*` settings from the client with a [workspace/configuration](https://microsoft.github.io/language-server-protocol/specification#workspace_configuration) request.\n\nSee [Settings](src/types.ts) for details about the expected format.\n","readmeFilename":"README.md"}
![\"Cucumber](\"https://raw.githubusercontent.com/cucumber/cucumber-js/46a5a78107be27e99c6e044c69b6e8f885ce456c/docs/images/logo.svg\"){kind=logo}
\n ![\"npm\"](\"https://img.shields.io/npm/v/@crewlm/gherkin-lsp.svg?color=dark-green\")
\n \n