ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-vale

by SublimeLinter ST3

Plugin for SublimeLinter to provide an interface to Vale

Labels linting, SublimeLinter, markdown, plain text, prose

Details

  • 1.1.0
    1.0.2
  • github.​com
  • github.​com
  • 1 year ago
  • 1 hour ago
  • 7 years ago

Installs

  • Total 416
  • Win 149
  • Mac 175
  • Linux 92
Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7
Windows 0 0 1 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 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 1 0 0 0 0 2 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 1 0 1
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 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-vale

This linter plugin for SublimeLinter provides an interface to Vale. It will be used with files that have the Plain text or Markdown syntaxes.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that vale is installed on your system (See https://vale.sh/docs/vale-cli/installation/).

Note: This plugin requires vale 0.5.0 or later.

Windows

You can install Vale using choco

choco install vale

macOS

You can install Vale using Homebrew:

brew tap ValeLint/vale
brew install vale

Linux

You can install Vale using snap:

snap install vale

Linter configuration

In order for vale to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured vale, you can proceed to install the SublimeLinter-vale plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available.

To install this package with Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type vale. Among the entries you should see SublimeLinter-vale. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

You can configure Vale for your project using a configuration file named .vale or _vale. For more information, see Vale's documentation.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork this repository.
  2. Work on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are well known.

Thank you for helping out!