/
.vale.ini
180 lines (147 loc) · 4.96 KB
/
.vale.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# SPDX-FileCopyrightText: 2023 Ross Patterson <me@rpatterson.net>
#
# SPDX-License-Identifier: MIT
# Default configuration used for markup, not source code:
StylesPath = ./styles
Vocab = Markup
MinAlertLevel = suggestion
Packages = Microsoft, Google, RedHat, proselint, write-good, alex, Readability, Joblint
# [Supported markup extensions](https://vale.sh/docs/topics/scoping/#formats):
[*.{md,mdown,markdown,markdn,html,htm,shtml,xhtml,rst,rest,adoc,asciidoc,asc,org,txt}]
BasedOnStyles = Vale, Microsoft, Google, RedHat, proselint, write-good, alex, Readability, Joblint, local
# Redundant rules that add noise to the output:
# These generate the same alerts. The first has the most detailed messages and
# documentation:
# RedHat.PassiveVoice = error
Google.Passive = NO
Microsoft.Passive = NO
write-good.Passive = NO
# These generate the same alerts. The first has the most detailed messages and
# documentation:
RedHat.Spacing = error
Microsoft.Spacing = NO
Google.Spacing = NO
# The first reports more alerts and has the most detailed messages and documentation:
Microsoft.Foreign = error
Google.Latin = NO
# These generate the same alerts. The first has the most detailed messages and
# documentation:
RedHat.SentenceLength = error
Microsoft.SentenceLength = NO
# The first has a good list of exceptions common to technical writing about software:
RedHat.Spelling = error
Vale.Spelling = NO
# These generate almost the same alerts. The first has the most detailed messages and
# documentation:
RedHat.SimpleWords = error
Microsoft.ComplexWords = NO
# The first catches more alerts:
Microsoft.FirstPerson = error
Google.FirstPerson = NO
Microsoft.We = error
Google.We = NO
# The first has a longer list of exceptions:
RedHat.Definitions = error
Google.Acronyms = NO
Microsoft.Acronyms = NO
# The first generates more alerts than Google and RedHat conflicts with the others:
Microsoft.Contractions = error
RedHat.Contractions = NO
Google.Contractions = NO
# Conflicts with `*.Acronyms` and `*.Definitions`:
Google.Parens = suggestion
# The first reports more alerts and has the most detailed messages and documentation:
RedHat.Ellipses = error
Google.Ellipses = NO
Microsoft.Ellipses = NO
# The first reports more alerts and has the most detailed messages and documentation:
RedHat.RepeatedWords = error
write-good.Illusions = NO
Vale.Repetition = NO
# Exceptions for rules not enforced:
# Too broad, difficult to resolve, noisy alerts:
write-good.E-Prime = suggestion
# Demanding to the point they couldn't pass even when sacrificing clarity for brevity:
Readability.LIX = warning
Readability.FleschKincaid = warning
Readability.FleschReadingEase = warning
Readability.SMOG = warning
Readability.ColemanLiau = warning
Readability.AutomatedReadability = warning
Readability.GunningFog = warning
# Avoiding the passive voice in all cases often results in phrasing that's less clear
# and lost information:
RedHat.PassiveVoice = suggestion
# Too broad a list of weasel words. Replacing them often reduced clarity or explicitness
# and there are a significant number of cases where there's no good replacement:
write-good.Weasel = warning
# Enforce all other rules not enforced by default:
Microsoft.HeadingPunctuation = error
Microsoft.OxfordComma = error
Microsoft.Headings = error
Microsoft.Adverbs = error
Microsoft.Suspended = error
Microsoft.Terms = error
Microsoft.GeneralURL = error
Microsoft.Vocab = error
Microsoft.Hyphens = error
Microsoft.Accessibility = error
Microsoft.Ranges = error
Microsoft.Semicolon = error
Microsoft.Wordiness = error
Microsoft.HeadingAcronyms = error
Google.HeadingPunctuation = error
Google.OxfordComma = error
Google.Headings = error
Google.WordList = error
Google.Will = error
Google.Colons = error
Google.Semicolons = error
Google.Ranges = error
Google.Spelling = error
RedHat.HeadingPunctuation = error
RedHat.PascalCamelCase = error
RedHat.OxfordComma = error
RedHat.ConsciousLanguage = error
RedHat.UserReplacedValues = error
RedHat.Symbols = error
RedHat.Headings = error
RedHat.SelfReferentialText = error
RedHat.ReadabilityGrade = error
RedHat.DoNotUseTerms = error
RedHat.Slash = error
RedHat.TermsWarnings = error
RedHat.Hyphens = error
RedHat.TermsSuggestions = error
RedHat.Conjunctions = error
RedHat.ReleaseNotes = error
proselint.Currency = error
proselint.DenizenLabels = error
proselint.P-Value = error
proselint.LGBTTerms = error
proselint.LGBTOffensive = error
proselint.Needless = error
proselint.GroupTerms = error
write-good.TooWordy = error
write-good.Cliches = error
alex.Race = error
alex.ProfanityUnlikely = error
alex.Gendered = error
alex.LGBTQ = error
alex.Ablist = error
alex.ProfanityLikely = error
alex.Press = error
alex.ProfanityMaybe = error
alex.Suicide = error
Joblint.Competitive = error
Joblint.Reassure = error
Joblint.DumbTitles = error
Joblint.Visionary = error
Joblint.Benefits = error
Joblint.DevEnv = error
Joblint.LegacyTech = error
Joblint.Profanity = error
Joblint.Sexualised = error
Joblint.Starter = error
Joblint.Acronyms = error
Joblint.Meritocracy = error