VS Code extension

The Elide extension turns any folder with an elide.pkl into a VS Code project: it syncs dependencies and source sets into the Kotlin language server, and runs, tests and debugs through the elide CLI.

Requirements

The extension needs a trusted workspace: a sync runs the workspace’s elide CLI.

Install

curl -LOJ "https://plugins.elide.dev/vscode/files?id=elide.elide"
code --install-extension elide-*.vsix

Help → Get Started → Get started with Elide walks through install, project, sync, run and test.

Sync a project

Opening a folder with elide.pkl syncs it: Elide resolves the manifest, installs dependencies when the lockfile is stale, and writes workspace.json for the Kotlin language server. Add workspace.json to .gitignore.

Click the status bar item for the Elide menu: sync, run a command, run all tests, open elide.pkl or the output. When elide.pkl changes, the extension asks to reload (elide.sync.onManifestChange).

The Elide sidebar

The Elide view in the activity bar lists each project:

Code intelligence

Kotlin and Java completion, navigation and diagnostics come from the Kotlin language server, which imports the synced workspace.json: one module per source set, every library with its sources, the JDK and the manifest’s Kotlin options.

• Sources jars are installed for declared Maven packages, so Go to Definition opens library code (elide.install.classifiers).
• The JDK comes from elide.jdk.home, then jvm.javaHome, $JAVA_HOME, or an installed JDK matching jvm.target.
• A checkout can keep an IntelliJ .idea directory: the extension sets intellij.buildTool to json in the workspace settings, so each editor reads its own model.

Run

Code lenses run what the project declares:

Runs are VS Code tasks of type elide; compiler errors become Problems on the reported file and line.

In .vscode/tasks.json:

{ "type": "elide", "command": "test", "args": ["src/api"], "options": { "bail": 3 } }

Test

JUnit tests in the test source sets appear in the Testing view, with gutter icons on each class and method. A run calls elide test --reporter=tap for the selection and reports each test as it finishes; a failure shows its assertion message and links to the failing line.

The Debug profile runs the same tests under the debugger.

Run with Coverage runs the selection with --coverage and shows the result in the editor gutter and the Test Coverage view: JavaScript and TypeScript from LCOV, Java and Kotlin from a JaCoCo XML report. Request the XML report in elide.pkl:

import "elide:Coverage.pkl" as Coverage

coverage {
  jvm {
    reports { Coverage.xmlReport() }
  }
}

Debug

Debug with Elide starts elide run --debugger and attaches to it. Breakpoints in Kotlin and Java sources stop the program; ending the session stops Elide.

In .vscode/launch.json:

{
  "type": "elide",
  "request": "launch",
  "name": "Elide: Run (debug)",
  "entrypoint": "src/main/kotlin/shop/Main.kt"
}

elide.debug.adapter picks the debugger: intellij (default, from the Kotlin extension) or java (Debugger for Java). The debugger listens on port 5005, so one session runs at a time. For CDP and DAP debugging of JavaScript, TypeScript and Python, see Debugging.

Native Image

Launch type elide-native builds a Native Image artifact and debugs the binary under GDB, through the C/C++ extension (ms-vscode.cpptools):

{ "type": "elide-native", "request": "launch", "name": "Elide: Debug Native Image", "artifact": "bin" }

Add -g to the artifact’s options.flags in elide.pkl for source-level breakpoints; debug info is emitted on Linux only. program debugs an existing binary, build: false skips the build.

Workspaces

A manifest with workspace.members syncs as one build. Each member is a project in the sidebar, the Testing view, tasks and launch configurations, and code intelligence follows project("name") dependencies between members without a build. Opening a member’s directory offers to open the workspace root. See Workspaces.

Settings