Use Vale

Vale is a linter that checks documentation source files for style, grammar, and terminology issues. The Vale Language Server extension integrates Vale into Qt Creator using the language server protocol (LSP).

Set a Vale configuration file

You need a .vale.ini configuration file to use Vale. For more information, see Vale: .vale.ini.

To set your .vale.ini configuration file path, go to Preferences > Vale > Config path.

Run Vale

After installing the extension and creating the configuration file, open a text file that you want to check with Vale.

Qt Creator prompts you to allow the extension to fetch updates to the Vale language server. To see what will be downloaded, select Show Details.

You can see suggestions from Vale as annotations in the editor.

Set Vale preferences

To install the lanaguge server later or use another Vale LS installation:

1. Go to Preferences > Vale > Language Server.

   

2. In Binary, set the path to the Vale language server executable.
3. In Config path, set the path to the Vale configuration file.
4. Select Auto install Vale to automatically install Vale CLI.
5. Select Sync on startup to run vale sync when the server starts.
6. Select Install Vale Language Server to install the Vale language server.