@eclipse-glsp/ide

Glue code to integrate GLSP clients into Eclipse via a webapp


Keywords
diagram-editors, diagramming, eclipse, graphical-modeling, java
Licenses
EPL-2.0/BSD-3-Clause-Attribution
Install
npm install @eclipse-glsp/ide@0.10.0-next.91a2bc4.74

Documentation

Eclipse GLSP Eclipse IDE Integration Build Status

Contains the glue code for opening browser-based GLSP diagrams in an Eclipse IDE Editor

For details on building the project, please see both README files in the directories client and server.

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.

glsp-eclipse-integration.mp4

How to start the Workflow Diagram example?

First, you need to build both the client and the server (see instructions on building the client and building the server). Then, import the following Eclipse plug-in projects into your Eclipse IDE workspace:

  • server/plugins/org.eclipse.glsp.ide.editor
  • server/example/org.eclipse.glsp.ide.workflow.editor
  • server/releng/org.eclipse.glsp.ide.releng.target

Now open the server/releng/org.eclipse.glsp.ide.releng.target/r2020-09.target target platform definition and set it as your target platform. Now, you can start an Eclipse Application containing the example plug-in project for the workflow editor, org.eclipse.glsp.ide.workflow.editor, e.g. using the WorkflowEditor.launch launch configuration provided in that project. The Workflow Diagram Editor is registered for any .wf files. You can use the provided example .wf file from: server/example/runtime/test

Where to find the sources?

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

More information

For more information, please visit the Eclipse GLSP Umbrella repository and the Eclipse GLSP Website. If you have questions, please raise them in the discussions and have a look at our communication and support options.