@eclipse-glsp/theia-integration
@eclipse-glsp/theia-integration
npm i @eclipse-glsp/theia-integration
@eclipse-glsp/theia-integration

@eclipse-glsp/theia-integration

Integration of the web-based GLSP client with Eclipse Theia

by eclipse-glsp

1.0.0-theia1.27.0 (see all)License:(EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0)TypeScript:Not Found
npm i @eclipse-glsp/theia-integration
Readme

Eclipse GLSP - Theia Integration for GLSP Clients build-status build-status-server

This project contains the glue code necessary to integrate diagram editors built with the graphical language server platform with Eclipse Theia as well as an example Theia application for testing purposes.

This project is built with yarn and is available from npm via @eclipse-glsp/theia-integration.

For details on building the project, please see the README file of the theia-integration package.

Theia Version Compatibility

The @eclipse-glsp/theia-integration package in version 1.0.0 is currently compatible with Theia >=1.25.0. Theia releases currently have no stable public API so new Theia versions might introduce API breaks. If that is the case, a new compatible 1.0.0 version prefixed with the supported minimal Theia version will be released (e.g. 1.0.0-theia1.27.0 for Theia >= 1.27.0).

@eclipse-glsp/theia-integrationTheia
0.8.0<=1.4.0
0.9.0>=1.20.0 <= 1.25.0
1.0.0>=1.25.0 <= 1.26.0
1.0.0-theia1.27.0>=1.27.0
next>=1.27.0

Note: Due to a transitive dependency to sprotty-theia it's currently not possible to safely restrict the maximum version of Theia packages. If you encounter build errors related to multiple resolved Theia versions please add a resolutions block to the package.json of your project e.g. for 1.0.0-theia1.27.0:

...
 "resolutions": {
    "**/@theia/core": "1.27.0",
    "**/@theia/editor": "1.27.0",
    "**/@theia/filesystem": "1.27.0",
    "**/@theia/messages": "1.27.0",
    "**/@theia/monaco": "1.27.0"
  },
...

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.

https://user-images.githubusercontent.com/588090/154459938-849ca684-11b3-472c-8a59-98ea6cb0b4c1.mp4

How to start the Workflow Diagram example?

Clone this repository and build Theia-Integration packages:

yarn install

Next, download a pre-built version of the Workflow Diagram Server, start the Theia application, and point your browser to localhost:3000:

yarn download:exampleServer
cd examples/browser-app
yarn start

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 pre-built version of the Workflow Diagram Server. See workflow example glsp-server for instructions on building and running the Workflow Diagram Server example.

Once the Workflow Diagram Server is running, start the Theia application with the debug flag so that it'll connect to an existing server process -- the one you started from the command line or from your IDE before:

cd examples/browser-app
yarn start:debug

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.

Downloads/wk

478

GitHub Stars

15

LAST COMMIT

8mos ago

MAINTAINERS

5

CONTRIBUTORS

8

OPEN ISSUES

0

OPEN PRs

1
VersionTagPublished
1.0.0-theia1.27.0
latest
5mos ago
1.1.0-RC02
rc
24d ago
1.1.0-next.f5de50c.143
next
24d ago
1.0.0-theia1.27.0
theia-cr
5mos ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate