From 112dc4c1545a84586b58722704fdc1f15eb65564 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 24 Dec 2024 19:19:54 +0530 Subject: [PATCH 01/25] added vale prose linter to CI pipeline --- .github/workflows/vale.yml | 22 ++++++++++++++++++++++ .vale/config.json | 13 +++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 .github/workflows/vale.yml create mode 100644 .vale/config.json diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 00000000000..e77f4b6e900 --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,22 @@ +name: Check Prose with Vale + +on: + pull_request: + paths: + - '**/*.md' # You can specify other file extensions or directories if needed + +jobs: + vale: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Set up Vale + run: | + curl -sSL https://github.com/errata-ai/vale/releases/download/v2.12.0/vale_2.12.0_Linux_64-bit.tar.gz | tar -xz -C /tmp + sudo mv /tmp/vale /usr/local/bin/vale + + - name: Run Vale + run: | + vale . diff --git a/.vale/config.json b/.vale/config.json new file mode 100644 index 00000000000..f2616103bac --- /dev/null +++ b/.vale/config.json @@ -0,0 +1,13 @@ +{ + "Styles": [ + { + "Name": "Microsoft", + "Path": "https://github.com/errata-ai/vale/tree/master/styles/Microsoft" + } + ], + "MinAlertLevel": "warning", + "Extensions": [ + "md" + ] + } + \ No newline at end of file From a8eaab806c425042af8eb761a2b7d453b0b36995 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 24 Dec 2024 23:14:43 +0530 Subject: [PATCH 02/25] finished vale setup --- .github/workflows/vale.yml | 2 +- .pre-commit-config.yaml | 1 + .vale.ini | 21 ++ .vale/config.json | 1 - .vale/styles/Microsoft/AMPM.yml | 9 + .vale/styles/Microsoft/Accessibility.yml | 30 ++ .vale/styles/Microsoft/Acronyms.yml | 64 +++++ .vale/styles/Microsoft/Adverbs.yml | 272 ++++++++++++++++++ .vale/styles/Microsoft/Auto.yml | 11 + .vale/styles/Microsoft/Avoid.yml | 14 + .vale/styles/Microsoft/Contractions.yml | 50 ++++ .vale/styles/Microsoft/Dashes.yml | 13 + .vale/styles/Microsoft/DateFormat.yml | 8 + .vale/styles/Microsoft/DateNumbers.yml | 40 +++ .vale/styles/Microsoft/DateOrder.yml | 8 + .vale/styles/Microsoft/Ellipses.yml | 9 + .vale/styles/Microsoft/FirstPerson.yml | 16 ++ .vale/styles/Microsoft/Foreign.yml | 13 + .vale/styles/Microsoft/Gender.yml | 8 + .vale/styles/Microsoft/GenderBias.yml | 42 +++ .vale/styles/Microsoft/GeneralURL.yml | 11 + .vale/styles/Microsoft/HeadingAcronyms.yml | 7 + .vale/styles/Microsoft/HeadingColons.yml | 8 + .vale/styles/Microsoft/HeadingPunctuation.yml | 13 + .vale/styles/Microsoft/Headings.yml | 28 ++ .vale/styles/Microsoft/Hyphens.yml | 14 + .vale/styles/Microsoft/Negative.yml | 13 + .vale/styles/Microsoft/Ordinal.yml | 13 + .vale/styles/Microsoft/OxfordComma.yml | 8 + .vale/styles/Microsoft/Passive.yml | 183 ++++++++++++ .vale/styles/Microsoft/Percentages.yml | 7 + .vale/styles/Microsoft/Plurals.yml | 7 + .vale/styles/Microsoft/Quotes.yml | 7 + .vale/styles/Microsoft/RangeTime.yml | 13 + .vale/styles/Microsoft/Semicolon.yml | 8 + .vale/styles/Microsoft/SentenceLength.yml | 7 + .vale/styles/Microsoft/Spacing.yml | 8 + .vale/styles/Microsoft/Suspended.yml | 7 + .vale/styles/Microsoft/Terms.yml | 42 +++ .vale/styles/Microsoft/URLFormat.yml | 9 + .vale/styles/Microsoft/Units.yml | 16 ++ .vale/styles/Microsoft/Vocab.yml | 25 ++ .vale/styles/Microsoft/We.yml | 11 + .vale/styles/Microsoft/Wordiness.yml | 127 ++++++++ .vale/styles/Microsoft/meta.json | 4 + 45 files changed, 1226 insertions(+), 2 deletions(-) create mode 100644 .vale.ini create mode 100644 .vale/styles/Microsoft/AMPM.yml create mode 100644 .vale/styles/Microsoft/Accessibility.yml create mode 100644 .vale/styles/Microsoft/Acronyms.yml create mode 100644 .vale/styles/Microsoft/Adverbs.yml create mode 100644 .vale/styles/Microsoft/Auto.yml create mode 100644 .vale/styles/Microsoft/Avoid.yml create mode 100644 .vale/styles/Microsoft/Contractions.yml create mode 100644 .vale/styles/Microsoft/Dashes.yml create mode 100644 .vale/styles/Microsoft/DateFormat.yml create mode 100644 .vale/styles/Microsoft/DateNumbers.yml create mode 100644 .vale/styles/Microsoft/DateOrder.yml create mode 100644 .vale/styles/Microsoft/Ellipses.yml create mode 100644 .vale/styles/Microsoft/FirstPerson.yml create mode 100644 .vale/styles/Microsoft/Foreign.yml create mode 100644 .vale/styles/Microsoft/Gender.yml create mode 100644 .vale/styles/Microsoft/GenderBias.yml create mode 100644 .vale/styles/Microsoft/GeneralURL.yml create mode 100644 .vale/styles/Microsoft/HeadingAcronyms.yml create mode 100644 .vale/styles/Microsoft/HeadingColons.yml create mode 100644 .vale/styles/Microsoft/HeadingPunctuation.yml create mode 100644 .vale/styles/Microsoft/Headings.yml create mode 100644 .vale/styles/Microsoft/Hyphens.yml create mode 100644 .vale/styles/Microsoft/Negative.yml create mode 100644 .vale/styles/Microsoft/Ordinal.yml create mode 100644 .vale/styles/Microsoft/OxfordComma.yml create mode 100644 .vale/styles/Microsoft/Passive.yml create mode 100644 .vale/styles/Microsoft/Percentages.yml create mode 100644 .vale/styles/Microsoft/Plurals.yml create mode 100644 .vale/styles/Microsoft/Quotes.yml create mode 100644 .vale/styles/Microsoft/RangeTime.yml create mode 100644 .vale/styles/Microsoft/Semicolon.yml create mode 100644 .vale/styles/Microsoft/SentenceLength.yml create mode 100644 .vale/styles/Microsoft/Spacing.yml create mode 100644 .vale/styles/Microsoft/Suspended.yml create mode 100644 .vale/styles/Microsoft/Terms.yml create mode 100644 .vale/styles/Microsoft/URLFormat.yml create mode 100644 .vale/styles/Microsoft/Units.yml create mode 100644 .vale/styles/Microsoft/Vocab.yml create mode 100644 .vale/styles/Microsoft/We.yml create mode 100644 .vale/styles/Microsoft/Wordiness.yml create mode 100644 .vale/styles/Microsoft/meta.json diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index e77f4b6e900..5d1dabe40af 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -11,7 +11,7 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v3 - + - name: Set up Vale run: | curl -sSL https://github.com/errata-ai/vale/releases/download/v2.12.0/vale_2.12.0_Linux_64-bit.tar.gz | tar -xz -C /tmp diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7209ceebcac..c1fadee8ff0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,3 +32,4 @@ repos: "--ignore-words", ".codespellignore", ] + exclude: .vale/styles/Microsoft/Avoid.yml diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000000..ae07b708988 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,21 @@ +StylesPath = .vale/styles +MinAlertLevel = warning + +[*.md] +BasedOnStyles = Microsoft + +# Do not apply any style to .yml files (by simply not defining a style) +[*.yml] +BasedOnStyles = + +[.vale/**] +BasedOnStyles = + +[.github/**] +BasedOnStyles = + +[.vale/styles/Microsoft/**/*.yml] +BasedOnStyles = + +[*] +BasedOnStyles = \ No newline at end of file diff --git a/.vale/config.json b/.vale/config.json index f2616103bac..abd93b4b5eb 100644 --- a/.vale/config.json +++ b/.vale/config.json @@ -10,4 +10,3 @@ "md" ] } - \ No newline at end of file diff --git a/.vale/styles/Microsoft/AMPM.yml b/.vale/styles/Microsoft/AMPM.yml new file mode 100644 index 00000000000..8b9fed162ab --- /dev/null +++ b/.vale/styles/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]\.' diff --git a/.vale/styles/Microsoft/Accessibility.yml b/.vale/styles/Microsoft/Accessibility.yml new file mode 100644 index 00000000000..f5f48293921 --- /dev/null +++ b/.vale/styles/Microsoft/Accessibility.yml @@ -0,0 +1,30 @@ +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/.vale/styles/Microsoft/Acronyms.yml b/.vale/styles/Microsoft/Acronyms.yml new file mode 100644 index 00000000000..308ff7c0ed8 --- /dev/null +++ b/.vale/styles/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 diff --git a/.vale/styles/Microsoft/Adverbs.yml b/.vale/styles/Microsoft/Adverbs.yml new file mode 100644 index 00000000000..5619f99d8c9 --- /dev/null +++ b/.vale/styles/Microsoft/Adverbs.yml @@ -0,0 +1,272 @@ +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/.vale/styles/Microsoft/Auto.yml b/.vale/styles/Microsoft/Auto.yml new file mode 100644 index 00000000000..4da4393530d --- /dev/null +++ b/.vale/styles/Microsoft/Auto.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/Avoid.yml b/.vale/styles/Microsoft/Avoid.yml new file mode 100644 index 00000000000..dab7822c792 --- /dev/null +++ b/.vale/styles/Microsoft/Avoid.yml @@ -0,0 +1,14 @@ +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/.vale/styles/Microsoft/Contractions.yml b/.vale/styles/Microsoft/Contractions.yml new file mode 100644 index 00000000000..8c81dcbce78 --- /dev/null +++ b/.vale/styles/Microsoft/Contractions.yml @@ -0,0 +1,50 @@ +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/.vale/styles/Microsoft/Dashes.yml b/.vale/styles/Microsoft/Dashes.yml new file mode 100644 index 00000000000..72b05ba3e56 --- /dev/null +++ b/.vale/styles/Microsoft/Dashes.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/DateFormat.yml b/.vale/styles/Microsoft/DateFormat.yml new file mode 100644 index 00000000000..196531394ac --- /dev/null +++ b/.vale/styles/Microsoft/DateFormat.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/DateNumbers.yml b/.vale/styles/Microsoft/DateNumbers.yml new file mode 100644 index 00000000000..14d46747ca2 --- /dev/null +++ b/.vale/styles/Microsoft/DateNumbers.yml @@ -0,0 +1,40 @@ +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/.vale/styles/Microsoft/DateOrder.yml b/.vale/styles/Microsoft/DateOrder.yml new file mode 100644 index 00000000000..12d69ba51e4 --- /dev/null +++ b/.vale/styles/Microsoft/DateOrder.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Ellipses.yml b/.vale/styles/Microsoft/Ellipses.yml new file mode 100644 index 00000000000..320457a8bc5 --- /dev/null +++ b/.vale/styles/Microsoft/Ellipses.yml @@ -0,0 +1,9 @@ +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/.vale/styles/Microsoft/FirstPerson.yml b/.vale/styles/Microsoft/FirstPerson.yml new file mode 100644 index 00000000000..f58dea31420 --- /dev/null +++ b/.vale/styles/Microsoft/FirstPerson.yml @@ -0,0 +1,16 @@ +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/.vale/styles/Microsoft/Foreign.yml b/.vale/styles/Microsoft/Foreign.yml new file mode 100644 index 00000000000..0d3d6002a9a --- /dev/null +++ b/.vale/styles/Microsoft/Foreign.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Gender.yml b/.vale/styles/Microsoft/Gender.yml new file mode 100644 index 00000000000..47c08024797 --- /dev/null +++ b/.vale/styles/Microsoft/Gender.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/GenderBias.yml b/.vale/styles/Microsoft/GenderBias.yml new file mode 100644 index 00000000000..fc987b94e93 --- /dev/null +++ b/.vale/styles/Microsoft/GenderBias.yml @@ -0,0 +1,42 @@ +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/.vale/styles/Microsoft/GeneralURL.yml b/.vale/styles/Microsoft/GeneralURL.yml new file mode 100644 index 00000000000..dcef503d995 --- /dev/null +++ b/.vale/styles/Microsoft/GeneralURL.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/HeadingAcronyms.yml b/.vale/styles/Microsoft/HeadingAcronyms.yml new file mode 100644 index 00000000000..9dc3b6c2de7 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingAcronyms.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/HeadingColons.yml b/.vale/styles/Microsoft/HeadingColons.yml new file mode 100644 index 00000000000..7013c391486 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingColons.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/HeadingPunctuation.yml b/.vale/styles/Microsoft/HeadingPunctuation.yml new file mode 100644 index 00000000000..4954cb11aeb --- /dev/null +++ b/.vale/styles/Microsoft/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Headings.yml b/.vale/styles/Microsoft/Headings.yml new file mode 100644 index 00000000000..63624edc1b4 --- /dev/null +++ b/.vale/styles/Microsoft/Headings.yml @@ -0,0 +1,28 @@ +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/.vale/styles/Microsoft/Hyphens.yml b/.vale/styles/Microsoft/Hyphens.yml new file mode 100644 index 00000000000..7e5731c9955 --- /dev/null +++ b/.vale/styles/Microsoft/Hyphens.yml @@ -0,0 +1,14 @@ +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/.vale/styles/Microsoft/Negative.yml b/.vale/styles/Microsoft/Negative.yml new file mode 100644 index 00000000000..d73221f5390 --- /dev/null +++ b/.vale/styles/Microsoft/Negative.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Ordinal.yml b/.vale/styles/Microsoft/Ordinal.yml new file mode 100644 index 00000000000..e3483e380c7 --- /dev/null +++ b/.vale/styles/Microsoft/Ordinal.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/OxfordComma.yml b/.vale/styles/Microsoft/OxfordComma.yml new file mode 100644 index 00000000000..493b55c3ce4 --- /dev/null +++ b/.vale/styles/Microsoft/OxfordComma.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Passive.yml b/.vale/styles/Microsoft/Passive.yml new file mode 100644 index 00000000000..102d377cac8 --- /dev/null +++ b/.vale/styles/Microsoft/Passive.yml @@ -0,0 +1,183 @@ +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/.vale/styles/Microsoft/Percentages.yml b/.vale/styles/Microsoft/Percentages.yml new file mode 100644 index 00000000000..b68a7363f47 --- /dev/null +++ b/.vale/styles/Microsoft/Percentages.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Plurals.yml b/.vale/styles/Microsoft/Plurals.yml new file mode 100644 index 00000000000..1bb6660ade8 --- /dev/null +++ b/.vale/styles/Microsoft/Plurals.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Quotes.yml b/.vale/styles/Microsoft/Quotes.yml new file mode 100644 index 00000000000..38f49760619 --- /dev/null +++ b/.vale/styles/Microsoft/Quotes.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/RangeTime.yml b/.vale/styles/Microsoft/RangeTime.yml new file mode 100644 index 00000000000..72d8bbfbe3e --- /dev/null +++ b/.vale/styles/Microsoft/RangeTime.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Semicolon.yml b/.vale/styles/Microsoft/Semicolon.yml new file mode 100644 index 00000000000..4d905467dd2 --- /dev/null +++ b/.vale/styles/Microsoft/Semicolon.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/SentenceLength.yml b/.vale/styles/Microsoft/SentenceLength.yml new file mode 100644 index 00000000000..f248cf0513b --- /dev/null +++ b/.vale/styles/Microsoft/SentenceLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep sentences short (< 30 words)." +scope: sentence +level: suggestion +max: 30 +token: \b(\w+)\b + diff --git a/.vale/styles/Microsoft/Spacing.yml b/.vale/styles/Microsoft/Spacing.yml new file mode 100644 index 00000000000..bbd10e51df7 --- /dev/null +++ b/.vale/styles/Microsoft/Spacing.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Suspended.yml b/.vale/styles/Microsoft/Suspended.yml new file mode 100644 index 00000000000..7282e9c9cf5 --- /dev/null +++ b/.vale/styles/Microsoft/Suspended.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Terms.yml b/.vale/styles/Microsoft/Terms.yml new file mode 100644 index 00000000000..65fca10aaa8 --- /dev/null +++ b/.vale/styles/Microsoft/Terms.yml @@ -0,0 +1,42 @@ +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/.vale/styles/Microsoft/URLFormat.yml b/.vale/styles/Microsoft/URLFormat.yml new file mode 100644 index 00000000000..4e24aa59fe0 --- /dev/null +++ b/.vale/styles/Microsoft/URLFormat.yml @@ -0,0 +1,9 @@ +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/.vale/styles/Microsoft/Units.yml b/.vale/styles/Microsoft/Units.yml new file mode 100644 index 00000000000..f062418ee0d --- /dev/null +++ b/.vale/styles/Microsoft/Units.yml @@ -0,0 +1,16 @@ +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/.vale/styles/Microsoft/Vocab.yml b/.vale/styles/Microsoft/Vocab.yml new file mode 100644 index 00000000000..eebe97b15ee --- /dev/null +++ b/.vale/styles/Microsoft/Vocab.yml @@ -0,0 +1,25 @@ +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/.vale/styles/Microsoft/We.yml b/.vale/styles/Microsoft/We.yml new file mode 100644 index 00000000000..97c901c1bae --- /dev/null +++ b/.vale/styles/Microsoft/We.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/Wordiness.yml b/.vale/styles/Microsoft/Wordiness.yml new file mode 100644 index 00000000000..3d008d1894e --- /dev/null +++ b/.vale/styles/Microsoft/Wordiness.yml @@ -0,0 +1,127 @@ +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/.vale/styles/Microsoft/meta.json b/.vale/styles/Microsoft/meta.json new file mode 100644 index 00000000000..297719bbbff --- /dev/null +++ b/.vale/styles/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} From cdc94a3fd30e8aef50231a80b1d54b9149f30412 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 24 Dec 2024 23:33:00 +0530 Subject: [PATCH 03/25] configured vlae to run on push --- .github/workflows/vale.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 5d1dabe40af..858c66d549f 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -2,6 +2,9 @@ name: Check Prose with Vale on: pull_request: + paths: + - '**/*.md' + push: paths: - '**/*.md' # You can specify other file extensions or directories if needed From ff46b1bea99705be433bbcc006fb45a2dd0bc60b Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 24 Dec 2024 23:37:49 +0530 Subject: [PATCH 04/25] test to see if vale is working --- TESTVALE.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 TESTVALE.md diff --git a/TESTVALE.md b/TESTVALE.md new file mode 100644 index 00000000000..75c29ce40ed --- /dev/null +++ b/TESTVALE.md @@ -0,0 +1,16 @@ +# My Cool Project + +This is an awesome project that does all kinds of stuff. You can use it to solve your problems in no time. Just clone it and run it, and you’re good to go. It’s super simple. + +## Install +- Clone the repo with `git clone` +- Run `pip install -r requirements.txt` + +## Usage +Just run the main.py file and it should work, no worries. + +## Contributing +Feel free to contribute however you like! Fork the repo and make a pull request. + +## License +MIT License. \ No newline at end of file From c9ac5533e06944ed1388fbdb40b4aa4e94c6a735 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 24 Dec 2024 23:52:20 +0530 Subject: [PATCH 05/25] deleted test .md file --- TESTVALE.md | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 TESTVALE.md diff --git a/TESTVALE.md b/TESTVALE.md deleted file mode 100644 index 75c29ce40ed..00000000000 --- a/TESTVALE.md +++ /dev/null @@ -1,16 +0,0 @@ -# My Cool Project - -This is an awesome project that does all kinds of stuff. You can use it to solve your problems in no time. Just clone it and run it, and you’re good to go. It’s super simple. - -## Install -- Clone the repo with `git clone` -- Run `pip install -r requirements.txt` - -## Usage -Just run the main.py file and it should work, no worries. - -## Contributing -Feel free to contribute however you like! Fork the repo and make a pull request. - -## License -MIT License. \ No newline at end of file From 1ab114b30361a8fc5395d7366ded9865428ad16f Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 10:53:29 +0530 Subject: [PATCH 06/25] suppressed vale to allow the use of 'agent' --- .vale/styles/Microsoft/Terms.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale/styles/Microsoft/Terms.yml b/.vale/styles/Microsoft/Terms.yml index 65fca10aaa8..70552269f56 100644 --- a/.vale/styles/Microsoft/Terms.yml +++ b/.vale/styles/Microsoft/Terms.yml @@ -7,7 +7,6 @@ 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) From 9c004787d1bb5bc28bae77eeda30c79c76ce09dd Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 11:01:51 +0530 Subject: [PATCH 07/25] added testing.md --- testing.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 testing.md diff --git a/testing.md b/testing.md new file mode 100644 index 00000000000..1d89924fca5 --- /dev/null +++ b/testing.md @@ -0,0 +1,2 @@ +###Summary +Checking if vale reacts to the use of the term agent. \ No newline at end of file From df7fdee0a3c590a4882024e975ef760d5d9723b4 Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 13:24:34 +0530 Subject: [PATCH 08/25] delted ms files --- .github/workflows/vale.yml | 9 +- .vale/styles/Microsoft/AMPM.yml | 9 - .vale/styles/Microsoft/Accessibility.yml | 30 -- .vale/styles/Microsoft/Acronyms.yml | 64 ----- .vale/styles/Microsoft/Adverbs.yml | 272 ------------------ .vale/styles/Microsoft/Auto.yml | 11 - .vale/styles/Microsoft/Avoid.yml | 14 - .vale/styles/Microsoft/Contractions.yml | 50 ---- .vale/styles/Microsoft/Dashes.yml | 13 - .vale/styles/Microsoft/DateFormat.yml | 8 - .vale/styles/Microsoft/DateNumbers.yml | 40 --- .vale/styles/Microsoft/DateOrder.yml | 8 - .vale/styles/Microsoft/Ellipses.yml | 9 - .vale/styles/Microsoft/FirstPerson.yml | 16 -- .vale/styles/Microsoft/Foreign.yml | 13 - .vale/styles/Microsoft/Gender.yml | 8 - .vale/styles/Microsoft/GenderBias.yml | 42 --- .vale/styles/Microsoft/GeneralURL.yml | 11 - .vale/styles/Microsoft/HeadingAcronyms.yml | 7 - .vale/styles/Microsoft/HeadingColons.yml | 8 - .vale/styles/Microsoft/HeadingPunctuation.yml | 13 - .vale/styles/Microsoft/Headings.yml | 28 -- .vale/styles/Microsoft/Hyphens.yml | 14 - .vale/styles/Microsoft/Negative.yml | 13 - .vale/styles/Microsoft/Ordinal.yml | 13 - .vale/styles/Microsoft/OxfordComma.yml | 8 - .vale/styles/Microsoft/Passive.yml | 183 ------------ .vale/styles/Microsoft/Percentages.yml | 7 - .vale/styles/Microsoft/Plurals.yml | 7 - .vale/styles/Microsoft/Quotes.yml | 7 - .vale/styles/Microsoft/RangeTime.yml | 13 - .vale/styles/Microsoft/Semicolon.yml | 8 - .vale/styles/Microsoft/SentenceLength.yml | 7 - .vale/styles/Microsoft/Spacing.yml | 8 - .vale/styles/Microsoft/Suspended.yml | 7 - .vale/styles/Microsoft/Terms.yml | 41 --- .vale/styles/Microsoft/URLFormat.yml | 9 - .vale/styles/Microsoft/Units.yml | 16 -- .vale/styles/Microsoft/Vocab.yml | 25 -- .vale/styles/Microsoft/We.yml | 11 - .vale/styles/Microsoft/Wordiness.yml | 127 -------- .vale/styles/Microsoft/meta.json | 4 - testing.md | 2 +- 43 files changed, 6 insertions(+), 1207 deletions(-) delete mode 100644 .vale/styles/Microsoft/AMPM.yml delete mode 100644 .vale/styles/Microsoft/Accessibility.yml delete mode 100644 .vale/styles/Microsoft/Acronyms.yml delete mode 100644 .vale/styles/Microsoft/Adverbs.yml delete mode 100644 .vale/styles/Microsoft/Auto.yml delete mode 100644 .vale/styles/Microsoft/Avoid.yml delete mode 100644 .vale/styles/Microsoft/Contractions.yml delete mode 100644 .vale/styles/Microsoft/Dashes.yml delete mode 100644 .vale/styles/Microsoft/DateFormat.yml delete mode 100644 .vale/styles/Microsoft/DateNumbers.yml delete mode 100644 .vale/styles/Microsoft/DateOrder.yml delete mode 100644 .vale/styles/Microsoft/Ellipses.yml delete mode 100644 .vale/styles/Microsoft/FirstPerson.yml delete mode 100644 .vale/styles/Microsoft/Foreign.yml delete mode 100644 .vale/styles/Microsoft/Gender.yml delete mode 100644 .vale/styles/Microsoft/GenderBias.yml delete mode 100644 .vale/styles/Microsoft/GeneralURL.yml delete mode 100644 .vale/styles/Microsoft/HeadingAcronyms.yml delete mode 100644 .vale/styles/Microsoft/HeadingColons.yml delete mode 100644 .vale/styles/Microsoft/HeadingPunctuation.yml delete mode 100644 .vale/styles/Microsoft/Headings.yml delete mode 100644 .vale/styles/Microsoft/Hyphens.yml delete mode 100644 .vale/styles/Microsoft/Negative.yml delete mode 100644 .vale/styles/Microsoft/Ordinal.yml delete mode 100644 .vale/styles/Microsoft/OxfordComma.yml delete mode 100644 .vale/styles/Microsoft/Passive.yml delete mode 100644 .vale/styles/Microsoft/Percentages.yml delete mode 100644 .vale/styles/Microsoft/Plurals.yml delete mode 100644 .vale/styles/Microsoft/Quotes.yml delete mode 100644 .vale/styles/Microsoft/RangeTime.yml delete mode 100644 .vale/styles/Microsoft/Semicolon.yml delete mode 100644 .vale/styles/Microsoft/SentenceLength.yml delete mode 100644 .vale/styles/Microsoft/Spacing.yml delete mode 100644 .vale/styles/Microsoft/Suspended.yml delete mode 100644 .vale/styles/Microsoft/Terms.yml delete mode 100644 .vale/styles/Microsoft/URLFormat.yml delete mode 100644 .vale/styles/Microsoft/Units.yml delete mode 100644 .vale/styles/Microsoft/Vocab.yml delete mode 100644 .vale/styles/Microsoft/We.yml delete mode 100644 .vale/styles/Microsoft/Wordiness.yml delete mode 100644 .vale/styles/Microsoft/meta.json diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 858c66d549f..0139e22a0d6 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -6,20 +6,21 @@ on: - '**/*.md' push: paths: - - '**/*.md' # You can specify other file extensions or directories if needed + - '**/*.md' jobs: vale: runs-on: ubuntu-latest steps: - - name: Checkout repo + - name: Checkout repository uses: actions/checkout@v3 - - name: Set up Vale + - name: Set up Vale 3.9.1 run: | - curl -sSL https://github.com/errata-ai/vale/releases/download/v2.12.0/vale_2.12.0_Linux_64-bit.tar.gz | tar -xz -C /tmp + curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp sudo mv /tmp/vale /usr/local/bin/vale - name: Run Vale run: | vale . + diff --git a/.vale/styles/Microsoft/AMPM.yml b/.vale/styles/Microsoft/AMPM.yml deleted file mode 100644 index 8b9fed162ab..00000000000 --- a/.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/.vale/styles/Microsoft/Accessibility.yml b/.vale/styles/Microsoft/Accessibility.yml deleted file mode 100644 index f5f48293921..00000000000 --- a/.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/.vale/styles/Microsoft/Acronyms.yml b/.vale/styles/Microsoft/Acronyms.yml deleted file mode 100644 index 308ff7c0ed8..00000000000 --- a/.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/.vale/styles/Microsoft/Adverbs.yml b/.vale/styles/Microsoft/Adverbs.yml deleted file mode 100644 index 5619f99d8c9..00000000000 --- a/.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/.vale/styles/Microsoft/Auto.yml b/.vale/styles/Microsoft/Auto.yml deleted file mode 100644 index 4da4393530d..00000000000 --- a/.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/.vale/styles/Microsoft/Avoid.yml b/.vale/styles/Microsoft/Avoid.yml deleted file mode 100644 index dab7822c792..00000000000 --- a/.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/.vale/styles/Microsoft/Contractions.yml b/.vale/styles/Microsoft/Contractions.yml deleted file mode 100644 index 8c81dcbce78..00000000000 --- a/.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/.vale/styles/Microsoft/Dashes.yml b/.vale/styles/Microsoft/Dashes.yml deleted file mode 100644 index 72b05ba3e56..00000000000 --- a/.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/.vale/styles/Microsoft/DateFormat.yml b/.vale/styles/Microsoft/DateFormat.yml deleted file mode 100644 index 196531394ac..00000000000 --- a/.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/.vale/styles/Microsoft/DateNumbers.yml b/.vale/styles/Microsoft/DateNumbers.yml deleted file mode 100644 index 14d46747ca2..00000000000 --- a/.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/.vale/styles/Microsoft/DateOrder.yml b/.vale/styles/Microsoft/DateOrder.yml deleted file mode 100644 index 12d69ba51e4..00000000000 --- a/.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/.vale/styles/Microsoft/Ellipses.yml b/.vale/styles/Microsoft/Ellipses.yml deleted file mode 100644 index 320457a8bc5..00000000000 --- a/.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/.vale/styles/Microsoft/FirstPerson.yml b/.vale/styles/Microsoft/FirstPerson.yml deleted file mode 100644 index f58dea31420..00000000000 --- a/.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/.vale/styles/Microsoft/Foreign.yml b/.vale/styles/Microsoft/Foreign.yml deleted file mode 100644 index 0d3d6002a9a..00000000000 --- a/.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/.vale/styles/Microsoft/Gender.yml b/.vale/styles/Microsoft/Gender.yml deleted file mode 100644 index 47c08024797..00000000000 --- a/.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/.vale/styles/Microsoft/GenderBias.yml b/.vale/styles/Microsoft/GenderBias.yml deleted file mode 100644 index fc987b94e93..00000000000 --- a/.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/.vale/styles/Microsoft/GeneralURL.yml b/.vale/styles/Microsoft/GeneralURL.yml deleted file mode 100644 index dcef503d995..00000000000 --- a/.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/.vale/styles/Microsoft/HeadingAcronyms.yml b/.vale/styles/Microsoft/HeadingAcronyms.yml deleted file mode 100644 index 9dc3b6c2de7..00000000000 --- a/.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/.vale/styles/Microsoft/HeadingColons.yml b/.vale/styles/Microsoft/HeadingColons.yml deleted file mode 100644 index 7013c391486..00000000000 --- a/.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/.vale/styles/Microsoft/HeadingPunctuation.yml b/.vale/styles/Microsoft/HeadingPunctuation.yml deleted file mode 100644 index 4954cb11aeb..00000000000 --- a/.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/.vale/styles/Microsoft/Headings.yml b/.vale/styles/Microsoft/Headings.yml deleted file mode 100644 index 63624edc1b4..00000000000 --- a/.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/.vale/styles/Microsoft/Hyphens.yml b/.vale/styles/Microsoft/Hyphens.yml deleted file mode 100644 index 7e5731c9955..00000000000 --- a/.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/.vale/styles/Microsoft/Negative.yml b/.vale/styles/Microsoft/Negative.yml deleted file mode 100644 index d73221f5390..00000000000 --- a/.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/.vale/styles/Microsoft/Ordinal.yml b/.vale/styles/Microsoft/Ordinal.yml deleted file mode 100644 index e3483e380c7..00000000000 --- a/.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/.vale/styles/Microsoft/OxfordComma.yml b/.vale/styles/Microsoft/OxfordComma.yml deleted file mode 100644 index 493b55c3ce4..00000000000 --- a/.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/.vale/styles/Microsoft/Passive.yml b/.vale/styles/Microsoft/Passive.yml deleted file mode 100644 index 102d377cac8..00000000000 --- a/.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/.vale/styles/Microsoft/Percentages.yml b/.vale/styles/Microsoft/Percentages.yml deleted file mode 100644 index b68a7363f47..00000000000 --- a/.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/.vale/styles/Microsoft/Plurals.yml b/.vale/styles/Microsoft/Plurals.yml deleted file mode 100644 index 1bb6660ade8..00000000000 --- a/.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/.vale/styles/Microsoft/Quotes.yml b/.vale/styles/Microsoft/Quotes.yml deleted file mode 100644 index 38f49760619..00000000000 --- a/.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/.vale/styles/Microsoft/RangeTime.yml b/.vale/styles/Microsoft/RangeTime.yml deleted file mode 100644 index 72d8bbfbe3e..00000000000 --- a/.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/.vale/styles/Microsoft/Semicolon.yml b/.vale/styles/Microsoft/Semicolon.yml deleted file mode 100644 index 4d905467dd2..00000000000 --- a/.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/.vale/styles/Microsoft/SentenceLength.yml b/.vale/styles/Microsoft/SentenceLength.yml deleted file mode 100644 index f248cf0513b..00000000000 --- a/.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/.vale/styles/Microsoft/Spacing.yml b/.vale/styles/Microsoft/Spacing.yml deleted file mode 100644 index bbd10e51df7..00000000000 --- a/.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/.vale/styles/Microsoft/Suspended.yml b/.vale/styles/Microsoft/Suspended.yml deleted file mode 100644 index 7282e9c9cf5..00000000000 --- a/.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/.vale/styles/Microsoft/Terms.yml b/.vale/styles/Microsoft/Terms.yml deleted file mode 100644 index 70552269f56..00000000000 --- a/.vale/styles/Microsoft/Terms.yml +++ /dev/null @@ -1,41 +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: - "(?: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/.vale/styles/Microsoft/URLFormat.yml b/.vale/styles/Microsoft/URLFormat.yml deleted file mode 100644 index 4e24aa59fe0..00000000000 --- a/.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/.vale/styles/Microsoft/Units.yml b/.vale/styles/Microsoft/Units.yml deleted file mode 100644 index f062418ee0d..00000000000 --- a/.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/.vale/styles/Microsoft/Vocab.yml b/.vale/styles/Microsoft/Vocab.yml deleted file mode 100644 index eebe97b15ee..00000000000 --- a/.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/.vale/styles/Microsoft/We.yml b/.vale/styles/Microsoft/We.yml deleted file mode 100644 index 97c901c1bae..00000000000 --- a/.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/.vale/styles/Microsoft/Wordiness.yml b/.vale/styles/Microsoft/Wordiness.yml deleted file mode 100644 index 3d008d1894e..00000000000 --- a/.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/.vale/styles/Microsoft/meta.json b/.vale/styles/Microsoft/meta.json deleted file mode 100644 index 297719bbbff..00000000000 --- a/.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" -} diff --git a/testing.md b/testing.md index 1d89924fca5..63414d325a0 100644 --- a/testing.md +++ b/testing.md @@ -1,2 +1,2 @@ ###Summary -Checking if vale reacts to the use of the term agent. \ No newline at end of file +Checking if vale reacts to the use of the term agent, which it previously didn't allow. \ No newline at end of file From 0e7df0fb3112bdf36da9ef5320ce21806f0c02ed Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 13:29:16 +0530 Subject: [PATCH 09/25] added ms files again --- .vale/styles/Microsoft/AMPM.yml | 9 + .vale/styles/Microsoft/Accessibility.yml | 30 ++ .vale/styles/Microsoft/Acronyms.yml | 64 +++++ .vale/styles/Microsoft/Adverbs.yml | 272 ++++++++++++++++++ .vale/styles/Microsoft/Auto.yml | 11 + .vale/styles/Microsoft/Avoid.yml | 14 + .vale/styles/Microsoft/Contractions.yml | 50 ++++ .vale/styles/Microsoft/Dashes.yml | 13 + .vale/styles/Microsoft/DateFormat.yml | 8 + .vale/styles/Microsoft/DateNumbers.yml | 40 +++ .vale/styles/Microsoft/DateOrder.yml | 8 + .vale/styles/Microsoft/Ellipses.yml | 9 + .vale/styles/Microsoft/FirstPerson.yml | 16 ++ .vale/styles/Microsoft/Foreign.yml | 13 + .vale/styles/Microsoft/Gender.yml | 8 + .vale/styles/Microsoft/GenderBias.yml | 42 +++ .vale/styles/Microsoft/GeneralURL.yml | 11 + .vale/styles/Microsoft/HeadingAcronyms.yml | 7 + .vale/styles/Microsoft/HeadingColons.yml | 8 + .vale/styles/Microsoft/HeadingPunctuation.yml | 13 + .vale/styles/Microsoft/Headings.yml | 28 ++ .vale/styles/Microsoft/Hyphens.yml | 14 + .vale/styles/Microsoft/Negative.yml | 13 + .vale/styles/Microsoft/Ordinal.yml | 13 + .vale/styles/Microsoft/OxfordComma.yml | 8 + .vale/styles/Microsoft/Passive.yml | 183 ++++++++++++ .vale/styles/Microsoft/Percentages.yml | 7 + .vale/styles/Microsoft/Plurals.yml | 7 + .vale/styles/Microsoft/Quotes.yml | 7 + .vale/styles/Microsoft/RangeTime.yml | 13 + .vale/styles/Microsoft/Semicolon.yml | 8 + .vale/styles/Microsoft/SentenceLength.yml | 7 + .vale/styles/Microsoft/Spacing.yml | 8 + .vale/styles/Microsoft/Suspended.yml | 7 + .vale/styles/Microsoft/Terms.yml | 41 +++ .vale/styles/Microsoft/URLFormat.yml | 9 + .vale/styles/Microsoft/Units.yml | 16 ++ .vale/styles/Microsoft/Vocab.yml | 25 ++ .vale/styles/Microsoft/We.yml | 11 + .vale/styles/Microsoft/Wordiness.yml | 127 ++++++++ .vale/styles/Microsoft/meta.json | 4 + testing.md | 2 +- 42 files changed, 1203 insertions(+), 1 deletion(-) create mode 100644 .vale/styles/Microsoft/AMPM.yml create mode 100644 .vale/styles/Microsoft/Accessibility.yml create mode 100644 .vale/styles/Microsoft/Acronyms.yml create mode 100644 .vale/styles/Microsoft/Adverbs.yml create mode 100644 .vale/styles/Microsoft/Auto.yml create mode 100644 .vale/styles/Microsoft/Avoid.yml create mode 100644 .vale/styles/Microsoft/Contractions.yml create mode 100644 .vale/styles/Microsoft/Dashes.yml create mode 100644 .vale/styles/Microsoft/DateFormat.yml create mode 100644 .vale/styles/Microsoft/DateNumbers.yml create mode 100644 .vale/styles/Microsoft/DateOrder.yml create mode 100644 .vale/styles/Microsoft/Ellipses.yml create mode 100644 .vale/styles/Microsoft/FirstPerson.yml create mode 100644 .vale/styles/Microsoft/Foreign.yml create mode 100644 .vale/styles/Microsoft/Gender.yml create mode 100644 .vale/styles/Microsoft/GenderBias.yml create mode 100644 .vale/styles/Microsoft/GeneralURL.yml create mode 100644 .vale/styles/Microsoft/HeadingAcronyms.yml create mode 100644 .vale/styles/Microsoft/HeadingColons.yml create mode 100644 .vale/styles/Microsoft/HeadingPunctuation.yml create mode 100644 .vale/styles/Microsoft/Headings.yml create mode 100644 .vale/styles/Microsoft/Hyphens.yml create mode 100644 .vale/styles/Microsoft/Negative.yml create mode 100644 .vale/styles/Microsoft/Ordinal.yml create mode 100644 .vale/styles/Microsoft/OxfordComma.yml create mode 100644 .vale/styles/Microsoft/Passive.yml create mode 100644 .vale/styles/Microsoft/Percentages.yml create mode 100644 .vale/styles/Microsoft/Plurals.yml create mode 100644 .vale/styles/Microsoft/Quotes.yml create mode 100644 .vale/styles/Microsoft/RangeTime.yml create mode 100644 .vale/styles/Microsoft/Semicolon.yml create mode 100644 .vale/styles/Microsoft/SentenceLength.yml create mode 100644 .vale/styles/Microsoft/Spacing.yml create mode 100644 .vale/styles/Microsoft/Suspended.yml create mode 100644 .vale/styles/Microsoft/Terms.yml create mode 100644 .vale/styles/Microsoft/URLFormat.yml create mode 100644 .vale/styles/Microsoft/Units.yml create mode 100644 .vale/styles/Microsoft/Vocab.yml create mode 100644 .vale/styles/Microsoft/We.yml create mode 100644 .vale/styles/Microsoft/Wordiness.yml create mode 100644 .vale/styles/Microsoft/meta.json diff --git a/.vale/styles/Microsoft/AMPM.yml b/.vale/styles/Microsoft/AMPM.yml new file mode 100644 index 00000000000..8b9fed162ab --- /dev/null +++ b/.vale/styles/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]\.' diff --git a/.vale/styles/Microsoft/Accessibility.yml b/.vale/styles/Microsoft/Accessibility.yml new file mode 100644 index 00000000000..f5f48293921 --- /dev/null +++ b/.vale/styles/Microsoft/Accessibility.yml @@ -0,0 +1,30 @@ +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/.vale/styles/Microsoft/Acronyms.yml b/.vale/styles/Microsoft/Acronyms.yml new file mode 100644 index 00000000000..308ff7c0ed8 --- /dev/null +++ b/.vale/styles/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 diff --git a/.vale/styles/Microsoft/Adverbs.yml b/.vale/styles/Microsoft/Adverbs.yml new file mode 100644 index 00000000000..5619f99d8c9 --- /dev/null +++ b/.vale/styles/Microsoft/Adverbs.yml @@ -0,0 +1,272 @@ +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/.vale/styles/Microsoft/Auto.yml b/.vale/styles/Microsoft/Auto.yml new file mode 100644 index 00000000000..4da4393530d --- /dev/null +++ b/.vale/styles/Microsoft/Auto.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/Avoid.yml b/.vale/styles/Microsoft/Avoid.yml new file mode 100644 index 00000000000..dab7822c792 --- /dev/null +++ b/.vale/styles/Microsoft/Avoid.yml @@ -0,0 +1,14 @@ +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/.vale/styles/Microsoft/Contractions.yml b/.vale/styles/Microsoft/Contractions.yml new file mode 100644 index 00000000000..8c81dcbce78 --- /dev/null +++ b/.vale/styles/Microsoft/Contractions.yml @@ -0,0 +1,50 @@ +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/.vale/styles/Microsoft/Dashes.yml b/.vale/styles/Microsoft/Dashes.yml new file mode 100644 index 00000000000..72b05ba3e56 --- /dev/null +++ b/.vale/styles/Microsoft/Dashes.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/DateFormat.yml b/.vale/styles/Microsoft/DateFormat.yml new file mode 100644 index 00000000000..196531394ac --- /dev/null +++ b/.vale/styles/Microsoft/DateFormat.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/DateNumbers.yml b/.vale/styles/Microsoft/DateNumbers.yml new file mode 100644 index 00000000000..14d46747ca2 --- /dev/null +++ b/.vale/styles/Microsoft/DateNumbers.yml @@ -0,0 +1,40 @@ +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/.vale/styles/Microsoft/DateOrder.yml b/.vale/styles/Microsoft/DateOrder.yml new file mode 100644 index 00000000000..12d69ba51e4 --- /dev/null +++ b/.vale/styles/Microsoft/DateOrder.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Ellipses.yml b/.vale/styles/Microsoft/Ellipses.yml new file mode 100644 index 00000000000..320457a8bc5 --- /dev/null +++ b/.vale/styles/Microsoft/Ellipses.yml @@ -0,0 +1,9 @@ +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/.vale/styles/Microsoft/FirstPerson.yml b/.vale/styles/Microsoft/FirstPerson.yml new file mode 100644 index 00000000000..f58dea31420 --- /dev/null +++ b/.vale/styles/Microsoft/FirstPerson.yml @@ -0,0 +1,16 @@ +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/.vale/styles/Microsoft/Foreign.yml b/.vale/styles/Microsoft/Foreign.yml new file mode 100644 index 00000000000..0d3d6002a9a --- /dev/null +++ b/.vale/styles/Microsoft/Foreign.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Gender.yml b/.vale/styles/Microsoft/Gender.yml new file mode 100644 index 00000000000..47c08024797 --- /dev/null +++ b/.vale/styles/Microsoft/Gender.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/GenderBias.yml b/.vale/styles/Microsoft/GenderBias.yml new file mode 100644 index 00000000000..fc987b94e93 --- /dev/null +++ b/.vale/styles/Microsoft/GenderBias.yml @@ -0,0 +1,42 @@ +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/.vale/styles/Microsoft/GeneralURL.yml b/.vale/styles/Microsoft/GeneralURL.yml new file mode 100644 index 00000000000..dcef503d995 --- /dev/null +++ b/.vale/styles/Microsoft/GeneralURL.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/HeadingAcronyms.yml b/.vale/styles/Microsoft/HeadingAcronyms.yml new file mode 100644 index 00000000000..9dc3b6c2de7 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingAcronyms.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/HeadingColons.yml b/.vale/styles/Microsoft/HeadingColons.yml new file mode 100644 index 00000000000..7013c391486 --- /dev/null +++ b/.vale/styles/Microsoft/HeadingColons.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/HeadingPunctuation.yml b/.vale/styles/Microsoft/HeadingPunctuation.yml new file mode 100644 index 00000000000..4954cb11aeb --- /dev/null +++ b/.vale/styles/Microsoft/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Headings.yml b/.vale/styles/Microsoft/Headings.yml new file mode 100644 index 00000000000..63624edc1b4 --- /dev/null +++ b/.vale/styles/Microsoft/Headings.yml @@ -0,0 +1,28 @@ +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/.vale/styles/Microsoft/Hyphens.yml b/.vale/styles/Microsoft/Hyphens.yml new file mode 100644 index 00000000000..7e5731c9955 --- /dev/null +++ b/.vale/styles/Microsoft/Hyphens.yml @@ -0,0 +1,14 @@ +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/.vale/styles/Microsoft/Negative.yml b/.vale/styles/Microsoft/Negative.yml new file mode 100644 index 00000000000..d73221f5390 --- /dev/null +++ b/.vale/styles/Microsoft/Negative.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Ordinal.yml b/.vale/styles/Microsoft/Ordinal.yml new file mode 100644 index 00000000000..e3483e380c7 --- /dev/null +++ b/.vale/styles/Microsoft/Ordinal.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/OxfordComma.yml b/.vale/styles/Microsoft/OxfordComma.yml new file mode 100644 index 00000000000..493b55c3ce4 --- /dev/null +++ b/.vale/styles/Microsoft/OxfordComma.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Passive.yml b/.vale/styles/Microsoft/Passive.yml new file mode 100644 index 00000000000..102d377cac8 --- /dev/null +++ b/.vale/styles/Microsoft/Passive.yml @@ -0,0 +1,183 @@ +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/.vale/styles/Microsoft/Percentages.yml b/.vale/styles/Microsoft/Percentages.yml new file mode 100644 index 00000000000..b68a7363f47 --- /dev/null +++ b/.vale/styles/Microsoft/Percentages.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Plurals.yml b/.vale/styles/Microsoft/Plurals.yml new file mode 100644 index 00000000000..1bb6660ade8 --- /dev/null +++ b/.vale/styles/Microsoft/Plurals.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Quotes.yml b/.vale/styles/Microsoft/Quotes.yml new file mode 100644 index 00000000000..38f49760619 --- /dev/null +++ b/.vale/styles/Microsoft/Quotes.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/RangeTime.yml b/.vale/styles/Microsoft/RangeTime.yml new file mode 100644 index 00000000000..72d8bbfbe3e --- /dev/null +++ b/.vale/styles/Microsoft/RangeTime.yml @@ -0,0 +1,13 @@ +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/.vale/styles/Microsoft/Semicolon.yml b/.vale/styles/Microsoft/Semicolon.yml new file mode 100644 index 00000000000..4d905467dd2 --- /dev/null +++ b/.vale/styles/Microsoft/Semicolon.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/SentenceLength.yml b/.vale/styles/Microsoft/SentenceLength.yml new file mode 100644 index 00000000000..f248cf0513b --- /dev/null +++ b/.vale/styles/Microsoft/SentenceLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep sentences short (< 30 words)." +scope: sentence +level: suggestion +max: 30 +token: \b(\w+)\b + diff --git a/.vale/styles/Microsoft/Spacing.yml b/.vale/styles/Microsoft/Spacing.yml new file mode 100644 index 00000000000..bbd10e51df7 --- /dev/null +++ b/.vale/styles/Microsoft/Spacing.yml @@ -0,0 +1,8 @@ +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/.vale/styles/Microsoft/Suspended.yml b/.vale/styles/Microsoft/Suspended.yml new file mode 100644 index 00000000000..7282e9c9cf5 --- /dev/null +++ b/.vale/styles/Microsoft/Suspended.yml @@ -0,0 +1,7 @@ +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/.vale/styles/Microsoft/Terms.yml b/.vale/styles/Microsoft/Terms.yml new file mode 100644 index 00000000000..70552269f56 --- /dev/null +++ b/.vale/styles/Microsoft/Terms.yml @@ -0,0 +1,41 @@ +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: + "(?: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/.vale/styles/Microsoft/URLFormat.yml b/.vale/styles/Microsoft/URLFormat.yml new file mode 100644 index 00000000000..4e24aa59fe0 --- /dev/null +++ b/.vale/styles/Microsoft/URLFormat.yml @@ -0,0 +1,9 @@ +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/.vale/styles/Microsoft/Units.yml b/.vale/styles/Microsoft/Units.yml new file mode 100644 index 00000000000..f062418ee0d --- /dev/null +++ b/.vale/styles/Microsoft/Units.yml @@ -0,0 +1,16 @@ +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/.vale/styles/Microsoft/Vocab.yml b/.vale/styles/Microsoft/Vocab.yml new file mode 100644 index 00000000000..eebe97b15ee --- /dev/null +++ b/.vale/styles/Microsoft/Vocab.yml @@ -0,0 +1,25 @@ +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/.vale/styles/Microsoft/We.yml b/.vale/styles/Microsoft/We.yml new file mode 100644 index 00000000000..97c901c1bae --- /dev/null +++ b/.vale/styles/Microsoft/We.yml @@ -0,0 +1,11 @@ +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/.vale/styles/Microsoft/Wordiness.yml b/.vale/styles/Microsoft/Wordiness.yml new file mode 100644 index 00000000000..3d008d1894e --- /dev/null +++ b/.vale/styles/Microsoft/Wordiness.yml @@ -0,0 +1,127 @@ +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/.vale/styles/Microsoft/meta.json b/.vale/styles/Microsoft/meta.json new file mode 100644 index 00000000000..297719bbbff --- /dev/null +++ b/.vale/styles/Microsoft/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/Microsoft/releases.atom", + "vale_version": ">=1.0.0" +} diff --git a/testing.md b/testing.md index 63414d325a0..1d89924fca5 100644 --- a/testing.md +++ b/testing.md @@ -1,2 +1,2 @@ ###Summary -Checking if vale reacts to the use of the term agent, which it previously didn't allow. \ No newline at end of file +Checking if vale reacts to the use of the term agent. \ No newline at end of file From 9e8d9009b43653e29f033274d0e1d8641f9d97d4 Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 22:12:18 +0530 Subject: [PATCH 10/25] updated pre-commit --- .pre-commit-config.yaml | 68 ++++++++++++++++++++++++----------------- testing.md | 2 +- 2 files changed, 41 insertions(+), 29 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c1fadee8ff0..e91dbd2e942 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,35 +1,47 @@ ci: - autoupdate_schedule: 'monthly' + autoupdate_schedule: 'monthly' repos: -- repo: https://github.com/astral-sh/ruff-pre-commit - # Ruff version. - rev: v0.8.1 - hooks: - # Run the linter. - - id: ruff - types_or: [ python, pyi, jupyter ] - args: [ --fix ] - # Run the formatter. - - id: ruff-format - types_or: [ python, pyi, jupyter ] -- repo: https://github.com/asottile/pyupgrade + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.8.1 + hooks: + # Run the linter. + - id: ruff + types_or: [ python, pyi, jupyter ] + args: [ --fix ] + # Run the formatter. + - id: ruff-format + types_or: [ python, pyi, jupyter ] + + - repo: https://github.com/asottile/pyupgrade rev: v3.19.0 hooks: - - id: pyupgrade - args: [--py311-plus] -- repo: https://github.com/pre-commit/pre-commit-hooks + - id: pyupgrade + args: [ --py311-plus ] + + - repo: https://github.com/pre-commit/pre-commit-hooks rev: v5.0.0 # Use the ref you want to point at hooks: - - id: trailing-whitespace - - id: check-toml - - id: check-yaml -- repo: https://github.com/codespell-project/codespell - rev: v2.3.0 - hooks: - - id: codespell - args: [ - "--ignore-words", - ".codespellignore", - ] - exclude: .vale/styles/Microsoft/Avoid.yml + - id: trailing-whitespace + - id: check-toml + - id: check-yaml + + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + args: + - "--ignore-words" + - ".codespellignore" + exclude: .vale/styles/Microsoft/Avoid.yml + + - repo: https://github.com/errata-ai/vale + rev: v3.9.1 # Use the version of Vale you want + hooks: + - id: vale + name: Vale + entry: vale + language: docker + types: [file] + files: \.(md|txt|rst)$ # Adjust file extensions as needed + diff --git a/testing.md b/testing.md index 1d89924fca5..13da4cdd39d 100644 --- a/testing.md +++ b/testing.md @@ -1,2 +1,2 @@ ###Summary -Checking if vale reacts to the use of the term agent. \ No newline at end of file +Checking if vale reacts to the use of the term agent in md files. \ No newline at end of file From ea477ab6704417bddb15e0c2db3adcd0e2efe301 Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 23:37:53 +0530 Subject: [PATCH 11/25] deleted a test file --- testing.md | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 testing.md diff --git a/testing.md b/testing.md deleted file mode 100644 index 13da4cdd39d..00000000000 --- a/testing.md +++ /dev/null @@ -1,2 +0,0 @@ -###Summary -Checking if vale reacts to the use of the term agent in md files. \ No newline at end of file From dcc756dee3a401f31826429773d5b8dacfbc6bed Mon Sep 17 00:00:00 2001 From: sanika Date: Wed, 25 Dec 2024 23:59:20 +0530 Subject: [PATCH 12/25] modified pre-commit-config --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e91dbd2e942..e11b3ba4e38 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -41,7 +41,7 @@ repos: - id: vale name: Vale entry: vale - language: docker + language: system types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From 7b318da25fe17e120c5c1ced0e98cee6454eb4b7 Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 00:09:49 +0530 Subject: [PATCH 13/25] test file --- test.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 test.md diff --git a/test.md b/test.md new file mode 100644 index 00000000000..8221c8460dd --- /dev/null +++ b/test.md @@ -0,0 +1 @@ +###test file \ No newline at end of file From ced393e41bb4d9dbe821eea2a60c1b8e65491936 Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 00:25:35 +0530 Subject: [PATCH 14/25] changed vale.yml file --- .github/workflows/vale.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 0139e22a0d6..acc79e18a2f 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -19,6 +19,7 @@ jobs: run: | curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp sudo mv /tmp/vale /usr/local/bin/vale + chmod +x /usr/local/bin/vale - name: Run Vale run: | From 7724441570432615b63b2ee259d48e851fecd792 Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:01:41 +0530 Subject: [PATCH 15/25] modified workflow --- .github/workflows/build_lint.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/build_lint.yml b/.github/workflows/build_lint.yml index ab62e75bce5..fa754b62650 100644 --- a/.github/workflows/build_lint.yml +++ b/.github/workflows/build_lint.yml @@ -49,6 +49,12 @@ jobs: python-version: ${{ matrix.python-version }} allow-prereleases: true cache: 'pip' + - name: Set up Vale + run: | + curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp + sudo mv /tmp/vale /usr/local/bin/vale + chmod +x /usr/local/bin/vale + if: runner.os == 'Linux' # Only install on Linux runners - name: Install uv run: pip install uv - name: Install Mesa and dependencies From f40435a939feba1614b4515773a680afefa6f10a Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:11:01 +0530 Subject: [PATCH 16/25] edited pre-commit --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e11b3ba4e38..1a4c9f81b9a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,7 +40,7 @@ repos: hooks: - id: vale name: Vale - entry: vale + entry: bash -c 'curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp && /tmp/vale "$@"' -- language: system types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From ce498a1cbee75b7ef6d19aaae515e83802b6b4bb Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:13:52 +0530 Subject: [PATCH 17/25] edited pre-commit --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1a4c9f81b9a..792359627c7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,7 +40,7 @@ repos: hooks: - id: vale name: Vale - entry: bash -c 'curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp && /tmp/vale "$@"' -- + entry: bash -c 'wget https://raw.githubusercontent.com/errata-ai/vale/v3.9.1/vale -O /tmp/vale && chmod +x /tmp/vale && /tmp/vale "$@"' -- language: system types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From 911e472d1e3ef3704d5684e5aa722fca3fcbeb20 Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:15:53 +0530 Subject: [PATCH 18/25] edited pre-commit --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 792359627c7..1353c66f15b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,7 +40,7 @@ repos: hooks: - id: vale name: Vale - entry: bash -c 'wget https://raw.githubusercontent.com/errata-ai/vale/v3.9.1/vale -O /tmp/vale && chmod +x /tmp/vale && /tmp/vale "$@"' -- + entry: bash -c 'curl https://raw.githubusercontent.com/errata-ai/vale/v3.9.1/vale -O /tmp/vale && chmod +x /tmp/vale && /tmp/vale "$@"' -- language: system types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From ffedd3b2752353ec225f16a79cfc50a25fb5f9ae Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:20:37 +0530 Subject: [PATCH 19/25] edited pre-commit --- .github/workflows/build_lint.yml | 6 ------ .pre-commit-config.yaml | 2 -- 2 files changed, 8 deletions(-) diff --git a/.github/workflows/build_lint.yml b/.github/workflows/build_lint.yml index fa754b62650..ab62e75bce5 100644 --- a/.github/workflows/build_lint.yml +++ b/.github/workflows/build_lint.yml @@ -49,12 +49,6 @@ jobs: python-version: ${{ matrix.python-version }} allow-prereleases: true cache: 'pip' - - name: Set up Vale - run: | - curl -sSL https://github.com/errata-ai/vale/releases/download/v3.9.1/vale_3.9.1_Linux_64-bit.tar.gz | tar -xz -C /tmp - sudo mv /tmp/vale /usr/local/bin/vale - chmod +x /usr/local/bin/vale - if: runner.os == 'Linux' # Only install on Linux runners - name: Install uv run: pip install uv - name: Install Mesa and dependencies diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1353c66f15b..645483821fe 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,8 +40,6 @@ repos: hooks: - id: vale name: Vale - entry: bash -c 'curl https://raw.githubusercontent.com/errata-ai/vale/v3.9.1/vale -O /tmp/vale && chmod +x /tmp/vale && /tmp/vale "$@"' -- - language: system types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From e18625a0294b5c062b9921484dc7989fce0937cc Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:39:25 +0530 Subject: [PATCH 20/25] edited pre-commit --- .pre-commit-config.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 645483821fe..4c32f78a5ba 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -40,6 +40,8 @@ repos: hooks: - id: vale name: Vale + entry: vale + language: golang types: [file] files: \.(md|txt|rst)$ # Adjust file extensions as needed From 079097049234320252954a7d88026ec2614d057b Mon Sep 17 00:00:00 2001 From: sanika Date: Thu, 26 Dec 2024 12:47:22 +0530 Subject: [PATCH 21/25] delted an unnecessary file --- test.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 test.md diff --git a/test.md b/test.md deleted file mode 100644 index 8221c8460dd..00000000000 --- a/test.md +++ /dev/null @@ -1 +0,0 @@ -###test file \ No newline at end of file From 65be4de2ad660d0552538c63d2e020d036cdf858 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 31 Dec 2024 10:39:00 +0530 Subject: [PATCH 22/25] corrected repo structure --- {.vale => .github}/styles/Microsoft/AMPM.yml | 0 .../styles/Microsoft/Accessibility.yml | 0 {.vale => .github}/styles/Microsoft/Acronyms.yml | 0 {.vale => .github}/styles/Microsoft/Adverbs.yml | 0 {.vale => .github}/styles/Microsoft/Auto.yml | 0 {.vale => .github}/styles/Microsoft/Avoid.yml | 0 {.vale => .github}/styles/Microsoft/Contractions.yml | 0 {.vale => .github}/styles/Microsoft/Dashes.yml | 0 {.vale => .github}/styles/Microsoft/DateFormat.yml | 0 {.vale => .github}/styles/Microsoft/DateNumbers.yml | 0 {.vale => .github}/styles/Microsoft/DateOrder.yml | 0 {.vale => .github}/styles/Microsoft/Ellipses.yml | 0 {.vale => .github}/styles/Microsoft/FirstPerson.yml | 0 {.vale => .github}/styles/Microsoft/Foreign.yml | 0 {.vale => .github}/styles/Microsoft/Gender.yml | 0 {.vale => .github}/styles/Microsoft/GenderBias.yml | 0 {.vale => .github}/styles/Microsoft/GeneralURL.yml | 0 .../styles/Microsoft/HeadingAcronyms.yml | 0 .../styles/Microsoft/HeadingColons.yml | 0 .../styles/Microsoft/HeadingPunctuation.yml | 0 {.vale => .github}/styles/Microsoft/Headings.yml | 0 {.vale => .github}/styles/Microsoft/Hyphens.yml | 0 {.vale => .github}/styles/Microsoft/Negative.yml | 0 {.vale => .github}/styles/Microsoft/Ordinal.yml | 0 {.vale => .github}/styles/Microsoft/OxfordComma.yml | 0 {.vale => .github}/styles/Microsoft/Passive.yml | 0 {.vale => .github}/styles/Microsoft/Percentages.yml | 0 {.vale => .github}/styles/Microsoft/Plurals.yml | 0 {.vale => .github}/styles/Microsoft/Quotes.yml | 0 {.vale => .github}/styles/Microsoft/RangeTime.yml | 0 {.vale => .github}/styles/Microsoft/Semicolon.yml | 0 .../styles/Microsoft/SentenceLength.yml | 0 {.vale => .github}/styles/Microsoft/Spacing.yml | 0 {.vale => .github}/styles/Microsoft/Suspended.yml | 0 {.vale => .github}/styles/Microsoft/Terms.yml | 0 {.vale => .github}/styles/Microsoft/URLFormat.yml | 0 {.vale => .github}/styles/Microsoft/Units.yml | 0 {.vale => .github}/styles/Microsoft/Vocab.yml | 0 {.vale => .github}/styles/Microsoft/We.yml | 0 {.vale => .github}/styles/Microsoft/Wordiness.yml | 0 {.vale => .github}/styles/Microsoft/meta.json | 0 .pre-commit-config.yaml | 2 +- .vale.ini | 2 +- .vale/config.json | 12 ------------ 44 files changed, 2 insertions(+), 14 deletions(-) rename {.vale => .github}/styles/Microsoft/AMPM.yml (100%) rename {.vale => .github}/styles/Microsoft/Accessibility.yml (100%) rename {.vale => .github}/styles/Microsoft/Acronyms.yml (100%) rename {.vale => .github}/styles/Microsoft/Adverbs.yml (100%) rename {.vale => .github}/styles/Microsoft/Auto.yml (100%) rename {.vale => .github}/styles/Microsoft/Avoid.yml (100%) rename {.vale => .github}/styles/Microsoft/Contractions.yml (100%) rename {.vale => .github}/styles/Microsoft/Dashes.yml (100%) rename {.vale => .github}/styles/Microsoft/DateFormat.yml (100%) rename {.vale => .github}/styles/Microsoft/DateNumbers.yml (100%) rename {.vale => .github}/styles/Microsoft/DateOrder.yml (100%) rename {.vale => .github}/styles/Microsoft/Ellipses.yml (100%) rename {.vale => .github}/styles/Microsoft/FirstPerson.yml (100%) rename {.vale => .github}/styles/Microsoft/Foreign.yml (100%) rename {.vale => .github}/styles/Microsoft/Gender.yml (100%) rename {.vale => .github}/styles/Microsoft/GenderBias.yml (100%) rename {.vale => .github}/styles/Microsoft/GeneralURL.yml (100%) rename {.vale => .github}/styles/Microsoft/HeadingAcronyms.yml (100%) rename {.vale => .github}/styles/Microsoft/HeadingColons.yml (100%) rename {.vale => .github}/styles/Microsoft/HeadingPunctuation.yml (100%) rename {.vale => .github}/styles/Microsoft/Headings.yml (100%) rename {.vale => .github}/styles/Microsoft/Hyphens.yml (100%) rename {.vale => .github}/styles/Microsoft/Negative.yml (100%) rename {.vale => .github}/styles/Microsoft/Ordinal.yml (100%) rename {.vale => .github}/styles/Microsoft/OxfordComma.yml (100%) rename {.vale => .github}/styles/Microsoft/Passive.yml (100%) rename {.vale => .github}/styles/Microsoft/Percentages.yml (100%) rename {.vale => .github}/styles/Microsoft/Plurals.yml (100%) rename {.vale => .github}/styles/Microsoft/Quotes.yml (100%) rename {.vale => .github}/styles/Microsoft/RangeTime.yml (100%) rename {.vale => .github}/styles/Microsoft/Semicolon.yml (100%) rename {.vale => .github}/styles/Microsoft/SentenceLength.yml (100%) rename {.vale => .github}/styles/Microsoft/Spacing.yml (100%) rename {.vale => .github}/styles/Microsoft/Suspended.yml (100%) rename {.vale => .github}/styles/Microsoft/Terms.yml (100%) rename {.vale => .github}/styles/Microsoft/URLFormat.yml (100%) rename {.vale => .github}/styles/Microsoft/Units.yml (100%) rename {.vale => .github}/styles/Microsoft/Vocab.yml (100%) rename {.vale => .github}/styles/Microsoft/We.yml (100%) rename {.vale => .github}/styles/Microsoft/Wordiness.yml (100%) rename {.vale => .github}/styles/Microsoft/meta.json (100%) delete mode 100644 .vale/config.json diff --git a/.vale/styles/Microsoft/AMPM.yml b/.github/styles/Microsoft/AMPM.yml similarity index 100% rename from .vale/styles/Microsoft/AMPM.yml rename to .github/styles/Microsoft/AMPM.yml diff --git a/.vale/styles/Microsoft/Accessibility.yml b/.github/styles/Microsoft/Accessibility.yml similarity index 100% rename from .vale/styles/Microsoft/Accessibility.yml rename to .github/styles/Microsoft/Accessibility.yml diff --git a/.vale/styles/Microsoft/Acronyms.yml b/.github/styles/Microsoft/Acronyms.yml similarity index 100% rename from .vale/styles/Microsoft/Acronyms.yml rename to .github/styles/Microsoft/Acronyms.yml diff --git a/.vale/styles/Microsoft/Adverbs.yml b/.github/styles/Microsoft/Adverbs.yml similarity index 100% rename from .vale/styles/Microsoft/Adverbs.yml rename to .github/styles/Microsoft/Adverbs.yml diff --git a/.vale/styles/Microsoft/Auto.yml b/.github/styles/Microsoft/Auto.yml similarity index 100% rename from .vale/styles/Microsoft/Auto.yml rename to .github/styles/Microsoft/Auto.yml diff --git a/.vale/styles/Microsoft/Avoid.yml b/.github/styles/Microsoft/Avoid.yml similarity index 100% rename from .vale/styles/Microsoft/Avoid.yml rename to .github/styles/Microsoft/Avoid.yml diff --git a/.vale/styles/Microsoft/Contractions.yml b/.github/styles/Microsoft/Contractions.yml similarity index 100% rename from .vale/styles/Microsoft/Contractions.yml rename to .github/styles/Microsoft/Contractions.yml diff --git a/.vale/styles/Microsoft/Dashes.yml b/.github/styles/Microsoft/Dashes.yml similarity index 100% rename from .vale/styles/Microsoft/Dashes.yml rename to .github/styles/Microsoft/Dashes.yml diff --git a/.vale/styles/Microsoft/DateFormat.yml b/.github/styles/Microsoft/DateFormat.yml similarity index 100% rename from .vale/styles/Microsoft/DateFormat.yml rename to .github/styles/Microsoft/DateFormat.yml diff --git a/.vale/styles/Microsoft/DateNumbers.yml b/.github/styles/Microsoft/DateNumbers.yml similarity index 100% rename from .vale/styles/Microsoft/DateNumbers.yml rename to .github/styles/Microsoft/DateNumbers.yml diff --git a/.vale/styles/Microsoft/DateOrder.yml b/.github/styles/Microsoft/DateOrder.yml similarity index 100% rename from .vale/styles/Microsoft/DateOrder.yml rename to .github/styles/Microsoft/DateOrder.yml diff --git a/.vale/styles/Microsoft/Ellipses.yml b/.github/styles/Microsoft/Ellipses.yml similarity index 100% rename from .vale/styles/Microsoft/Ellipses.yml rename to .github/styles/Microsoft/Ellipses.yml diff --git a/.vale/styles/Microsoft/FirstPerson.yml b/.github/styles/Microsoft/FirstPerson.yml similarity index 100% rename from .vale/styles/Microsoft/FirstPerson.yml rename to .github/styles/Microsoft/FirstPerson.yml diff --git a/.vale/styles/Microsoft/Foreign.yml b/.github/styles/Microsoft/Foreign.yml similarity index 100% rename from .vale/styles/Microsoft/Foreign.yml rename to .github/styles/Microsoft/Foreign.yml diff --git a/.vale/styles/Microsoft/Gender.yml b/.github/styles/Microsoft/Gender.yml similarity index 100% rename from .vale/styles/Microsoft/Gender.yml rename to .github/styles/Microsoft/Gender.yml diff --git a/.vale/styles/Microsoft/GenderBias.yml b/.github/styles/Microsoft/GenderBias.yml similarity index 100% rename from .vale/styles/Microsoft/GenderBias.yml rename to .github/styles/Microsoft/GenderBias.yml diff --git a/.vale/styles/Microsoft/GeneralURL.yml b/.github/styles/Microsoft/GeneralURL.yml similarity index 100% rename from .vale/styles/Microsoft/GeneralURL.yml rename to .github/styles/Microsoft/GeneralURL.yml diff --git a/.vale/styles/Microsoft/HeadingAcronyms.yml b/.github/styles/Microsoft/HeadingAcronyms.yml similarity index 100% rename from .vale/styles/Microsoft/HeadingAcronyms.yml rename to .github/styles/Microsoft/HeadingAcronyms.yml diff --git a/.vale/styles/Microsoft/HeadingColons.yml b/.github/styles/Microsoft/HeadingColons.yml similarity index 100% rename from .vale/styles/Microsoft/HeadingColons.yml rename to .github/styles/Microsoft/HeadingColons.yml diff --git a/.vale/styles/Microsoft/HeadingPunctuation.yml b/.github/styles/Microsoft/HeadingPunctuation.yml similarity index 100% rename from .vale/styles/Microsoft/HeadingPunctuation.yml rename to .github/styles/Microsoft/HeadingPunctuation.yml diff --git a/.vale/styles/Microsoft/Headings.yml b/.github/styles/Microsoft/Headings.yml similarity index 100% rename from .vale/styles/Microsoft/Headings.yml rename to .github/styles/Microsoft/Headings.yml diff --git a/.vale/styles/Microsoft/Hyphens.yml b/.github/styles/Microsoft/Hyphens.yml similarity index 100% rename from .vale/styles/Microsoft/Hyphens.yml rename to .github/styles/Microsoft/Hyphens.yml diff --git a/.vale/styles/Microsoft/Negative.yml b/.github/styles/Microsoft/Negative.yml similarity index 100% rename from .vale/styles/Microsoft/Negative.yml rename to .github/styles/Microsoft/Negative.yml diff --git a/.vale/styles/Microsoft/Ordinal.yml b/.github/styles/Microsoft/Ordinal.yml similarity index 100% rename from .vale/styles/Microsoft/Ordinal.yml rename to .github/styles/Microsoft/Ordinal.yml diff --git a/.vale/styles/Microsoft/OxfordComma.yml b/.github/styles/Microsoft/OxfordComma.yml similarity index 100% rename from .vale/styles/Microsoft/OxfordComma.yml rename to .github/styles/Microsoft/OxfordComma.yml diff --git a/.vale/styles/Microsoft/Passive.yml b/.github/styles/Microsoft/Passive.yml similarity index 100% rename from .vale/styles/Microsoft/Passive.yml rename to .github/styles/Microsoft/Passive.yml diff --git a/.vale/styles/Microsoft/Percentages.yml b/.github/styles/Microsoft/Percentages.yml similarity index 100% rename from .vale/styles/Microsoft/Percentages.yml rename to .github/styles/Microsoft/Percentages.yml diff --git a/.vale/styles/Microsoft/Plurals.yml b/.github/styles/Microsoft/Plurals.yml similarity index 100% rename from .vale/styles/Microsoft/Plurals.yml rename to .github/styles/Microsoft/Plurals.yml diff --git a/.vale/styles/Microsoft/Quotes.yml b/.github/styles/Microsoft/Quotes.yml similarity index 100% rename from .vale/styles/Microsoft/Quotes.yml rename to .github/styles/Microsoft/Quotes.yml diff --git a/.vale/styles/Microsoft/RangeTime.yml b/.github/styles/Microsoft/RangeTime.yml similarity index 100% rename from .vale/styles/Microsoft/RangeTime.yml rename to .github/styles/Microsoft/RangeTime.yml diff --git a/.vale/styles/Microsoft/Semicolon.yml b/.github/styles/Microsoft/Semicolon.yml similarity index 100% rename from .vale/styles/Microsoft/Semicolon.yml rename to .github/styles/Microsoft/Semicolon.yml diff --git a/.vale/styles/Microsoft/SentenceLength.yml b/.github/styles/Microsoft/SentenceLength.yml similarity index 100% rename from .vale/styles/Microsoft/SentenceLength.yml rename to .github/styles/Microsoft/SentenceLength.yml diff --git a/.vale/styles/Microsoft/Spacing.yml b/.github/styles/Microsoft/Spacing.yml similarity index 100% rename from .vale/styles/Microsoft/Spacing.yml rename to .github/styles/Microsoft/Spacing.yml diff --git a/.vale/styles/Microsoft/Suspended.yml b/.github/styles/Microsoft/Suspended.yml similarity index 100% rename from .vale/styles/Microsoft/Suspended.yml rename to .github/styles/Microsoft/Suspended.yml diff --git a/.vale/styles/Microsoft/Terms.yml b/.github/styles/Microsoft/Terms.yml similarity index 100% rename from .vale/styles/Microsoft/Terms.yml rename to .github/styles/Microsoft/Terms.yml diff --git a/.vale/styles/Microsoft/URLFormat.yml b/.github/styles/Microsoft/URLFormat.yml similarity index 100% rename from .vale/styles/Microsoft/URLFormat.yml rename to .github/styles/Microsoft/URLFormat.yml diff --git a/.vale/styles/Microsoft/Units.yml b/.github/styles/Microsoft/Units.yml similarity index 100% rename from .vale/styles/Microsoft/Units.yml rename to .github/styles/Microsoft/Units.yml diff --git a/.vale/styles/Microsoft/Vocab.yml b/.github/styles/Microsoft/Vocab.yml similarity index 100% rename from .vale/styles/Microsoft/Vocab.yml rename to .github/styles/Microsoft/Vocab.yml diff --git a/.vale/styles/Microsoft/We.yml b/.github/styles/Microsoft/We.yml similarity index 100% rename from .vale/styles/Microsoft/We.yml rename to .github/styles/Microsoft/We.yml diff --git a/.vale/styles/Microsoft/Wordiness.yml b/.github/styles/Microsoft/Wordiness.yml similarity index 100% rename from .vale/styles/Microsoft/Wordiness.yml rename to .github/styles/Microsoft/Wordiness.yml diff --git a/.vale/styles/Microsoft/meta.json b/.github/styles/Microsoft/meta.json similarity index 100% rename from .vale/styles/Microsoft/meta.json rename to .github/styles/Microsoft/meta.json diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c32f78a5ba..c553c8136cf 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -33,7 +33,7 @@ repos: args: - "--ignore-words" - ".codespellignore" - exclude: .vale/styles/Microsoft/Avoid.yml + exclude: .github/styles/Microsoft/Avoid.yml - repo: https://github.com/errata-ai/vale rev: v3.9.1 # Use the version of Vale you want diff --git a/.vale.ini b/.vale.ini index ae07b708988..62dd8970cfa 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .vale/styles +StylesPath = .github/styles MinAlertLevel = warning [*.md] diff --git a/.vale/config.json b/.vale/config.json deleted file mode 100644 index abd93b4b5eb..00000000000 --- a/.vale/config.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "Styles": [ - { - "Name": "Microsoft", - "Path": "https://github.com/errata-ai/vale/tree/master/styles/Microsoft" - } - ], - "MinAlertLevel": "warning", - "Extensions": [ - "md" - ] - } From 74d4971d0f339634a79fc2968d1d5f8b4b0d7315 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 31 Dec 2024 11:45:15 +0530 Subject: [PATCH 23/25] added test file to check cli --- test.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 test.md diff --git a/test.md b/test.md new file mode 100644 index 00000000000..339d1218ff3 --- /dev/null +++ b/test.md @@ -0,0 +1 @@ +# TEST FILE \ No newline at end of file From 9a3ac952b1cec0d1e0aafd0625c93638c3fa3a22 Mon Sep 17 00:00:00 2001 From: sanika Date: Tue, 31 Dec 2024 11:48:16 +0530 Subject: [PATCH 24/25] deleted a test file --- test.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 test.md diff --git a/test.md b/test.md deleted file mode 100644 index 339d1218ff3..00000000000 --- a/test.md +++ /dev/null @@ -1 +0,0 @@ -# TEST FILE \ No newline at end of file From 201937ea64e5213557de8259330b5b4895c2bb0d Mon Sep 17 00:00:00 2001 From: Jan Kwakkel Date: Tue, 31 Dec 2024 09:10:44 +0100 Subject: [PATCH 25/25] Update .pre-commit-config.yaml --- .pre-commit-config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c553c8136cf..00a9cf85fb8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,6 +3,7 @@ ci: repos: - repo: https://github.com/astral-sh/ruff-pre-commit + # Ruff version. rev: v0.8.1 hooks: # Run the linter.