Repository navigation
Expand file tree
/
Copy path.vale.ini
More file actions
134 lines (123 loc) · 6.6 KB
/
Copy path.vale.ini
File metadata and controls
134 lines (123 loc) · 6.6 KB
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
StylesPath = .vale/styles
MinAlertLevel = suggestion
Vocab = nix-oci
Packages = Google, Microsoft, RedHat, write-good, proselint, alex, Joblint, Readability
# Prose - every human-authored markdown surface in the repo
[{docs/content/**/*.md,README.md,CHANGELOG.md,CONTRIBUTING.md,openspec/**/*.md,plan/**/*.md}]
BasedOnStyles = Vale, Google, Microsoft, RedHat, write-good, proselint, alex
# Aggressive profile: every rule at error level. Suppress in-place with
# <!-- vale off --> ... <!-- vale on --> or grow .vale/config/vocabularies/nix-oci
# for accepted terms. Do NOT downgrade rules globally.
# Kept strict: grammatical + consistency + high-signal
# Vale.Terms enforces first-cased canonical of each vocab entry, but our
# vocab necessarily includes both brand-cased forms (Cosign) and lowercase
# command names (cosign), so it produces contradictory hits. Disabled -
# vocab acts as a spelling allowlist only.
Vale.Terms = NO
Vale.Spelling = error
Google.Acronyms = error
Google.Latin = error
# Google.Passive: fires on "is built", "is executed", "is generated" -
# necessary descriptive prose for computational processes.
Google.Passive = NO
Microsoft.Acronyms = error
Microsoft.Contractions = error
Microsoft.Auto = error
# Passive: 4 rules all catch the same thing. Keep Google.Passive only.
Microsoft.Passive = NO
RedHat.PassiveVoice = NO
write-good.Passive = NO
RedHat.Spelling = error
# alex.ProfanityUnlikely fires on "dive", "executed", "failure", "kill" -
# false positives in tech docs. Disabled.
alex.ProfanityUnlikely = NO
# Disabled: high false-positive rate in technical docs
# (verbose reasoning kept for future revisit)
Readability.Polysyllables = NO # technical vocab needs long words
Readability.FleschReadingEase = NO # readability score is grade-level noise
Readability.FleschKincaid = NO
Readability.GunningFog = NO
Readability.LIX = NO
Readability.SMOG = NO
Readability.AutomatedReadability = NO
Readability.ColemanLiau = NO
RedHat.Definitions = NO # requires "Acronym (Definition)" form; too invasive
RedHat.PascalCamelCase = NO # collides with Nix identifiers
RedHat.TermsSuggestions = NO # RedHat product-lexicon-specific
RedHat.Slash = NO # "and/or" is useful
RedHat.Headings = NO # sentence-case-only; collides with product names
write-good.E-Prime = NO # forbids "to be" - unreasonable
write-good.TooWordy = NO # aggressive on standard prose
write-good.So = NO
Google.Parens = NO # parentheticals are useful in tech docs
Google.Semicolons = NO # discourages complex sentences
Google.Colons = NO # discourages complex sentences
Google.Headings = NO # sentence-case-only; collides with product names
Google.Contractions = NO # covered by Microsoft.Contractions
Google.We = NO
Google.OxfordComma = NO # taste
Microsoft.Semicolon = NO # duplicate of Google.Semicolons
Microsoft.SentenceLength = NO # kills long-but-clear sentences
Microsoft.Headings = NO # duplicate of Google.Headings
Microsoft.HeadingColons = NO
Microsoft.OxfordComma = NO
Microsoft.We = NO
Microsoft.Wordiness = NO
Microsoft.Vocab = NO # product-lexicon-specific
RedHat.TermsWarnings = NO # hits "vs", "may", "etc"
RedHat.SimpleWords = NO # tech docs need precise terms
RedHat.DoNotUseTerms = NO
RedHat.SentenceLength = NO
RedHat.GitLinks = NO # requires specific Git URL patterns
RedHat.Contractions = NO # covered by Microsoft.Contractions
Google.WordListCase = NO # duplicate of Vale.Terms behavior
Google.Timeless = NO # bans "currently" - useful sometimes
Google.Will = NO # bans "will" - awkward in reference docs
Google.WordList = NO # forces "Cloud"->"cloud" globally, too invasive
Microsoft.Adverbs = NO # bans "silently", "roughly" - useful
Microsoft.Terms = NO # bans "spec" - accepted in tech
Microsoft.HeadingAcronyms = NO # bans "PR" in headings
Microsoft.Uppercase = NO # collides with RFC 2119 SHALL/NOT combos
alex.Race = NO # flags "primitive" as racist-context
RedHat.CaseSensitiveTerms = NO # aggressive case rewrites (oci->OCI)
RedHat.TermsErrors = NO # bans "vs"
proselint.Typography = NO # (c) - not worth enforcing
Microsoft.Avoid = NO # bans "backend" - tech term
Microsoft.Accessibility = NO # flags "disabled" as ableist
alex.Ablist = NO # flags "disabled features" as ableist
write-good.Weasel = NO # bans "several", "mostly"
RedHat.ReadabilityGrade = NO # subjective score
RedHat.UserReplacedValues = NO # <placeholder> format flagged
RedHat.Using = NO # bans "using"
RedHat.Spacing = NO
Google.Quotes = NO # quote-style flags in prose
Microsoft.Quotes = NO
Google.LyHyphens = NO # compound modifiers OK
Microsoft.Hyphens = NO
RedHat.EmDash = NO # em-dash policy handled by no-em-dash skill
RedHat.ProductCentricWriting = NO # bans "lets you"
RedHat.Conjunctions = NO # bans sentence-starting "Or"
RedHat.NoGerundsInTitles = NO # "-ing" titles fine
RedHat.SelfReferentialText = NO # bans "this section"
RedHat.Symbols = NO # bans "!"
Google.Exclamation = NO
Microsoft.ExclamationPoints = NO
Google.Ellipses = NO
Microsoft.Ellipses = NO
RedHat.Ellipses = NO
Google.Anthropomorphism = NO # bans "the system sees"
Microsoft.GeneralURL = NO # bans "URL"
Google.Spacing = NO # false-positives on `.gpu` refs
alex.Condescending = NO # bans "simple"
proselint.Cliches = NO # bans "for free"
# Global disable of a few rules that misfire everywhere
proselint.Cliches = NO
RedHat.ConsciousLanguage = NO # blocks upstream terms (postfix "master")
Microsoft.Foreign = NO # duplicate of Google.Latin
Joblint.Competitive = NO # bans "fail" in tech docs
# Job / HR content - Joblint only where explicitly opted-in
[{docs/content/**/*careers*.md,docs/content/**/*hiring*.md,CONTRIBUTING.md}]
BasedOnStyles = Joblint
# Readability metrics on published docs only
[docs/content/**/*.md]
BasedOnStyles = Readability