Commit graph

4 commits

Author SHA1 Message Date
Amy Qualls 2273074e2c Don't run Vale on SVG replacement codes
The SVG replacement codes can't be guaranteed to be
real words, but it doesn't matter. They shouldn't be
linted by Vale. This MR proposes a TokenIgnores
line that skips items matching a regex of **{this}**.

Note that tier badges, blessedly, use **(this)**
instead of curly braces, so we can lint them
separately.
2020-12-09 06:03:12 +00:00
Evan Read 2e2a108c54 Restructure Vale configuration 2020-03-17 07:09:14 +00:00
Amy Qualls a1e61e6c4c Remove redundant section from .vale.ini
The .vale.ini file for linting tests contained a section for
instructions on how to lint just *.md files, and another section for
linting both *.md and *.txt files. If you included conflicting
instructions in those sections, Vale became very confused and did
not apply tests in the manner you might expect.

This commit removes the redundant section so test results will be
predictable and less error-prone.
2020-02-11 16:10:02 -08:00
Amy Qualls c44331965c Add Vale as an English language linter
Vale (https://errata-ai.github.io/vale/) is a grammar, style, and word
usage linter for the English language. This merge request adds an
INI file for Vale (.vale.ini) to the root directory of the repository,
and creates a hidden folder (doc/.linting) for the storage of linting
tests.

Since the TW team uses multiple linting tools, and Vale also supports
multiple collections of rules (called 'styles'), the path to the tests
folder is doc/.linting/vale/styles/gitlab to support any future
expansions that can't be predicted at this time.

The folder currently contains only a .gitkeep file to meet the goal
of a MVC. Tests should be developed, vetted, and added in separate
merge requests, but those MRs all depend on the addition of the
INI file and the directory structure.
2020-01-27 04:22:02 +00:00