Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quarkus rules for the Vale linter: Fix false positive messages and enhance regular expression of some rules #35092

Merged
merged 1 commit into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ IPSec
iSeries
iso
iso image
Istio Service Mesh
Itanium2
JBoss.org
jetbrains
Expand Down
5 changes: 5 additions & 0 deletions docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Exif
FAQ
Fedora™ Project
Fortran
Fluentd
FQDN
GB
Gbps
Expand All @@ -38,6 +39,7 @@ GNU
GPL
GraalVM
Gradle
Graylog
gRPC
GRUB
GTK+
Expand All @@ -60,9 +62,11 @@ IPsec
ISeries
ISO
ISO image
Istio service mesh
Itanium
Itanium 2
JBoss Community
JBoss Logging
JetBrains
JUnit
JVM
Expand All @@ -72,6 +76,7 @@ Kickstart
KVM
LAN
Linux
Logstash
Mandrel
MicroProfile
Microsoft
Expand Down
6 changes: 5 additions & 1 deletion docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,8 @@
== Kogito updates
== IBM Cloud is a valid product name
== Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK.
= Using xDS gRPC
== Use xDS gRPC
== Use JBoss Logging for application logging
== JBoss Logging API
== A heading about Graylog, Logstash, or Fluentd open-source software
== About the Istio service mesh
10 changes: 10 additions & 0 deletions docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,14 @@ CSVs
Ctrl
customizer
Cygmon
datasource
datasources
DaemonSet
Datadog
declaratively
decompiler
deserialization
deserialized
Dev
dev
devfile
Expand Down Expand Up @@ -117,9 +120,11 @@ Failsafe
Fernflower
findability
Findability
Fluentd
Fortran
Funqy
Gbps
Graylog
gRPC
GCC
getters
Expand Down Expand Up @@ -154,6 +159,7 @@ Infinispan
Inode
Intelephense
IntelliJ
Istio
Itanium
Item
Jakarta
Expand Down Expand Up @@ -189,6 +195,7 @@ libvirt
Libvirt
Licensor
Liveness
Logstash
Lombok
Loopback
Makefile
Expand Down Expand Up @@ -241,6 +248,7 @@ OpenShift
OpenTracing
Operator
osd
OTel
overridable
PHP
Podman
Expand Down Expand Up @@ -330,6 +338,8 @@ Subusers
Subvolume
Subvolumes
Suchow
Syslog
syslog
Symfony
SVG
Systemd
Expand Down
42 changes: 23 additions & 19 deletions docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,26 @@ action:
name: replace
swap:
"(?<!/)var": VAR
# Bind: BIND
"(?<!Business )Resource Planner|(?<!Business Resource )Planner": Business Resource Planner
"(?<!Microsoft )Azure": Microsoft Azure
"(?<!Microsoft Azure )On-Demand Marketplace": Microsoft Azure On-Demand Marketplace
"(?<!Red Hat )Customer Portal": Red Hat Customer Portal
"(?<!Red Hat )JBoss Enterprise Application Platform": Red Hat JBoss Enterprise Application Platform
"(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP": Red Hat OpenStack Platform
"(?<!Red Hat JBoss )BRMS(?! engine)": inference engine
"(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS": Red Hat JBoss BRMS
"[dD]ay-0|day 0": Day 0
"[dD]ay-1|day 1": Day 1
"[dD]ay-2|day 2": Day 2
"BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)": Red Hat JBoss BPM Suite
"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)": 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
'(?<!\.)yaml|Yaml': YAML
'(?<!Business )Resource Planner|(?<!Business Resource )Planner': Business Resource Planner
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
'(?<!Microsoft Azure )On-Demand Marketplace': Microsoft Azure On-Demand Marketplace
'(?<!Realtime )Decision\sServer': Realtime Decision Server
'(?<!Red Hat )Customer Portal': Red Hat Customer Portal
'(?<!Red Hat )JBoss Enterprise Application Platform': Red Hat JBoss Enterprise Application Platform
'(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP': Red Hat OpenStack Platform
'(?<!Red Hat JBoss )BRMS(?! engine)': inference engine
'(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS': Red Hat JBoss BRMS
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
'\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': .NET
'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
Expand All @@ -30,20 +39,14 @@ swap:
'ack\spacket|ACK(?!\sflag)|ack': ACK flag
'ActiveMQ\sArtemis|ActiveMQ(?!\sArtemis)': built-in messaging|JBoss EAP built-in messaging|JBoss EAP messaging
'Admin\sPortal|webadmin\sportal|webadmin|Administrator\sPortal|Administration\sportal': Administration Portal
'BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)': Red Hat JBoss BPM Suite
'BRMS\sengine': inference engine
'GUI\seditor|Business\sCentral\seditor': guided editor
'JBoss Broker|Red Hat Broker|The AMQ Broker': AMQ Broker
'JBoss Console|Red Hat Console': AMQ Console
'JBoss\.org': JBoss Community
'JBoss\sAMQ': AMQ
'JBoss\sInterconnect': AMQ Interconnect
'Kernel(?!-based Virtual Machine)': kernel
'Kie(?!\sServer)': KIE
'Kie\sServer': Intelligent Process Server
'O\.K\.D|okd|OpenShift Kubernetes Distribution|OpenShift\sOrigin': OKD
'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
'Red\sHat\sInterconnect': AMQ Interconnect
'Red\sHat\sVirtualization\sHypervisor|RHV\sHost|RHV-H': Red Hat Virtualization Host
'RHVM|RHV-M|RHV\sManager': Red Hat Virtualization Manager
Expand Down Expand Up @@ -116,7 +119,6 @@ swap:
Fqdn|fqdn: FQDN
gb|Gb: GB
gbps|GBPS: Gbps
gb|Gb: GB
GDBTK: Insight
gid|Gid: GID
Gimp|gimp: GIMP
Expand All @@ -139,6 +141,8 @@ swap:
IBM z Systems: IBM Z
Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
ignition config: Ignition config
Image Builder: image builder
Istio Service Mesh : Istio service mesh
INSTALL_DIR|installDir: FUSE_HOME
Iops|IOPs: IOPS
Ip: IP
Expand Down Expand Up @@ -194,13 +198,14 @@ swap:
OCP: Red Hat OpenShift Container Platform
ODF: Red Hat OpenShift Data Foundation
Open InfiniBand|Infiniband: InfiniBand
openid connect|Openid Connect: OpenID Connect
Open InfiniBand|Infiniband: InfiniBand
Open JDK|openjdk|JDK: OpenJDK
openid connect|Openid Connect: OpenID Connect
openrewrite|Openrewrite|Open Rewrite: OpenRewrite
Openshift online|OO: Red Hat OpenShift Online
Operating Environment: operating environment
Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
Opex|Opex|OPEX|opEx: OpEx
ORAN: O-RAN
Organization administrator|Org Admin|org admin: Organization Administrator
OS|Operating System: operating system
Overcloud: overcloud
Expand Down Expand Up @@ -229,7 +234,6 @@ swap:
Ram|ram: RAM
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
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Quarkus/Ellipses.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: existence
level: suggestion
link: https://developers.google.com/style/ellipses?hl=en
link: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-reference.adoc
message: "Avoid the ellipsis (...) except to indicate omitted words. Insert a space before and after an ellipsis."
nonword: true
# source: Quarkus contributor guide
Expand Down
14 changes: 12 additions & 2 deletions docs/.vale/styles/Quarkus/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ exceptions:
- Azure
- Basic authentication
- Basic HTTP authentication
- BOM
- Bierner
- Bitbucket
- BOM
Expand Down Expand Up @@ -82,8 +83,10 @@ exceptions:
- Flathub
- Flatpak
- Flatpak Builder
- Fluentd
- Fortran
- Funqy
- gRPC
- GCC
- GTKplus
- GUI
Expand All @@ -96,6 +99,7 @@ exceptions:
- GraalVM
- Gradle
- GraphQL
- Graylog
- Grayscale
- GTK
- HTTP
Expand All @@ -117,14 +121,18 @@ exceptions:
- Infinispan
- Intelephense
- IntelliJ
- Istio
- Itanium
- JAR file
- JBang
- JUnit
- JVM
- Jakarta
- Jandex
- Java
- Jave
- JBoss Log Manager
- JBoss Logging
- JetBrains
- Jira
- Jolokia
Expand All @@ -138,6 +146,7 @@ exceptions:
- Kubespray
- Kylin
- Laravel
- Logstash
- Lombok
- Makefile
- Mandrel
Expand Down Expand Up @@ -167,6 +176,7 @@ exceptions:
- OpEx
- OpenID Connect
- OpenJDK
- OpenRewrite
- OpenShift
- OpenTracing
- PHP
Expand All @@ -184,7 +194,6 @@ exceptions:
- Qt
- Quarkiverse
- Quarkus
- Quarkus Security
- Quiltflower
- Qute
- RESTEasy
Expand Down Expand Up @@ -246,4 +255,5 @@ exceptions:
- startx
- vNIC
- vNUMA
- xterm
- xDS
- xterm
2 changes: 1 addition & 1 deletion docs/.vale/styles/Quarkus/OxfordComma.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ link: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-
message: "Use the Oxford comma in '%s'."
# source: Quarkus contributor guide
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'
Loading
Loading