Setting Up Vale

Vale is a linter that highlights language issues such as grammar, terminology, and style issues.

Vale is available as a tool for Qt Creator and as a VS Code extension.

This page helps you set up Vale on VS Code or Qt Creator.

1. Install Vale

First, install Vale on your computer. The https://vale.sh/docs/vale-cli/installation/ page shows how to install Vale on various desktop platforms.

2. Download Microsoft Style Guide Rules and Configure Vale

We use the Microsoft Style Guide and a custom set of style rules relevant to Qt. To configure Vale, download the qtqa.git repository

The qtqa.git repository has the style rules that we use. Clone the qtqa.git repository and the relevant directory is at <code>qtqa/vale_linter_config</code>

Configure Vale for VS Code

/extension

Configure Vale for Qt Creator

/outline tool