/write-good

A Vale-compatible implementation of the write-good linter.

Primary LanguageGherkinMIT LicenseMIT

write-good Build Status Vale version license

write-good: Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.

This repository contains a Vale-compatible implementation of the guidelines enforced by the write-good (LICENSE) linter.

Getting Started

❗ write-good requires Vale >= 1.7.0. ❗

Download the latest release, copy the "write-good" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = write-good

See Usage for more information.