diff --git a/docs/.vale.ini b/docs/.vale.ini index 57fa9b375bbdb..fdabbe6f26ece 100644 --- a/docs/.vale.ini +++ b/docs/.vale.ini @@ -1,11 +1,11 @@ StylesPath = "vale/styles" MinAlertLevel = suggestion -Packages = Google, Microsoft +Packages = Google Vocab = Dagster [*.{md,mdx,rst}] -BasedOnStyles = Vale, Google, Microsoft, Dagster +BasedOnStyles = Vale, Google, Dagster ; Ignore all :py directives IgnorePatterns = (:py:[^`]+`[^`]+`) @@ -13,17 +13,6 @@ IgnorePatterns = (:py:[^`]+`[^`]+`) ; Error on headings that aren't sentence cased. Google.Headings = Error -; these are already covered in Google which we prioritize -Microsoft.Contractions = NO -Microsoft.Headings = NO -Microsoft.Passive = NO -Microsoft.Spacing = NO -Microsoft.Semicolon = NO -Microsoft.GeneralURL = NO -Microsoft.We = NO -Microsoft.ComplexWords = NO -Microsoft.Vocab = NO - ; Google avoids using will, we don't need to check for this Google.Will = NO Google.WordList = NO diff --git a/docs/docs-next/package.json b/docs/docs-next/package.json index 5423a43e25206..7cc80bd7e67fa 100644 --- a/docs/docs-next/package.json +++ b/docs/docs-next/package.json @@ -28,6 +28,7 @@ "docusaurus-plugin-sass": "^0.2.5", "modern-normalize": "^2.0.0", "prism-react-renderer": "^2.3.0", + "raw-loader": "^4.0.2", "react": "^18.0.0", "react-dom": "^18.0.0" }, diff --git a/docs/docs-next/pnpm-lock.yaml b/docs/docs-next/pnpm-lock.yaml index d35039836a739..762579c58f54d 100644 --- a/docs/docs-next/pnpm-lock.yaml +++ b/docs/docs-next/pnpm-lock.yaml @@ -38,6 +38,9 @@ importers: prism-react-renderer: specifier: ^2.3.0 version: 2.3.1(react@18.3.1) + raw-loader: + specifier: ^4.0.2 + version: 4.0.2(webpack@5.93.0) react: specifier: ^18.0.0 version: 18.3.1 @@ -4704,6 +4707,12 @@ packages: resolution: {integrity: sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==} engines: {node: '>= 0.8'} + raw-loader@4.0.2: + resolution: {integrity: sha512-ZnScIV3ag9A4wPX/ZayxL/jZH+euYb6FcUinPcgiQW0+UBtEv0O6Q3lGd3cqJ+GHH+rksEv3Pj99oxJ3u3VIKA==} + engines: {node: '>= 10.13.0'} + peerDependencies: + webpack: ^4.0.0 || ^5.0.0 + rc@1.2.8: resolution: {integrity: sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==} hasBin: true @@ -11978,6 +11987,12 @@ snapshots: iconv-lite: 0.4.24 unpipe: 1.0.0 + raw-loader@4.0.2(webpack@5.93.0): + dependencies: + loader-utils: 2.0.4 + schema-utils: 3.3.0 + webpack: 5.93.0 + rc@1.2.8: dependencies: deep-extend: 0.6.0 diff --git a/docs/vale/styles/Dagster/section-heading-gerund.yml b/docs/vale/styles/Dagster/section-heading-gerund.yml index 62d1ba518c5d6..3342d45930d98 100644 --- a/docs/vale/styles/Dagster/section-heading-gerund.yml +++ b/docs/vale/styles/Dagster/section-heading-gerund.yml @@ -4,4 +4,4 @@ level: error scope: heading ignorecase: false raw: - '^(\w+ing\b.*)$' + ^(?!Troubleshooting)(\w+ing\b.*)$ diff --git a/docs/vale/styles/Microsoft/AMPM.yml b/docs/vale/styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed162ab72..0000000000000 --- a/docs/vale/styles/Microsoft/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -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]\.' diff --git a/docs/vale/styles/Microsoft/Accessibility.yml b/docs/vale/styles/Microsoft/Accessibility.yml deleted file mode 100644 index f5f482939212c..0000000000000 --- a/docs/vale/styles/Microsoft/Accessibility.yml +++ /dev/null @@ -1,30 +0,0 @@ -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 - - an epileptic - - birth defect - - crippled - - differently abled - - disabled - - dumb - - handicapped - - handicaps - - healthy person - - hearing-impaired - - lame - - maimed - - mentally handicapped - - missing a limb - - mute - - non-verbal - - normal person - - sight-impaired - - slow learner - - stricken with - - suffers from - - vision-impaired diff --git a/docs/vale/styles/Microsoft/Acronyms.yml b/docs/vale/styles/Microsoft/Acronyms.yml deleted file mode 100644 index 308ff7c0ed8cd..0000000000000 --- a/docs/vale/styles/Microsoft/Acronyms.yml +++ /dev/null @@ -1,64 +0,0 @@ -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 diff --git a/docs/vale/styles/Microsoft/Adverbs.yml b/docs/vale/styles/Microsoft/Adverbs.yml deleted file mode 100644 index 5619f99d8c9a5..0000000000000 --- a/docs/vale/styles/Microsoft/Adverbs.yml +++ /dev/null @@ -1,272 +0,0 @@ -extends: existence -message: "Remove '%s' if it's not important to the meaning of the statement." -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 - - effectively - - 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 - - quite - - 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 diff --git a/docs/vale/styles/Microsoft/Auto.yml b/docs/vale/styles/Microsoft/Auto.yml deleted file mode 100644 index 4da4393530d9e..0000000000000 --- a/docs/vale/styles/Microsoft/Auto.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "In general, don't hyphenate '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto -ignorecase: true -level: error -action: - name: convert - params: - - simple -tokens: - - 'auto-\w+' diff --git a/docs/vale/styles/Microsoft/Avoid.yml b/docs/vale/styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c79243..0000000000000 --- a/docs/vale/styles/Microsoft/Avoid.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "Don't use '%s'. See the A-Z word list for details." -# See the A-Z word list -link: https://docs.microsoft.com/en-us/style-guide -ignorecase: true -level: error -tokens: - - abortion - - and so on - - app(?:lication)?s? (?:developer|program) - - app(?:lication)? file - - backbone - - backend - - contiguous selection diff --git a/docs/vale/styles/Microsoft/Contractions.yml b/docs/vale/styles/Microsoft/Contractions.yml deleted file mode 100644 index 8c81dcbce7889..0000000000000 --- a/docs/vale/styles/Microsoft/Contractions.yml +++ /dev/null @@ -1,50 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error -ignorecase: true -action: - name: replace -swap: - are not: aren't - cannot: can't - could not: couldn't - did not: didn't - do not: don't - does not: doesn't - has not: hasn't - have not: haven't - how is: how's - is not: isn't - - 'it is(?!\.)': it's - 'it''s(?=\.)': it is - - should not: shouldn't - - "that is(?![.,])": that's - 'that''s(?=\.)': that is - - 'they are(?!\.)': they're - 'they''re(?=\.)': they are - - was not: wasn't - - 'we are(?!\.)': we're - 'we''re(?=\.)': we are - - 'we have(?!\.)': we've - 'we''ve(?=\.)': we have - - were not: weren't - - 'what is(?!\.)': what's - 'what''s(?=\.)': what is - - 'when is(?!\.)': when's - 'when''s(?=\.)': when is - - 'where is(?!\.)': where's - 'where''s(?=\.)': where is - - will not: won't diff --git a/docs/vale/styles/Microsoft/Dashes.yml b/docs/vale/styles/Microsoft/Dashes.yml deleted file mode 100644 index 72b05ba3e5680..0000000000000 --- a/docs/vale/styles/Microsoft/Dashes.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Remove the spaces around '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes -ignorecase: true -nonword: true -level: error -action: - name: edit - params: - - trim - - " " -tokens: - - '\s[—–]\s|\s[—–]|[—–]\s' diff --git a/docs/vale/styles/Microsoft/DateFormat.yml b/docs/vale/styles/Microsoft/DateFormat.yml deleted file mode 100644 index 196531394ac74..0000000000000 --- a/docs/vale/styles/Microsoft/DateFormat.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: Use 'July 31, 2016' format, not '%s'. -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/docs/vale/styles/Microsoft/DateNumbers.yml b/docs/vale/styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747ca23d..0000000000000 --- a/docs/vale/styles/Microsoft/DateNumbers.yml +++ /dev/null @@ -1,40 +0,0 @@ -extends: existence -message: "Don't use ordinal numbers for dates." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -level: error -nonword: true -ignorecase: true -raw: - - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* -tokens: - - first - - second - - third - - fourth - - fifth - - sixth - - seventh - - eighth - - ninth - - tenth - - eleventh - - twelfth - - thirteenth - - fourteenth - - fifteenth - - sixteenth - - seventeenth - - eighteenth - - nineteenth - - twentieth - - twenty-first - - twenty-second - - twenty-third - - twenty-fourth - - twenty-fifth - - twenty-sixth - - twenty-seventh - - twenty-eighth - - twenty-ninth - - thirtieth - - thirty-first diff --git a/docs/vale/styles/Microsoft/DateOrder.yml b/docs/vale/styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba51e40b..0000000000000 --- a/docs/vale/styles/Microsoft/DateOrder.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Always spell out the name of the month." -link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates -ignorecase: true -level: error -nonword: true -tokens: - - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/docs/vale/styles/Microsoft/Ellipses.yml b/docs/vale/styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8bc54a..0000000000000 --- a/docs/vale/styles/Microsoft/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/docs/vale/styles/Microsoft/FirstPerson.yml b/docs/vale/styles/Microsoft/FirstPerson.yml deleted file mode 100644 index f58dea3142001..0000000000000 --- a/docs/vale/styles/Microsoft/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Use first person (such as '%s') sparingly." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I(?=\s) - - (?:^|\s)I(?=,\s) - - \bI'd\b - - \bI'll\b - - \bI'm\b - - \bI've\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/docs/vale/styles/Microsoft/Foreign.yml b/docs/vale/styles/Microsoft/Foreign.yml deleted file mode 100644 index 0d3d6002a9a5e..0000000000000 --- a/docs/vale/styles/Microsoft/Foreign.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is - '\b(?:viz\.)[\s,]': namely - '\b(?:ergo)[\s,]': therefore diff --git a/docs/vale/styles/Microsoft/Gender.yml b/docs/vale/styles/Microsoft/Gender.yml deleted file mode 100644 index 47c0802479773..0000000000000 --- a/docs/vale/styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he diff --git a/docs/vale/styles/Microsoft/GenderBias.yml b/docs/vale/styles/Microsoft/GenderBias.yml deleted file mode 100644 index fc987b94e9384..0000000000000 --- a/docs/vale/styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,42 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/docs/vale/styles/Microsoft/GeneralURL.yml b/docs/vale/styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d995b0..0000000000000 --- a/docs/vale/styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL diff --git a/docs/vale/styles/Microsoft/HeadingAcronyms.yml b/docs/vale/styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 9dc3b6c2de730..0000000000000 --- a/docs/vale/styles/Microsoft/HeadingAcronyms.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Avoid using acronyms in a title or heading." -link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings -level: warning -scope: heading -tokens: - - '[A-Z]{2,4}' diff --git a/docs/vale/styles/Microsoft/HeadingColons.yml b/docs/vale/styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391486bf..0000000000000 --- a/docs/vale/styles/Microsoft/HeadingColons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Capitalize '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons -nonword: true -level: error -scope: heading -tokens: - - ':\s[a-z]' diff --git a/docs/vale/styles/Microsoft/HeadingPunctuation.yml b/docs/vale/styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index 4954cb11aeb92..0000000000000 --- a/docs/vale/styles/Microsoft/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't use end punctuation in headings." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - trim_right - - ".?!" -tokens: - - "[a-z][.?!]$" diff --git a/docs/vale/styles/Microsoft/Headings.yml b/docs/vale/styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc1b4c8..0000000000000 --- a/docs/vale/styles/Microsoft/Headings.yml +++ /dev/null @@ -1,28 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: https://docs.microsoft.com/en-us/style-guide/capitalization -level: suggestion -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/docs/vale/styles/Microsoft/Hyphens.yml b/docs/vale/styles/Microsoft/Hyphens.yml deleted file mode 100644 index 7e5731c995559..0000000000000 --- a/docs/vale/styles/Microsoft/Hyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -level: warning -ignorecase: false -nonword: true -action: - name: edit - params: - - regex - - "-" - - " " -tokens: - - '\b[^\s-]+ly-\w+\b' diff --git a/docs/vale/styles/Microsoft/Negative.yml b/docs/vale/styles/Microsoft/Negative.yml deleted file mode 100644 index d73221f539059..0000000000000 --- a/docs/vale/styles/Microsoft/Negative.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Form a negative number with an en dash, not a hyphen." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - regex - - "-" - - "–" -tokens: - - '(?<=\s)-\d+(?:\.\d+)?\b' diff --git a/docs/vale/styles/Microsoft/Ordinal.yml b/docs/vale/styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e380c7c2..0000000000000 --- a/docs/vale/styles/Microsoft/Ordinal.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't add -ly to an ordinal number." -link: https://docs.microsoft.com/en-us/style-guide/numbers -level: error -action: - name: edit - params: - - trim - - ly -tokens: - - firstly - - secondly - - thirdly diff --git a/docs/vale/styles/Microsoft/OxfordComma.yml b/docs/vale/styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3ce4f2..0000000000000 --- a/docs/vale/styles/Microsoft/OxfordComma.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas -scope: sentence -level: suggestion -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/docs/vale/styles/Microsoft/Passive.yml b/docs/vale/styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377cac81f..0000000000000 --- a/docs/vale/styles/Microsoft/Passive.yml +++ /dev/null @@ -1,183 +0,0 @@ -extends: existence -message: "'%s' looks like passive voice." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/docs/vale/styles/Microsoft/Percentages.yml b/docs/vale/styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363f471a..0000000000000 --- a/docs/vale/styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' diff --git a/docs/vale/styles/Microsoft/Plurals.yml b/docs/vale/styles/Microsoft/Plurals.yml deleted file mode 100644 index 1bb6660ade814..0000000000000 --- a/docs/vale/styles/Microsoft/Plurals.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't add '%s' to a singular noun. Use plural instead." -ignorecase: true -level: error -link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/s-es -raw: - - '\(s\)|\(es\)' diff --git a/docs/vale/styles/Microsoft/Quotes.yml b/docs/vale/styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f497606197e..0000000000000 --- a/docs/vale/styles/Microsoft/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: 'Punctuation should be inside the quotes.' -link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: error -nonword: true -tokens: - - '["“][^"”“]+["”][.,]' diff --git a/docs/vale/styles/Microsoft/RangeTime.yml b/docs/vale/styles/Microsoft/RangeTime.yml deleted file mode 100644 index 72d8bbfbe3ef8..0000000000000 --- a/docs/vale/styles/Microsoft/RangeTime.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use 'to' instead of a dash in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -action: - name: edit - params: - - regex - - "[-–]" - - "to" -tokens: - - '\b(?:AM|PM)\s?[-–]\s?.+(?:AM|PM)\b' diff --git a/docs/vale/styles/Microsoft/Semicolon.yml b/docs/vale/styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467dd262..0000000000000 --- a/docs/vale/styles/Microsoft/Semicolon.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Try to simplify this sentence." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/docs/vale/styles/Microsoft/SentenceLength.yml b/docs/vale/styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf0513b37..0000000000000 --- a/docs/vale/styles/Microsoft/SentenceLength.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: occurrence -message: "Try to keep sentences short (< 30 words)." -scope: sentence -level: suggestion -max: 30 -token: \b(\w+)\b - diff --git a/docs/vale/styles/Microsoft/Spacing.yml b/docs/vale/styles/Microsoft/Spacing.yml deleted file mode 100644 index bbd10e51df713..0000000000000 --- a/docs/vale/styles/Microsoft/Spacing.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' diff --git a/docs/vale/styles/Microsoft/Suspended.yml b/docs/vale/styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9cf5da..0000000000000 --- a/docs/vale/styles/Microsoft/Suspended.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use '%s' unless space is limited." -link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens -ignorecase: true -level: warning -tokens: - - '\w+- and \w+-' diff --git a/docs/vale/styles/Microsoft/Terms.yml b/docs/vale/styles/Microsoft/Terms.yml deleted file mode 100644 index 65fca10aaa85f..0000000000000 --- a/docs/vale/styles/Microsoft/Terms.yml +++ /dev/null @@ -1,42 +0,0 @@ -extends: substitution -message: "Prefer '%s' over '%s'." -# term preference should be based on microsoft style guide, such as -link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/adapter -level: warning -ignorecase: true -action: - name: replace -swap: - "(?:agent|virtual assistant|intelligent personal assistant)": personal digital assistant - "(?:assembler|machine language)": assembly language - "(?:drive C:|drive C>|C: drive)": drive C - "(?:internet bot|web robot)s?": bot(s) - "(?:microsoft cloud|the cloud)": cloud - "(?:mobile|smart) ?phone": phone - "24/7": every day - "audio(?:-| )book": audiobook - "back(?:-| )light": backlight - "chat ?bots?": chatbot(s) - adaptor: adapter - administrate: administer - afterwards: afterward - alphabetic: alphabetical - alphanumerical: alphanumeric - an URL: a URL - anti-aliasing: antialiasing - anti-malware: antimalware - anti-spyware: antispyware - anti-virus: antivirus - appendixes: appendices - artificial intelligence: AI - caap: CaaP - conversation-as-a-platform: conversation as a platform - eb: EB - gb: GB - gbps: Gbps - kb: KB - keypress: keystroke - mb: MB - pb: PB - tb: TB - zb: ZB diff --git a/docs/vale/styles/Microsoft/URLFormat.yml b/docs/vale/styles/Microsoft/URLFormat.yml deleted file mode 100644 index 4e24aa59fe0a9..0000000000000 --- a/docs/vale/styles/Microsoft/URLFormat.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: substitution -message: Use 'of' (not 'for') to describe the relationship of the word URL to a resource. -ignorecase: true -link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/u/url -level: suggestion -action: - name: replace -swap: - URL for: URL of diff --git a/docs/vale/styles/Microsoft/Units.yml b/docs/vale/styles/Microsoft/Units.yml deleted file mode 100644 index f062418ee0d35..0000000000000 --- a/docs/vale/styles/Microsoft/Units.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: existence -message: "Don't spell out the number in '%s'." -link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms -level: error -raw: - - '[a-zA-Z]+\s' -tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' - - cm - - inches - - lb - - miles - - pounds diff --git a/docs/vale/styles/Microsoft/Vocab.yml b/docs/vale/styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b15ee63..0000000000000 --- a/docs/vale/styles/Microsoft/Vocab.yml +++ /dev/null @@ -1,25 +0,0 @@ -extends: existence -message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' -level: suggestion -ignorecase: true -tokens: - - above - - accessible - - actionable - - against - - alarm - - alert - - alias - - allows? - - and/or - - as well as - - assure - - author - - avg - - beta - - ensure - - he - - insure - - sample - - she diff --git a/docs/vale/styles/Microsoft/We.yml b/docs/vale/styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1bae48..0000000000000 --- a/docs/vale/styles/Microsoft/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/docs/vale/styles/Microsoft/Wordiness.yml b/docs/vale/styles/Microsoft/Wordiness.yml deleted file mode 100644 index 3d008d1894e2b..0000000000000 --- a/docs/vale/styles/Microsoft/Wordiness.yml +++ /dev/null @@ -1,127 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: suggestion -action: - name: replace -swap: - (?:extract|take away|eliminate): remove - (?:in order to|as a means to): to - (?:inform|let me know): tell - (?:previous|prior) to: before - (?:utilize|make use of): use - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of (?!a sudden|these): all - all of a sudden: suddenly - all of these: these - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - doomed to fail: doomed - drag and drop: drag - drag-and-drop: drag - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - establish connectivity: connect - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in addition: also - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for diff --git a/docs/vale/styles/Microsoft/meta.json b/docs/vale/styles/Microsoft/meta.json deleted file mode 100644 index 297719bbbff9e..0000000000000 --- a/docs/vale/styles/Microsoft/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Microsoft/releases.atom", - "vale_version": ">=1.0.0" -}