Skip to main content

:::tip Looking for the recipe? See Workflows → Your daily dev loop for the task-driven guide. This page is the reference. :::

zuit lsp

zuit lsp

Use zuit lsp to get zuit findings as inline diagnostics inside your editor. Once configured, your editor shows findings as warnings and errors directly in the file you are editing — no terminal required. The server re-analyzes each file when you open or save it.

When to use this​

  • See findings inline while you write code, without leaving your editor.
  • Get severity-colour-coded warnings (error, warning, info, hint) using your editor's standard diagnostic UI.
  • Use as an alternative to zuit watch if your editor supports LSP.

How it works​

The server communicates over stdin/stdout using standard LSP JSON-RPC. Configure your editor to launch zuit lsp as the server command; the editor handles the connection automatically.

Supported LSP messages​

Editor actionWhat happens
Open a filezuit analyzes the file and sends diagnostics.
Save a filezuit re-analyzes the file and updates diagnostics.
Edit a filezuit re-analyzes on each change and updates diagnostics.
Close the editorServer shuts down cleanly.

Severity mapping​

zuit severities appear in your editor using the standard diagnostic levels:

zuit severityEditor diagnostic level
criticalError
highError
mediumWarning
lowInformation
infoHint

Editor setup​

Neovim (via nvim-lspconfig)​

vim.api.nvim_create_autocmd("FileType", {
  pattern = { "rust", "python", "javascript", "typescript" },
  callback = function()
    vim.lsp.start({
      name = "zuit",
      cmd = { "zuit", "lsp" },
      root_dir = vim.fs.dirname(
        vim.fs.find({ "zuit.toml", "Cargo.toml", "pyproject.toml" }, { upward = true })[1]
      ),
    })
  end,
})

VS Code​

Install the zuit VS Code extension if available, or configure any generic LSP client extension to launch zuit lsp as the server command. Point the extension at the languages you want covered (rust, python, javascript, typescript).

Other editors​

Any editor with LSP support (Helix, Emacs with lsp-mode or eglot, Sublime Text with LSP) can use zuit lsp. Set the server command to zuit lsp and configure it for the file types you want.

Known limitations​

  • Each save triggers a full re-analysis of that file. The incremental cache used by zuit analyze is not active during LSP sessions.
  • No code actions, no hover documentation, no workspace symbols. The server provides diagnostics only.

See also​