Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ci/lint english #68

Closed
wants to merge 9 commits into from
27 changes: 27 additions & 0 deletions .github/actions/spelling/advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If you see a bunch of garbage</summary>

If it relates to a ...
<details><summary>well-formed pattern</summary>

See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.

If not, try writing one and adding it to the `patterns.txt` file.

Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.
</details>
<details><summary>binary-ish string</summary>

Please add a file path to the `excludes.txt` file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.

`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
../tree/HEAD/README.md) (on whichever branch you're using).
</details>

</details>
42 changes: 42 additions & 0 deletions .github/actions/spelling/allow.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
OKP4
DAO
DEX
CEX
DAOs
DEXs
CEXs
IPFS
tokenomics
delegator
validator
curator
blockchain
blockchains
cryptocurrency
crypto
dataverse
dataset
tendermint
XaaS
KNOWs
auditability
contextualizations
Cosm
crowdsource
dataverse
delegators
discoverability
hackatons
incentivized
incentivizes
Keplr
multisigs
permissionless
Rulebook
Tendermint
Tokenomics
trustlessly
trustlessness
unbounding
whitepaper
roadmap
17 changes: 17 additions & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
ignore$
\.avi$
\.ico$
\.jpe?g$
\.lock$
\.map$
\.min\.
\.mod$
\.mp[34]$
\.png$
\.wav$
^\.github/
Empty file.
2 changes: 2 additions & 0 deletions .github/actions/spelling/only.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
\.md?$
\.mdx?$
4 changes: 4 additions & 0 deletions .github/actions/spelling/patterns.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns

# ignore long runs of a single character:
\b([A-Za-z])\g{-1}{3,}\b
7 changes: 7 additions & 0 deletions .github/actions/spelling/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
^attache$
benefitting
occurence
Sorce
^[Ss]pae
^untill
^wether
26 changes: 26 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Spell checking
on:
pull_request_target:
workflow_dispatch:

jobs:
spelling:
name: Spell checking
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
- uses: check-spelling/check-spelling@v0.0.20-alpha7
id: spelling
with:
experimental_path: docs/whitepaper
extra_dictionaries:
cspell:cpp/cpp.txt
cspell:aws/aws.txt
cspell:html/html.txt
cspell:django/django.txt
cspell:filetypes/filetypes.txt
cspell:npm/npm.txt
cspell:golang/go.txt
cspell:fullstack/fullstack.txt
cspell:css/css.txt