Skip to content

README.md

Latest commit

 

History

History
81 lines (71 loc) · 2.98 KB

README.md

File metadata and controls

81 lines (71 loc) · 2.98 KB
Raw

vale-ls

The Vale Language Server (vale-ls) is an implementation of the Language Server Protocol (LSP) for Vale.

It provides high-level interface for managing Vale and its assets (binary, StylesPath, etc.) with the goal of making it easy to add IDE-like features to any text editor that supports the Language Server Protocol.

See the documentation for more information.

Features

HoverProvider CompletionProvider
See in-editor documentation for any symbol. Autocomplete all StylesPath assets: Styles, Packages, Vocabularies, etc.
DocumentLinkProvider CodeActionProvider
Quickly navigate to external URLs. Fix alerts with a single click.

Releasing

Releases are cut with cargo release, which bumps Cargo.toml and Cargo.lock, commits, tags, and pushes:

$ cargo release patch --execute

Pushing the tag triggers the release workflow, which builds the binaries. Don't tag by hand: vale-ls --version reports the version in Cargo.toml, so a tag that doesn't match it ships a binary that reports the wrong version. The workflow now rejects that.