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

Tweak and optimize vale config #30397

Merged
merged 1 commit into from
Jan 17, 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
2 changes: 0 additions & 2 deletions docs/.vale/fixtures/Quarkus/Spelling/testinvalid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ dns
dotnet
endevor
gluster
gradle
Graal VM
graal vm
gui
Expand Down Expand Up @@ -60,5 +59,4 @@ velero
webview
webviews
woopra
yaml
zowe
1 change: 1 addition & 0 deletions docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ Webviews
Wildfly
Woopra
Wordpress
YAML
Yana
Yeoman
Zowe
2 changes: 2 additions & 0 deletions docs/.vale/styles/Quarkus/Spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ filters:
- "[gG]bps"
- "[gG]etter"
- "[gG]it"
- "[gG]radle"
- "[gG]rafana"
- "[hH]ardcoding"
- "[hH]eatmap"
Expand Down Expand Up @@ -159,6 +160,7 @@ filters:
- "[uU]psell"
- "[uU]pselling"
- "[vV]alidator"
- "[yY]aml"
- "Let\'s Encrypt"
- adoc
- Agroal
Expand Down
41 changes: 5 additions & 36 deletions docs/.vale/vale.ini
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Vale configuration file for the https://github.com/redhat-documentation/vale-at-red-hat repository.
# See: https://docs.errata.ai/vale/config

# Core settings appear at the top (the "global" section).
# Vale configuration file.
# For more information, see: https://docs.errata.ai/vale/config.

# The relative path to the folder containing linting rules (styles).
StylesPath = ./styles

# Vocab define the exceptions to use in *all* `BasedOnStyles`.
# See: https://docs.errata.ai/vale/vocab

# Minimum alert level
# -------------------
# The minimum alert level in the output (suggestion, warning, or error).
Expand All @@ -20,44 +15,18 @@ MinAlertLevel = suggestion
# These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts.
# Default: ignore `code` and `tt`.
IgnoredScopes = code, tt, img, url, a, body.id

# SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes.
# Default: ignore `script`, `style`, `pre`, and `figure`.
# For AsciiDoc: by default, listingblock, and literalblock.
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock

[formats]
# Associate `*.properties` files with the `md` format
properties = md

# Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping
# Ignore files in a directory starting by `.`
# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
[[!.]*.adoc]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = Quarkus
; Ignore attributes definition, id statements
TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+)


# Match Markdown files. See: https://docs.errata.ai/vale/scoping
# Match also `*.properties` files (see the `format` section).
[*.md]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = Quarkus

# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)

# Match Restructured text files
[*.rst]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = Quarkus

# Match INI files. See: https://docs.errata.ai/vale/scoping
[*.ini]
# Styles to load, located in the `StylesPath` folder:
BasedOnStyles = Quarkus
# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)

; Disabling rules (NO)
# Ignore attributes definition, id statements
TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+)