https://github.com/agda/agda-language-server

Language Server for Agda
https://github.com/agda/agda-language-server

agda agda-mode language-server-protocol

Last synced: about 1 month ago
JSON representation

Language Server for Agda

• Host: GitHub
• URL: https://github.com/agda/agda-language-server
• Owner: agda
• License: mit
• Created: 2017-08-18T08:42:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-16T07:51:48.000Z (7 months ago)
• Last Synced: 2024-05-19T18:16:33.719Z (about 2 months ago)
• Topics: agda, agda-mode, language-server-protocol
• Language: Haskell
• Homepage:
• Size: 363 KB
• Stars: 95
• Watchers: 9
• Forks: 17
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• my-awesome-stars - banacorn/agda-language-server - Language Server for Agda (Haskell)

README

        
# Agda Language Server

## Installation

The simplest way of acquiring Agda Language Server is through [agda-mode on VS Code](https://github.com/banacorn/agda-mode-vscode#agda-language-server).

Follow the instructions and the language server should be installed within seconds.

### Prebuilt binaries

You can also download prebuilt binaries [from the release page](https://github.com/banacorn/agda-language-server/releases) if you are using other LSP-compatible text editors.

Supported platforms: **Windows**, **Mac**, and **Ubuntu**.

### Build from source

You will need [Haskell Stack](https://docs.haskellstack.org/en/stable/README/) 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?

* for less impact on the Agda codebase

* to help [decouple the Agda codebase](https://github.com/agda/agda/projects/5)

* we can always merge it back to Agda later anyway

## Hacking 

This language server is co-developed alongside [agda-mode on VS Code](https://github.com/banacorn/agda-mode-vscode). 

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.