Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dagger/cuelsp
https://github.com/dagger/cuelsp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dagger/cuelsp
- Owner: dagger
- License: apache-2.0
- Archived: true
- Created: 2022-05-12T09:20:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-19T09:49:11.000Z (about 2 years ago)
- Last Synced: 2024-06-19T17:52:10.061Z (5 months ago)
- Language: Go
- Size: 5.45 MB
- Stars: 87
- Watchers: 8
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cue - cuelsp - Language Server implementation for CUE, with built-in support for Dagger. (Projects)
README
# CUE LSP
Language Server implementation for [CUE](https://cuelang.org), with built-in support for [Dagger](https://dagger.io).
## Install
CUE LSP can be used in one of two ways:
* As a standalone binary `cuelsp`: `go install github.com/dagger/cuelsp/cmd/cuelsp@latest`
* As a subcommand of the Dagger CLI: `dagger cuelsp`. This requires [dagger v0.2.27 or later](https://docs.dagger.io/install).
## Configure your code editor
| Code Editor | Documentation |
|:-----------:|:----------------------------------------------------:|
| VS Code | [Extension](https://marketplace.visualstudio.com/items?itemName=Dagger.dagger) |
| Vim | [Guide](./docs/vim.md) |
### Capabilities
| Feature | Supported | Link to documentation |
|-------------------------|--------------------|-------------------------------------------|
| Load cue plan | :white_check_mark: | [how cuelsp loads CUE](./docs/load.md) |
| Load multiples files | :white_check_mark: | [how cuelsp loads CUE](./docs/load.md) |
| Jump to CUE definition | :white_check_mark: | [managing jump-to](./docs/jump-to.md) |
| Doc Hover | :white_check_mark: | |
| Syntax highlighting | :hourglass: | |
| Auto completion | :no_entry_sign: | |
| Jump to CUE keys | :no_entry_sign: | |
| Error highlighting | :no_entry_sign: | |
| Code snippet | :no_entry_sign: | |
| Optimization suggestion | :no_entry_sign: | |
### Development & CI
We use [Dagger](https://dagger.io) to lint, test and build CUELSP. Using Dagger, commands running in the
CI behave the same as on your local system :rocket:
| Action | Command |
|--------------|-------------------|
| Run linter | `dagger do lint` |
| Run test | `dagger do test` |
| Build binary | `dagger do build` |
> If you are on Mac M1, you should build binary using `go build -o cuelsp` because Buildkit
> does not support `darwin/arm64` platform, yet.
### Release
CUELSP is versioned through tagged release.
There is a complete [release workflow](./.github/workflows/release.yaml) to produce CUELSP binaries for multiple
platforms.
To publish a new release, we just create a new tag.
```shell
# Tag current commit
git tag vX.X.X
# Push tag to repository
git push origin vX.X.X
```
### Maintainers
| [
Vasek](https://github.com/TomChv) | [
Guillaume de Rouville](https://github.com/grouville) | [
Tanguy ⧓ Herrmann](https://github.com/dolanor) |
|:-------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------:|