Skip to content

Commit

Permalink
chore: fix/remove broken vale rules
Browse files Browse the repository at this point in the history
Signed-off-by: David Karlsson <[email protected]>
  • Loading branch information
dvdksn committed Sep 14, 2023
1 parent e6301f1 commit a910fdb
Show file tree
Hide file tree
Showing 17 changed files with 102 additions and 170 deletions.
8 changes: 8 additions & 0 deletions .github/vale/.vale-config/0-Hugo.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[*.md]
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
(\[.+\]\({{< .+ >}}\))

# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
3 changes: 2 additions & 1 deletion .github/vale/Docker/Avoid.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ message: "Consider removing '%s'."
ignorecase: true
level: warning
tokens:
- Please
- Please
- At this time
8 changes: 0 additions & 8 deletions .github/vale/Docker/Bold.yml

This file was deleted.

12 changes: 0 additions & 12 deletions .github/vale/Docker/CodeIndentation.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/vale/Docker/Contractions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ swap:

should not: shouldn't

'that is(?!\.)': that's
'that is(?!\.,)': that's
'that''s(?=\.)': that is

'they are(?!\.)': they're
Expand Down
8 changes: 0 additions & 8 deletions .github/vale/Docker/Currently.yml

This file was deleted.

8 changes: 3 additions & 5 deletions .github/vale/Docker/GenericCTA.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ extends: existence
message: "Avoid generic calls to action: '%s'"
link: https://docs.docker.com/contribute/style/formatting/#links
level: warning
scope: link
scope: raw
ignorecase: true
tokens:
- click here
- find out more
- learn more
raw:
- \[(click here|(find out|learn) more)\]
20 changes: 0 additions & 20 deletions .github/vale/Docker/Italics.yml

This file was deleted.

7 changes: 0 additions & 7 deletions .github/vale/Docker/LinkLength.yml

This file was deleted.

8 changes: 0 additions & 8 deletions .github/vale/Docker/LinkPunctuation.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/vale/Docker/OxfordComma.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ scope: sentence
level: suggestion
nonword: true
tokens:
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'
- '(?:[^\s,]+,){1,}\s\w+\s(?:and|or)\s\w+[.?!]'
1 change: 0 additions & 1 deletion .github/vale/Docker/SentenceCase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ match: $sentence
exceptions:
- Vocab/Docker/accept.txt
- Vocab/Technology/accept.txt
- Vocab/Industry/accept.txt
18 changes: 11 additions & 7 deletions .github/vale/Docker/Substitute.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@ level: suggestion
action:
name: replace
swap:
'(?<!Docker)\s Hub': Docker Hub
'(?<!Docker)\sScout': Docker Scout
k8s: Kubernetes
'\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is
(?:account name|accountname|user name): username
(?:drop down|dropdown): drop-down
(?:log out|logout): sign out
(?:sign on|log on|log in|logon|login): sign in
above: previous
adaptor: adapter
(?:account name|accountname|user name): username
administrate: administer
admin: administrator
administrate: administer
afterwards: afterward
allow: let
allows: lets
Expand All @@ -28,24 +36,20 @@ swap:
click: select
deselect: clear
disable: turn off|toggle off
(?:drop down|dropdown): drop-down
'\b(?:eg|e\.g\.)[\s,]': for example
enable: turn on|toggle on
ergo: therefore
execute: run
gb: GB
gbps: Gbps
'\b(?:ie|i\.e\.)[\s,]': that is
kb: KB
keypress: keystroke
(?:log out|logout): sign out
mb: MB
mutices: mutexes
paas: PaaS
pb: PB
repo: repository
scan: analyze
scroll: navigate
(?:sign on|log on|log in|logon|login): sign in
tb: TB
vs: versus
wish: want
12 changes: 0 additions & 12 deletions .github/vale/Docker/Terminology.yml

This file was deleted.

74 changes: 0 additions & 74 deletions .github/vale/Vocab/Industry/accept.txt

This file was deleted.

75 changes: 73 additions & 2 deletions .github/vale/Vocab/Technology/accept.txt
Original file line number Diff line number Diff line change
@@ -1,27 +1,94 @@
APIs?
ARM
AWS
Amazon
Ambassador
Anchore
Apple
Artifactory
Azure( Blob Storage)?
BusyBox
CNCF
CVEs?
CentOS
Ceph
CloudFront
Codefresh
CouchDB
Couchbase
DHCP
DNS
Ddosify
Django
Ethernet
Fargate
Fedora
Flink
GPG
GRUB
GeoNetwork
Git
GitHub( Actions)?
Google
HTTP
IPs?
IPv[46]
IPvlan
Intel
JFrog
JPEG
JetBrains
Kubernetes
LTS
Lightstreamer
Linux
Logstash
MAC
RPM
Mac
Mail(chimp|gun)
Microsoft
MySQL
Nginx
Nuxeo
OAuth
OCI
Okta
PNG
Postgres
PowerShell
Python
QEMU
RHEL
RPM
Raspbian
S3
SARIF
SBOMs?
SDKs?
SLES
SLSA
SPDX
SQLite
SSO
Slack
Snyk
Solr
SonarQube
Syft
TCP
TLS
Telepresence
Twilio
UDP
Ubuntu
Unix
VLAN
VM
WSL
Wasm
Windows
XWiki
Zsh
[Ll]oopback
[Nn]ameserver
[Nn]amespace
Expand All @@ -31,18 +98,21 @@ containerd
deserialization
deserialize
filepath
firewalld
filetype
firewalld
glibc
goroutine
hostname
inotify
iptables
kubectl
kubefwd
kubelet
lookup
macOS
macvlan
mfsymlinks
minikube
musl
osquery
osxfs
Expand All @@ -51,6 +121,7 @@ proxying
real-time
runc
runtime
sandbox(ed)?
stdin
stdout
subnet
Expand Down
6 changes: 3 additions & 3 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
StylesPath = .github/vale
MinAlertLevel = suggestion

Vocab = Docker, Industry, Technology
Vocab = Docker, Technology

Packages = Hugo

[*.md]
BasedOnStyles = Vale, Docker
TokenIgnores = ({%.*%}), \
({:(?:.|\n)*?})

0 comments on commit a910fdb

Please sign in to comment.