Check typos in CI

[storopoli]

typos
is a powerful source code spell checker.

• Adds a CI job that runs on every PR and
  push to master (but can also be run manually with
  workflow_dispatch) that checks for typos.

• Adds a config file .typos.toml that deals with
  false positives and only checks for top-level/one-level
  .mediawiki and .md files. This config can be extended
  quite easily with actual terms or regexes to whitelist
  (false-positives)

• Fixes some typos in several BIPs that were flagged locally by typos.

[jonatack]

Concept ACK

[jonatack]

(but can also be run manually with workflow_dispatch)

Can you provide a cross-platform command to run this check manually?

[storopoli]

(but can also be run manually with workflow_dispatch)

Can you provide the cross-platform command to run this check manually? (I tried with macOS)

Install typos and then run from the root dir:

typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md

EDIT: add a typo to any md or mediawiki file and see it being flagged

[jonatack]

Thanks! Tested.

Install typos and then run from the root dir:

typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md

• Would you please update the PR description with that documentation? (Separate from this PR, it may be a good idea to add a CONTRIBUTING file, or a section to the readme, that documents how to run the CI checks manually.)

• Would it make sense to add this task into github-action-checks.yml, and/or make the CI output more like the other tasks:

@@ -1,4 +1,4 @@
-name: Check Typos
+name: GitHub Actions Check
 on:
   push:
     branches:
@@ -8,6 +8,7 @@ on:
 
 jobs:
   typos:
+    name: "Spelling Checks"
     runs-on: ubuntu-latest
     steps:
     - name: Checkout Actions Repository

[storopoli]

• Would you please update the PR description with that documentation? (Separate from this PR, it may be a good idea to add a CONTRIBUTING file, or a section to the readme, that documents how to run the CI checks manually.)

Done, added a CONTRIBUTING.md in ce4351d.

• Would it make sense to add this task into github-action-checks.yml, and/or make the CI output more like the other tasks:

Good idea! I've removed the new typos.yml and added the job in the already existing github-action-checks.yml in ce4351d.

[murchandamus]

Looks good to me, thank you for proposing this and putting in the work!

[murchandamus]

@jonatack: could you take another look whether your change requests have been satisfactorily addressed? I’m not particularly familiar with CI stuff, so please feel free to merge if you feel confident that it’s ready.

[jonatack]

WDYT about simplifying running the linter with something like the following:

diff --git a/.github/workflows/github-action-checks.yml b/.github/workflows/github-action-checks.yml
index 3f1fce9..17f19c1 100644
--- a/.github/workflows/github-action-checks.yml
+++ b/.github/workflows/github-action-checks.yml
@@ -29,5 +29,3 @@ jobs:
     - name: Check spelling
       uses: crate-ci/typos@master
-      with:
-        files: ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
diff --git a/.typos.toml b/.typos.toml
index e645929..e81f41c 100644
--- a/.typos.toml
+++ b/.typos.toml
@@ -27,3 +27,5 @@ Atack = "Atack"
 Meni = "Meni"
 
+[files]
+extend-exclude = ["/*/*.csv", "/*.d*", "/*/*.d*", "/*/*.go", "/*/*.json", "/*/*/*.json", "/*/*.mod", "/*/*.proto", "scripts", "/*/*.s*", "/*/*.t*"]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 506a295..df6d947 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,5 +8,5 @@ install [`typos`](https://github.com/crate-ci/typos)
 and then run in the root directory:
 
-typos ./*.mediawiki ./*.md ./**/*.mediawiki ./**/*.md
+typos

This seems to work better for me locally and it also allows debugging the linter with its built-in options like typos --files.

Edit: about the commit order, it seems best to fix the typos before adding the linter, or in the same commit, as otherwise the commits after adding the linter are non-hygienic.

[storopoli]

Great suggestions! Thanks! I incorporated them all. I also took the liberty of adding .py files since we are not typo checking the scripts for now.

[jonatack]

@storopoli looks good to me (thanks!) A few nits follow. Let me know if you'd like to update for them or merge this pull as-is.

Edit: also suggest doing the spelling fixups in a single commit.

[storopoli]

Addressed all the nits, sorry for the delay...
Thanks!

[jonatack]

ACK 52fdb00 (thanks!)

We could fill out the contributing guide a bit more.