NOTE: This project is neither maintained nor endorsed by Microsoft.
This repository contains a Vale-compatible implementation of the Microsoft Writing Style Guide (LICENSE).
The goal is to showcase how to build and maintain a full-featured style guide for Vale, including many examples of using extension points and a test suite using Cucumber, yamllint, and Travis CI.
Getting Started
❗ Microsoft requires Vale >= 1.7.0.❗
Download the latest release, copy the "Microsoft" 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 = MicrosoftSee Usage for more information.
Repository Structure
/Microsoft- 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
/Microsoftand include its own.vale.inifile 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 |
Accessibility.yml, Adverbs.yml, AMPM.yml, Auto.yml, Avoid.yml, Dashes.yml, DateFormat.yml, Ellipses.yml, FirstPerson.yml, HeadingColons.yml, HeadingPunctuation.yml, Hyphens.yml, OxfordComma.yml, Passive.yml, Quotes.yml |
substitution |
Backend.yml (POS tags), ComplexWords.yml, Contractions.yml, Foreign.yml, Terms.yml |
occurrence |
N/A |
repetition |
N/A |
consistency |
N/A |
capitalization |
Headings.yml |
readability |
N/A |
conditional |
Acronyms.yml |
spelling |
N/A |