diff --git a/.github/.vale.ini b/.github/.vale.ini new file mode 100644 index 0000000..2f6b467 --- /dev/null +++ b/.github/.vale.ini @@ -0,0 +1,41 @@ +# Vale configuration file. +# For more information, see: https://vale.sh/docs/topics/config. + +# The relative path to the folder containing linting rules (styles). +StylesPath = .github/styles + +# Minimum alert level +# ------------------- +# The minimum alert level in the output (suggestion, warning, or error). +# If integrated into CI, builds fail by default on error-level alerts, unless you run Vale with the --no-exit flag +MinAlertLevel = warning + +# IgnoredScopes specifies inline-level HTML tags to ignore. +# 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`. +SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock + +Vocab = quarkus-kafka-streams-definitions + +Packages = RedHat, AsciiDoc + +[*.adoc] +BasedOnStyles = Custom, RedHat, AsciiDoc + +# Ignore code matching the following patterns: +# (\x60[^\n\x60]+\x60) - code surrounded by backticks - e.g. `BatchApplication` +# (:[^\n]+: [^\n]+) - attributes definitions - e.g. `:param: value` +# ([^\n]+=[^\n]*) - config definitions - e.g. param=value +# (https?:\/\/[^\n\s]+) - URLs - e.g. https://www.example.com +# (\b\w+_\w+\b) - snake case words - e.g. batch_application +# (\b\w+_\w+\b) - kebab case words - e.g. batch-application +# (\{[^\}]+\}\S+\[) - URLs based on attribute - e.g. {url}/path[link] +# (^\.\w+\.\w+$) - callouts title - e.g. .pom.xml +TokenIgnores = (\x60[^\n\x60]+\x60), (:[^\n]+: [^\n]+), ([^\n]+=[^\n]*), (https?:\/\/[^\n\s]+), (\b\w+_\w+\b), (\b\w+-\w+\b), (\{[^\}]+\}\S+\[), (^\.\w+\.\w+$) + +# Disable the execution of this style as all our callouts are using include::[] directive +AsciiDoc.MatchingNumberedCallouts = NO \ No newline at end of file diff --git a/.github/styles/Custom/HeadingNestingDepth.yml b/.github/styles/Custom/HeadingNestingDepth.yml new file mode 100644 index 0000000..82359ec --- /dev/null +++ b/.github/styles/Custom/HeadingNestingDepth.yml @@ -0,0 +1,7 @@ +--- +extends: existence +message: 'The subheading "%s" is nested too deeply. The max heading nesting depth is set to 3.' +level: error +scope: raw +raw: + - '(?<=\n)={4,}\s.+' \ No newline at end of file diff --git a/.github/styles/Custom/SingleStatementPerLine.yml b/.github/styles/Custom/SingleStatementPerLine.yml new file mode 100644 index 0000000..f6a683d --- /dev/null +++ b/.github/styles/Custom/SingleStatementPerLine.yml @@ -0,0 +1,9 @@ +--- +extends: occurrence +message: Only use one sentence per line. +level: error +scope: + - paragraph + - list +max: 1 +token: '(? Example of decorated method, here the main `punctuate` method of the `Punctuator` interface. +==== A new too much nestad section + +This is a new section that is too much nested. It should raise several Vale errors as the nesting is too deep and/or there isn`t a sigle line per stetament. + +Normally the word NFRs should raise a spelling issue but it won't as we have added it in the `accept.txt` file. + +You may delete this section once you have tested the vale intgration. + + [[extension-configuration-reference]] == Extension configuration reference