vale

README

Vale: Your Style, Our Editor

Vale is a linter for prose—no matter if it's plain text, markup or source-code comments. It's built around a plugin system that allows it to lint against arbitrary rules. In practice, this means that it can help you adhere to entire editorial style guides or simply break writer-specific bad habits (see Use Cases for more ideas).

Here's an example of Vale's versatility:

# These options are specified in either a .vale or _vale file.
StylesPath = path/to/my/project/styles/directory
MinAlertLevel = warning

[*.{md,txt}]
BasedOnStyles = TheEconomist
vale.Editorializing = YES

[*.py]
BasedOnStyles = vale
write-good.ThereIs = YES
vale.PassiveVoice = NO

In this case, we are linting all Markdown and text files in our project against The Economist. We are also linting Python comments against vale and write-goods's ThereIs rule.

Check out the wiki to learn more!

Features

• Supports Markdown, reStructuredText, AsciiDoc, HTML, and source code
• Extensible without programming experience
• External checks can be written in any programming language
• Standalone binaries for Windows, macOS, and Linux
• Expressive, EditorConfig-like configuration

Installation

See the project wiki.