.github/vale.ini at main · asong56/.github · GitHub

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
; Vale prose linter — https://vale.sh
; Applies to all Markdown and plain-text documentation.

StylesPath = .vale/styles
MinAlertLevel = suggestion

[formats]
; Treat .mdx as Markdown
mdx = md

[*.{md,mdx,txt}]
BasedOnStyles = Vale, write-good

; ── Vale built-in rules ────────────────────────────────────────────
Vale.Avoid          = YES   ; flag commonly misused words
Vale.Repetition     = YES   ; flag immediately repeated words
Vale.Spelling       = NO    ; disable — too many false positives on code terms
Vale.Terms          = YES   ; enforce consistent terminology (see below)

; ── write-good rules ───────────────────────────────────────────────
write-good.Cliches         = YES
write-good.E-Prime         = NO    ; "to be" is fine in technical docs
write-good.Illusions       = YES   ; flag word illusions (the the)
write-good.Passive         = suggestion
write-good.TooWordy        = suggestion
write-good.Weasel          = suggestion

; ── Project-specific terminology ────────────────────────────────────
; Add preferred spellings and capitalisations here.
; Format: incorrect = correct
[vocab.default]
accept = [
  GitHub,
  JavaScript,
  TypeScript,
  Markdown,
  README,
  API,
  PR,
  CLI,
  UI,
  CSS,
  HTML,
  JSON,
  YAML,
  ESLint,
  Prettier
]