diff --git a/.github/workflows/vale-linting.yml b/.github/workflows/vale-linting.yml index 9111e19..08cd975 100644 --- a/.github/workflows/vale-linting.yml +++ b/.github/workflows/vale-linting.yml @@ -1,10 +1,11 @@ +--- name: Linting with Vale using Reusable Config -on: - push: - branches: [main] - pull_request: - branches: [main] +on: + push: + branches: [main] + pull_request: + branches: [main] jobs: - call-reusable-vale-workflow-in-riscv-vale-repo: - uses: riscv-admin/riscv-vale/.github/workflows/vale-reusable.yml@main \ No newline at end of file + call-reusable-vale-workflow-in-riscv-vale-repo: + uses: riscv-admin/riscv-vale/.github/workflows/vale-reusable.yml@main diff --git a/.vale.ini b/.vale.ini index e69de29..1911362 100644 --- a/.vale.ini +++ b/.vale.ini @@ -0,0 +1,35 @@ +StylesPath = .github/styles +minAlertLevel = suggestion + +IgnoredScopes = code, tt, img, url, a, body.id + +SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock + +Packages = RedHat, AsciiDoc, https://github.com/riscv-admin/riscv-vale/releases/latest/download/riscv.zip, https://github.com/riscv-admin/riscv-vale/releases/latest/download/config.zip +Vocab = riscv-vocab + +[*.adoc] +BasedOnStyles = riscv +#BasedOnStyles = Vale, RedHat, riscv, AsciiDoc + +#[*.md] +#BasedOnStyles = Vale, RISCV-Vale, AsciiDoc + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + +# Match INI files. See: https://docs.errata.ai/vale/scoping +#[*.ini] +#BasedOnStyles = Vale, RISCV-Vale + +# Disabling rules (NO) +#RedHat.CaseSensitiveTerms = NO +#RedHat.ConfigMap = NO +#RedHat.Definitions = NO +#RedHat.Slash = NO +#RedHat.Spacing = NO +#RedHat.Spelling = NO +#RedHat.TermsSuggestions = NO + +#with: +# files: src/*.adoc