ci: add typo checking

[storopoli]

Since this is a public-facing documentation/resource repository,
we should be extra-careful and
judicious with typos.

typos is a powerful source code spell checker.

I've added 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.

I've also added a config file .typos.toml that deals with false positives and ignore some vendor related files and some filetypes that we don't want to check/correct for typos,
e.g. lock files.

Finally, I've also corrected a few typos that were in the codebase that typos flagged.

If you want to run yourself you can do a cargo install (or binstall) the typos-cli:

cargo install typos-cli

It is also available in several pkg managers,
check the installation options at the typos repo

[storopoli]

PS: If you find this useful, I can PR this across the rust-bitcoin crate ecosystem.

Cc @apoelstra.

[apoelstra]

utACK 81bbee2.

I'm a bit confused about how this works and distinguishes between bech32/base64/base58/hex words and "real" words. But in general I think it's a good idea and we should have some sort of automatic typo checking. Would also be happy to have this elsewhere in the rust-bitcoin ecosystem.

[apoelstra]

ACK 9cc833b

Awesome, thanks!

[tcharding]

This is sweet, thanks.

ACK 9cc833b

nit: There is a newline missing from the workflow. In case its interesting to you I have my editor configured to add a newline at end of file on save if its missing.

[storopoli]

nit: There is a newline missing from the workflow. In case its interesting to you I have my editor configured to add a newline at end of file on save if its missing.

Done!

[apoelstra]

utACK ac5fc0e

[tcharding]

Needs rebase mate.

[apoelstra]

It looks like now there is a merge commit and an unsigned commit :). Can you try rebasing again.

[tcharding]

Still not quite right :)

I pulled it down and had a look, I think you want to hard reset away the last patch and then rebase on master and fix the two conflicts. You should be left with a single patch.

[storopoli]

Sorry, I was with a unsynced fork. Took me a while to figure out that this was the issue.
But I think it's ready now

[apoelstra]

utACK 6968fbf

[tcharding]

ACK 6968fbf