gitlab-org--gitlab-foss/doc/.vale/gitlab/Uppercase.yml

209 lines
2.2 KiB
YAML

---
# Warning: gitlab.Uppercase
#
# Checks for use of all uppercase letters with unknown reason.
#
# For a list of all options, see https://docs.errata.ai/vale/styles.
extends: conditional
message: "'%s' is uppercase. Use lowercase or `backticks` if possible. Otherwise add this word to the rule's exception list."
link: https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms
level: warning
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- AJAX
- ANSI
- API
- APM
- ARM
- ARN
- ASCII
- AWS
- BSD
- CAS
- CDN
- CIDR
- CLI
- CNA
- CNAME
- CORE
- CPU
- CRIME
- CSRF
- CSS
- CSV
- CVE
- CVS
- DAG
- DAST
- DHCP
- DNS
- DOM
- DSA
- DSL
- DVCS
- ECDSA
- ECS
- EFS
- EKS
- ELB
- EOL
- EWM
- EXIF
- FAQ
- FIDO
- FIFO
- FIPS
- FLAG
- FOSS
- FQDN
- FREE
- FTP
- GCP
- GDK
- GDPR
- GET
- GID
- GIF
- GKE
- GNU
- GPG
- GPL
- GPU
- GUI
- HAML
- HDD
- HEAD
- HIPAA
- HLL
- HTML
- HTTP
- HTTPS
- IAM
- IANA
- IBM
- IDE
- IID
- IMAP
- IOPS
- IRC
- ISO
- JPEG
- JPG
- JSON
- JVM
- JWT
- LAN
- LDAP
- LDAPS
- LESS
- LFS
- LRU
- LTM
- LTS
- MIME
- MIT
- MVC
- NAT
- NDA
- NFS
- NGINX
- NOTE
- NPM
- NTP
- ONLY
- OSS
- OTP
- OWASP
- PAT
- PCI-DSS
- PDF
- PEM
- PEP
- PGP
- PHP
- PID
- PKCS
- PNG
- POSIX
- POST
- PUT
- RAID
- RAM
- RBAC
- RDP
- RDS
- RDS
- REST
- RFC
- RHEL
- RPC
- RPM
- RPS
- RSA
- RSS
- RTC
- RVM
- SAAS
- SAML
- SAN
- SAST
- SATA
- SCIM
- SCP
- SCSS
- SDK
- SELF
- SEO
- SFTP
- SHA
- SLA
- SLI
- SMS
- SMTP
- SOC
- SOX
- SPDX
- SPF
- SQL
- SRE
- SSD
- SSG
- SSH
- SSL
- SSO
- STI
- SVG
- SVN
- TCP
- TIFF
- TIP
- TLD
- TLS
- TODO
- TOML
- TOTP
- TTL
- UDP
- UID
- UID
- UNIX
- URI
- URL
- USB
- UTC
- UTF
- UUID
- VCS
- VPC
- VPN
- WIP
- WSL
- XML
- XSS
- YAML
- ZAP
- ZIP