Microsoft
NOTE: This project is neither maintained nor endorsed by Microsoft.
This repository contains a Vale-compatible implementation of the Microsoft Writing Style Guide (LICENSE).
Getting Started
To get started, add the package to your configuration file (as shown below) and then run vale sync
.
StylesPath = styles
MinAlertLevel = suggestion
Packages = Microsoft
[*]
BasedOnStyles = Vale, Microsoft
See Packages 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
/Microsoft
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 |
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 |