chore: vale styles cleanup

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-02-15 14:13:05 +01:00
parent a750614b96
commit 1ebdffea52
15 changed files with 183 additions and 193 deletions

View File

@ -5,11 +5,15 @@ level: warning
ignorecase: false ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'. # Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b' first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+(?: |\n))+\(([A-Z]{3,5})\)' second: '(?:\b[A-Za-z]+(?: |\n))+\(([A-Z]{3,5})\)'
# ... with the exception of these: # ... with the exception of these:
exceptions: exceptions:
- API - API
- BIOS
- FUSE
- ARM
- ASP - ASP
- AWS
- CLI - CLI
- CPU - CPU
- CSS - CSS
@ -43,6 +47,7 @@ exceptions:
- PATH - PATH
- PDF - PDF
- PHP - PHP
- POSIX
- POST - POST
- RAM - RAM
- REPL - REPL
@ -62,6 +67,7 @@ exceptions:
- URL - URL
- USB - USB
- UTF - UTF
- WSL
- XML - XML
- XSS - XSS
- YAML - YAML

View File

@ -1,7 +1,7 @@
extends: existence extends: existence
message: "Consider removing '%s'." message: "Consider removing '%s'."
ignorecase: true ignorecase: true
level: warning level: suggestion
tokens: tokens:
- abnormally - abnormally
- absentmindedly - absentmindedly

View File

@ -5,3 +5,4 @@ level: warning
tokens: tokens:
- Please - Please
- At this time - At this time
- Currently

View File

@ -3,14 +3,12 @@ message: "Consider using '%s' instead of '%s'."
ignorecase: true ignorecase: true
level: suggestion level: suggestion
swap: swap:
accelerate: speed up
accentuate: stress accentuate: stress
accompany: go with accompany: go with
accomplish: carry out|do accomplish: carry out|do
accorded: given accorded: given
accordingly: so accordingly: so
accrue: add accrue: add
accurate: right|exact
acquiesce: agree acquiesce: agree
acquire: get|buy acquire: get|buy
addressees: you addressees: you
@ -38,13 +36,11 @@ swap:
confer: give|award confer: give|award
consequently: so consequently: so
consolidate: merge consolidate: merge
constitutes: forms
convene: meet convene: meet
demonstrate: show|prove demonstrate: show|prove
depart: leave depart: leave
designate: choose designate: choose
desire: want|wish desire: want|wish
determine: decide|find
detrimental: bad|harmful detrimental: bad|harmful
disclose: share|tell disclose: share|tell
discontinue: stop discontinue: stop
@ -60,7 +56,6 @@ swap:
equivalent: equal equivalent: equal
exclusively: only exclusively: only
expedite: hurry expedite: hurry
facilitate: ease
females: women females: women
finalize: complete|finish finalize: complete|finish
illustrate: show illustrate: show

View File

@ -1,6 +1,6 @@
extends: substitution extends: substitution
message: "Consider using '%s' instead of '%s'." message: "Consider using '%s' instead of '%s'."
level: warning level: suggestion
ignorecase: false ignorecase: false
action: action:
name: replace name: replace

View File

@ -3,6 +3,6 @@ message: "Use sentence case for headings: '%s'."
level: warning level: warning
scope: heading scope: heading
match: $sentence match: $sentence
exceptions: threshold: 0.4
- Vocab/Docker/accept.txt indicators:
- Vocab/Technology/accept.txt - ":"

View File

@ -1,7 +1,7 @@
extends: existence extends: existence
message: "Use the Oxford comma in '%s'." message: "Use the Oxford comma in '%s'."
scope: sentence scope: sentence
level: suggestion level: warning
nonword: true nonword: true
tokens: tokens:
- '(?:[^\s,]+,){1,}\s\w+\s(?:and|or)\s\w+[.?!]' - '(?:[^\s,]+,){1,}\s\w+\s(?:and|or)\s\w+[.?!]'

View File

@ -6,9 +6,6 @@ level: suggestion
action: action:
name: replace name: replace
swap: swap:
'(?<!Docker)\s Hub': Docker Hub
'(?<!Docker)\sScout': Docker Scout
k8s: Kubernetes
'\b(?:eg|e\.g\.)[\s,]': for example '\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is '\b(?:ie|i\.e\.)[\s,]': that is
(?:account name|accountname|user name): username (?:account name|accountname|user name): username
@ -29,27 +26,17 @@ swap:
anti-spyware: antispyware anti-spyware: antispyware
anti-virus: antivirus anti-virus: antivirus
appendixes: appendices appendixes: appendices
assembler: assembly language assembler: assembly
below: following below: following
check box: checkbox check box: checkbox
check boxes: checkboxes check boxes: checkboxes
click: select click: select
deselect: clear deselect: clear
disable: turn off|toggle off
enable: turn on|toggle on
ergo: therefore ergo: therefore
execute: run
gb: GB
gbps: Gbps
kb: KB
keypress: keystroke keypress: keystroke
mb: MB
mutices: mutexes mutices: mutexes
paas: PaaS
pb: PB
repo: repository repo: repository
scan: analyze scan: analyze
scroll: navigate scroll: navigate
tb: TB
vs: versus vs: versus
wish: want wish: want

View File

@ -1,7 +1,10 @@
extends: existence extends: existence
message: "'%s' should have one space." message: "'%s' should have one space."
level: error level: error
scope:
- list
- heading
- paragraph
nonword: true nonword: true
tokens: tokens:
- "[a-z][.?!] {2,}[A-Z]" - " {2,}"
- "[a-z][.?!][A-Z]"

View File

@ -1,10 +0,0 @@
# Checks for use of bold that doesn't start with a capital letter
# which might indicate a reference to something other than a UI label
extends: existence
message: "Check for correct usage of tab versus view"
link: https://docs.docker.com/contribute/recommended-words/
level: suggestion
ignorecase: true
tokens:
- tab
- view

View File

@ -1,7 +1,7 @@
extends: substitution extends: substitution
message: "Use '%s' instead of '%s'." message: "Use '%s' instead of '%s'."
ignorecase: true ignorecase: true
level: error level: warning
action: action:
name: replace name: replace
swap: swap:

10
.github/vale/Docker/Units.yml vendored Normal file
View File

@ -0,0 +1,10 @@
extends: substitution
message: "Use '%s' instead of '%s'"
link: https://docs.docker.com/contribute/style/recommended-words/
level: error
swap:
(?:kilobytes?|KB): kB
gigabytes?: GB
megabyte?: MB
petabytes?: PB
terrabytes?: TB

View File

@ -1,30 +1,167 @@
(Certified|Verified) Publisher( Program)? A?GPLv3
Docker-Sponsored Open Source APIs?
ARM
AWS
Amazon
Ambassador
Anchore
Apple
Artifactory
Autobuild
Autotest Autotest
Azure
BuildKit BuildKit
BusyBox
CNCF
CVEs?
CentOS
Ceph
Chrome
Chrome DevTools
CloudFront
Codefresh
CouchDB
Couchbase
DHCP
DNS
DSOS
DVP
Ddosify
Dev Environments?
Django
Docker Docker
Dockerize Docker Build Cloud
Dockerizing
Docker Business Docker Business
Docker Dasboard Docker Dasboard
Docker Desktop Docker Desktop
Docker Engine Docker Engine
Docker Hub
Docker Team
Docker Extension Docker Extension
Docker Hub
Docker Scout
Docker Team
Docker-Sponsored Open Source
Dockerfile Dockerfile
Dockerize
Dockerizing
Ethernet
Fargate
Fedora
Flink
GPG
GPUs?
GRUB
GeoNetwork
Git
GitHub( Actions)?
Google
HTTP
HyperKit HyperKit
IPs?
IPv[46]
IPvlan
Intel
JFrog
JetBrains
Kitematic Kitematic
Kubernetes
LTS
Linux
LinuxKit LinuxKit
Official Images? Logstash
Sponsored (OSS|Open Source Software) MAC
Swarm Mac
Swarm Mode Mail(chimp|gun)
Microsoft
MySQL
Nginx
Nuxeo
OAuth
OCI
Okta
Postgres
PowerShell
Python
QEMU
RHEL
RPM
S3
SARIF
SBOMs?
SDKs?
SLES
SLSA
SPDX
SQLite
SSO
Slack
Snyk
Solr
SonarQube
Syft
Sysdig
TCP
TLS
UDP
URLs?
Ubuntu
Unix
VLAN
VM
VMware
WSL
Wasm
Windows
Zsh
[Bb]uildx [Bb]uildx
[Cc]ompose [Cc]ompose
[Dd]istros
[Ff]ilepaths?
[Ff]iletypes?
[GgCc]oroutine
[Hh]ostname
[Ll]oopback
[Mm]oby [Mm]oby
dockerd [Pp]aravirtualization
[Pp]roxying
[Rr]eal-time
[Rr]untimes?
[Ss]andbox(ed)?
[Ss]wappable
[Ss]warm
[Vv]irtualize
[Ww]alkthrough
cgroup
config
containerd
deserialization
deserialize
dockerignore dockerignore
Docker Hub Vulnerability Scanning firewalld
Docker Vulnerability Scanning gRPC
Basic vulnerability scanning glibc
inotify
iptables
kubectl
kubefwd
kubelet
lookup
macOS
macvlan
mfsymlinks
minikube
musl
nameserver
namespace
npm
osquery
osxfs
runc
stdin
stdout
subnet
systemd
ufw
umask
ungated
vSphere
virtiofs

View File

@ -1,139 +0,0 @@
AGPLv3
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
GPLv3
GRUB
GeoNetwork
Git
GitHub( Actions)?
Google
HTTP
IPs?
IPv[46]
IPvlan
Intel
JFrog
JPEG
JetBrains
Kubernetes
LTS
Lightstreamer
Linux
Logstash
MAC
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
Sysdig
TCP
TLS
Telepresence
Twilio
UDP
Ubuntu
Unix
VLAN
VM
WSL
Wasm
Windows
XWiki
Zsh
[Ll]oopback
[Nn]ameserver
[Nn]amespace
cgroup
config
containerd
deserialization
deserialize
filepath
filetype
firewalld
glibc
goroutine
hostname
inotify
iptables
kubectl
kubefwd
kubelet
lookup
macOS
macvlan
mfsymlinks
minikube
musl
npm
osquery
osxfs
paravirtualization
proxying
real-time
runc
runtime
sandbox(ed)?
stdin
stdout
subnet
swappable
systemd
ufw
umask
ungated
virtiofs
virtualize
walkthrough

View File

@ -1,7 +1,7 @@
StylesPath = .github/vale StylesPath = .github/vale
MinAlertLevel = suggestion MinAlertLevel = suggestion
Vocab = Docker, Technology Vocab = Docker
Packages = Hugo Packages = Hugo