Vale

The linter for prose.

The https://vale.sh linter for prose is available in Padawan pipelines, but disabled by default. You can enable it by setting your SKIP_VALE GitLab variable to false.

To use it, Vale requires you to supply a .vale.ini file at the root of your repo, and a path to the folder with the styles to apply (usually named styles). Ensure that you have both in your repo.

A simple .vale.ini looks like:

StylesPath = styles

[*.md]
BasedOnStyles = Vale, write-good

This file will apply the style rules to all Markdown (*.md) files in your repo. The Vale style is built in, but for this file to work, the repo must have a styles/write-good folder containing style rules.

You can create your own styles and rules. See https://vale.sh/explorer/ for community-made rules. If you come up with some good ones, feel free to share them with us!