phijor/alster

A proof-of-concept Language Server for the Agda programming language.

Alster

A proof-of-concept Language Server for the Agda programming language.

So far it doesn't do much, but it can parse your Agda files and highlight (some) syntax errors as you type.

Building

Currently, the only tested compiler is GHC 9.4.2. Use cabal to build the project:

$ cabal build exe:alster

Alternatively, use nix to obtain a reproducible development environment:

# Binary will be symlinked to ./result/bin/Alster
$ nix build

$ nix shell
(nix-shell) # Inside of a Nix shell, all dev dependencies are available:
(nix-shell) which ghc
/nix/store/44lbf7kcza4a5k1w2hspga2621zjg62k-ghc-9.4.2-with-packages/bin/ghc

Usage

To set up Alster for use with Neovim, use this fork of lspconfig, or copy the file lua/lspconfig/server_configurations/alster.lua there to your runtime path. Afterwards, the Alster is configured like any other language server:

require('lspconfig').alster.setup {
    cmd = { '/custom/path/to/alster', 'arg1', 'arg2', ... },
    settings = {
        Alster = { ... },
    },
}

If want to use Alster with a different editor, consult your editor's LSP documentation. For Emacs, lsp-mode is probably a good starting point. If you're using VS Code and feel brave, good luck.

Contributing

Don't wait for me to implement everything! Feel free to open issues if you need help getting the server to run, or if you want to discuss its design. Alternatively, head over to the Agda Zulip and discuss with us there.

License

This project is licensed under the MIT License. See LICENSE.