22 lines
1,017 B
YAML
22 lines
1,017 B
YAML
---
|
|
# Error: gitlab.AlertBoxStyle
|
|
#
|
|
# Makes sure alert boxes follow standard formatting.
|
|
#
|
|
# Checks for 4 known issues:
|
|
# - Alert boxes with no colon, or colon outside the bold text
|
|
# - Known incorrect capitalization of the most commonly used alert box text
|
|
# - Alert boxes with the note text on the same line
|
|
# - Alert boxes using blockquote formatting, like "> **Note:**"
|
|
#
|
|
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
|
|
extends: existence
|
|
message: 'Alert box "%s" must use the formatting in the style guide.'
|
|
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
|
|
level: error
|
|
scope: raw
|
|
raw:
|
|
- '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
|
|
- '((NOTE: \*\*(NOTE|note):\*\*)|(TIP: \*\*(TIP|tip):\*\*)|(CAUTION: \*\*(CAUTION|caution):\*\*)|(DANGER: \*\*(DANGER|danger):\*\*))|'
|
|
- '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
|
|
- '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'
|