Add vale linter

README.md

@@ -423,7 +423,7 @@ They can be defined as environment variables or resource parameters (has priorit
 
 If you'd like to contribute to this project please see [Contributing Rules](CONTRIBUTING.md). 
 
-For a detailed walk-through of resource creation, see the [Resource Creation Guide](docs/resource_creation_guide.md).
+For a detailed walk-through of resource creation, see the [Resource Creation Guide](dev-docs/resource_creation_guide.md).
 
 ### Developing a Static Resource
 

docs/.vale.ini

@@ -0,0 +1,17 @@
+# Vale configuration file.
+#
+# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration.
+
+StylesPath = tools/vale
+MinAlertLevel = suggestion
+
+[*.md]
+BasedOnStyles = Microsoft, write-good, chef
+
+Microsoft.Contractions = NO
+Microsoft.Headings = NO
+Microsoft.GeneralURL = NO
+Microsoft.RangeFormat = NO
+
+# Ignore SVG markup
+TokenIgnores = (\*\*\{\w*\}\*\*)

docs/tools/vale/Microsoft/AMPM.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: Use 'AM' or 'PM' (preceded by a space).
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
+level: error
+nonword: true
+tokens:
+  - '\d{1,2}[AP]M'
+  - '\d{1,2} ?[ap]m'
+  - '\d{1,2} ?[aApP]\.[mM]\.'

docs/tools/vale/Microsoft/Accessibility.yml

@@ -0,0 +1,25 @@
+extends: existence
+message: "Don't use language (such as '%s') that defines people by their disability."
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms
+level: suggestion
+ignorecase: true
+tokens:
+  - a victim of
+  - able-bodied
+  - affected by
+  - an epileptic
+  - crippled
+  - disabled
+  - dumb
+  - handicapped
+  - handicaps
+  - healthy
+  - lame
+  - maimed
+  - missing a limb
+  - mute
+  - normal
+  - sight-impaired
+  - stricken with
+  - suffers from
+  - vision-impaired

docs/tools/vale/Microsoft/Acronyms.yml

@@ -0,0 +1,64 @@
+extends: conditional
+message: "'%s' has no definition."
+link: https://docs.microsoft.com/en-us/style-guide/acronyms
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - API
+  - ASP
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DEBUG
+  - DOM
+  - DPI
+  - FAQ
+  - GCC
+  - GDB
+  - GET
+  - GPU
+  - GTK
+  - GUI
+  - HTML
+  - HTTP
+  - HTTPS
+  - IDE
+  - JAR
+  - JSON
+  - JSX
+  - LESS
+  - LLDB
+  - NET
+  - NOTE
+  - NVDA
+  - OSS
+  - PATH
+  - PDF
+  - PHP
+  - POST
+  - RAM
+  - REPL
+  - RSA
+  - SCM
+  - SCSS
+  - SDK
+  - SQL
+  - SSH
+  - SSL
+  - SVG
+  - TBD
+  - TCP
+  - TODO
+  - URI
+  - URL
+  - USB
+  - UTF
+  - XML
+  - XSS
+  - YAML
+  - ZIP

docs/tools/vale/Microsoft/Adverbs.yml

@@ -0,0 +1,270 @@
+extends: existence
+message: "Consider removing '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
+ignorecase: true
+level: warning
+action:
+  name: remove
+tokens:
+  - abnormally
+  - absentmindedly
+  - accidentally
+  - adventurously
+  - anxiously
+  - arrogantly
+  - awkwardly
+  - bashfully
+  - beautifully
+  - bitterly
+  - bleakly
+  - blindly
+  - blissfully
+  - boastfully
+  - boldly
+  - bravely
+  - briefly
+  - brightly
+  - briskly
+  - broadly
+  - busily
+  - calmly
+  - carefully
+  - carelessly
+  - cautiously
+  - cheerfully
+  - cleverly
+  - closely
+  - coaxingly
+  - colorfully
+  - continually
+  - coolly
+  - courageously
+  - crossly
+  - cruelly
+  - curiously
+  - daintily
+  - dearly
+  - deceivingly
+  - deeply
+  - defiantly
+  - deliberately
+  - delightfully
+  - diligently
+  - dimly
+  - doubtfully
+  - dreamily
+  - easily
+  - elegantly
+  - energetically
+  - enormously
+  - enthusiastically
+  - excitedly
+  - extremely
+  - fairly
+  - faithfully
+  - famously
+  - ferociously
+  - fervently
+  - fiercely
+  - fondly
+  - foolishly
+  - fortunately
+  - frankly
+  - frantically
+  - freely
+  - frenetically
+  - frightfully
+  - furiously
+  - generally
+  - generously
+  - gently
+  - gladly
+  - gleefully
+  - gracefully
+  - gratefully
+  - greatly
+  - greedily
+  - happily
+  - hastily
+  - healthily
+  - heavily
+  - helplessly
+  - honestly
+  - hopelessly
+  - hungrily
+  - innocently
+  - inquisitively
+  - intensely
+  - intently
+  - interestingly
+  - inwardly
+  - irritably
+  - jaggedly
+  - jealously
+  - jovially
+  - joyfully
+  - joyously
+  - jubilantly
+  - judgmentally
+  - justly
+  - keenly
+  - kiddingly
+  - kindheartedly
+  - knavishly
+  - knowingly
+  - knowledgeably
+  - lazily
+  - lightly
+  - limply
+  - lively
+  - loftily
+  - longingly
+  - loosely
+  - loudly
+  - lovingly
+  - loyally
+  - madly
+  - majestically
+  - meaningfully
+  - mechanically
+  - merrily
+  - miserably
+  - mockingly
+  - mortally
+  - mysteriously
+  - naturally
+  - nearly
+  - neatly
+  - nervously
+  - nicely
+  - noisily
+  - obediently
+  - obnoxiously
+  - oddly
+  - offensively
+  - optimistically
+  - overconfidently
+  - painfully
+  - partially
+  - patiently
+  - perfectly
+  - playfully
+  - politely
+  - poorly
+  - positively
+  - potentially
+  - powerfully
+  - promptly
+  - properly
+  - punctually
+  - quaintly
+  - queasily
+  - queerly
+  - questionably
+  - quickly
+  - quietly
+  - quirkily
+  - quizzically
+  - randomly
+  - rapidly
+  - rarely
+  - readily
+  - really
+  - reassuringly
+  - recklessly
+  - regularly
+  - reluctantly
+  - repeatedly
+  - reproachfully
+  - restfully
+  - righteously
+  - rightfully
+  - rigidly
+  - roughly
+  - rudely
+  - safely
+  - scarcely
+  - scarily
+  - searchingly
+  - sedately
+  - seemingly
+  - selfishly
+  - separately
+  - seriously
+  - shakily
+  - sharply
+  - sheepishly
+  - shrilly
+  - shyly
+  - silently
+  - sleepily
+  - slowly
+  - smoothly
+  - softly
+  - solemnly
+  - solidly
+  - speedily
+  - stealthily
+  - sternly
+  - strictly
+  - suddenly
+  - supposedly
+  - surprisingly
+  - suspiciously
+  - sweetly
+  - swiftly
+  - sympathetically
+  - tenderly
+  - tensely
+  - terribly
+  - thankfully
+  - thoroughly
+  - thoughtfully
+  - tightly
+  - tremendously
+  - triumphantly
+  - truthfully
+  - ultimately
+  - unabashedly
+  - unaccountably
+  - unbearably
+  - unethically
+  - unexpectedly
+  - unfortunately
+  - unimpressively
+  - unnaturally
+  - unnecessarily
+  - urgently
+  - usefully
+  - uselessly
+  - utterly
+  - vacantly
+  - vaguely
+  - vainly
+  - valiantly
+  - vastly
+  - verbally
+  - very
+  - viciously
+  - victoriously
+  - violently
+  - vivaciously
+  - voluntarily
+  - warmly
+  - weakly
+  - wearily
+  - wetly
+  - wholly
+  - wildly
+  - willfully
+  - wisely
+  - woefully
+  - wonderfully
+  - worriedly
+  - yawningly
+  - yearningly
+  - yieldingly
+  - youthfully
+  - zealously
+  - zestfully
+  - zestily