Skip to content

README.md

Latest commit

 

History

History
77 lines (53 loc) · 2.58 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.58 KB
Raw

grigson-language-server

A standalone Language Server Protocol server for Grigson .chart files. Provides real-time parse error diagnostics in any LSP-capable editor.

Install

npm install -g grigson-language-server

Or build from source (within the monorepo):

pnpm --filter grigson run build          # build the grigson library first
pnpm --filter grigson-language-server run build
# → packages/language-server/dist/server.js

What it does

Diagnostics

On every file open and every keystroke, the server calls validate() from the grigson package and sends the resulting diagnostics to the editor via textDocument/publishDiagnostics. Valid files produce zero diagnostics; parse errors appear as red squiggles with hover tooltips.

Diagnostics include:

  • range — 0-indexed start/end position of the error
  • severity — Error (1) for parse errors
  • message — the Peggy parse error message
  • source — "grigson"

Formatting

The server advertises documentFormattingProvider and handles textDocument/formatting requests. On a format request it runs parseSong → normaliseSong → TextRenderer.render and returns a single TextEdit replacing the entire document with the normalised output. If the file cannot be parsed, or if the normalised output is identical to the current content, the server returns an empty edit list (no change).

Editor setup

VS Code

Handled automatically by the vscode-grigson extension — no manual configuration needed. See packages/vscode-extension.

Neovim (nvim-lspconfig)

require('lspconfig').grigson.setup({
  cmd = { 'grigson-language-server', '--stdio' },
  filetypes = { 'grigson' },
  root_dir = function(fname)
    return require('lspconfig').util.find_git_ancestor(fname) or vim.loop.cwd()
  end,
})

Helix (~/.config/helix/languages.toml)

[[language]]
name = "grigson"
scope = "source.grigson"
file-types = ["chart"]
language-servers = ["grigson-language-server"]

[language-server.grigson-language-server]
command = "grigson-language-server"
args = ["--stdio"]

Emacs (eglot)

(add-to-list 'eglot-server-programs
             '(grigson-mode . ("grigson-language-server" "--stdio")))

Tree-sitter integration

The LSP provides diagnostics. For syntax highlighting and structural text objects, pair it with the tree-sitter grammar — see packages/tree-sitter-grammar for setup instructions. Both run side-by-side and do not conflict.