build: Add vale configuration and demonstrate usage

.github/workflows/pr-changeset-review.yml

@@ -0,0 +1,35 @@
+name: "pr-changeset-review"
+
+# This workflow runs lint-like checks against changesets in PRs. The linting tool used is called Vale. The worflow will
+# add comments for any warnings or errors that Vale finds in the changeset.
+
+# To run vale locally against changesets, you can use `pnpm run check:changesets`.
+
+on:
+  pull_request:
+    types:
+      - opened # PR is created
+      - synchronize # commits added to PR
+      - reopened # closed PR re-opened
+    branches:
+      - main
+    paths:
+      - ".changeset/**" # Trigger only when changes are found under .changeset
+
+permissions:
+  pull-requests: write
+
+jobs:
+  vale:
+    name: vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # ratchet:actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # ratchet:errata-ai/vale-action@v2.1.1
+        with:
+          files: .changeset
+          vale_flags: "--glob=*-*-*.md"
+          reporter: github-pr-review
+          filter_mode: nofilter

.gitignore

@@ -7,6 +7,15 @@ nyc
 *.log
 .DS_Store
 
+.vale/*
+!.vale/config/
+
+.vale/config/*
+!.vale/config/vocabularies/
+
+.vale/config/vocabularies/*
+!.vale/config/vocabularies/fluid/
+
 # Generated Node10 module resolution compatibility files
 alpha.d.ts
 beta.d.ts

.vale.ini

@@ -0,0 +1,21 @@
+StylesPath = .vale
+
+MinAlertLevel = suggestion
+
+Packages = Microsoft, MDX, proselint
+
+Vocab = fluid
+
+[*README.md]
+Microsoft.We = NO
+
+[*.{md}]
+BasedOnStyles = Vale, Microsoft, proselint
+
+; Note that only errors will be reported in GitHub PR comments.
+; This seems to be a limitation of the GitHub Action.
+; When running locally, all levels will be reported.
+Microsoft.Contractions = NO
+Microsoft.Passive = NO
+Microsoft.Terms = suggestion
+Microsoft.Vocab = NO

.vale/config/vocabularies/fluid/accept.txt

@@ -0,0 +1,5 @@
+Fluid Framework
+FluidFramework
+JavaScript
+SharedTree
+TypeScript

.vale/config/vocabularies/fluid/reject.txt

@@ -0,0 +1,3 @@
+shared tree
+fluid
+fluid framework

package.json

@@ -41,6 +41,7 @@
 		"bundle-analysis:run": "flub run bundleStats --dangerfile build-tools/packages/build-cli/lib/library/dangerfile.cjs",
 		"changeset": "flub changeset add --releaseGroup client",
 		"check:are-the-types-wrong": "fluid-build --task check:are-the-types-wrong",
+		"check:changesets": "vale .changeset --glob=*-*-*.md",
 		"check:format:repo": "biome check .",
 		"check:versions": "flub check buildVersion -g client --path .",
 		"check:versions:fix": "flub check buildVersion -g client --path . --fix",
@@ -172,6 +173,7 @@
 		"@fluidframework/test-tools": "^1.0.195075",
 		"@microsoft/api-documenter": "^7.21.6",
 		"@microsoft/api-extractor": "7.50.1",
+		"@vvago/vale": "^3.11.2",
 		"auto-changelog": "^2.4.0",
 		"c8": "^8.0.1",
 		"changesets-format-with-issue-links": "^0.3.0",