pat-glich / sprotty-vscode

sprotty-vscode

sprotty-vscode

This repository contains the glue code to integrate Sprotty diagrams - with or without a language server - in VSCode extensions.

Also contains an example extension for a domain-specific language for statemachines. The example is also available as States Example from the VS Code Marketplace.

Features

• running Sprotty diagrams in VS Code webviews,
• SVG export (ALT-E), animated center selection (ALT-C) and fit to screen (ALT-F) actions,
• interaction with Sprotty-enhanced language servers to automatically synchronize diagrams with language artifacts.

Architecture

In VS Code, extensions can contribute new UI components using a webview. Webviews communicate with the extension using the postMessage API. The SprottyVscodeExtension use this to send and receive Sprotty Actions to and from a SprottyWebview. The latter runs a webpacked bundle.js that contains the Sprotty diagram code.

If your extension provides a language, you can include a Sprotty-enhanced language server to get fully synchronized diagrams for your language artifacts. The SprottyVscodeLanguageExtension acts as a relay between the language server and a SprottyLanguageWebview, and intercepts actions/LSP messages that require to interact with the VS Code workbench.

Contents

The repo is structured as follows

• example/: an example using an Xtext-based Language Server and with Sprotty visualization.
• sprotty-vscode-extension/: library code for the VSCode extension.
• sprotty-vscode-protocol/: common protocol classes for the communication between the extension and the webview.
• sprotty-vscode-webview/: library code for the script that is run in the webview.

Development

Compile the library code and the example

example/states/language-server/gradlew -p example/states/language-server/ build &&
yarn