Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.89 KB

DEVELOPING.md

File metadata and controls

51 lines (33 loc) · 2.89 KB
Raw

Development setup for Liberty Config Language Server

Note: Starting with the Liberty LemMinX Language Server 1.0-M1 early release and Liberty Config Language Server 1.0-M1 early release, Java 17 is required.

This repo contains a couple projects providing IDE / language support for Open Liberty using the Language Server Protocol.

Projects

  • lemminx-liberty - an extension to the Eclipse LemMinX XML language server providing language features for the Liberty server.xml file.
    • mvn clean install to build. Produces the /lemminx-liberty/target/lemminx-liberty-x.x-SNAPSHOT.jar.
  • liberty-ls - a language server providing language features for the Liberty bootstrap.properties and server.env files.
    • mvn clean install to build. Produces the /liberty-ls/target/liberty.ls-x.x-SNAPSHOT.jar.

To test the changes interactively, you must use a language client.

Below, we will document how to build and test using the VS Code language client for Liberty Config Language Server.

Project setup in VS Code

Prerequisites

These projects require the following VS Code extensions to function:

Setup

Clone the Liberty Tools for VS Code repo as a sibling folder to this repo. Create a VS Code workspace with these two repos at the root of the workspace. The folder structure should look something like this:

| > liberty-tools-vscode
| v liberty-language-server
| | > lemminx-liberty
| | > liberty-ls

Building and Testing with the VS Code client

Prerequisites: Debugger for Java extension for VS Code

  1. In the liberty-tools-vscode directory, run npm run buildLocal.

    a) Optionally, vsce package may be run next to ensure the VS Code extension can be built properly.

  2. Open the debug view, select and launch Run Extension (liberty-tools-vscode). It will open a new window with the newly built extension running.

Debugging the Liberty Config Language Server

After building and running with the instructions above, you may start debugging the Liberty Config Language Server by running one of the Debug tasks.

In the same debug view, select and launch one of the following to debug each respective project:

  • Debug attach liberty-lemminx
  • Debug attach liberty-ls (in progress)