Skip to content

Commit

Permalink
chore: update Vale spelling checker to v3
Browse files Browse the repository at this point in the history
Add author names to accepted list as well as company names.

Signed-off-by: Jan van den Berg <[email protected]>
  • Loading branch information
koozz authored and anajsana committed Mar 26, 2024
1 parent 6d4021f commit ba67c7d
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 24 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/review-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Review docs
on:
pull_request:
paths:
- "ospo-book/content/*/*.md"
- "ospo-book/content/en/*.md"

jobs:
review-docs:
Expand All @@ -16,12 +16,12 @@ jobs:
- name: Download vale
env:
BASEURL: https://github.com/errata-ai/vale/releases/download
VERSION: 2.29.0
VERSION: 3.3.0
run: |
mkdir -p .vale/bin && cd .vale/bin
wget -O vale.tar.gz --quiet "${BASEURL}/v${VERSION}/vale_${VERSION}_Linux_64-bit.tar.gz"
tar xzf vale.tar.gz
pwd >> "$GITHUB_PATH"
- name: Run vale
run: |
vale --output=".vale.tmpl" --no-exit ospo-book/content
vale --output=".vale.tmpl" --no-exit ospo-book/content/en
6 changes: 4 additions & 2 deletions .vale/.vale-config/2-Hugo.ini
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
[*.md]
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
(\[.+\]\({{< .+ >}}\))
(\[.+\]\({{< .+ >}}\)), \
({{[%<] .+ [%>]}})

# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}}), \
({{[%<] .+ [%>]}})
3 changes: 0 additions & 3 deletions .vale/Vocab/TODO/accept.txt

This file was deleted.

14 changes: 0 additions & 14 deletions .vale/alex/ProfanityUnlikely.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,18 @@ ignorecase: true
tokens:
- adult
- africa
- african
- allah
- amateur
- american
- angie
- angry
- arab
- arabs
- aroused
- asian
- assassin
- assassinate
- assassination
- assault
- attack
- australian
- babies
- backdoor
- backseat
Expand Down Expand Up @@ -50,14 +46,12 @@ tokens:
- buffy
- burn
- butt
- canadian
- cancer
- catholic
- catholics
- cemetery
- childrens
- chin
- chinese
- christ
- christian
- church
Expand Down Expand Up @@ -98,9 +92,6 @@ tokens:
- escort
- ethiopian
- ethnic
- execute
- executed
- execution
- executioner
- explosion
- failed
Expand All @@ -120,7 +111,6 @@ tokens:
- funeral
- fungus
- gay
- german
- gin
- girls
- gun
Expand Down Expand Up @@ -149,7 +139,6 @@ tokens:
- israels
- itch
- jade
- japanese
- jerry
- jew
- jewish
Expand All @@ -162,7 +151,6 @@ tokens:
- killing
- kills
- kimchi
- knife
- laid
- latin
- lesbian
Expand All @@ -172,7 +160,6 @@ tokens:
- lotion
- lucifer
- mad
- mexican
- mideast
- minority
- moles
Expand All @@ -194,7 +181,6 @@ tokens:
- premature
- primetime
- propaganda
- pros
- que
- rabbi
- racial
Expand Down
65 changes: 65 additions & 0 deletions .vale/config/vocabularies/TODO/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Accepted words (other acronyms must be explained)
CEOs?
CFOs?
InnerSource
NGOs?
OSPOs?
SBOMs?
TODO
Whitepaper
deliverables
libre

# Author names
Alin
Aniszczyk
Annania
Ashish
Bogaard
Brasseur
Chitale
Coughlan
Csatari
Fukuchi
Gergely
Hendriks
Hiro
Hoving
Ibrahim
Ildiko
Jeroen
Jerpelea
Jiri
Khalaf
Khalil
Koymans
Kuwata
Lieggi
Maltzhan
Marek
Marz
Masae
Masayuki
Melaku
Moffat
Remy
Saebi
Scheerder
Seo
Shida
Shilla
Supriya
Takanori
Ulises
Vancsa
Xie
Yehuda
Yeon

# Company names
Autodesk
Comcast
Qiita
Synopsys
Uber
VMware
1 change: 0 additions & 1 deletion .vale/proselint/Annotations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ level: error
tokens:
- XXX
- FIXME
- TODO
- NOTE
1 change: 0 additions & 1 deletion .vale/proselint/GenderBias.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ swap:
repair(?:m[ae]n|wom[ae]n): technician(s)
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
service(?:m[ae]n|wom[ae]n): soldier(s)
steward(?:ess)?: flight attendant
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
waitress: waiter
woman doctor: doctor
Expand Down

0 comments on commit ba67c7d

Please sign in to comment.