-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Add vale ini and styles for docs linting (#385)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Maximilian Schulz <[email protected]>
- Loading branch information
3 people
authored
Mar 27, 2024
1 parent
bcfa0d1
commit 74ee3b5
Showing
49 changed files
with
1,369 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,6 +98,12 @@ repos: | |
| - [email protected] | ||
| args: ["--fix"] | ||
|
|
||
| - repo: https://github.com/errata-ai/vale | ||
| rev: 16d3a7f | ||
| hooks: | ||
| - id: vale | ||
| args: [--config=.vale/.vale.ini] | ||
|
|
||
| # Configuration for https://pre-commit.ci/. | ||
| ci: | ||
| autoupdate_schedule: monthly | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| StylesPath = styles | ||
|
|
||
| MinAlertLevel = suggestion | ||
|
|
||
|
|
||
| [*.md] | ||
| Vale.Spelling = NO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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]\.' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| 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: | ||
| - AI | ||
| - API | ||
| - ALT | ||
| - ASP | ||
| - CLI | ||
| - CPU | ||
| - CSS | ||
| - CSV | ||
| - DEBUG | ||
| - DOM | ||
| - DPI | ||
| - FAQ | ||
| - GCC | ||
| - GDB | ||
| - GDP | ||
| - GET | ||
| - GPU | ||
| - GTK | ||
| - GUI | ||
| - HTML | ||
| - HTTP | ||
| - HTTPS | ||
| - IDE | ||
| - JAR | ||
| - JSON | ||
| - JSX | ||
| - LESS | ||
| - LLDB | ||
| - LLM | ||
| - NET | ||
| - NOTE | ||
| - NVDA | ||
| - OSS | ||
| - PATH | ||
| - PHP | ||
| - POST | ||
| - RAM | ||
| - REPL | ||
| - RSA | ||
| - SCM | ||
| - SCSS | ||
| - SDK | ||
| - SQL | ||
| - SSH | ||
| - SSL | ||
| - SVG | ||
| - TBD | ||
| - TCP | ||
| - TODO | ||
| - URI | ||
| - URL | ||
| - USB | ||
| - UTF | ||
| - Vizro-AI | ||
| - WSGI | ||
| - XML | ||
| - XSS | ||
| - YAML | ||
| - ZIP |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
Oops, something went wrong.