Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/banacorn/agda-mode-vscode

agda-mode on VS Code
https://github.com/banacorn/agda-mode-vscode

agda agda-mode reasonml vscode vscode-extension

Last synced: 4 days ago
JSON representation

agda-mode on VS Code

Host: GitHub
URL: https://github.com/banacorn/agda-mode-vscode
Owner: banacorn
License: mit
Created: 2020-01-25T13:05:31.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-08-31T00:17:14.000Z (3 months ago)
Last Synced: 2024-10-04T10:45:00.608Z (about 1 month ago)
Topics: agda, agda-mode, reasonml, vscode, vscode-extension
Language: ReScript
Homepage: https://marketplace.visualstudio.com/items?itemName=banacorn.agda-mode
Size: 3.81 MB
Stars: 170
Watchers: 10
Forks: 40
Open Issues: 55
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # agda-mode on VS Code

## Installation

If you have [Agda](https://agda.readthedocs.io/en/latest/getting-started/installation.html) properly installed (to check this in your terminal, type `agda` and see if it's on your machine). Open an Agda file and you should be able to load it by typing C-c C-l.

It's okay if you don't have Agda installed, just proceed to the next section and check out our experimental language server for Agda.

## [Agda Language Server](https://github.com/banacorn/agda-language-server)

Simply enable `agdaMode.connection.agdaLanguageServer` in the settings, and then hit *restart* C-x C-r.

The language server should be downloaded and installed within seconds.



Prebuilt binaries for the language server are available on Windows, macOS, and Ubuntu.

### Extension Activation

To activate the extension, open an Agda file, and trigger either of these 2 commands:

| Command                       |            Keymap             |

| :---------------------------- | :---------------------------: |

| load                          | C-c C-l |

| activate unicode input method |         \\         |

See the next section for the exhaustive list of other commands.

You will get `command ... not found` if you try to trigger other commands without activating the extension first.

## Commands

* C-c stands for "press Ctrl and c at the same time"

* When it comes to combos like C-c C-l, you can often slur

them into "hold Ctrl while pressing c and then l"

Commands working with types (marked with the 🎚 emoji below) can have different levels of normalization. However, due to some [technical limitations](https://github.com/microsoft/vscode/issues/6966), we cannot prefix commands with `C-u` or ` C-u C-u` like in Emacs. Instead, we replace the `C-u C-c` prefix with `C-u` and the `C-u C-u C-c` prefix with `C-y`.

Take *infer type* for example:

| Level of normalization                         |       Keymap in VS Code       |                       Keymap in Emacs                        |

| :--------------------------------------------- | :---------------------------: | :----------------------------------------------------------: |

| "simplified"   (default)                       | C-c C-d |                C-c C-d                 |

| "instantiated" (without further normalisation) | C-u C-d |         C-u C-c C-d         |

| "normalized"   (fully normalized)              | C-y C-d | C-u C-u C-c  C-d |

### Global commands

| Command                                 |            Keymap             |

| :-------------------------------------- | :---------------------------: |

| load                                    | C-c C-l |

| compile                                 | C-x C-c |

| quit                                    | C-c C-q |

| quit and restart                        | C-x C-r |

| toggle display of hidden arguments      | C-x C-h |

| toggle display of irrelevant arguments  | C-x C-i |

| show constraints                        | C-c C-= |

| solve constraints 🎚                     | C-c C-s |

| show all goals                          | C-c C-? |

| move to next goal (forward)             | C-c C-f |

| move to previous goal (backwards)       | C-c C-b |

| infer type 🎚                            | C-c C-d |

| module contents 🎚                       | C-c C-o |

| search definitions in scope 🎚           | C-c C-z |

| compute normal form (default compute)   | C-c C-n |

| compute normal form (ignore abstract)   | C-u C-n |

| compute normal form (use show instance) | C-y C-n |

| switch to a different Agda version      | C-x C-s |

| Unicode symbol input sequences lookup   | C-x C-= |

### Commands in context of a goal

| Command                                 |             Keymap              |

| :-------------------------------------- | :-----------------------------: |

| give (fill goal)                        | C-c C-SPC |

| refine                                  |  C-c C-r  |

| elaborate and give 🎚                    |  C-c C-m  |

| auto                                    |  C-c C-a  |

| case split                              |  C-c C-c  |

| compute helper function type and copy 🎚 |  C-y C-h  |

| goal type 🎚                             |  C-c C-t  |

| context (environment) 🎚                 |  C-c C-e  |

| infer type 🎚                            |  C-c C-d  |

| goal type and context 🎚                 |  C-c C-,  |

| goal type, context and inferred term 🎚  |  C-c C-.  |

| goal type, context and checked term  🎚  |  C-c C-;  |

| module contents 🎚                       |  C-c C-o  |

| compute normal form (default compute)   |  C-c C-n  |

| compute normal form (ignore abstract)   |  C-u C-n  |

| compute normal form (use show instance) |  C-y C-n  |

| why in scope                            |  C-c C-w  |

### Commands yet to be implemented

| Command                          |            Keymap             |

| :------------------------------- | :---------------------------: |

| abort a command                  | C-x C-a |

| remove goals and highlighting    | C-x C-d |

| comment/uncomment rest of buffer |                               |

## Unicode Input

Pretty much the same like on Emacs.

Press backslash "\\" and you should see a keyboard popping up in the panel, with key suggestions and symbol candidates. Use arrow keys to explore and navigate between the candidates (if there's any).

Unicode input also works in the input prompt, though it's a bit less powerful.

If you are having trouble typing the backslash "\\", you can change it by:

1. Go to "Preferences: Open Keyboard Shortcuts" and configure the keybinding of "Agda: Activate input method" (`agda-mode.input-symbol[Activate]`).

2. Go to "Settings > Agda Mode > Input Method: Activation Key" and replace it with the same keybinding as above.

Cancel `agdaMode.inputMethod.enable` in the settings to disable the input method.

## Syntax Highlighting

Cancel `agdaMode.highlighting.getHighlightWithThemeColors` in the settings if you want to fallback to the old way of highlighting stuff with fixed colors.

## Debug Buffer

Execute `Agda: Open Debug Buffer` in the *Command Palette* to open it.

The number at the end of each message indicates its verbosity.

## Troubleshooting

### Agda files won't load, commands don't work

Please go to "Preferences: Open Keyboard Shortcuts" and see if any extension is fighting for the same key combo.

You're probably a victim of the [*Vim* extension](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim).

### "Give" command not working on macOS

*Give* (C-c C-SPC) would trigger "Spotlight" (C-SPC) on Mac.

Please consider using *Refine* (C-c C-r) instead.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)