-
Notifications
You must be signed in to change notification settings - Fork 71
Vale.sh Integration
Francisco Cabrera edited this page Jan 17, 2024
·
4 revisions
This repository uses vale.sh to help tech writers and contributors adhere to Microsoft's writing styling guidelines. Vale is a command-line tool that allows you to check your writing for grammar and spelling errors against a set of style rules.
To use Vale linting in this project, the repository has already been configurated with the .vale.ini file, which contains the set of rules to check against. For more information about these rules, see Vale configuration.
This repository is configured to follow the Microsoft Styling Guide. Styling configuration can be found at styles/Microsoft.
To integrate Vale with Visual Studio Code, you can use the Vale VSCode extension. Follow the steps below to complete the Vale installation and use the extension:
- Install the vale.sh cli.
- Open Visual Studio Code and click on the Extensions icon on the left-hand side of the window to navigate to the Extensions Marketplace.
- Search for "Vale VSCode" in the search bar and install the extension by clicking on the "Install" button.
- After installation, restart the Visual Studio Code instance.
- Ensure that you have a Vale configuration available within your project. Configuration should be already created under
docs\.vale.ini. - Start using Vale to lint your content. Open a file in Visual Studio Code and Vale.sh will run automatically. Any errors or warnings will be displayed in the Problems output tab at the bottom of the Visual Studio Code window.