LSP-vale-ls

by jdkato ST4

A vale-ls client for Sublime Text.

Labels lsp, vale

Details

Version 0.6.0
Homepage packagecontrol.io
Issues github.com
Modified 10 hours ago
Last Seen 6 hours ago
First Seen 3 years ago

Installs

Total 272
Win 67
Mac 113
Linux 92

	Aug 2	Aug 1	Jul 31	Jul 30	Jul 29	Jul 28	Jul 27	Jul 26	Jul 25	Jul 24	Jul 23	Jul 22	Jul 21	Jul 20	Jul 19	Jul 18	Jul 17	Jul 16	Jul 15	Jul 14	Jul 13	Jul 12	Jul 11	Jul 10	Jul 9	Jul 8	Jul 7	Jul 6	Jul 5	Jul 4	Jul 3	Jul 2	Jul 1	Jun 30	Jun 29	Jun 28	Jun 27	Jun 26	Jun 25	Jun 24	Jun 23	Jun 22	Jun 21	Jun 20	Jun 19
Windows	0	0	1	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	0	0	0	0	2	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	3	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

LSP-vale-ls

This is a helper package that automatically installs and updates vale-ls for Sublime Text. Vale is a syntax-aware linter for prose built with speed and extensibility in mind.

Requirements

To use this package, you must have the LSP package installed.

It's recommended, but not required, to install the LSP-json package which will provide auto-completion and validation for this package's settings.

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.

The server also provides:

Diagnostics: Vale's alerts, updated as you type rather than only on save (see lintOnChange and debounceMs).
CodeLensProvider: a per-document metrics lens — word count, reading time, and so on (see showMetrics).
Vocabulary code actions: accept a flagged term into your vocabulary, or reject it.

Configuration

There are multiple ways to configure the package and the language server.

Global configuration: Preferences > Package Settings > LSP > Servers > LSP-vale-ls

Project-specific configuration: From the Command Palette run Project: Edit Project and add your settings in:

{
    "settings": {
        "LSP": {
            "LSP-vale-ls": {
                "initialization_options": {
                    // Put your settings here
                }
            }
        }
    }
}

Settings

Setting	Default	Description
`installVale`	`true`	Install and update Vale automatically. If `false`, Vale must be installed and available on your `$PATH`.
`syncOnStartup`	`true`	Run `vale sync` when the server starts.
`filter`	`""`	An output filter to apply when calling Vale.
`configPath`	`""`	An absolute path to a `.vale.ini` file, used instead of the default search process.
`valeBinaryPath`	`""`	An absolute path to the Vale binary to run, instead of the server-managed copy.
`lintOnChange`	`true`	Lint the buffer as it changes, not just when it's saved.
`debounceMs`	`300`	How long typing has to settle before linting, in milliseconds.
`showMetrics`	`true`	Show the document metrics code lens.
`root`	`""`	An absolute path to the directory to run Vale from, instead of the document's workspace folder.

Commands

From the Command Palette:

LSP-vale-ls: Sync Configuration — download the packages and styles your .vale.ini asks for.
LSP-vale-ls: Install or Update Vale — install or update the server-managed copy of Vale.