Eclipse GLSP VSCode Integration

This project contains the glue code necessary to diagram editors built with the graphical language server platform (GLSP) with VSCode, as well as an example VSCode extension for the workflow diagram example for testing purposes.

Workflow Diagram Example

The workflow diagram is a consistent example provided by all GLSP components. The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below). The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone). As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor. See our project website for an overview of the workflow example and all components implementing it.

vscode-diagram.mp4

How to start the Workflow Diagram example?

Clone this repository and build the VSCode integration packages:

yarn install

Additionally you can download a precompiled version of the Workflow Diagram Server:

yarn --cwd example/workflow/extension download:Server

The downloaded server will be launched automatically by the extension. To debug or modify the server and run it separately: see the instructions below.

Now you can start the VSCode extension by opening this repository in VSCode and executing the "Workflow GLSP Example Extension" launch configuration, provided with this project.

How to start the Workflow Diagram example server from the sources

If you want to explore or change the Workflow Diagram Server too, you can clone, build and start the workflow example glsp-server from your IDE instead of using the embedded pre-built version of the Workflow Diagram Server. See workflow example glsp-server for instructions on building and running the Workflow Diagram Server example.

To test the VSCode extension with an external server (e.g started from your IDE) the launch configuration "Workflow GLSP Example Extension (External GLSP Server)" can be used.

Where to find the sources?

In addition to this repository, the related source code can be found here:

More information