An open API service indexing awesome lists of open source software.

https://github.com/cucumber/language-server

Cucumber Language Server
https://github.com/cucumber/language-server

polyglot-release

Last synced: 9 months ago
JSON representation

Cucumber Language Server

Awesome Lists containing this project

README

          


Cucumber logo


Cucumber Language Server



A Language Server for Cucumber



npm


test-javascript-package


release-package-github


backers


sponsors

Provides most of the functionality offered by the
[Cucumber Visual Studio Code Extension](https://github.com/cucumber/vscode) and can also be utilised with other editors that support the Language Server Protocol (LSP).

## Features

See [Cucumber Language Service](https://github.com/cucumber/language-service), which implements most of the logic in this server.
If you are looking to add a new feature, you should probably add it to [Cucumber Language Service](https://github.com/cucumber/language-service).

## Install

Cucumber Language Server is [available on npm](https://www.npmjs.com/package/@cucumber/language-server):

```console
npm install @cucumber/language-server
```

### Settings

The LSP client can provide settings to the server, but the server provides [reasonable defaults](https://github.com/cucumber/language-server/blob/main/src/CucumberLanguageServer.ts) (see `defaultSettings`) if the client does not
provide them.

The server retrieves `cucumber.*` settings from the client with a [workspace/configuration](https://microsoft.github.io/language-server-protocol/specification#workspace_configuration) request.

See [Settings](https://github.com/cucumber/language-server/blob/main/src/types.ts) for details about the expected format.

## External VSCode Usage

We've encountered an issue with the Node version used by [Treesitter](https://github.com/tree-sitter/tree-sitter/issues/2338), a
dependency of this language server, when working outside of VSCode. For optimal
compatibility, please use the same Node version as version 18 of VSCode.

## Support

Support is [available from the community](https://cucumber.io/tools/cucumber-open/support/) if you need it.