diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-17 14:33:21 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-17 14:33:21 +0300 |
commit | 7021455bd1ed7b125c55eb1b33c5a01f2bc55ee0 (patch) | |
tree | 5bdc2229f5198d516781f8d24eace62fc7e589e9 /doc/.vale | |
parent | 185b095e93520f96e9cfc31d9c3e69b498cdab7c (diff) |
Add latest changes from gitlab-org/gitlab@15-6-stable-eev15.6.0-rc42
Diffstat (limited to 'doc/.vale')
53 files changed, 207 insertions, 216 deletions
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml deleted file mode 100644 index 78a86e27456..00000000000 --- a/doc/.vale/gitlab/Admin.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Suggestion: gitlab.Admin -# -# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: substitution -message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html -level: suggestion -ignorecase: false -swap: - '[Aa]dmin ?\w*': '(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative|ering|ered))' diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index 5912c4707fd..0a4514fa3c8 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -3,13 +3,13 @@ # # Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues: # -# - Alert boxes inside a block quote (">") +# - Alert boxes inside a block quote ('>') # - Alert boxes with the note text on the same line -# - Alert boxes using words other than "NOTE" or "WARNING" +# - Alert boxes using words other than 'NOTE' or 'WARNING' # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Alert box "%s" must use the formatting in the style guide.' +message: "Update the format of the '%s' alert box. View the style guide for details." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes level: error nonword: true diff --git a/doc/.vale/gitlab/BadPlurals.yml b/doc/.vale/gitlab/BadPlurals.yml index 533805c67b0..9cdb8661708 100644 --- a/doc/.vale/gitlab/BadPlurals.yml +++ b/doc/.vale/gitlab/BadPlurals.yml @@ -1,11 +1,11 @@ --- # Warning: gitlab.BadPlurals # -# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable. +# Don't write plural words with the '(s)' construction. 'HTTP(S)' is acceptable. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rewrite "%s" to be plural, without parentheses.' +message: "Rewrite '%s' to be plural without parentheses." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#s level: warning ignorecase: true diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index 33425693d53..6e77c3fe822 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -3,9 +3,9 @@ # # Verifies that badges are not mixed case, which won't render properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Badge "%s" must be capitalized.' +message: "Capitalize the '%s' badge." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges level: error scope: raw diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index c63cbd917c7..432ed302e11 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -3,9 +3,9 @@ # # Checks that US spelling is used instead of British spelling. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use the US spelling "%s" instead of the British "%s".' +message: "Use the US spelling '%s' instead of the British '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: error ignorecase: true diff --git a/doc/.vale/gitlab/CIConfigFile.yml b/doc/.vale/gitlab/CIConfigFile.yml index 5a65e51ea16..4d2ba454410 100644 --- a/doc/.vale/gitlab/CIConfigFile.yml +++ b/doc/.vale/gitlab/CIConfigFile.yml @@ -3,9 +3,9 @@ # # Checks that the `.gitlab-ci.yml` file is referenced properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The CI/CD configuration file should be exactly: `.gitlab-ci.yml`' +message: "Change the file name to be exactly '.gitlab-ci.yml'." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 6c2d94e7b8d..9d5efe7f60a 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -3,9 +3,9 @@ # # Ensures all codeblock language tags use the full name, not aliases. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.' +message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks level: error scope: raw diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index a59fe64d990..efe7aa23832 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -3,9 +3,9 @@ # # Ensures all code blocks using `curl` wrap URL strings in quotation marks. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'For consistency across all cURL examples, always wrap the URL in double quotes ("): %s' +message: "For the cURL example, use double quotes around the URL: %s" link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands level: error scope: code diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 040fd3d8a8f..57b95dcf4ac 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -3,12 +3,12 @@ # # Checks for words that indicate a product or feature may change in the future. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid words like "%s" when you write about future features. Our documentation is about the current state of the product.' +message: "Remove '%s'. The documentation reflects the current state of the product." level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#promising-features-in-future-versions +link: https://docs.gitlab.com/ee/development/documentation/versions.html#promising-features-in-future-versions tokens: - currently - yet diff --git a/doc/.vale/gitlab/DefaultBranch.yml b/doc/.vale/gitlab/DefaultBranch.yml index 4bc68433c6d..86c627bcfe3 100644 --- a/doc/.vale/gitlab/DefaultBranch.yml +++ b/doc/.vale/gitlab/DefaultBranch.yml @@ -1,14 +1,14 @@ --- # Warning: gitlab.DefaultBranch # -# Do not refer to the default branch as the "master" branch, if possible. +# Do not refer to the default branch as the 'master' branch, if possible. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "default branch" or `main` instead of `master`, when possible.' +message: "Use 'default branch' or `main` instead of `master`, when possible." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#default-branch scope: raw raw: - '\`master\`' diff --git a/doc/.vale/gitlab/Dropdown.yml b/doc/.vale/gitlab/Dropdown.yml index 691d44d1a48..c656d1209f5 100644 --- a/doc/.vale/gitlab/Dropdown.yml +++ b/doc/.vale/gitlab/Dropdown.yml @@ -3,11 +3,11 @@ # # Catches many ways the phrase 'dropdown list' can be fumbled. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "dropdown list".' +message: "Use 'dropdown list'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#dropdown-list -level: suggestion +level: warning ignorecase: true tokens: - drop-down( [\w]*)? diff --git a/doc/.vale/gitlab/EOLWhitespace.yml b/doc/.vale/gitlab/EOLWhitespace.yml index e160b706014..153786443cc 100644 --- a/doc/.vale/gitlab/EOLWhitespace.yml +++ b/doc/.vale/gitlab/EOLWhitespace.yml @@ -3,9 +3,9 @@ # # Checks that there is no useless whitespace at the end of lines. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Lines should not end with whitespace characters.' +message: "Remove whitespace characters from the end of the line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: warning scope: raw diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index 36f1202aef1..f3573f5ce65 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -3,9 +3,9 @@ # # Suggests the correct way to describe elements in a form. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'When describing elements, %s "%s".' +message: "When describing elements, %s '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: suggestion ignorecase: true diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index 6fc93d9515c..e97b886b5ed 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -3,12 +3,12 @@ # # Checks for use of first person pronouns. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.' +message: "Instead of '%s', speak directly to the reader. Use 'you' or re-write to remove." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html tokens: - '\bI[ ,;:?!"]|\bI\x27.{1,2}' - me diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml index 64e79612fff..d1484b20008 100644 --- a/doc/.vale/gitlab/FutureTense.yml +++ b/doc/.vale/gitlab/FutureTense.yml @@ -3,12 +3,12 @@ # # Checks for use of future tense in sentences. Present tense is strongly preferred. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid using future tense: "%s". Use present tense instead.' +message: "Instead of future tense '%s', use present tense." ignorecase: true level: warning -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#future-tense raw: - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" - "will( |\n|[[:punct:]])[a-zA-Z]*|" diff --git a/doc/.vale/gitlab/HeadingContent.yml b/doc/.vale/gitlab/HeadingContent.yml index c2dd2a5c6c2..31ac3022934 100644 --- a/doc/.vale/gitlab/HeadingContent.yml +++ b/doc/.vale/gitlab/HeadingContent.yml @@ -3,12 +3,12 @@ # # Checks for generic, unhelpful subheadings. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rename the subheading "%s", or re-purpose the content elsewhere.' +message: "Rename the heading '%s', or re-purpose the content elsewhere." level: warning scope: heading -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#headings-1 +link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-headings ignorecase: false tokens: - How it works diff --git a/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab/HeadingDepth.yml index 466ab317226..7a3e5b4b552 100644 --- a/doc/.vale/gitlab/HeadingDepth.yml +++ b/doc/.vale/gitlab/HeadingDepth.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The subheading "%s" is nested too deeply. Headings deeper than H5 suggest the section or page should be refactored.' +message: "Refactor the section or page to avoid headings greater than H5." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#headings-in-markdown level: warning scope: raw diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 1ebb6a97cf8..7419430c8a2 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -3,10 +3,10 @@ # # Suggests alternatives for words that foster ableism. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionCultural.yml b/doc/.vale/gitlab/InclusionCultural.yml index 6f63d1725fc..6de838e7f25 100644 --- a/doc/.vale/gitlab/InclusionCultural.yml +++ b/doc/.vale/gitlab/InclusionCultural.yml @@ -3,10 +3,10 @@ # # Suggests alternatives for words that are culturally inappropriate. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index 313a1cc42dc..ce8861b6a09 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -3,10 +3,10 @@ # # Suggests alternatives for words that are gender-specific. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InternalLinkCase.yml b/doc/.vale/gitlab/InternalLinkCase.yml index c00e633426b..fded735812a 100644 --- a/doc/.vale/gitlab/InternalLinkCase.yml +++ b/doc/.vale/gitlab/InternalLinkCase.yml @@ -3,10 +3,10 @@ # # Checks that anchor fragments on internal links are in lower-case. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Links to subheadings in GitLab docs must be in lower-case: "%s"' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Use lowercase for the anchor link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 52142b50dfc..364263f90c8 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -3,10 +3,10 @@ # # Checks that internal links have .md extenstion and not .html extension. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must link directly to a file and use the .md file extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Link to a file and use the .md file extension instead of .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab/InternalLinkFormat.yml index b9ee83b7f5c..be09a020846 100644 --- a/doc/.vale/gitlab/InternalLinkFormat.yml +++ b/doc/.vale/gitlab/InternalLinkFormat.yml @@ -1,13 +1,13 @@ --- # Error: gitlab.InternalLinkFormat # -# Checks that internal link paths don't start with "./", which is not needed. +# Checks that internal link paths don't start with './', which is not needed. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must not start with "./".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Edit the link so it does not start with './'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: - - '\[.+\]\(\.\/.*?\)' + - '\[[^\]]+\]\(\.\/.*?\)' diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 12553a801a1..0bac0448bb1 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -3,10 +3,10 @@ # # Checks for use of Latin terms. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s", but consider rewriting the sentence.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +message: "Use '%s' instead of '%s', but consider rewriting the sentence." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/Markdown_emoji.yml b/doc/.vale/gitlab/Markdown_emoji.yml index ac0dab2d69d..9873fb8becd 100644 --- a/doc/.vale/gitlab/Markdown_emoji.yml +++ b/doc/.vale/gitlab/Markdown_emoji.yml @@ -3,9 +3,9 @@ # # Check for use of GLFM emoji syntax (https://docs.gitlab.com/ee/user/markdown.html#emojis), which doesn't render correctly in documentation. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'This appears to be GLFM emoji syntax. Replace "%s" with GitLab SVGs or Unicode emojis.' +message: "Replace '%s' with GitLab SVGs or Unicode emojis." link: https://docs.gitlab.com/ee/development/documentation/styleguide/#gitlab-svg-icons level: warning scope: text diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab/MeaningfulLinkWords.yml index 4a255e5aae4..6fb41c7ce95 100644 --- a/doc/.vale/gitlab/MeaningfulLinkWords.yml +++ b/doc/.vale/gitlab/MeaningfulLinkWords.yml @@ -3,13 +3,13 @@ # # Checks for the presence of semantically unhelpful words in link text. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Improve SEO and accessibility by rewriting "%s" in the link text.' +message: "Improve SEO and accessibility by rewriting '%s' in the link text." level: warning scope: link ignorecase: true -link: https://about.gitlab.com/handbook/communication/#writing-style-guidelines +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links tokens: - here - this page diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab/MergeConflictMarkers.yml index 4f216ac34c5..54e044f195d 100644 --- a/doc/.vale/gitlab/MergeConflictMarkers.yml +++ b/doc/.vale/gitlab/MergeConflictMarkers.yml @@ -3,9 +3,9 @@ # # Checks for the presence of merge conflict markers. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Merge conflict marker "%s" found.' +message: "Remove the merge conflict marker '%s'." link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request level: error scope: raw diff --git a/doc/.vale/gitlab/MultiLineLinks.yml b/doc/.vale/gitlab/MultiLineLinks.yml index 64ad017f16c..32fe38277dc 100644 --- a/doc/.vale/gitlab/MultiLineLinks.yml +++ b/doc/.vale/gitlab/MultiLineLinks.yml @@ -3,10 +3,10 @@ # # Checks that links are all on a single line. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be on a single line, even if very long.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put the full link on one line, even if the link is very long." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/NonStandardQuotes.yml b/doc/.vale/gitlab/NonStandardQuotes.yml index f31d615eb19..6161a4cc000 100644 --- a/doc/.vale/gitlab/NonStandardQuotes.yml +++ b/doc/.vale/gitlab/NonStandardQuotes.yml @@ -3,12 +3,12 @@ # # Use only standard single and double quotes, not left or right quotes. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' +message: "Use standard single quotes or double quotes only. Do not use left or right quotes." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation scope: raw raw: - '[‘’“”]' diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml index f25de44ad17..10fbaa0a676 100644 --- a/doc/.vale/gitlab/OutdatedVersions.yml +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -3,10 +3,10 @@ # # Checks for references to versions of GitLab that are no longer supported. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Can this reference to "%s" be refactored?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions +message: "If possible, remove the reference to '%s'." +link: https://docs.gitlab.com/ee/development/documentation/versions.html level: suggestion nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 1716145b26a..81a9ae5c1fc 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -3,9 +3,9 @@ # # 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.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/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/index.html#punctuation level: warning raw: diff --git a/doc/.vale/gitlab/Possessive.yml b/doc/.vale/gitlab/Possessive.yml index 92ae66543a2..64c9481ac28 100644 --- a/doc/.vale/gitlab/Possessive.yml +++ b/doc/.vale/gitlab/Possessive.yml @@ -3,11 +3,11 @@ # # The word GitLab should not be used in the possessive form. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "Rewrite '%s' to not use 's." +message: "Remove 's from %s." level: error ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab tokens: - GitLab's diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab/ReadingLevel.yml index cd7597ee8dc..a1ddebec1ea 100644 --- a/doc/.vale/gitlab/ReadingLevel.yml +++ b/doc/.vale/gitlab/ReadingLevel.yml @@ -4,8 +4,10 @@ # Checks the Flesch-Kincaid reading level. # # https://docs.errata.ai/vale/styles#metric +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: metric -message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." +message: "The grade level is %s. Aim for 8th grade or lower by using shorter sentences and words." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score level: suggestion formula: | diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index ca9948844f8..d9f20fa1bd6 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -3,10 +3,10 @@ # # Checks for reference-style links that should be converted to inline links. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be inline.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put this link inline with the rest of the text." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index 14ffc4bd0b8..6d46e432e08 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -3,11 +3,11 @@ # # Checks for the presence of absolute hyperlinks that should be relative. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be a relative link with a .md extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Use a relative link instead of a URL, and ensure the file name ends in .md and not .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: - - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/[ce]e.*\)' + - '\[[^\]]+\]\(https?:\/\/docs\.gitlab\.com\/[ce]e.*?\)' diff --git a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml index ce6ce8b5691..6a94c7f927a 100644 --- a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml +++ b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml @@ -3,10 +3,10 @@ # # Checks for the presence of double slashes in relative URLs. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Relative links must not include a double slash.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Remove the double slash from this relative link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab/Repetition.yml index c4b0cc14192..cdeb29e7d45 100644 --- a/doc/.vale/gitlab/Repetition.yml +++ b/doc/.vale/gitlab/Repetition.yml @@ -3,9 +3,9 @@ # # Checks for duplicate words, like `the the` or `and and`. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: repetition -message: '"%s" is repeated.' +message: "Remove this duplicate word: '%s'." level: error alpha: true tokens: diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index c60df1803e2..69b0d27072e 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -3,9 +3,9 @@ # # Counts words in a sentence and alerts if a sentence exceeds 25 words. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: occurrence -message: 'Shorter sentences improve readability (max 25 words).' +message: "Improve readability by using fewer than 25 words in this sentence." scope: sentence link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: warning diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index 0288abe834f..9ca685b00b8 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -3,9 +3,9 @@ # # Checks for incorrect spacing (no spaces, or more than one space) around punctuation. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: '"%s" must contain one and only one space.' +message: "Remove the extra space: '%s'" link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: error nonword: true diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index 44e78f89c20..89169c1aa46 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -3,12 +3,12 @@ # # Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.' +message: "Remove '%s'. Be precise instead of subjective." level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html tokens: - easy - easily diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 4ebaf7bfb70..92c5cb13b29 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -8,9 +8,9 @@ # Commands, like `git clone` must use backticks, and must not be added to the # exceptions. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: spelling -message: 'Spelling check: "%s"?' +message: "Check the spelling of '%s'. If the spelling is correct, add this word to the spelling exception list." level: warning ignore: - gitlab/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index 4b77def065d..21cabf1e0a7 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -4,25 +4,26 @@ # Suggests better options for frequently misused terms that are often - but not always - incorrect. # SubstitutionWarning.yml and Substitutions.yml also exist. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Consider %s instead of "%s".' +message: "Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: - active user: '"billable user"' - active users: '"billable users"' - docs: '"documentation"' - e-mail: '"email"' - GLFM: '"GitLab Flavored Markdown"' - it is recommended: '"we recommend"' + active user: "billable user" + active users: "billable users" + docs: "documentation" + e-mail: "email" + GLFM: "GitLab Flavored Markdown" + it is recommended: "you should" + we recommend: "you should" navigate: go - OAuth2: '"OAuth 2.0"' - once that: '"after that"' - once the: '"after the"' - once you: '"after you"' - since: '"because" or "after"' - sub-group: '"subgroup"' - sub-groups: '"subgroups"' - within: '"in"' + OAuth2: "OAuth 2.0" + once that: "after that" + once the: "after the" + once you: "after you" + since: "because' or 'after" + sub-group: "subgroup" + sub-groups: "subgroups" + within: "in" diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index d17015b97fd..8d6c18c1520 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -4,26 +4,26 @@ # Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors. # Substitutions.yml and SubstitionSuggestions.yml also exist. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'If possible, use "%s" instead of "%s".' +message: "If possible, use %s instead of '%s'." link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: warning ignorecase: true swap: - air(?:-| )?gapped: offline environment - bullet: list item - click: select - code base: codebase - config: configuration - deselect: clear - deselected: cleared - distro: distribution - file name: filename - filesystem: file system - GFM: GLFM - info: information - n/a: not applicable - repo: repository - timezone: time zone - utilize: use + air(?:-| )?gapped: "offline environment" + bullet: "list item" + click: "select" + code base: "codebase" + config: "configuration" + deselect: "clear" + deselected: "cleared" + distro: "distribution" + file name: "filename" + filesystem: "file system" + GFM: "'GitLab Flavored Markdown' or 'GitHub Flavored Markdown'" + info: "information" + n/a: "not applicable" + repo: "repository" + timezone: "time zone" + utilize: "use" diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index af426fa7e06..92791486491 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -4,9 +4,9 @@ # Checks for misused terms that should never be used at GitLab. # SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s".' +message: "Use '%s' instead of '%s'." link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab/ToDo.yml index a3725cb7f6b..079f13baa28 100644 --- a/doc/.vale/gitlab/ToDo.yml +++ b/doc/.vale/gitlab/ToDo.yml @@ -3,10 +3,10 @@ # # You should not use "To Do", unless it refers to the UI element. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "to-do item" in most cases, or "Add a to do" if referring to the UI button.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#feature-names +message: "Use 'to-do item' in most cases, or 'Add a to do' if referring to the UI button." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#to-do-item level: warning ignorecase: false swap: diff --git a/doc/.vale/gitlab/UnclearAntecedent.yml b/doc/.vale/gitlab/UnclearAntecedent.yml index 5f238598d9f..e5d43b6ab7d 100644 --- a/doc/.vale/gitlab/UnclearAntecedent.yml +++ b/doc/.vale/gitlab/UnclearAntecedent.yml @@ -3,9 +3,9 @@ # # Checks for words that need a noun for clarity. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "'%s' is not precise. Try rewriting with a specific subject and verb." +message: "Instead of '%s', try starting this sentence with a specific subject and verb." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#this-these-that-those level: warning ignorecase: false diff --git a/doc/.vale/gitlab/Units.yml b/doc/.vale/gitlab/Units.yml new file mode 100644 index 00000000000..4211fdee38b --- /dev/null +++ b/doc/.vale/gitlab/Units.yml @@ -0,0 +1,15 @@ +--- +# Suggestion: gitlab.Units +# +# Recommends a space between a number and a unit of measure. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Add a space between the number and the unit in '%s'." +link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/' +nonword: true +level: suggestion +ignorecase: true +tokens: + - \d+(?:B|kB|KiB|MB|MiB|GB|GiB|TB|TiB) + - \d+(?:ns|ms|μs|s|min|h|d) diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index dc05aa05730..f53e1c72dcb 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -3,9 +3,9 @@ # # Checks for use of all uppercase letters with unknown reason. # -# For a list of all options, see https://docs.errata.ai/vale/styles. +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: conditional -message: "'%s' is uppercase. Use lowercase or `backticks` if possible. Otherwise add this word to the rule's exception list." +message: "Instead of uppercase for '%s', use lowercase or backticks (`) if possible. Otherwise, add this word or acronym to the rule's exception list." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-uppercase-acronym-test level: warning ignorecase: false @@ -25,6 +25,7 @@ exceptions: - ARN - ASCII - ASG + - AST - AWS - BMP - BSD @@ -144,6 +145,7 @@ exceptions: - NOTE - NPM - NTP + - OCI - OKD - ONLY - OSS diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index 571fba52ab7..4fd80bc3f4e 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -9,9 +9,9 @@ # - `> Introduced in GitLab 14.0. # - `> Removed in GitLab 15.0. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.' +message: "Start each entry with `> -`. Keep long entries on one line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw diff --git a/doc/.vale/gitlab/VersionTextSingleLine.yml b/doc/.vale/gitlab/VersionTextSingleLine.yml index f76574bcf8a..552ccb9951e 100644 --- a/doc/.vale/gitlab/VersionTextSingleLine.yml +++ b/doc/.vale/gitlab/VersionTextSingleLine.yml @@ -3,9 +3,9 @@ # # Verifies that single-item version notes don't have a hyphen. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Version text with only a single item must not start with a hyphen.' +message: "Do not use a hyphen '-' in version text if there is only a single item." link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item level: error scope: raw diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab/Wordy.yml index 7888d16dadb..45546435ee9 100644 --- a/doc/.vale/gitlab/Wordy.yml +++ b/doc/.vale/gitlab/Wordy.yml @@ -3,15 +3,15 @@ # # Suggests shorter versions of wordy phrases. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: '%s "%s".' +message: "%s" link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: - in order to: "Be concise: use 'to' rather than" - needs? to: "Rewrite the sentence, or use 'must', instead of" - note that: "Be concise: rewrite the sentence to not use" - please: "Remove this word from the sentence: " - respectively: "Rewrite the sentence to be more precise, instead of using " + note that: "Remove the phrase 'note that'." + please: "Use 'please' only if we've inconvenienced the user." + respectively: "Remove 'respectively' and list each option instead." + and so on: "Remove 'and so on'. Try to use 'like' and provide examples instead." + in order to: "Remove 'in order' and leave 'to'." diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 5d268fdb241..0fc7c9703ac 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -546,6 +546,7 @@ relicensing remediations renderers replicables +rpcs repmgr repmgrd repurposing @@ -570,6 +571,7 @@ roadmap roadmaps rollout rollouts +RSpec rsync rsynced rsyncing @@ -613,6 +615,7 @@ Silverlight Sisense Sitespeed skippable +skopeo Slack Slackbot Slony diff --git a/doc/.vale/vale-json.tmpl b/doc/.vale/vale-json.tmpl index ed3c3259df3..7969cb704a0 100644 --- a/doc/.vale/vale-json.tmpl +++ b/doc/.vale/vale-json.tmpl @@ -1,47 +1,28 @@ {{- /* Modify Vale's output https://docs.errata.ai/vale/cli#--output */ -}} -{{- /* Keep track of our various counts */ -}} +{{- $fileIndexes := len .Files -}} +{{- $fileIndexes = sub $fileIndexes 1 -}} -{{- $e := 0 -}} -{{- $w := 0 -}} -{{- $s := 0 -}} -{{- $f := 0 -}} - -{{- /* Range over the linted files */ -}} - -{{- range .Files}} - -{{- $f = add1 $f -}} -{{- $path := .Path -}} - -{{- /* Range over the file's alerts */ -}} [ - -{{- range $idx, $a := .Alerts -}} - -{{- $error := "" -}} -{{- if eq .Severity "error" -}} - {{- $error = .Severity -}} - {{- $e = add1 $e -}} -{{- else if eq .Severity "warning" -}} - {{- $error = .Severity -}} - {{- $w = add1 $w -}} -{{- else -}} - {{- $error = .Severity -}} - {{- $s = add1 $s -}} -{{- end}} - -{{- /* Variables setup */ -}} - -{{- $path = $path -}} -{{- $loc := printf "%d" .Line -}} -{{- $check := printf "%s" .Check -}} -{{- $message := printf "%s" .Message -}} -{{- $link := printf "%s" .Link -}} -{{- if $idx -}},{{- end -}} - -{{- /* Output */ -}} - + {{- /* Range over the linted files */ -}} + {{- range $idx1, $a := .Files -}} + {{- $path := .Path -}} + + {{/* Range over the file's alerts */}} + {{- range $idx2, $b := .Alerts -}} + {{- $error := "info" -}} + {{- if eq .Severity "error" -}} + {{- $error = "blocker" -}} + {{- else if eq .Severity "warning" -}} + {{- $error = "major" -}} + {{- end}} + + {{- /* Variables setup */ -}} + {{- $loc := printf "%d" .Line -}} + {{- $message := printf "%s" .Message -}} + {{- if $idx2 -}},{{- end -}} + + {{/* Output */}} { "description": "{{ $message }}", "fingerprint": "{{ $path }}-{{ $loc }}", @@ -53,6 +34,6 @@ } } } -{{end -}} -{{end -}} + {{- end}}{{- if (lt $idx1 $fileIndexes) -}},{{- end -}} + {{- end}} ] |