From 02fc1bf996edda2f06b0d2b80c55f9f712273da8 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 30 Jan 2026 12:20:24 +0000 Subject: [PATCH 1/9] attempted fix to lint only changed files --- docs-spelling-check/action.yml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/docs-spelling-check/action.yml b/docs-spelling-check/action.yml index b18a3b0..e36839a 100644 --- a/docs-spelling-check/action.yml +++ b/docs-spelling-check/action.yml @@ -3,12 +3,6 @@ name: 'test: spelling' description: 'Composite action to test spelling' -inputs: - FILEPATHS: - description: 'Filepaths to look at, specified as a comma separated string with glob patterns ie "docs/**/*.md,blog/**/*.mdx,etc"' - required: false - default: 'docs/**/*.md,docs/**/*.mdx' - runs: using: "composite" steps: @@ -22,9 +16,7 @@ runs: - uses: tj-actions/changed-files@2f7c5bfce28377bc069a65ba478de0a74aa0ca32 id: changed-files with: - files: ${{ inputs.FILEPATHS }} - separator: ',' - output_separator: '\n' + files_separator: "," - uses: actions/setup-python@v6 with: @@ -36,6 +28,7 @@ runs: uses: errata-ai/vale-action@38bf078c328061f59879b347ca344a718a736018 with: files: ${{ steps.changed-files.outputs.all_changed_files }} + separator: "," vale_flags: "--config .github-actions/docs-spelling-check/.vale.ini" # fail_on_error: true reporter: github-pr-check From c2d1847af4e07f990aa8781c09ab30e7fce8a607 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 30 Jan 2026 12:30:22 +0000 Subject: [PATCH 2/9] filtering to md and mdx to please bot --- docs-spelling-check/action.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs-spelling-check/action.yml b/docs-spelling-check/action.yml index e36839a..85feb72 100644 --- a/docs-spelling-check/action.yml +++ b/docs-spelling-check/action.yml @@ -16,6 +16,9 @@ runs: - uses: tj-actions/changed-files@2f7c5bfce28377bc069a65ba478de0a74aa0ca32 id: changed-files with: + files: | + **/*.md + **/*.mdx files_separator: "," - uses: actions/setup-python@v6 From fe8daa0c093c907c79b4698e80aa55bb43daff82 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 30 Jan 2026 12:33:35 +0000 Subject: [PATCH 3/9] specifying two separators to please bot, making it new line to assist people --- docs-spelling-check/action.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-spelling-check/action.yml b/docs-spelling-check/action.yml index 85feb72..6451ec4 100644 --- a/docs-spelling-check/action.yml +++ b/docs-spelling-check/action.yml @@ -19,7 +19,7 @@ runs: files: | **/*.md **/*.mdx - files_separator: "," + files_separator: "\n" - uses: actions/setup-python@v6 with: @@ -31,7 +31,7 @@ runs: uses: errata-ai/vale-action@38bf078c328061f59879b347ca344a718a736018 with: files: ${{ steps.changed-files.outputs.all_changed_files }} - separator: "," + separator: "\n" vale_flags: "--config .github-actions/docs-spelling-check/.vale.ini" # fail_on_error: true reporter: github-pr-check From 830c1840afc44e88c7820441240c1190d75c84e7 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Thu, 12 Feb 2026 12:59:51 +0000 Subject: [PATCH 4/9] adds rules --- .../styles/config/vocabularies/Consensys-common/accept.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt index 5644fae..2d0b212 100644 --- a/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt +++ b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt @@ -90,6 +90,7 @@ Homebrew [hH]ostname[s]? HSM[s]? Hyperledger +[iI]nviter(?:'s)? InfluxDB Infura [iI]nterlockUrl @@ -158,6 +159,7 @@ paramStructure [pP]asswordless Pegasys [pP]ermission(?:ing|ed)? +[pP]imlico(?:'s)? [pP]repend(?:s|ing|ed)? [Pp]recompile[s]? Photoshop @@ -242,6 +244,7 @@ USB Armory Mk II Vercel Vertx vCPU[s]? +[vV]iem(?:'s)? [vV]ue [wW]agmi [wW]eb3 From 6c6b63693d94403f1330a3de851aa2a345a96c40 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Thu, 12 Feb 2026 13:23:31 +0000 Subject: [PATCH 5/9] fix to pls bot; file separator --- docs-spelling-check/action.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs-spelling-check/action.yml b/docs-spelling-check/action.yml index 762ef42..19c6205 100644 --- a/docs-spelling-check/action.yml +++ b/docs-spelling-check/action.yml @@ -27,6 +27,8 @@ runs: files: ${{ inputs.FILEPATHS }} # input files separator files_separator: "\n" + # output files separator + separator: "\n" - uses: actions/setup-python@v6 with: From 273f1c4a2e5a51a9b0849d2828e732bbfae459cf Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Thu, 12 Feb 2026 13:24:23 +0000 Subject: [PATCH 6/9] fix to pls bot; alphabetical --- .../styles/config/vocabularies/Consensys-common/accept.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt index 2d0b212..6b834d9 100644 --- a/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt +++ b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt @@ -90,11 +90,11 @@ Homebrew [hH]ostname[s]? HSM[s]? Hyperledger -[iI]nviter(?:'s)? InfluxDB Infura [iI]nterlockUrl IntraLayer +[iI]nviter(?:'s)? Irys Jasypt JMeter From e1f2ca0610121706cf09b3b417083f70c20f061a Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Thu, 12 Feb 2026 13:54:50 +0000 Subject: [PATCH 7/9] run vale on this repo --- .github/workflows/spelling.yml | 23 +++++++++++++++++++++++ .gitignore | 5 ++++- 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/spelling.yml diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml new file mode 100644 index 0000000..8096a5a --- /dev/null +++ b/.github/workflows/spelling.yml @@ -0,0 +1,23 @@ +--- +name: Spell check + +on: + pull_request: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + +jobs: + vale: + name: Vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + with: + fetch-depth: 0 + - name: Run Vale + uses: ./docs-spelling-check diff --git a/.gitignore b/.gitignore index 3d72576..db9e7b5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ .DS_Store -.idea \ No newline at end of file +.idea +docs-spelling-check/styles/Microsoft/ +docs-spelling-check/styles/proselint/ +docs-spelling-check/styles/write-good/ \ No newline at end of file From 7c45e05a8edc8c1305289f86e1dea3dee397d21c Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Mon, 16 Feb 2026 09:01:31 +0000 Subject: [PATCH 8/9] clean out pr to style only --- docs-spelling-check/.vale.ini | 3 +++ docs-spelling-check/action.yml | 4 ++-- docs-spelling-check/styles/Consensys/Headings.yml | 1 + docs-spelling-check/styles/Microsoft/Acronyms.yml | 1 - docs-spelling-check/styles/Microsoft/Adverbs.yml | 13 ++++++++++++- docs-spelling-check/styles/Microsoft/Auto.yml | 2 +- .../styles/Microsoft/Contractions.yml | 2 +- docs-spelling-check/styles/Microsoft/Dashes.yml | 2 +- docs-spelling-check/styles/Microsoft/Ellipses.yml | 2 +- .../styles/Microsoft/HeadingPunctuation.yml | 4 ++-- docs-spelling-check/styles/Microsoft/Negative.yml | 2 +- docs-spelling-check/styles/Microsoft/Quotes.yml | 2 +- docs-spelling-check/styles/Microsoft/Terms.yml | 2 +- docs-spelling-check/styles/Microsoft/Very.yml | 6 ------ docs-spelling-check/styles/Microsoft/Wordiness.yml | 4 ++-- docs-spelling-check/styles/proselint/Typography.yml | 4 +++- docs-spelling-check/styles/write-good/So.yml | 2 +- docs-spelling-check/styles/write-good/ThereIs.yml | 2 +- 18 files changed, 34 insertions(+), 24 deletions(-) delete mode 100644 docs-spelling-check/styles/Microsoft/Very.yml diff --git a/docs-spelling-check/.vale.ini b/docs-spelling-check/.vale.ini index 2e97190..ccdbfc4 100644 --- a/docs-spelling-check/.vale.ini +++ b/docs-spelling-check/.vale.ini @@ -82,6 +82,9 @@ Microsoft.Contractions = NO # Microsoft.GeneralURL is not relevant Microsoft.GeneralURL = NO +# Allow "agent" variants despite Microsoft.Terms preference +Microsoft.Terms.Ignore = (?i)\bagents?\b + # Allows Microsoft.Adverbs to take precedence Microsoft.Very = NO diff --git a/docs-spelling-check/action.yml b/docs-spelling-check/action.yml index 19c6205..327385f 100644 --- a/docs-spelling-check/action.yml +++ b/docs-spelling-check/action.yml @@ -10,6 +10,8 @@ inputs: default: | **/*.md **/*.mdx + + runs: using: "composite" steps: @@ -27,8 +29,6 @@ runs: files: ${{ inputs.FILEPATHS }} # input files separator files_separator: "\n" - # output files separator - separator: "\n" - uses: actions/setup-python@v6 with: diff --git a/docs-spelling-check/styles/Consensys/Headings.yml b/docs-spelling-check/styles/Consensys/Headings.yml index 4d7adf3..2e5bf11 100644 --- a/docs-spelling-check/styles/Consensys/Headings.yml +++ b/docs-spelling-check/styles/Consensys/Headings.yml @@ -42,6 +42,7 @@ exceptions: - Ethers.js - EthSigner - EVM + - Embedded Wallets - FAQs - Flask - Go diff --git a/docs-spelling-check/styles/Microsoft/Acronyms.yml b/docs-spelling-check/styles/Microsoft/Acronyms.yml index bfd983f..308ff7c 100644 --- a/docs-spelling-check/styles/Microsoft/Acronyms.yml +++ b/docs-spelling-check/styles/Microsoft/Acronyms.yml @@ -43,7 +43,6 @@ exceptions: - POST - RAM - REPL - - REST - RSA - SCM - SCSS diff --git a/docs-spelling-check/styles/Microsoft/Adverbs.yml b/docs-spelling-check/styles/Microsoft/Adverbs.yml index 980e03d..5619f99 100644 --- a/docs-spelling-check/styles/Microsoft/Adverbs.yml +++ b/docs-spelling-check/styles/Microsoft/Adverbs.yml @@ -8,6 +8,7 @@ action: tokens: - abnormally - absentmindedly + - accidentally - adventurously - anxiously - arrogantly @@ -75,6 +76,7 @@ tokens: - frenetically - frightfully - furiously + - generally - generously - gently - gladly @@ -144,29 +146,35 @@ tokens: - 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 @@ -176,21 +184,24 @@ tokens: - rigidly - roughly - rudely + - safely - scarcely - scarily - searchingly - sedately - seemingly - selfishly + - separately - seriously - shakily - sharply - sheepishly - shrilly - shyly - - simply + - silently - sleepily - slowly + - smoothly - softly - solemnly - solidly diff --git a/docs-spelling-check/styles/Microsoft/Auto.yml b/docs-spelling-check/styles/Microsoft/Auto.yml index ab92f11..4da4393 100644 --- a/docs-spelling-check/styles/Microsoft/Auto.yml +++ b/docs-spelling-check/styles/Microsoft/Auto.yml @@ -2,7 +2,7 @@ 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: warning +level: error action: name: convert params: diff --git a/docs-spelling-check/styles/Microsoft/Contractions.yml b/docs-spelling-check/styles/Microsoft/Contractions.yml index 6c4b3cf..8c81dcb 100644 --- a/docs-spelling-check/styles/Microsoft/Contractions.yml +++ b/docs-spelling-check/styles/Microsoft/Contractions.yml @@ -1,7 +1,7 @@ extends: substitution message: "Use '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: suggestion +level: error ignorecase: true action: name: replace diff --git a/docs-spelling-check/styles/Microsoft/Dashes.yml b/docs-spelling-check/styles/Microsoft/Dashes.yml index 5bd21f9..72b05ba 100644 --- a/docs-spelling-check/styles/Microsoft/Dashes.yml +++ b/docs-spelling-check/styles/Microsoft/Dashes.yml @@ -3,7 +3,7 @@ message: "Remove the spaces around '%s'." link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes ignorecase: true nonword: true -level: warning +level: error action: name: edit params: diff --git a/docs-spelling-check/styles/Microsoft/Ellipses.yml b/docs-spelling-check/styles/Microsoft/Ellipses.yml index 6a00a61..320457a 100644 --- a/docs-spelling-check/styles/Microsoft/Ellipses.yml +++ b/docs-spelling-check/styles/Microsoft/Ellipses.yml @@ -2,7 +2,7 @@ extends: existence message: "In general, don't use an ellipsis." link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses nonword: true -level: suggestion +level: warning action: name: remove tokens: diff --git a/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml b/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml index 4c50b46..4954cb1 100644 --- a/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml +++ b/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml @@ -8,6 +8,6 @@ action: name: edit params: - trim_right - - ".!" + - ".?!" tokens: - - "[a-z][.!]$" + - "[a-z][.?!]$" diff --git a/docs-spelling-check/styles/Microsoft/Negative.yml b/docs-spelling-check/styles/Microsoft/Negative.yml index e5e7dda..d73221f 100644 --- a/docs-spelling-check/styles/Microsoft/Negative.yml +++ b/docs-spelling-check/styles/Microsoft/Negative.yml @@ -2,7 +2,7 @@ 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: suggestion +level: error action: name: edit params: diff --git a/docs-spelling-check/styles/Microsoft/Quotes.yml b/docs-spelling-check/styles/Microsoft/Quotes.yml index 3d3bf7e..38f4976 100644 --- a/docs-spelling-check/styles/Microsoft/Quotes.yml +++ b/docs-spelling-check/styles/Microsoft/Quotes.yml @@ -1,7 +1,7 @@ extends: existence message: 'Punctuation should be inside the quotes.' link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks -level: warning +level: error nonword: true tokens: - '["“][^"”“]+["”][.,]' diff --git a/docs-spelling-check/styles/Microsoft/Terms.yml b/docs-spelling-check/styles/Microsoft/Terms.yml index 856b561..65fca10 100644 --- a/docs-spelling-check/styles/Microsoft/Terms.yml +++ b/docs-spelling-check/styles/Microsoft/Terms.yml @@ -7,7 +7,7 @@ ignorecase: true action: name: replace swap: - "(?:virtual assistant|intelligent personal assistant)": personal digital assistant + "(?: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) diff --git a/docs-spelling-check/styles/Microsoft/Very.yml b/docs-spelling-check/styles/Microsoft/Very.yml deleted file mode 100644 index caf541b..0000000 --- a/docs-spelling-check/styles/Microsoft/Very.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: existence -message: "Remove '%s'." -ignorecase: true -level: suggestion -tokens: - - very \ No newline at end of file diff --git a/docs-spelling-check/styles/Microsoft/Wordiness.yml b/docs-spelling-check/styles/Microsoft/Wordiness.yml index 3d008d1..8a4fea7 100644 --- a/docs-spelling-check/styles/Microsoft/Wordiness.yml +++ b/docs-spelling-check/styles/Microsoft/Wordiness.yml @@ -6,6 +6,7 @@ level: suggestion action: name: replace swap: + "sufficient number(?: of)?": enough (?:extract|take away|eliminate): remove (?:in order to|as a means to): to (?:inform|let me know): tell @@ -16,9 +17,9 @@ swap: 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 of(?! a sudden| these): all all-time record: record almost all: most almost never: seldom @@ -111,7 +112,6 @@ swap: 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 diff --git a/docs-spelling-check/styles/proselint/Typography.yml b/docs-spelling-check/styles/proselint/Typography.yml index ca115fc..60283eb 100644 --- a/docs-spelling-check/styles/proselint/Typography.yml +++ b/docs-spelling-check/styles/proselint/Typography.yml @@ -1,9 +1,11 @@ extends: substitution message: Consider using the '%s' symbol instead of '%s'. -level: warning +level: error nonword: true swap: + '\.\.\.': … '\([cC]\)': © '\(TM\)': ™ '\(tm\)': ™ '\([rR]\)': ® + '[0-9]+ ?x ?[0-9]+': × diff --git a/docs-spelling-check/styles/write-good/So.yml b/docs-spelling-check/styles/write-good/So.yml index 4882534..e57f099 100644 --- a/docs-spelling-check/styles/write-good/So.yml +++ b/docs-spelling-check/styles/write-good/So.yml @@ -1,5 +1,5 @@ extends: existence message: "Don't start a sentence with '%s'." -level: warning +level: error raw: - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/docs-spelling-check/styles/write-good/ThereIs.yml b/docs-spelling-check/styles/write-good/ThereIs.yml index 6666106..8b82e8f 100644 --- a/docs-spelling-check/styles/write-good/ThereIs.yml +++ b/docs-spelling-check/styles/write-good/ThereIs.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't start a sentence with '%s'." ignorecase: false -level: warning +level: error raw: - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' From 94cf93ff7404b88018c2e9a046e929bba48aed50 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Mon, 16 Feb 2026 09:03:40 +0000 Subject: [PATCH 9/9] restore pages --- docs-spelling-check/styles/Microsoft/Acronyms.yml | 1 + docs-spelling-check/styles/Microsoft/Adverbs.yml | 13 +------------ docs-spelling-check/styles/Microsoft/Auto.yml | 2 +- .../styles/Microsoft/Contractions.yml | 2 +- docs-spelling-check/styles/Microsoft/Dashes.yml | 2 +- docs-spelling-check/styles/Microsoft/Ellipses.yml | 2 +- .../styles/Microsoft/HeadingPunctuation.yml | 4 ++-- docs-spelling-check/styles/Microsoft/Negative.yml | 2 +- docs-spelling-check/styles/Microsoft/Quotes.yml | 2 +- docs-spelling-check/styles/Microsoft/Terms.yml | 2 +- docs-spelling-check/styles/Microsoft/Wordiness.yml | 4 ++-- docs-spelling-check/styles/proselint/Typography.yml | 4 +--- docs-spelling-check/styles/write-good/So.yml | 2 +- docs-spelling-check/styles/write-good/ThereIs.yml | 2 +- 14 files changed, 16 insertions(+), 28 deletions(-) diff --git a/docs-spelling-check/styles/Microsoft/Acronyms.yml b/docs-spelling-check/styles/Microsoft/Acronyms.yml index 308ff7c..bfd983f 100644 --- a/docs-spelling-check/styles/Microsoft/Acronyms.yml +++ b/docs-spelling-check/styles/Microsoft/Acronyms.yml @@ -43,6 +43,7 @@ exceptions: - POST - RAM - REPL + - REST - RSA - SCM - SCSS diff --git a/docs-spelling-check/styles/Microsoft/Adverbs.yml b/docs-spelling-check/styles/Microsoft/Adverbs.yml index 5619f99..980e03d 100644 --- a/docs-spelling-check/styles/Microsoft/Adverbs.yml +++ b/docs-spelling-check/styles/Microsoft/Adverbs.yml @@ -8,7 +8,6 @@ action: tokens: - abnormally - absentmindedly - - accidentally - adventurously - anxiously - arrogantly @@ -76,7 +75,6 @@ tokens: - frenetically - frightfully - furiously - - generally - generously - gently - gladly @@ -146,35 +144,29 @@ tokens: - 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 @@ -184,24 +176,21 @@ tokens: - rigidly - roughly - rudely - - safely - scarcely - scarily - searchingly - sedately - seemingly - selfishly - - separately - seriously - shakily - sharply - sheepishly - shrilly - shyly - - silently + - simply - sleepily - slowly - - smoothly - softly - solemnly - solidly diff --git a/docs-spelling-check/styles/Microsoft/Auto.yml b/docs-spelling-check/styles/Microsoft/Auto.yml index 4da4393..ab92f11 100644 --- a/docs-spelling-check/styles/Microsoft/Auto.yml +++ b/docs-spelling-check/styles/Microsoft/Auto.yml @@ -2,7 +2,7 @@ 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 +level: warning action: name: convert params: diff --git a/docs-spelling-check/styles/Microsoft/Contractions.yml b/docs-spelling-check/styles/Microsoft/Contractions.yml index 8c81dcb..6c4b3cf 100644 --- a/docs-spelling-check/styles/Microsoft/Contractions.yml +++ b/docs-spelling-check/styles/Microsoft/Contractions.yml @@ -1,7 +1,7 @@ extends: substitution message: "Use '%s' instead of '%s'." link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions -level: error +level: suggestion ignorecase: true action: name: replace diff --git a/docs-spelling-check/styles/Microsoft/Dashes.yml b/docs-spelling-check/styles/Microsoft/Dashes.yml index 72b05ba..5bd21f9 100644 --- a/docs-spelling-check/styles/Microsoft/Dashes.yml +++ b/docs-spelling-check/styles/Microsoft/Dashes.yml @@ -3,7 +3,7 @@ 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 +level: warning action: name: edit params: diff --git a/docs-spelling-check/styles/Microsoft/Ellipses.yml b/docs-spelling-check/styles/Microsoft/Ellipses.yml index 320457a..6a00a61 100644 --- a/docs-spelling-check/styles/Microsoft/Ellipses.yml +++ b/docs-spelling-check/styles/Microsoft/Ellipses.yml @@ -2,7 +2,7 @@ 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 +level: suggestion action: name: remove tokens: diff --git a/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml b/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml index 4954cb1..4c50b46 100644 --- a/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml +++ b/docs-spelling-check/styles/Microsoft/HeadingPunctuation.yml @@ -8,6 +8,6 @@ action: name: edit params: - trim_right - - ".?!" + - ".!" tokens: - - "[a-z][.?!]$" + - "[a-z][.!]$" diff --git a/docs-spelling-check/styles/Microsoft/Negative.yml b/docs-spelling-check/styles/Microsoft/Negative.yml index d73221f..e5e7dda 100644 --- a/docs-spelling-check/styles/Microsoft/Negative.yml +++ b/docs-spelling-check/styles/Microsoft/Negative.yml @@ -2,7 +2,7 @@ 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 +level: suggestion action: name: edit params: diff --git a/docs-spelling-check/styles/Microsoft/Quotes.yml b/docs-spelling-check/styles/Microsoft/Quotes.yml index 38f4976..3d3bf7e 100644 --- a/docs-spelling-check/styles/Microsoft/Quotes.yml +++ b/docs-spelling-check/styles/Microsoft/Quotes.yml @@ -1,7 +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 +level: warning nonword: true tokens: - '["“][^"”“]+["”][.,]' diff --git a/docs-spelling-check/styles/Microsoft/Terms.yml b/docs-spelling-check/styles/Microsoft/Terms.yml index 65fca10..856b561 100644 --- a/docs-spelling-check/styles/Microsoft/Terms.yml +++ b/docs-spelling-check/styles/Microsoft/Terms.yml @@ -7,7 +7,7 @@ ignorecase: true action: name: replace swap: - "(?:agent|virtual assistant|intelligent personal assistant)": personal digital assistant + "(?: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) diff --git a/docs-spelling-check/styles/Microsoft/Wordiness.yml b/docs-spelling-check/styles/Microsoft/Wordiness.yml index 8a4fea7..3d008d1 100644 --- a/docs-spelling-check/styles/Microsoft/Wordiness.yml +++ b/docs-spelling-check/styles/Microsoft/Wordiness.yml @@ -6,7 +6,6 @@ level: suggestion action: name: replace swap: - "sufficient number(?: of)?": enough (?:extract|take away|eliminate): remove (?:in order to|as a means to): to (?:inform|let me know): tell @@ -17,9 +16,9 @@ swap: 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 of(?! a sudden| these): all all-time record: record almost all: most almost never: seldom @@ -112,6 +111,7 @@ swap: 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 diff --git a/docs-spelling-check/styles/proselint/Typography.yml b/docs-spelling-check/styles/proselint/Typography.yml index 60283eb..ca115fc 100644 --- a/docs-spelling-check/styles/proselint/Typography.yml +++ b/docs-spelling-check/styles/proselint/Typography.yml @@ -1,11 +1,9 @@ extends: substitution message: Consider using the '%s' symbol instead of '%s'. -level: error +level: warning nonword: true swap: - '\.\.\.': … '\([cC]\)': © '\(TM\)': ™ '\(tm\)': ™ '\([rR]\)': ® - '[0-9]+ ?x ?[0-9]+': × diff --git a/docs-spelling-check/styles/write-good/So.yml b/docs-spelling-check/styles/write-good/So.yml index e57f099..4882534 100644 --- a/docs-spelling-check/styles/write-good/So.yml +++ b/docs-spelling-check/styles/write-good/So.yml @@ -1,5 +1,5 @@ extends: existence message: "Don't start a sentence with '%s'." -level: error +level: warning raw: - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/docs-spelling-check/styles/write-good/ThereIs.yml b/docs-spelling-check/styles/write-good/ThereIs.yml index 8b82e8f..6666106 100644 --- a/docs-spelling-check/styles/write-good/ThereIs.yml +++ b/docs-spelling-check/styles/write-good/ThereIs.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't start a sentence with '%s'." ignorecase: false -level: error +level: warning raw: - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'