LSP guides on Mergeway

Configure Neovim

Mon, 01 Jan 0001 00:00:00 +0000

Configure Neovim

This setup uses Neovim’s built-in LSP client. It starts one mergeway-lsp process for files below the nearest directory containing mergeway.yaml or mergeway.yml.

Prerequisites

Install mergeway-lsp and confirm vim.fn.exepath("mergeway-lsp") is non-empty.
Use a Neovim release that provides vim.lsp.start and vim.fs.root.
Open the repository directory, not an individual unrelated file.

Add the client configuration

Put this in init.lua or a sourced Lua module:

vim.api.nvim_create_autocmd("FileType", {
 pattern = { "yaml", "json" },
 callback = function(args)
 local root = vim.fs.root(args.buf, { "mergeway.yaml", "mergeway.yml" })
 if not root then
 return
 end

 vim.lsp.start({
 name = "mergeway-lsp",
 cmd = { "mergeway-lsp" },
 root_dir = root,
 })
 end,
})

Restart Neovim and open a configured data file such as data/users/alice.yaml. Run :LspInfo; the attached client should be named mergeway-lsp.

Configure a generic LSP client

Mon, 01 Jan 0001 00:00:00 +0000

Configure a generic LSP client

Use these settings in any client that can launch a Language Server Protocol process. Setting names differ by client; the values are the portable contract.

Client setting	Value
Command	`mergeway-lsp`
Arguments	none, or logging flags only
Transport	stdio with standard LSP `Content-Length` framing
File types	YAML and JSON files used by the repository
Root markers	`mergeway.yaml`, `mergeway.yml`
Initialization root	the directory containing the root marker
Synchronization	full document, with open and close notifications

Configure the client to send a file:// URI in rootUri, or send one or more file-URI entries in workspaceFolders. When workspaceFolders is non-empty it is authoritative and rootUri/legacy rootPath are ignored. The server checks each supplied directory directly; the client must find the marker rather than expecting the server to search parent directories.

Capture LSP debug logs

Mon, 01 Jan 0001 00:00:00 +0000

Capture LSP debug logs

Prefer a log file because an editor may hide its child process’s standard error:

mergeway-lsp --log-file /tmp/mergeway-lsp.log --log-level debug

Configure those two arguments in the client launcher, reproduce the problem, and inspect the file. Existing content is retained because the server opens the file in append mode. The log can contain absolute paths and error details; review it before sharing and remove it when finished.

For a client that exposes child stderr, use:

Troubleshoot diagnostics and navigation

Mon, 01 Jan 0001 00:00:00 +0000

The server does not start

Run mergeway-lsp --help in the same environment as the editor and confirm the executable is found. Then enable a debug log. If the log path cannot be opened or the level is invalid, startup fails before protocol initialization.

The client attaches but reports nothing

Inspect the client’s initialization data. Each rootUri or workspaceFolders entry must be the exact repository directory containing mergeway.yaml or mergeway.yml; the server does not walk upward. Dynamic workspace/didChangeWorkspaceFolders notifications are not supported, so restart the client after adding or removing folders.