Skip to content

Update Vale configuration: reduce false positives and add hedge word rule #5590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 1 commit into from
May 21, 2026
Merged

Update Vale configuration: reduce false positives and add hedge word rule #5590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,7 @@ Microsoft.Hyphens = NO
Microsoft.We = NO
Microsoft.Avoid = NO


# Changelog entries use time-relative terms ("You can now...") by convention
[**/changelog/*.mdx]
FernStyles.Current = NO

15 changes: 15 additions & 0 deletions .vale/styles/FernStyles/Acronyms.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,18 @@ exceptions:
- ISO
- AUTO
- SHA
- GTM
- PATCH
- DELETE
- HEAD
- OPTIONS
- PEM
- HMAC
- MITM
- TOML
- ORM
- CORS
- CIDR
- NaN
- EOF
- CRUD
1 change: 0 additions & 1 deletion .vale/styles/FernStyles/Current.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ tokens:
- soon
- latest
- upcoming
- old
27 changes: 27 additions & 0 deletions .vale/styles/FernStyles/Headings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,30 @@ exceptions:
- BCP
- ISO
- Replay
- Fern Replay
- Playground
- API Playground
- Dashboard
- Fern Dashboard
- Editor
- Fern Editor
- Writer
- Fern Writer
- Ask Fern
- Explorer
- Autorelease
- Bitbucket
- NuGet
- Crates
- Terraform
- Gradle
- Swagger
- Webpack
- Vite
- Vercel
- Netlify
- Cloudflare
- PostgreSQL
- Redis
- Stripe
- Twilio
19 changes: 19 additions & 0 deletions .vale/styles/FernStyles/Hedges.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
extends: existence
message: "Avoid hedge words and filler like '%s'. Prefer direct statements."
level: suggestion
ignorecase: true
tokens:
- simply
- just
- make sure you
- make sure to
- be sure to
- you'll want to
- you'll need to
- you may want to
- you might want to
- please note that
- it is important to note
- it should be noted
- note that
- keep in mind
Loading