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 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/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/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/config/vocabularies/Consensys-common/accept.txt b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt index 5644fae..6b834d9 100644 --- a/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt +++ b/docs-spelling-check/styles/config/vocabularies/Consensys-common/accept.txt @@ -94,6 +94,7 @@ InfluxDB Infura [iI]nterlockUrl IntraLayer +[iI]nviter(?:'s)? Irys Jasypt JMeter @@ -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