This repository contains a Vale-compatible implementation of syntax rules adopted in the legal domain.

The goal is to build and maintain a full-featured style guide for Vale to be adopted by the legal community.

Getting Started

❗ LegalRules requires Vale >= 2.5.15. ❗

Download the latest release, copy the "LegalRules" 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 = LegalRules

See Usage for more information.

Repository Structure

/RuleBase

The YAML-based rule implementations that make up our style.

/fixtures

The individual unit tests. Each directory should be named after a rule found in /RuleBase 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.