Skip to content

Commit e0082b4

Browse files
authored
Update vale.ini with linter configurations
Configured Vale linter settings and project-specific vocabulary.
1 parent 8b7b876 commit e0082b4

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

vale.ini

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
1+
; Vale prose linter — https://vale.sh
2+
; Applies to all Markdown and plain-text documentation.
13

4+
StylesPath = .vale/styles
5+
MinAlertLevel = suggestion
6+
7+
[formats]
8+
; Treat .mdx as Markdown
9+
mdx = md
10+
11+
[*.{md,mdx,txt}]
12+
BasedOnStyles = Vale, write-good
13+
14+
; ── Vale built-in rules ────────────────────────────────────────────
15+
Vale.Avoid = YES ; flag commonly misused words
16+
Vale.Repetition = YES ; flag immediately repeated words
17+
Vale.Spelling = NO ; disable — too many false positives on code terms
18+
Vale.Terms = YES ; enforce consistent terminology (see below)
19+
20+
; ── write-good rules ───────────────────────────────────────────────
21+
write-good.Cliches = YES
22+
write-good.E-Prime = NO ; "to be" is fine in technical docs
23+
write-good.Illusions = YES ; flag word illusions (the the)
24+
write-good.Passive = suggestion
25+
write-good.TooWordy = suggestion
26+
write-good.Weasel = suggestion
27+
28+
; ── Project-specific terminology ────────────────────────────────────
29+
; Add preferred spellings and capitalisations here.
30+
; Format: incorrect = correct
31+
[vocab.default]
32+
accept = [
33+
GitHub,
34+
JavaScript,
35+
TypeScript,
36+
Markdown,
37+
README,
38+
API,
39+
PR,
40+
CLI,
41+
UI,
42+
CSS,
43+
HTML,
44+
JSON,
45+
YAML,
46+
ESLint,
47+
Prettier
48+
]

0 commit comments

Comments
 (0)