Skip to content

README.md

Latest commit

 

History

History
104 lines (74 loc) · 3.49 KB

README.md

File metadata and controls

104 lines (74 loc) · 3.49 KB

Aver — Editor Support

Aver ships with:

  • a VS Code extension backed by the aver-lsp language server
  • Sublime Text syntax highlighting

VS Code

Features

Feature Description
Syntax highlighting TextMate grammar for keywords, types, effects, string interpolation, and ? descriptions
Diagnostics Lex, parse, type, and project-policy diagnostics shown inline
Completion Built-in namespaces, user-defined types, user functions, and cross-module members
Hover Function contracts, verify summaries, decision context, type definitions, and namespace member signatures
Go-to-definition Cross-file navigation for functions, types, and bindings
Signature help Parameter hints inside function calls
Code lens verify / decision summaries above code, clickable to jump to related blocks
Formatting Uses Aver's native formatter through Format Document

All features work cross-module. depends [...] is resolved from the workspace root, matching aver run.

Install

Recommended:

# Install the language server
cargo install aver-lsp

Then install the VS Code extension:

  • Visual Studio Code Marketplace: Aver.aver-lang
  • Open VSX: Aver.aver-lang

Development install from this repository:

# Run from the repository root
cargo build -p aver-lsp --release
ln -sf $(pwd)/target/release/aver-lsp /usr/local/bin/aver-lsp
ln -snf $(pwd)/editors/vscode ~/.vscode/extensions/aver-lang

Open a .av file and the extension will activate automatically.

To use the new clickable summaries, keep VS Code code lenses enabled:

"editor.codeLens": true

Then:

  • hover functions and decisions to see verify/decision context
  • use the Outline panel to browse module, decisions, functions, and nested verify
  • click code lenses like verify: 2 cases, 1 law or decisions: 3 to jump to the related block
  • run Format Document to apply Aver formatting

To point VS Code at a different LSP binary, set aver.lsp.path in editor settings.

Alternative install method:

cp -r editors/vscode/ ~/.vscode/extensions/aver-lang

Or package the extension and install it through Extensions -> ... -> Install from VSIX.

Sublime Text

Copy editors/sublime/ to your Packages directory:

# macOS
cp -r editors/sublime/ ~/Library/Application\ Support/Sublime\ Text/Packages/Aver/

# Linux
cp -r editors/sublime/ ~/.config/sublime-text/Packages/Aver/

# Windows
cp -r editors/sublime/ %APPDATA%\Sublime Text\Packages\Aver\

Hot-reloads with no restart needed. Select Aver from the language menu in the bottom-right corner.

What's highlighted

  • Keywords: fn, type, record, module, match, verify, decision, depends, exposes, effects
  • Reserved words (parse errors): val, var
  • Effect declarations: ! [Console.print, Http.get, Disk.readText]
  • Function descriptions: ? "..."
  • String interpolation: "Hello, {name}!"
  • Escape sequences: \n, \t, \\, \", etc.
  • Built-in types: Int, Float, String, Bool, Unit, Result, Option, List, Map, Fn
  • Built-in values: true, false
  • Namespace calls: Console.print, Http.get, Disk.readText, Tcp.send, Int.fromString, String.len, List.concat, Map.get, Char.toCode, Byte.toHex
  • Qualified constructors: Result.Ok, Option.Some, Option.None
  • ADR keys: date, reason, chosen, rejected, impacts, author
  • Numbers: integers, floats, scientific notation (1.5e-3)
  • Comments: // ...