Skip to content

Commit f521cb3

Browse files
Update Vale configuration: reduce false positives and add hedge word rule
(#5590) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 37c2c69 commit f521cb3

5 files changed

Lines changed: 64 additions & 2 deletions

File tree

.vale.ini

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,7 @@ Microsoft.Hyphens = NO
4545
Microsoft.We = NO
4646
Microsoft.Avoid = NO
4747

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

.vale/styles/FernStyles/Acronyms.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,18 @@ exceptions:
110110
- ISO
111111
- AUTO
112112
- SHA
113+
- GTM
114+
- PATCH
115+
- DELETE
116+
- HEAD
117+
- OPTIONS
118+
- PEM
119+
- HMAC
120+
- MITM
121+
- TOML
122+
- ORM
123+
- CORS
124+
- CIDR
125+
- NaN
126+
- EOF
127+
- CRUD

.vale/styles/FernStyles/Current.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,3 @@ tokens:
1414
- soon
1515
- latest
1616
- upcoming
17-
- old

.vale/styles/FernStyles/Headings.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,30 @@ exceptions:
9191
- BCP
9292
- ISO
9393
- Replay
94+
- Fern Replay
95+
- Playground
96+
- API Playground
97+
- Dashboard
98+
- Fern Dashboard
99+
- Editor
100+
- Fern Editor
101+
- Writer
102+
- Fern Writer
103+
- Ask Fern
104+
- Explorer
105+
- Autorelease
106+
- Bitbucket
107+
- NuGet
108+
- Crates
109+
- Terraform
110+
- Gradle
111+
- Swagger
112+
- Webpack
113+
- Vite
114+
- Vercel
115+
- Netlify
116+
- Cloudflare
117+
- PostgreSQL
118+
- Redis
119+
- Stripe
120+
- Twilio

.vale/styles/FernStyles/Hedges.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
extends: existence
2+
message: "Avoid hedge words and filler like '%s'. Prefer direct statements."
3+
level: suggestion
4+
ignorecase: true
5+
tokens:
6+
- simply
7+
- just
8+
- make sure you
9+
- make sure to
10+
- be sure to
11+
- you'll want to
12+
- you'll need to
13+
- you may want to
14+
- you might want to
15+
- please note that
16+
- it is important to note
17+
- it should be noted
18+
- note that
19+
- keep in mind

0 commit comments

Comments
 (0)