Skip to content

Repository files navigation

sprocket-intellij

CI Status Apache 2.0 MIT

WDL language support for JetBrains IDEs via the Sprocket LSP

Request Feature · Report Bug

Overview

sprocket-intellij provides comprehensive WDL (Workflow Description Language) support for JetBrains IDEs, including IntelliJ IDEA, PyCharm, CLion, and others. It's powered by the Sprocket language server. WDL is widely used in bioinformatics for defining portable, reproducible analysis workflows.

Features

  • LSP Integration. Completions, diagnostics, hover documentation, go-to-definition, and references powered by Sprocket
  • Syntax Highlighting. TextMate grammar support for WDL 1.0 through 1.3
  • Document Formatting. Format WDL files on demand via LSP
  • Status Bar Widget. Monitor language server status at a glance
  • Configurable. Customize behavior via Settings → Tools → Sprocket

Getting Started

Requirements

  • JetBrains IDE 2024.2 or later
  • sprocket binary in your PATH

Installation

  1. Download the latest .zip from Releases
  2. Go to Settings → Plugins → ⚙️ → Install Plugin from Disk...
  3. Select the downloaded .zip file

Installing Sprocket

The sprocket binary must be available in your PATH. Choose one of the following methods:

Homebrew (macOS/Linux)

brew install sprocket

Cargo (Rust)

cargo install sprocket

Pre-built binaries

Download from GitHub Releases and add to your PATH.

Configuration

Settings are available at Settings → Tools → Sprocket:

Setting Default Description
Sprocket binary path (auto) Custom path to sprocket binary; leave empty to search PATH
Output level Quiet Server output verbosity (Quiet / Information / Verbose)
Enable lint checks false Enable additional linting via --lint flag
Maximum retry attempts 1 Retry attempts if server fails to start

Development

To build the plugin locally, you'll need JDK 17+ and Gradle 8.x. The project uses the IntelliJ Platform Gradle Plugin for building and testing.

# Build
./gradlew build

# Run sandbox IDE
./gradlew runIde

# Run tests
./gradlew test

# Package for distribution
./gradlew buildPlugin

The plugin .zip will be in build/distributions/.

License

Licensed under either of

at your option.

Copyright © 2026-Present St. Jude Children's Research Hospital.

About

JetBrains IDE plugin for WDL development powered by the Sprocket language server

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages