Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (47 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.48 KB
Raw

Contributing to LiquidJava VS Code Extension

Prerequisites

Before starting development, ensure you have:

  • Java 20 or higher installed and configured in your PATH
  • Maven 3.6 or higher for building the language server
  • Node.js and npm for building and packaging the client
  • Visual Studio Code and the Language Support for Java(TM) by Red Hat extension installed and enabled

Cloning and Setup

To get started, clone the repository and install the client dependencies:

git clone https://github.com/liquid-java/vscode-liquidjava.git
cd vscode-liquidjava
cd client
npm install

Packaging and Installation

To build the language server, package the extension, and install it in your local VS Code instance, you can run the provided script from the repository root:

./install.sh

Use ./install.sh --skip-server to package and install the extension without rebuilding the language server.

Releasing

Create a version bump pull request from main with the release script:

./release.sh

By default, this bumps the patch version in client/package.json. Pass a version to set it explicitly:

./release.sh <new-version>

After the pull request passes Checks and is merged, create and push its release tag from main:

./release.sh --tag <new-version>

The tag runs Checks again and publishes the verified extension artifact to the VS Code Marketplace and the Open VSX Registry.

Development Mode

To run the extension in development mode, follow these steps:

  1. Go to Run > Run Extension (or press F5)
  2. A new VS Code instance will open with the extension installed, which will automatically run the language server in the background and connect to it
  3. Open a Java project using LiquidJava

To run the language server manually, follow these steps:

  1. Run the server in port 50000 (default)
  2. In the client, set the DEBUG constant in client/src/extension.ts to true
  3. Run the client which will connect to the server in port 50000

Project Structure

  • /server - Implements the language server in Java using LSP4J
  • /client - Implements the VS Code extension in TypeScript that connects to the language server via LSP