vale-boilerplate

This repository is meant to serve as a starting point for creating and maintaining your own Vale-compatible style guide. It includes a (fairly) complete implementation of the 18F Content Guide, including example rules for all of Vale's extension points and a unit test suite using Cucumber, yamllint, and Travis CI.

Dependencies

yamllint

You can install yamllint through Homebrew:

$ brew install yamllint

Cucumber

To install Cucumber on OSX, run:

gem update --system
gem install rspec --no-ri --no-rdoc
gem install watir-webdriver --no-ri --no-rdoc
gem install cucumber --no-ri --no-rdoc
gem install aruba

Repository Structure

/src

The YAML-based rule implementations that make up our style (in this case, 18F).

/fixtures

The individual unit tests. Each directory should be named after a rule found in /src and include its own .vale.ini file that isolates its target rule.

/features

The Cucumber Step Definitions we use to test our fixtures. Essentially, we use the aruba framework to test Vale's output after running it on each of our fixture directories.

Extension Points

check	Implementation(s)
existence	Spacing.yml
substitution	Terms.yml, DropDown.yml (POS tags)
occurrence	SentenceLength.yml
repetition	Repetition.yml
consistency	Spelling.yml
capitalization	Headings.yml
readability	Reading.yml
conditional	UnexpandedAcronyms.yml
spelling	Spellcheck.yml

Test Process

To check the style guide, run the following commands:

• yamllint src
• `cucumber'