Ghalactic Vale style

A Vale style that enforces the Galactic style, which builds on the Google developer documentation style guide.

Installation

Add the Ghalactic style to your .vale.ini configuration:

Packages = https://github.com/ghalactic/vale-style/releases/download/v0.1.3/Ghalactic.zip

[*]
BasedOnStyles = Ghalactic

Then run:

vale sync

This downloads and installs the Ghalactic style.

Rules reference

Rule	Scope	Description
Abbreviations	substitution	Expands abbreviations like e.g., i.e.
Ableist	existence	Flags ableist language
Ampersand	existence	Flags & used as "and"
Contractions	substitution	Suggests contractions for formal phrases
CurlyQuotes	existence	Flags curly/smart quotes
DateFormat	existence	Flags ambiguous date formats
Directional	existence	Flags directional language (above/below)
Ellipsis	existence	Flags ellipsis character
EnDash	existence	Flags en dash character
Exclamation	existence	Flags exclamation marks
Gender	existence	Flags gendered pronouns
HeadingEndPunctuation	existence	Flags punctuation at end of headings
HeadingGerund	existence	Flags gerund-starting headings
HeadingSentenceCase	capitalization	Enforces sentence case in headings
Inclusive	substitution	Suggests inclusive alternatives
OrdinalNumerals	existence	Flags ordinal numbers (1st, 2nd)
OxfordComma	existence	Flags missing serial comma
Passive	existence	Flags passive voice
Please	existence	Flags "please" in instructions
ReadingLevel	metric	Enforces eighth-grade reading level
Repetition	repetition	Flags repeated words in nearby sentences
Seasons	existence	Flags seasonal time references
SentenceLength	occurrence	Flags sentences over 40 words
Simply	existence	Flags minimizing words (simply, easily, just)
Slang	existence	Flags internet slang
WeOur	existence	Flags first-person pronouns (we/our/us)
Will	existence	Flags future tense
WordList	substitution	Google word list substitutions
Would	existence	Flags hypothetical language

Configuration

Enable the style

Enable Ghalactic for all files in your .vale.ini:

[*]
BasedOnStyles = Ghalactic

Or enable it for specific file types:

[*.md]
BasedOnStyles = Ghalactic

[*.rst]
BasedOnStyles = Ghalactic

Inline suppression

You can suppress individual rules inline using Vale comments:

<!-- vale Ghalactic.Exclamation = NO -->

This is amazing!

<!-- vale Ghalactic.Exclamation = YES -->

Contribute

To run the test suite:

make test

This runs Vale against the test fixtures in testdata/ and verifies the expected output.