ci: add typo detection tool

keep-starknet-strange / joyboy

Decentralized social built with Nostr and powered by Starknet account abstraction.

https://joyboy.community

MIT License

62 stars 41 forks source link

ci: add typo detection tool #139

Closed goofylfg closed 1 month ago

goofylfg commented 1 month ago

Time spent on this PR: 1h

use typos-action detect typos in github action
fixed all checked typos && test github action

Exclude some false postive word, please refer to the configuration file for details. like.

error: `ba` should be `by`, `be`
--> ./onchain/src/bip340.cairo:68:5
|
68 |     ba.append_word(rx.low.into(), 16);
|     ^^
|
error: `ba` should be `by`, `be`
--> ./onchain/src/bip340.cairo:70:5
|
70 |     ba.append_word(px.high.into(), 16);

Result

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
joyboy	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 0:23am
joyboy-webapp	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 0:23am

ugur-eren commented 1 month ago

@maciejka do we need this?

goofylfg commented 1 month ago

I think adding automated tools to check typos is a once and for all way to avoid many subsequent small PRs

maciejka commented 1 month ago

If it does not generate to many false positives.