Skip to content

Commit

Permalink
chore: add acronym rule to vale DOC-940 (#2273) (#2277)
Browse files Browse the repository at this point in the history
* chore: add acronym rule to vale DOC-940

* chore: add more ignore extensions

(cherry picked from commit b5905d9)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
  • Loading branch information
1 parent 0778b5b commit e961619
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions vale/styles/spectrocloud/acronym.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
extends: conditional
message: "Use title case to define the acronym '%s'."
link: 'https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Acronyms'
level: error
ignorecase: false
scope: text
# Match two to five capital letters to detect an acronym
first: '([A-Z]{2,5})'
# Match two to five capitalised words before the acronym definition
second: '(?:\b[A-Z][a-z]+ ){2,5}\(([A-Z]{2,5})\)'
exceptions:
- API
- AWS
- BYOOS
- CLI
- CPU
- CSS
- CSV
- FAQ
- GCP
- GET
- GPU
- HTML
- HTTP
- HTTPS
- IDE
- ISO
- JPEG
- JPG
- JSON
- OS
- OSS
- PDF
- PNG
- POST
- RAM
- SDK
- SQL
- SSH
- SSL
- SVG
- TCP
- URI
- URL
- USB
- YAML
- YML
- XML
- ZIP

0 comments on commit e961619

Please sign in to comment.