Skip to content

Commit

Permalink
vale rules update
Browse files Browse the repository at this point in the history
update vale rules to latest
  • Loading branch information
chmouel authored and savitaashture committed Sep 10, 2024
1 parent 763b96a commit 9bf2293
Show file tree
Hide file tree
Showing 17 changed files with 93 additions and 35 deletions.
15 changes: 7 additions & 8 deletions .vale/styles/RedHat/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ swap:
"DM(?![ -]Multipath)|directory manager": Directory Manager
"JBoss Broker|Red Hat Broker|The AMQ Broker": AMQ Broker
"JBoss Console|Red Hat Console": AMQ Console
"Kernel(?!-based Virtual Machine| Module Management)": kernel
"Kernel(?!-based Virtual Machine| Module Management| parameters| arguments| packet filtering)": kernel
"OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager": Red Hat OpenShift Cluster Manager
"OD": Red Hat OpenShift Dedicated
"sub version|(?<!Apache )Subversion": sub-version
'(?<!\.)IM': instant message
'(?<!\.)yaml|Yaml': YAML
'(?<!\.)yaml(?!-patch)|Yaml': YAML
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
'(?<!Realtime )Decision\sServer': Realtime Decision Server
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
'\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': .NET
'dotNet': .NET
'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
'A-MQ\sBroker': AMQ Broker
'A-MQ\sClients': AMQ Clients
Expand Down Expand Up @@ -87,10 +87,10 @@ swap:
classic mode: GNOME Classic
CloudForms Management Engine|CFME: Red Hat CloudForms|Red Hat CloudForms Appliance
command prompt: shell prompt|Command Prompt (Windows product)
Composite Content view|composite content view|Composite View|composite view: Composite Content View
Composite Content view|Composite Content Ciew|Composite View|composite view: composite content view
configmap: config map
configuration map: config map
Content view|content view: Content View
Content view|Content View: content view
control key|ctrl: Ctrl
CP|RHCP|customer portal: Customer Portal|Red Hat Customer Portal
crush map|crushmap: CRUSH map
Expand Down Expand Up @@ -243,12 +243,11 @@ swap:
RAW: raw
Red Hat JBoss Data Grid|JDG: Red Hat Data Grid
Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
Red Hat Network Satellite server: Red Hat Network Satellite Server
Red Hat Proxy: Red Hat Network Proxy Server
Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server
Red Hat Satellite server: Red Hat Satellite Server
Red Hat satellite: Red Hat Satellite
Redboot|Red Boot: RedBoot
RedFish: Redfish
redis: Redis
RESTEASY|resteasy|Resteasy: RESTEasy
RHDS: Red Hat Directory Server
Expand Down Expand Up @@ -288,7 +287,7 @@ swap:
StartX: startx
STI|source to image: Source-to-Image (S2I)
SU: su
Subscription manifest: Subscription Manifest
Subscription Manifest: subscription manifest
Sys V|System V: SysV
system D|system D|SystemD|system d: systemd
Technology preview|technology preview: Technology Preview
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/Contractions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ message: "Avoid contractions. Use '%s' rather than '%s.'"
action:
name: replace
swap:
"aren't": is not
"aren't": are not
"can't": cannot
"couldn't": could not
"didn't": did not
Expand Down
2 changes: 2 additions & 0 deletions .vale/styles/RedHat/Definitions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ exceptions:
- PPP
- PROM
- PTP
- PV
- PVC
- PXE
- QCOW2
- QEMU
Expand Down
12 changes: 12 additions & 0 deletions .vale/styles/RedHat/GitLinks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
extends: existence
message: Do not include a link to %s unless it is explicitly approved.
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/gitlinks/
ignorecase: true
level: warning
scope: raw
action:
name: remove
tokens:
- 'https:\/\/gitlab\.com\/.*'
- 'https:\/\/github\.com\/(?!openshift|redhat-developer).*'
1 change: 1 addition & 0 deletions .vale/styles/RedHat/Hyphens.yml
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ swap:
re-direct: redirect
re-edit: reedit
re-examine: reexamine
re-register: reregister
re-synchronize: resynchronize
recreate: re-create
reenable: re-enable
Expand Down
2 changes: 2 additions & 0 deletions .vale/styles/RedHat/PascalCamelCase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ exceptions:
- NetXen
- NetXtreme
- NFSv
- NMState
- NuGet
- NVidia
- NVMe
Expand Down Expand Up @@ -172,6 +173,7 @@ exceptions:
- TypeScript
- UltraSPARC
- USBGuard
- vCenter
- vDisk
- vHost
- VMware
Expand Down
7 changes: 7 additions & 0 deletions .vale/styles/RedHat/PassiveVoice.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,10 @@ tokens:
- woven
- written
- wrung
exceptions:
- deprecated
- displayed
- imported
- supported
- tested
- trusted
11 changes: 4 additions & 7 deletions .vale/styles/RedHat/ReadabilityGrade.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---
extends: readability
grade: 21
level: suggestion
grade: 9
message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9."
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/
message: "Grade level ('%s') too high."
level: suggestion
metrics:
- Automated Readability
- Coleman-Liau
- Flesch-Kincaid
- Gunning Fog
- SMOG

6 changes: 5 additions & 1 deletion .vale/styles/RedHat/RepeatedWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference
ignorecase: false
alpha: true
action:
name: remove
name: edit
params:
- regex
- '(\w+)(\s\w+)' # pattern
- "$1" # replace
tokens:
- '[^\s\.]+'
- '[^\s]+'
1 change: 0 additions & 1 deletion .vale/styles/RedHat/SimpleWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ swap:
"objective(?! C?)": aim|goal
absent: none|not here
abundance: plenty
accelerate: speed up
accentuate: stress
accompany: go with
accomplish: carry out|do
Expand Down
1 change: 1 addition & 0 deletions .vale/styles/RedHat/Slash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ exceptions:
- "upstream/downstream"
- "z/OS"
- "z/OSMF"
- "[Kk]ey/value"
11 changes: 8 additions & 3 deletions .vale/styles/RedHat/Spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
extends: spelling
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
message: "Use correct American English spelling. Did you really mean '%s'?"
message: "Verify the word '%s'. It is not in the American English spelling dictionary used by Vale."
# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
# Spelling rule applies to individual words
# There is no need to add plural forms (s?) to th regex
# There is no need to add plural forms (s?) to the regex
filters:
- "[aA]ccessor"
- "[aA]llowlist"
Expand Down Expand Up @@ -49,7 +49,7 @@ filters:
- "[dD]ev"
- "[dD]ev[wW]orkspace"
- "[dD]evfile"
- "[dD]evfiles"
- "[dD]istro"
- "[dD]ownstream"
- "[dD]ownstreaming"
- "[eE]xposal"
Expand All @@ -60,6 +60,7 @@ filters:
- "[fF]ailover"
- "[fF]indability"
- "[gG]bps"
- "[gG]ibibyte"
- "[gG]it"
- "[gG]lock"
- "[gG]radle"
Expand All @@ -85,6 +86,7 @@ filters:
- "[kK]eyrings"
- "[kK]eyspace"
- "[kK]eytab"
- "[kK]ustomize"
- "[lL]ibvirt"
- "[lL]icensor"
- "[lL]iquibase"
Expand Down Expand Up @@ -123,6 +125,7 @@ filters:
- "[mM]ultizone"
- "[nN]amespace"
- "[nN]amespaces"
- "[nN]MState"
- "[nN]onheap"
- "[nN]oninteractive"
- "[nN]onpaired"
Expand Down Expand Up @@ -216,6 +219,7 @@ filters:
- "[sS]ysctl"
- "[sS]yslog"
- "[sS]ystemd"
- "[tT]elco"
- "[tT]emplated"
- "[tT]heia"
- "[tT]olerations"
Expand Down Expand Up @@ -493,6 +497,7 @@ filters:
- USBGuard
- Vale
- Valgrind
- vCenter
- vDisk
- Velero
- Vert.x
Expand Down
6 changes: 4 additions & 2 deletions .vale/styles/RedHat/TermsErrors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ swap:
"(?<!Mozilla )Thunderbird": Mozilla Thunderbird
"(?<!pseudo-)ops": operations
"(?<!self-)hosted engine|hosted-engine": self-hosted engine
"bare metal( clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| instances?| machines?| media| nodes?| provisioning| servers?| workers?)": bare-metal$1
"bare-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| instances?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal
"[bB]asic [aA]uth": Basic HTTP authentication|Basic authentication
"a lot(?: of)?": many|much
"best of breed|best-of-breed": best in class
Expand All @@ -34,7 +36,6 @@ swap:
"top(?:-)?left": upper left|upper right|upper-left|upper-right
"top(?:-)?right": upper left|upper right|upper-left|upper-right
"UPI": user-provisioned infrastructure
"w/(?!o) ": "with "
"w/o": without
'(?<!IBM\s)S\/390|S90|S\s390': IBM S/390
'backwards?\scompatible': compatible with earlier versions
Expand Down Expand Up @@ -142,7 +143,7 @@ swap:
cyber threat: cyberthreat
cyberresilience: cyber resilience
data base: database
datacenter|data-center|data centre|datacentre: data center
(?<!vCenter )datacenter|data-center|data centre|datacentre: data center
datafile: data file
dataflow: data flow
datamart: data mart
Expand Down Expand Up @@ -302,6 +303,7 @@ swap:
pain point: challenge|concern|difficulty|issue
parent task: parent process
parent/child: parent-child
peer-pod: peer pod
passive broker: slave broker
pathname: path name
PCOMM: Personal Communications
Expand Down
10 changes: 4 additions & 6 deletions .vale/styles/RedHat/TermsSuggestions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ ignorecase: false
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termssuggestions/
message: "Depending on the context, consider using '%s' rather than '%s'."
scope: sentence
action:
name: replace
swap:
"(?<!,| in| on| at| to| for| from| of| with| without| against) which": ", which| that"
"(?<!, | in | on | at | to | for | from | of | with | without | against )which": "that|, which"
", that": "that|, which"
"(?<!.-)jar": compress|archive
"(?<![Bb]y |not |are |to |about |[Ww]hen )using": by using|that uses
", that": ", which| that"
"[Bb]are metal(?= clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare-metal
"[Bb]are-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal
"[Nn]avigate": click|select|browse|go to
"bottom(?:-)?left": lower left|lower-left
"bottom(?:-)?right": lower right|lower-right
Expand All @@ -30,11 +28,11 @@ swap:
bottom left: lower left
bottom right: lower right
bugfix: bug fix
can not: cannot
choose: select
componentization: component-based development|component model|component architecture|shared components
componentize: develop components|divide into components|re-engineer into reusable software components
consumes: uses
distro: distribution
drag and drop: drag
executable(?! program| routine| files?): executable program
frontend: front end|front-end
Expand Down
9 changes: 8 additions & 1 deletion .vale/styles/RedHat/TermsWarnings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,24 @@ swap:
"bottom(?:-)?left": lower left|lower-left
"bottom(?:-)?right": lower right|lower-right
"non-English(?!-language?)": in languages other than English|non-English-language
'(?<!.-)like': such as
'(?<!.-|acts? |performs? |behaves? |operates? |functions? |reacts? |moves? |looks? |feels? |works? |runs? |advances? |shifts? )like': such as
'(?<!\/)etc(?!\/)': and so on
'\b(?:eg)': for example
'\b(?:ie)': that is
'I(?!/O)': you
'is updatable|are updatable': can be updated|can be changed
"(?<!the |the Red Hat )Hybrid Cloud Console|(?<!the )Red Hat Hybrid Cloud Console|(?<!the |Red Hat |Hybrid )Cloud Console|the Cloud Console": the Red Hat Hybrid Cloud Console|the Hybrid Cloud Console
all caps: uppercase
appears: is displayed
architected: designed
as well as(?! per): and
BIOS: firmware
bottom left: lower left
bottom right: lower right
bugfix: bug fix
call up: call
can not: cannot
carry on: continue
carry out: test|run
click on: click
deselect: clear
Expand All @@ -37,6 +40,7 @@ swap:
downgrade: upgrade|fallback|fall back|rollback|roll back
entitlement: repository|subscription
execute: run|issue|start|enter
find out: discover
hamburger|kebab menu|kebab: more options icon|options icon
he|she: you
host name: hostname
Expand All @@ -54,11 +58,14 @@ swap:
opt into|opting into: opt in
preload: preinstall
preloaded: preinstalled
print out: print
right double-click: double right-click
sane: accurate|valid|verified
shift-click: press Shift and click
spawn: create
start up: start
speed up: accelerate
speeds up: accelerates
switch on: turn on
tap on: tap
tarball: tar file
Expand Down
18 changes: 13 additions & 5 deletions .vale/styles/RedHat/UserReplacedValues.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
---
extends: substitution
message: "%s."
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
extends: existence
level: suggestion
message: "Separate words by underscores in user-replaced values."
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
scope: raw
swap:
'__<[a-z_\x60]+-[\x60a-z_-]+>__': Separate words by underscores in user-replaced values
nonword: true
action:
name: edit
params:
- regex
- "(-)" # pattern
- "_" # replace
tokens:
- '__<[a-z_\x60]+-[\x60a-z_-]+>__'
- '<[a-z_]+-[a-z_-]+>'
14 changes: 14 additions & 0 deletions .vale/styles/RedHat/Using.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
extends: sequence
message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness."
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/
level: warning
action:
name: edit
params:
- regex
- '(\w+)( using)' # pattern
- "$1 by using" # replace
tokens:
- tag: NN|NNP|NNPS|NNS
- pattern: using

0 comments on commit 9bf2293

Please sign in to comment.