Skip to content

Commit f99fc2a

Browse files
devalogdevalog
authored
chore: clean up vale styles based on recent PRs, change all warnings to suggestions (#1356)
1 parent 6239bbd commit f99fc2a

File tree

7 files changed

+359
-8
lines changed

7 files changed

+359
-8
lines changed

‎.vale.ini‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,29 @@ mdx = md
1111
BasedOnStyles = Microsoft, FernStyles
1212

1313
# Disable specific rules
14-
Microsoft.GenderBias = NO # Not relevant for technical documentation
15-
Microsoft.Acronyms = NO # Handled in FernStyles
16-
Microsoft.Vocab = NO # Too granular for now
17-
Microsoft.HeadingAcronyms = NO # Not relevant for Fern audience
18-
Microsoft.GeneralURL = NO # Not relevant for Fern audience
19-
Microsoft.Headings = NO # Handled in FernStyles
20-
Microsoft.Passive = NO # Too noisy
21-
Microsoft.Accessibility = NO # Too noisy
14+
# Not relevant for technical documentation
15+
Microsoft.GenderBias = NO
16+
17+
# Too granular
18+
Microsoft.Accessibility = NO
19+
Microsoft.Passive = NO
20+
Microsoft.Suspended = NO
21+
Microsoft.Vocab = NO
22+
23+
# Not relevant for Fern audience
24+
Microsoft.GeneralURL = NO
25+
Microsoft.HeadingAcronyms = NO
26+
Microsoft.Terms = NO
27+
28+
# Handled in FernStyles
29+
Microsoft.Acronyms = NO
30+
Microsoft.Adverbs = NO
31+
Microsoft.Ellipses = NO
32+
Microsoft.FirstPerson = NO
33+
Microsoft.Headings = NO
34+
Microsoft.HeadingPunctuation = NO
35+
Microsoft.Hyphens = NO
36+
Microsoft.We = NO
37+
2238

2339

‎.vale/styles/FernStyles/Adverbs.yml‎

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
extends: existence
2+
message: "Remove '%s' if it's not important to the meaning of the statement."
3+
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
4+
ignorecase: true
5+
level: suggestion
6+
action:
7+
name: remove
8+
tokens:
9+
- abnormally
10+
- absentmindedly
11+
- accidentally
12+
- adventurously
13+
- anxiously
14+
- arrogantly
15+
- awkwardly
16+
- bashfully
17+
- beautifully
18+
- bitterly
19+
- bleakly
20+
- blindly
21+
- blissfully
22+
- boastfully
23+
- boldly
24+
- bravely
25+
- briefly
26+
- brightly
27+
- briskly
28+
- broadly
29+
- busily
30+
- calmly
31+
- carefully
32+
- carelessly
33+
- cautiously
34+
- cheerfully
35+
- cleverly
36+
- closely
37+
- coaxingly
38+
- colorfully
39+
- continually
40+
- coolly
41+
- courageously
42+
- crossly
43+
- cruelly
44+
- curiously
45+
- daintily
46+
- dearly
47+
- deceivingly
48+
- deeply
49+
- defiantly
50+
- deliberately
51+
- delightfully
52+
- diligently
53+
- dimly
54+
- doubtfully
55+
- dreamily
56+
- easily
57+
- effectively
58+
- elegantly
59+
- energetically
60+
- enormously
61+
- enthusiastically
62+
- excitedly
63+
- extremely
64+
- fairly
65+
- faithfully
66+
- famously
67+
- ferociously
68+
- fervently
69+
- fiercely
70+
- fondly
71+
- foolishly
72+
- fortunately
73+
- frankly
74+
- frantically
75+
- freely
76+
- frenetically
77+
- frightfully
78+
- furiously
79+
- generally
80+
- generously
81+
- gently
82+
- gladly
83+
- gleefully
84+
- gracefully
85+
- gratefully
86+
- greatly
87+
- greedily
88+
- happily
89+
- hastily
90+
- healthily
91+
- heavily
92+
- helplessly
93+
- honestly
94+
- hopelessly
95+
- hungrily
96+
- innocently
97+
- inquisitively
98+
- intensely
99+
- intently
100+
- interestingly
101+
- inwardly
102+
- irritably
103+
- jaggedly
104+
- jealously
105+
- jovially
106+
- joyfully
107+
- joyously
108+
- jubilantly
109+
- judgmentally
110+
- justly
111+
- keenly
112+
- kiddingly
113+
- kindheartedly
114+
- knavishly
115+
- knowingly
116+
- knowledgeably
117+
- lazily
118+
- lightly
119+
- limply
120+
- lively
121+
- loftily
122+
- longingly
123+
- loosely
124+
- loudly
125+
- lovingly
126+
- loyally
127+
- madly
128+
- majestically
129+
- meaningfully
130+
- mechanically
131+
- merrily
132+
- miserably
133+
- mockingly
134+
- mortally
135+
- mysteriously
136+
- naturally
137+
- nearly
138+
- neatly
139+
- nervously
140+
- nicely
141+
- noisily
142+
- obediently
143+
- obnoxiously
144+
- oddly
145+
- offensively
146+
- optimistically
147+
- overconfidently
148+
- painfully
149+
- partially
150+
- patiently
151+
- perfectly
152+
- playfully
153+
- politely
154+
- poorly
155+
- positively
156+
- potentially
157+
- powerfully
158+
- promptly
159+
- properly
160+
- punctually
161+
- quaintly
162+
- queasily
163+
- queerly
164+
- questionably
165+
- quickly
166+
- quietly
167+
- quirkily
168+
- quite
169+
- quizzically
170+
- randomly
171+
- rapidly
172+
- rarely
173+
- readily
174+
- really
175+
- reassuringly
176+
- recklessly
177+
- regularly
178+
- reluctantly
179+
- repeatedly
180+
- reproachfully
181+
- restfully
182+
- righteously
183+
- rightfully
184+
- rigidly
185+
- roughly
186+
- rudely
187+
- safely
188+
- scarcely
189+
- scarily
190+
- searchingly
191+
- sedately
192+
- seemingly
193+
- selfishly
194+
- separately
195+
- seriously
196+
- shakily
197+
- sharply
198+
- sheepishly
199+
- shrilly
200+
- shyly
201+
- silently
202+
- sleepily
203+
- slowly
204+
- smoothly
205+
- softly
206+
- solemnly
207+
- solidly
208+
- speedily
209+
- stealthily
210+
- sternly
211+
- strictly
212+
- suddenly
213+
- supposedly
214+
- surprisingly
215+
- suspiciously
216+
- sweetly
217+
- swiftly
218+
- sympathetically
219+
- tenderly
220+
- tensely
221+
- terribly
222+
- thankfully
223+
- thoroughly
224+
- thoughtfully
225+
- tightly
226+
- tremendously
227+
- triumphantly
228+
- truthfully
229+
- ultimately
230+
- unabashedly
231+
- unaccountably
232+
- unbearably
233+
- unethically
234+
- unexpectedly
235+
- unfortunately
236+
- unimpressively
237+
- unnaturally
238+
- unnecessarily
239+
- urgently
240+
- usefully
241+
- uselessly
242+
- utterly
243+
- vacantly
244+
- vaguely
245+
- vainly
246+
- valiantly
247+
- vastly
248+
- verbally
249+
- very
250+
- viciously
251+
- victoriously
252+
- violently
253+
- vivaciously
254+
- voluntarily
255+
- warmly
256+
- weakly
257+
- wearily
258+
- wetly
259+
- wholly
260+
- wildly
261+
- willfully
262+
- wisely
263+
- woefully
264+
- wonderfully
265+
- worriedly
266+
- yawningly
267+
- yearningly
268+
- yieldingly
269+
- youthfully
270+
- zealously
271+
- zestfully
272+
- zestily

‎.vale/styles/FernStyles/Ellipses.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: existence
2+
message: "In general, don't use an ellipsis."
3+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses
4+
nonword: true
5+
level: suggestion
6+
action:
7+
name: remove
8+
tokens:
9+
- '\.\.\.'

‎.vale/styles/FernStyles/FirstPerson.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
extends: existence
2+
message: "Use first person (such as '%s') sparingly."
3+
link: https://docs.microsoft.com/en-us/style-guide/grammar/person
4+
ignorecase: true
5+
level: suggestion
6+
nonword: true
7+
tokens:
8+
- (?:^|\s)I(?=\s)
9+
- (?:^|\s)I(?=,\s)
10+
- \bI'd\b
11+
- \bI'll\b
12+
- \bI'm\b
13+
- \bI've\b
14+
- \bme\b
15+
- \bmy\b
16+
- \bmine\b

‎.vale/styles/FernStyles/HeadingPunctuation.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
extends: existence
2+
message: "Don't use end punctuation in headings."
3+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
4+
nonword: true
5+
level: suggestion
6+
scope: heading
7+
action:
8+
name: edit
9+
params:
10+
- trim_right
11+
- ".?!"
12+
tokens:
13+
- "[a-z][.?!]$"

‎.vale/styles/FernStyles/Hyphens.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
extends: existence
2+
message: "'%s' doesn't need a hyphen."
3+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens
4+
level: suggestion
5+
ignorecase: false
6+
nonword: true
7+
action:
8+
name: edit
9+
params:
10+
- regex
11+
- "-"
12+
- " "
13+
tokens:
14+
- '\b[^\s-]+ly-\w+\b'

‎.vale/styles/FernStyles/We.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
extends: existence
2+
message: "Try to avoid using first-person plural like '%s'."
3+
link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural
4+
level: suggestion
5+
ignorecase: true
6+
tokens:
7+
- we
8+
- we'(?:ve|re)
9+
- ours?
10+
- us
11+
- let's

0 commit comments

Comments
 (0)