debian-mirror-gitlab/doc/.vale/gitlab/AlertBoxStyle.yml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

21 lines
770 B
YAML
Raw Normal View History

2020-07-28 23:09:34 +05:30
---
# Error: gitlab.AlertBoxStyle
#
2021-03-08 18:12:59 +05:30
# Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues:
2020-07-28 23:09:34 +05:30
#
2021-02-22 17:27:13 +05:30
# - Alert boxes inside a block quote (">")
2020-11-24 15:15:51 +05:30
# - Alert boxes with the note text on the same line
2021-02-22 17:27:13 +05:30
# - Alert boxes using words other than "NOTE" or "WARNING"
2020-11-24 15:15:51 +05:30
#
2020-07-28 23:09:34 +05:30
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
2020-10-24 23:57:45 +05:30
message: 'Alert box "%s" must use the formatting in the style guide.'
2021-04-17 20:07:23 +05:30
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes
2020-07-28 23:09:34 +05:30
level: error
2021-02-22 17:27:13 +05:30
nonword: true
2020-07-28 23:09:34 +05:30
scope: raw
raw:
2021-02-22 17:27:13 +05:30
- '(\n *\> *(?:NOTE|WARNING)|'
2021-03-08 18:12:59 +05:30
- '\n\n(NOTE|WARNING):[^\n]|'
- '\n\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|Warning|warning):.*)'