Prerequisites

Before setting up the project, ensure you have the following dependencies installed:

Required Software

• Java 17 – Ensure java -version returns Java 17.
• Maven 3.9 - Ensure mvn -version returns Maven 3.9.9.
• Node.js 20.17.0 – Check with node -v.
• Git – Required for submodule management (git submodule update --init).
• Visual Studio Code (Latest Version) – Required for running code serve-web and tests.
• GLSP Extension for VSCode – Installed automatically during tests (Marketplace).
• Bash – Required to run .sh scripts (use WSL or Git Bash on Windows).
• Playwright (for Eclipse GLSP Integration tests) – Included in devDependencies but can be installed manually if needed.

Verify Installation

node -v      # Should return v20.17.0
java -version # Should return Java 17
git --version # Ensure Git is available
code -v      # Check VSCode installation

Reporting Issues

If you encounter any issues while setting up or running the project, please create an issue in our repository so we can review and address it. You can submit an issue here.

Project Setup

To set up the project, start by installing the necessary dependencies using the following command in the root folder:

npm run setup

Initializing GLSP Submodules

GLSP (Graphical Language Server Platform) submodules are required to run GLSP on different IDEs. Each submodule corresponds to a specific IDE integration for testing purposes. Initialize the submodules by executing:

git submodule update --init

Disclaimer:

The following sections explain how to set up the required submodules to run our test examples. At least one submodule must be set up to run the project, while the other two are optional. For more detailed information about GLSP projects and their integrations, please refer to the respective README files in the official GLSP GitHub repository. We have provided a simplified setup process to streamline the configuration of each submodule.

Before running the tests

Before running the tests, you need to modify the IDE variable in the example.spec.ts file located in the tests folder. This variable allows you to select the IDE on which the tests will run.

It is essential to have the latest release of Visual Studio Code installed, as it is required to run the code-server-web command effectively. Keeping your VS Code installation up to date ensures compatibility with the latest features, security patches, and extensions.

VSCode GLSP Integration Setup

1. Navigate to the glsp-vscode-integration folder and install its dependencies by running:

yarn install

2. Open the vscode_setup.ts file and update the vscode binary location (specified in the results variable) to point to your local VS Code binary file and modify the vscode binary location (results var) to point to your local vscode binary.

3. In a terminal, start the VS Code web server for a first time for it to download the latest version by running:

code serve-web

To verify the installation was successful, open the example1.wf file within the example/workspace folder.

This command launches a local web server that serves the web interface of your VS Code, allowing you to access VS Code through a web browser and enabling the tests to interact directly with it. After the latest version is downloaded close this process.

Eclipse Theia GLSP Integration setup

NOTE: The Theia example can be run inside both the Theia IDE and VS Code, as it mounts the IDE software on a localhost, similar to the previous VS Code example.

1. Open the glsp-theia-integration submodule folder and install its dependencies by running:

yarn install

2. To build the browser application execute:

yarn browser build

3. Start the application by running:

yarn browser start

By default the application will run on the localhost:3000 port.

3. Open the example1.wf file to confirm that GLSP is working as expected.

Eclipse GLSP Integration setup

A script is provided to streamline the Eclipse setup process. In the parent chromium-multiplatform-testing folder, execute the following command in a bash terminal to install all dependencies:

./setup_glsp_integration.sh

Microsoft Defender Warning

When launching the generated Eclipse application on Windows you may encounter a dialog about Microsoft Defender which you can either ignore or give access to make it disappear.