agda / agda-language-server

Language Server for Agda
MIT License
102 stars 17 forks source link
agda agda-mode language-server-protocol

Agda Language Server

Installation

The simplest way of acquiring Agda Language Server is through agda-mode on VS Code. Follow the instructions and the language server should be installed within seconds.

Prebuilt binaries

You can also download prebuilt binaries from the release page if you are using other LSP-compatible text editors.

Supported platforms: Windows, Mac, and Ubuntu.

Build from source

You will need Haskell Stack to build the project:

stack install

Versioning

The version is x.a.b.c.d.y where a.b.c.d is the 4-digit Agda version (2.6.4.0), x is 0 but may be bumped for revolutionary changes to the agda-language-server, and y is for patch releases.

Why make it standalone?

Hacking

This language server is co-developed alongside agda-mode on VS Code. Enable agdaMode.connection.agdaLanguageServer in agda-mode's settings, and then hit restart C-x C-r to connect to the language server. The editor extension will search for the language server in the following order:

  1. localhost:4096 via TCP
  2. als executable on your machine
  3. Prebuilt binaries on GitHub

To host the language server locally at localhost:4096, run :main -p in the REPL (stack repl). This allows us to reload the language server in the REPL without having to recompile and reinstall the whole project on your system every time there is a change.