Skip to content

Commit c1be494

Browse files
committed
GLSP-813 Also publish workflow-server bundle (#46)
Ensure that bundled example-server is part of the published package contents so that it can be reused in the dev-examples eclipse-glsp/glsp#813
1 parent d47240f commit c1be494

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,29 @@ yarn test
5151
It's also possible to execute and debug a single test file in VSCode/Theia via the File explorer.
5252
Simply select a test file (`*.spec.ts`), then go to the `Run & Debug` View (`Ctrl+Shift+D`), select the 'Run current test" launch config and start debugging (`Ctrl+F11`)
5353

54-
## Start & Debug
54+
## Workflow Diagram Example
5555

56-
### Socket
56+
The workflow diagram is a consistent example provided by all GLSP components.
57+
The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below).
58+
The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone).
59+
As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor.
60+
See [our project website](https://www.eclipse.org/glsp/documentation/#workflowoverview) for an overview of the workflow example and all components implementing it.
61+
62+
https://user-images.githubusercontent.com/588090/154459938-849ca684-11b3-472c-8a59-98ea6cb0b4c1.mp4
63+
64+
### How to start the Workflow Diagram example?
65+
66+
To see the diagram in action, you need to choose and launch one diagram client, see [here for an overview of available clients](https://www.eclipse.org/glsp/examples/#workflowoverview).
67+
68+
- [`glsp-theia-integration`](https://github.com/eclipse-glsp/glsp-theia-integration): Diagrams clients integrated into [Theia](https://github.com/theia-ide/theia).
69+
- [`glsp-vscode-integration`](https://github.com/eclipse-glsp/glsp-vscode-integration): Diagram clients integrated into [VSCode](https://github.com/microsoft/vscode).
70+
- [`glsp-eclipse-integration`](https://github.com/eclipse-glsp/glsp-eclipse-integration): Diagram clients integrated into Eclipse IDE.
71+
72+
Please look at the workflow example guides in the repository linked above to get more information on building and running the respective GLSP clients.
73+
74+
### Launch Workflow Example Server
75+
76+
#### Socket
5777

5878
To launch the server for TCP sockets use:
5979

@@ -67,7 +87,7 @@ To debug you can use the `Debug workflow example GLSP Server` launch configurati
6787
To test the server you have to connect a workflow GLSP client that supports JSON-RPC via socket.
6888
We recommend to use the client provided by the [`glsp-integration`](https://github.com/eclipse-glsp/glsp-theia-integration#how-to-start-the-workflow-diagram-example-server-from-the-sources).
6989

70-
### Websocket
90+
#### Websocket
7191

7292
To launch the server for WebSockets use:
7393

@@ -85,7 +105,3 @@ We recommend to use the standalone example provided by [`glsp-client`](https://g
85105

86106
For more information, please visit the [Eclipse GLSP Umbrella repository](https://github.com/eclipse-glsp/glsp) and the [Eclipse GLSP Website](https://www.eclipse.org/glsp/).
87107
If you have questions, please raise them in the [discussions](https://github.com/eclipse-glsp/glsp/discussions) and have a look at our [communication and support options](https://www.eclipse.org/glsp/contact/).
88-
89-
```
90-
91-
```

examples/workflow-server/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@
4343
"node.js",
4444
"node.d.ts",
4545
"browser.d.ts",
46-
"browser.js"
46+
"browser.js",
47+
"bundle/wf-glsp-server-node.js"
4748
],
4849
"scripts": {
4950
"build": "tsc -b && yarn bundle",

0 commit comments

Comments
 (0)