basex-lsp/README.md
2025-08-16 18:01:03 +01:00

1.9 KiB

Work in progress.

An attempt to write a Language Server Protocol server using XQuery 4.0 and the BaseX websocket feature.

LSP Server

  • webapp/lsp The LSP implementation in XQuery using WebSockets for transport and the JSON-RPC 2.0 API for data format.

Dev notes

State is held in websocket attributes.

Name Use
initized set true after client sends intialized messag
files A map whose keys are open uris, values are maps (doctype-> attribute name where doctype is stored
file-{uuid} name of websocket attribute with textDocument
parse-{uuid} name of websocket attribute with parse tree XML

Sample html clients

Using CodeMirror6 https://codemirror.net/

  • webapp/static/codemirror A test html page using the CodeMirror6 editor that connects to the BaseX LSP instance

uses

Using Ace Editor

  • webapp/static/ace A test html page using the Ace editor that connects to the BaseX LSP instance

Uses

Make a websocket server for lsp on port 3000 https://mkslanc.github.io/ace-linters/websocket.html

http://localhost:3000/exampleServer

c1b317e012/packages/demo/websockets-lsp/server/server.ts I needed set NODE_OPTIONS=--max_old_space_size=8192 for build to complete

Or node --max-old-space-size=8192 node_modules/webpack-dev-serve r/bin/webpack-dev-server.js

Monaco

https://socket.dev/npm/package/monaco-editor

java -cp org.eclipse.lemminx-uber.jar org.eclipse.lemminx.XMLServerSocketLauncher`