Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.32 KB

README.md

File metadata and controls

30 lines (16 loc) · 1.32 KB

VSCode vale

Build Status

Lint documents with Vale in Visual Studio Code.

Prerequisites

Install vale 0.7.2 or newer and make sure that the vale executable is in $PATH.

If your setup does not let you to add vale to $PATH, please open an issue.

If vale is too old the extension fails to activate. In this case please update Vale; the error message will tell you the required version.

Usage

Vale automatically checks a document when you open or save it. Use the Vale: Lint workspace command to check the entire workspace.

Vale always runs from the workspace directory in either case, so if you put a Vale configuration in the workspace directory it will automatically pick it up.

Currently this extension only supports Markdown, reStructuredText, LaTeX and plain text (.txt) documents; please open an issue or a pull request if you need support for more document formats, provided that Vale supports them.