ws-lsp-bridge
v1.0.1
Published
WebSocket bridge to connect any editor/client to LSP servers
Downloads
32
Maintainers
Readme
🧩 ws-lsp-bridge
A lightweight WebSocket → Language Server Protocol (LSP) bridge for editors and IDEs.
It allows web-based editors or remote clients to connect to any LSP server over WebSocket — perfect for environments like Acode or browser-based IDEs.
✨ Features
- 🔌 Spawn any LSP server (
stdiooripc) and expose it via WebSocket - 🌐 Bridge messages between web editors and LSP servers in real time
- 🧠 Multi-endpoint support (each LSP runs on its own WebSocket path)
- ⚡ Lightweight & dependency-free — only uses
wsandvscode-jsonrpc - 🪶 Ideal for browser-based editors, cloud IDEs, or mobile code editors
📦 Installation
Install globally via npm:
npm install -g ws-lsp-bridgeOr run directly with npx:
npx ws-lsp-bridge🚀 Usage
Start the WebSocket LSP bridge:
wslspBy default, the server listens on port 3030.
Then connect your editor to a WebSocket endpoint, specifying which LSP server to launch via query parameters.
Example (TypeScript LSP):
ws://localhost:3030/typescript?args=typescript-language-server,--stdio&type=stdioThis command launches typescript-language-server --stdio and bridges its LSP messages over WebSocket.
⚙️ CLI Options
wslsp [options]
Options:
--port, -p <number> Port for WebSocket server (default: 3030)
--help, -h Show this helpYou can also set the port via environment variable:
wslsp --port 4040🧠 How It Works
The bridge starts a WebSocket server on the specified port.
Each connection URL defines which LSP server to spawn via query parameters.
The bridge then pipes LSP JSON-RPC messages between:
- Editor/WebSocket client → LSP stdin
- LSP stdout → Editor/WebSocket client
Editor ----(WebSocket JSON-RPC)----> ws-lsp-bridge ----(stdio)----> LSP ServerThis enables web-based or remote editors to use any LSP server — even if they can’t use stdio or ipc directly.
💖 Donate
If you like this plugin and want to support development, you can donate using crypto:
🌐 Links
📜 License
MIT License © 2025 JOBIANSTECHIE
