TTD Vale

Abstract

Spelling, grammar, style and readability linter in a container.

Spelling

All spelling related tests generate error`s.

• Spelling with a common list of technical exceptions

Grammar

All grammar related tests generate warning`s.

• FutureTense

• Passive voice, from write-good

• Weasel words, from write-good

• Starting sentences with ‘there is’

• Hedging words, from vale

• Repetition of words, from vale

• Editorializing language that adds nothing, from vale

• Future tense, from us

• Unclear antecedent, from us

• Unnecessary usage of ‘very’, from proselint

• Poor comparisons, from proselint

• Ending a sentence with a preposition, from vale

• Use correct abbreviations, from 18F

Style

All style related tests generate suggestion`s.

• Consistent use of diacritics, from proselint

• Headings start with a capital, from the vale demo

• Gender bias, from proselint

• Highlight litotes, from vale

• British English quote and punctuation combination

• Negative language use, from MailChimp

• Using ‘guys’

• List start with a capital letter, from OpenStack

• Starting sentences with ‘so’ or ‘but’, from write-good

Readability

All style related tests generate suggestion`s.

• Annotations (from Vale) to flag remaining TODOs and other annotations in text

• Paragraph length from vale demo, set at 150 words

• Sentence length from vale demo, set at 25 words

• Overly complex text with too Wordy from write-good, avoid from MailChimp, terms from Pedantic, and complex from PlainLanguage

• Readability score

Usage

docker run -it -v `pwd`:/srv/tests testthedocs/ttd-vale

If you have any issues ttd-vale reports them, and the severity of the issue as defined by the .vale.ini file.

Source Code

The code of ttd-vale is located on GitHub.