README.md

Nextflow extension for Visual Studio Code

VS Code extension for Nextflow that provides language support for scripts and config files, using the Nextflow language server.

Read the blog post and the docs for more information.

See also:

• VSCode Marketplace
• Open VSX Registry

Features

The following language features are currently supported:

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

Requirements

The language server requires Java 17 or later.

Development

Clone this repository:

git clone https://github.com/nextflow-io/vscode-language-nextflow

Clone the language server into this repository:

cd vscode-language-nextflow
git clone https://github.com/nextflow-io/language-server

Build the extension:

./gradlew build

From VS Code, you can press F5 to launch a new VS Code window with the extension loaded.

Alternatively, you can install the extension into your environment (reload required):

./gradlew install

Publishing

Update the extension version number in package.json and .vscode/launch.json, then run the "Deploy Extension" action to publish the extension to the VSCode marketplace and Open VSX.

Contributing

Contributions are welcome. Feel free to fork this repository and open a pull request to propose changes.

Useful links

• https://manual.macromates.com/en/language_grammars
• https://code.visualstudio.com/docs/extensions/publish-extension
• https://code.visualstudio.com/docs/extensions/yocode
• https://code.visualstudio.com/docs/extensionAPI/extension-manifest

Enjoy!