Newton LSP Server Bridge

Credit

• https://github.com/mkslanc/websockets-ls
• https://github.com/lspcontainers/dockerfiles/

Overview

This repo provides a primary Dockerfile with additional examples that are seperate in form and structure but useful for reference. LSP Docker files under reference-servers are from lspcontainersproject that packages a number of LSPs. The code under src/ comes from websockets-ls and has been cleaned up and formatted to my style/asthetics as well as modified server list. (I.E NO structural changes) The code creates a WebSocket bridge to interface with multiple Language Servers through clients via a single WebSocket connection. It supports various language servers concurrently and handles language-specific file extensions and initialization parameters.

Features

• Utilizes vscode-jsonrpc for LSP message handling.
• Supports multiple language servers concurrently.
• Support for IPC and stdio communication with language servers.
• Easy language server configuration and initialization parameter modification.
• Error handling and logging for language server processes.
• Automatic file URI translation between server and client paths.
• Temporary file creation for textDocument/didOpen events.

Usage

Option 1:

1. Install Podman.
2. Create opt/ folder in Docker/ and add any additional programs (lsps) there.
3. Configure the desired language servers in src/defaultServers.js.
4. Configure the start script at Docker/scripts/start.sh with any additional env args or mount points.
5. Run from Newton-LSP/ Docker/build.sh .
6. Run Docker/scripts/start.sh
7. Connect to the WebSocket server on ws://localhost:9999/<language_endpoint>.
8. Transmit LSP messages via the WebSocket connection.

Option 2:

1. Install Node.js.
2. Run 'npm install'.
3. Configure the desired language servers in defaultServers.js.
4. Run the script: npm run start || start-verbose.
5. Connect to the WebSocket server on ws://localhost:9999/<language_endpoint>.
6. Transmit LSP messages via the WebSocket connection.

Configuration

Add or modify language server configurations in languageServers.js:

exports.servers = [
   {
       endpointName: "language_endpoint",                  // WebSocket endpoint name
       args: ['executable_path', ['arg1', 'arg2', ...]],
       connectionType: "ipc" | "stdio",                    // Communication type
       relativePath: true | false,                         // Whether to use relative paths
       serverFileNameReplacePattern: {                     // Server file name regex replacements
           from: /pattern/,
           to: "replacement"
       },
       clientFileNameReplacePattern: {                     // Client file name regex replacements
           from: /pattern/,
           to: "replacement"
       }
   },
   ...
];