Repository files navigation

The officiallanguage server forNextflow scripts and config files.

The following language features are currently supported:

• code navigation (outline, go to definition, find references)
• completion
• diagnostics (errors, warnings)
• formatting
• hover hints
• rename
• semantic highlighting
• DAG preview for workflows

The language server requires Java 17 or later.

The language server exposes a set of configuration settings that can be controlled through theworkspace/didChangeConfiguration event. See theNextflow VS Code extension for an example of how to set up these configuration settings with sensible defaults.

To build from the command line:

# clone Nextflow repositorygit clone https://github.com/nextflow-io/nextflow ../nextflow# build language server (with nf-lang module)make

To run unit tests:

maketest

To run the language server:

java -jar build/libs/language-server-all.jar

Protocol messages are exchanged using standard input/output.

The Nextflow language server follows the versioning scheme of Nextflow. For each stable release of Nextflow, there is a corresponding stable release of the language server. There is no correlation between patch releases of Nextflow and the language server -- they are patched independently of each other.

A separate branch is maintained for each stable release, starting withSTABLE-24.10.x. Themain branch corresponds to the upcoming stable release. Updates tomain should be backported as needed to maintain a consistent user experience, for example, when a new configuration option is added.

To make a new release of the language server:

1. Build the language server locally.
2. Create a new GitHub release with the language server JAR and a list of notable changes.

Sometimes the language server might crash or get out of sync with your workspace. If this happens, you can restart the server from the command palette. You can also view the server logs from the "Output" tab under "Nextflow Language Server".

When reporting an issue, please include a minimal code snippet that triggers the issue as well as any error traces from the server logs.

Based onGroovyLanguageServer/groovy-language-server.