aireilly / SubVale

A Sublime Text 3 client for Vale CLI

Vale + Sublime Text

A Sublime Text 4 package for Vale, the customizable linter for prose.

HACK

• Zip the contents of the SubVale folder > Vale.sublime-package and mv to ~/.config/sublime-text/Installed Packages/
• Put settings in ~/.config/sublime-text/Packages/User/Vale.sublime-settings

Interactive Linting

Bring your style guide to life with detailed pop-ups or status bar messages.

Style & Rule Management

Easily access styles defined in your Vale configuration file on a per-view basis.

Installation

1. Install Vale.
2. Install Package Control.
3. Bring up the Command Palette (Command-Shift-P on macOS and Ctrl-Shift-P on Linux/Windows).
4. Select Package Control: Install Package and then select Vale when the list appears.

Usage

The first step is to specify the location of the Vale binary in your settings file (Preferences → Package Settings → Vale → Settings - User):

// Enter your path here ...
{
    "vale_binary": "/usr/local/bin/vale",
}

From here, you can run one of the following commands via the Command Palette:

1. Vale: Lint View: runs the Vale binary on the active view.
2. Vale: Edit Styles: shows a list of styles relevant to the active view.
3. Vale: New Rule: shows a list of extension points and opens the associated template.

Configuration

This package exposes a number of configuration options. These include styling the in-text alerts, adding custom HTML/CSS for the pop-ups, and listing accepted syntaxes.

See the Default settings file (Preferences → Package Settings → Vale → Settings - Default) for more details.