Skip to content

Commit 9023641

Browse files
(MAINT) Add Vale config to repo (#9937)
Prior to this change, using Vale to lint the docs required knowledge of the tool and where to retrieve the configuration and rules. This change adds a new `.vale.ini` file to the repository root and configures it to use our own published prose style package. It also ensures the `.vale` and `.vscode/styles` folders are ignored by git for contributors who use `Install-WorkspaceVale` and sync the style packages respectively.
1 parent 638a45e commit 9023641

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ updatablehelp/
1717
xhtml/
1818
**/settings.json
1919
StaleContentReport.*.csv
20+
.vscode/styles
21+
.vale/

.vale.ini

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
StylesPath = .vscode/styles
2+
Packages = https://microsoft.github.io/Documentarian/packages/vale/PowerShell-Docs.zip
3+
MinAlertLevel = suggestion
4+
5+
[*]
6+
BasedOnStyles = PowerShell-Docs
7+
Vale.Spelling = NO # We use cspell
8+
9+
[*.md]
10+
BasedOnStyles = PowerShell-Docs

0 commit comments

Comments
 (0)