Writing style guide checks

Vale

To run the writing guideline checks locally, you need to install Asciidoctor and Vale, and install a plugin/extension for your preferred editor:

• VS Code: vale-vscode
• Atom: atomic-vale

In order to run all the same checks as are run for pull request, you need to install all the style libraries locally under .github/styles (next to the already existing Vaadin and Vocab folders):

• The Google folder from https://github.com/errata-ai/Google
• The Microsoft folder from https://github.com/errata-ai/Microsoft
• The write-good folder from https://github.com/errata-ai/write-good

To manually check an article, run vale path/to/article.asciidoc in the terminal.

If you need to disable certain checks for a piece of content, you can use the following in AsciiDoc:

pass:[<!-- vale Vale.Terms = NO -->]
This content will not produce errors or warnings for the Vale.Terms checks.
pass:[<!-- vale Vale.Terms = YES -->]

Alex

Install a Alex plugin/extension for your preferred editor:

• VS Code: vscode-alex
• Atom: linter-alex