Vale

.github/styles/Metrics/characters.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s characters"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: characters
+condition: "> 0"

.github/styles/Metrics/complex_words.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s complex_words"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: complex_words
+condition: "> 0"

.github/styles/Metrics/long_words.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s long_words"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: long_words
+condition: "> 0"

.github/styles/Metrics/paragraphs.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s paragraphs"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: paragraphs
+condition: "> 0"

.github/styles/Metrics/polysyllabic_words.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s polysyllabic_words"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: polysyllabic_words
+condition: "> 0"

.github/styles/Metrics/sentences.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s sentences"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: sentences
+condition: "> 0"

.github/styles/Metrics/words.yml

@@ -0,0 +1,5 @@
+extends: metric
+message: "%s words"
+link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
+formula: words
+condition: "> 0"

.github/styles/Test/DumpScopes.yml

@@ -0,0 +1,35 @@
+extends: existence
+message: "%s"
+description: "Test extraction of selected scopes"
+link: none
+ignorecase: true
+level: suggestion
+scope:
+  # - heading
+  # - list
+  # - paragraph
+  # - sentence
+  # - blockquote
+  # - table
+  # - table.header
+  # - table.cell
+  # - table.caption
+  # - alt
+  # - title
+  # - summary
+  # - raw
+  # - text
+  # - text.frontmatter.weight
+  # - text.frontmatter.title
+  # - text.frontmatter.summary
+  # - text.frontmatter.menutitle
+  # - text.frontmatter.last_reviewed
+  # - text.frontmatter.draft
+  # - text.frontmatter.description
+  # - text.frontmatter.date
+  # - comment.line
+  # - comment.block
+  # - comment
+
+raw:
+  - (?s).*

.github/styles/Test/ScopeHeading.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH1.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h1
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH2.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h2
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH3.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h3
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH4.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h4
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH5.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h5
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeHeadingH6.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - heading.h6
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeParagraph.yml

@@ -0,0 +1,14 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+nonword: true
+scope:
+  - paragraph
+level: error
+raw:
+  - (?s).+$
+
+# vale adds in the (?i)(?m)\b(?: automatically
+# error parsing regexp: invalid nested repetition operator in `(?i)(?m)\b(?:(?:^.+{20}))\b`

.github/styles/Test/ScopeRaw.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - raw
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeSentence.yml

@@ -0,0 +1,14 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://a.link
+ignorecase: true
+nonword: true
+scope:
+  - sentence
+level: error
+raw:
+  - (?s).+$
+
+# vale adds in the (?i)(?m)\b(?: automatically
+# revealed by error parsing regexp: invalid nested repetition operator in `(?i)(?m)\b(?:(?:^.+{20}))\b`

.github/styles/Test/ScopeTableCaption.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://docs.microsoft.com/en-us/style-guide
+ignorecase: true
+scope:
+  - table.caption
+level: error
+raw:
+  - (?s).+$

.github/styles/Test/ScopeText.yml

@@ -0,0 +1,10 @@
+extends: existence
+message: "%s"
+description: "This is the description"
+link: https://the.link
+ignorecase: true
+scope:
+  - text
+level: error
+raw:
+  - (?s).+$

.github/styles/Velociraptor/Spelling-Dictionaries.yml

@@ -0,0 +1,84 @@
+extends: spelling
+message: "The word '%s' was not found in any dictionaries. Is it a spelling mistake?"
+link: ""
+description: |
+  Checks words against several standard dictionaries.
+
+  There are several ways to exempt words and phrases from dictionary
+  checks:
+
+  * Enclose the word/phrase in backticks (++`xyz`++) to mark it as
+  `literal text`.
+  * ALL UPPERCASE words (which are usually acronyms)
+  are exempt from spell-checking.
+
+  If a word is flagged for spelling because it's not a dictionary word
+  then it might be a hint that the word could be a proper noun lacking
+  capitalisation or that the word might need to be in +++`literal
+  format`+++ (enclosed in backticks). In general, use `literal format`
+  for `commands`, `variables`, and `settings`.
+level: error
+scope:
+  # - heading
+  # - list
+  # - paragraph
+  # - sentence
+  # - blockquote
+  # - table
+  # - table.header
+  # - table.cell
+  # - table.caption
+  # - alt
+  # - title
+  # - summary
+  # - raw
+  # - text
+  # - text.frontmatter.weight
+  # - text.frontmatter.title
+  # - text.frontmatter.summary
+  # - text.frontmatter.menutitle
+  # - text.frontmatter.last_reviewed
+  # - text.frontmatter.draft
+  # - text.frontmatter.description
+  # - text.frontmatter.date
+  # - comment.line
+  # - comment.block
+  # - comment
+
+# Adds the array of dictionaries after the default Vale dictionary, instead of replacing it.
+append: false
+
+filters:
+  # likely filenames and extensions
+  - '\w{3,}\.[a-z]{2,4}(\.[a-z]{2,4})?'
+  - '\.\w{2,4}'
+  # likely function names
+  - '[\w_]+\((.*?\))?'
+  - '([a-z]+)?_([a-z]+)?(\()?'
+  # likely variable names
+  - '\w+=.*'
+  - '[A-Z]{1}[a-z]+[A-Z]+[0-9A-Za-z_]+(=.*)?'
+  - '\w+\$(=.*)?'
+  - '\$\w+(=.*)?'
+  # like Brands or Personal Names
+  - '[A-Z][a-z]+\b'
+  - '[A-Z][a-z]+[A-Z][a-z]+\b'
+  - '[A-Z]{2,3}[a-z0-9]+\b'
+  # Ignore all words starting with 'py' - e.g., 'PyYAML'.
+  - '[pP]y.*\b'
+  # strings with slashes before, in, or after them - e.g. and/or
+  - '[\w]*/[\w]*'
+  # ACRONYMS
+  - '[A-Z_-]{3,}['']?s?\b'
+  - '[A-Z0-9]{2,}['']?s?\b'
+action:
+  name: suggest
+  params:
+    - spellings
+dicpath: config/dictionaries
+dictionaries:
+  - en_US-web
+  - en_CA
+  - gitlab
+
+