Commit d1e747fc authored by Amy Qualls's avatar Amy Qualls

Merge branch 'eread/consistent-vale-config-rules' into 'master'

Make Vale rule configuration follow a pattern

See merge request gitlab-org/gitlab!34131
parents 04374751 200ba97e
---
# Warning: gitlab.Acronyms
#
# Checks for unexpanded acronyms.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: conditional
message: "'%s' has no definition."
message: '"%s" has no definition.'
link: https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms
level: warning
ignorecase: false
......@@ -60,4 +63,3 @@ exceptions:
- WIP
- XML
- YAML
---
# Error: gitlab.BadgeCapitalization
#
# Verifies that badges are not lower case, which won't render properly.
# Verifies that badges are not mixed case, which won't render properly.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
......
---
# Error: gitlab.British
#
# Checks for use of some of the top misused terms at GitLab.
# Checks that US spelling is used over British spelling.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
message: 'Use the American spelling "%s" instead of the British "%s".'
message: 'Use the US spelling "%s" instead of the British "%s".'
link: https://about.gitlab.com/handbook/communication/#top-misused-terms
level: error
ignorecase: true
......
---
# Error: gitlab.CodeblockFences
#
# Ensures all codeblock fences use the full name for the language.
# Ensures all codeblock language tags use the full name, not aliases.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
......
---
# Suggestion: gitlab.Contractions
#
# Checks for use of common and uncommon contractions.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
message: Use "%s" instead of "%s", for a friendly, informal tone.
message: 'Use "%s" instead of "%s", for a friendly, informal tone.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
level: suggestion
nonword: false
......
---
# Error: gitlab.CurlStringsQuoted
# Warning: gitlab.CurlStringsQuoted
#
# Ensures all codeblocks using curl quote any URL strings.
#
......
---
# Warning: gitlab.FirstPerson
#
# Checks for use of first person pronouns.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
message: '`%s` is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.'
message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.'
level: warning
ignorecase: true
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
......
......@@ -5,7 +5,7 @@
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
message: Link %s must use the .md file extension.
message: 'Link "%s" must use the .md file extension.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
level: error
scope: raw
......
---
# Checks for use of latin terms..
# Warning: gitlab.LatinTerms
#
# Checks for use of latin terms.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
message: Use "%s" instead of "%s," but consider rewriting the sentence.
message: 'Use "%s" instead of "%s", but consider rewriting the sentence.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
level: warning
nonword: true
......
---
# Error: gitlab.MeaningfulLinkWords
# Warning: gitlab.MeaningfulLinkWords
#
# Checks for the presence of semantically unhelpful words in link text.
#
......
---
# Warning: gitlab.OxfordComma
#
# Checks for the lack of an Oxford comma. In some cases, will catch overly
# complex sentence structures with lots of commas.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
message: Use a comma before the last "and" or "or" in a list of four or more items.
message: 'Use a comma before the last "and" or "or" in a list of four or more items.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
level: warning
raw:
......
......@@ -5,7 +5,7 @@
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
message: Link %s must be relative.
message: 'Link "%s" must be relative.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
level: error
scope: raw
......
---
# Warning: gitlab.SentenceLength
#
# Counts words in a sentence and alerts if a sentence exceeds 25 words.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: occurrence
message: "Shorter sentences improve readability (max 25 words)."
message: 'Shorter sentences improve readability (max 25 words).'
scope: sentence
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
level: warning
......
---
# Warning: gitlab.Spelling
#
# Checks for possible spelling mistakes in content, not code. May find false positives
# due to links using angle brackets: <https://example.com>. These can be ignored.
#
......
---
# Warning: gitlab.SubstitutionWarning
#
# Warns against using common shorthand for terms.
# For substitutions flagged as errors, see Substitutions.yml
#
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment