cuelsp

module
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2022 License: Apache-2.0

README

CUE LSP

Language Server implementation for CUE, with built-in support for Dagger.

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.

Configure your code editor

Code Editor Documentation
VS Code Extension
Vim Guide
Capabilities
Feature Supported Link to documentation
Load cue plan how cuelsp loads CUE
Load multiples files how cuelsp loads CUE
Jump to CUE definition managing jump-to
Doc Hover
Syntax highlighting
Auto completion 🚫
Jump to CUE keys 🚫
Error highlighting 🚫
Code snippet 🚫
Optimization suggestion 🚫
Development & CI

We use Dagger to lint, test and build CUELSP. Using Dagger, commands running in the CI behave the same as on your local system 🚀

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 to produce CUELSP binaries for multiple platforms.

To publish a new release, we just create a new tag.

# Tag current commit
git tag vX.X.X

# Push tag to repository
git push origin vX.X.X
Maintainers

Vasek

Guillaume de Rouville

Tanguy ⧓ Herrmann

Directories

Path Synopsis
cmd
Package server is a simple abstraction of glsp server that includes in custom handler that supports CUE language.
Package server is a simple abstraction of glsp server that includes in custom handler that supports CUE language.
handler
Package handler is a collection of all methods supported by LSP.
Package handler is a collection of all methods supported by LSP.
utils
Package utils is a simple package that group any pure functions useful in LSP /!\: functions in package utils should be the simplest possible
Package utils is a simple package that group any pure functions useful in LSP /!\: functions in package utils should be the simplest possible

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL