Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mjibson/acre
langserver client for acme in rust
https://github.com/mjibson/acre
Last synced: 4 months ago
JSON representation
langserver client for acme in rust
- Host: GitHub
- URL: https://github.com/mjibson/acre
- Owner: mjibson
- License: apache-2.0
- Created: 2020-02-08T17:36:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-15T17:27:26.000Z (over 1 year ago)
- Last Synced: 2024-02-17T02:42:51.987Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 209 KB
- Stars: 28
- Watchers: 6
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-acme - acre - Language server client for acme in Rust (Programs)
README
# acre
acre is a [langserver](https://langserver.org/) client for [acme](https://www.youtube.com/watch?v=dP1xVpMPn8M) in [Rust](https://www.rust-lang.org/).
This is very much in **beta** and purposefully crashes on most errors. If a crash occurs, please file a bug so the feature can be added. Lenses and some other features are not yet supported. Config files may change.
It functions by creating a new window in acme. The window lists all open supported files and commands. The commands can be run by right clicking on them. The currently focused window is prefixed by a `*`. Run the `Get` command in the acre window to clear the current output.
Note: while the open file list contains all supported file types, those files may or may not be supported by the server if, say, the project they are in has not been configured in acre.toml.
# Demo
# Installation
The [latest release](https://github.com/mjibson/acre/releases/latest) is available for Linux and OSX.
# Configuration
Configuration (which servers to run) is handled by a file at `~/.config/acre.toml` (note: I'm not sure if this is true on OSX, but the location will be printed in an error if it does not exist). The file should contain a `servers` object with where names are LSP servers and values are an object:
- `executable` (optional): the name of the binary to invoke. If not present, uses the name.
- `files`: regex matching files that should be associated with this server.
- `root_uri` (optional): Root URI of the workspace.
- `workspace_folders` (optional): array of workspace folder URIs.
- `options` (optional): list of options to be sent to the server.
- `format_on_put` (optional): boolean (defaults to true) to run formatting on Put.
- `actions_on_put` (optional): array of actions (strings) to run on Put. Only useful if `format_on_put` is not false.
- `env` (optional): table of `key = "value"` pairs to add to the environment for `executable`.
URIs should look something like `file:///home/user/project`.
Here's an example file for `rust-analyzer` and `gopls`:
```
[servers.rust-analyzer]
files = "\\.rs$"
workspace_folders = [
"file:///home/username/some-project",
"file:///home/username/other-project",
]
[servers.rust-analyzer.env]
CARGO_TARGET_DIR = "target-ra"
RUSTFLAGS = ""
[servers.gopls]
files = '\.go$'
root_uri = "file:///home/username/go-project"
actions_on_put = ["source.organizeImports"]
```
This will execute the `rust-analyzer-linux` binary and associate it with all files ending in `.rs`. Two workspaces are configured. `gopls` will run on a single root for `.go` files. `gopls` will run the `organizeImports` command (i.e., `goimports`) on Put.
Options to pass to each server can be added:
```
[servers.name]
files = '\.ext$'
root_uri = "file:///home/username/project"
[servers.name.options]
enableSomething = true
hoverMode = "OneLine"
# Disable checkOnSave in rust-analyzer:
[servers.rust-analyzer.options]
checkOnSave.enable = false
```
# Tested servers
The following is a list of servers that have been tested with acre and are expected to work.
- [rust-analyzer](https://rust-analyzer.github.io/)
- [gopls](https://github.com/golang/tools/blob/master/gopls/README.md)
# Other clients
- [acme-lsp](https://github.com/fhs/acme-lsp) is another client for acme. It functions using Win commands instead of the new window method that acre uses.