valkey icon indicating copy to clipboard operation
valkey copied to clipboard

Fix typos and replace 'codespell' with 'typos'

Open jayvdb opened this issue 1 year ago • 5 comments

Uses https://github.com/taiki-e/install-action to install https://github.com/crate-ci/typos in CI

This finds many more/different typos than https://github.com/codespell-project/codespell , while having very few false positives.

jayvdb avatar Mar 29 '24 02:03 jayvdb

Please consider dropping codespell. Its dictionary is included in typos: https://github.com/crate-ci/typos/tree/master/crates/codespell-dict

szepeviktor avatar Mar 29 '24 04:03 szepeviktor

Please consider dropping codespell. Its dictionary is included in typos: https://github.com/crate-ci/typos/tree/master/crates/codespell-dict

I am not familiar with codespell nor spellchecker in general. Are you saying that the existing spellchecker is sufficient?

BTW, @jayvdb, all other changes LGTM. Thanks!

PingXie avatar Mar 29 '24 17:03 PingXie

I did a bit of digging and can confirm typos is a superset of codespell wrt to misspelling detection capability, and finer grained configuration. codespell has a few UX features that typos doesnt have, such as an interactive TUI mode. Anyone wanting those features can continue to use codespell locally.

jayvdb avatar Mar 29 '24 20:03 jayvdb

LGTM

How can I run typos locally? It's useful to be able to run it before pushing, instead of waiting for CI failure to find out.

See https://github.com/crate-ci/typos?tab=readme-ov-file#install

jayvdb avatar Mar 30 '24 17:03 jayvdb

How can I run typos locally?

Just download typos, it is a single binary. Nicely fits in ~/bin/ https://github.com/crate-ci/typos/releases

szepeviktor avatar Mar 30 '24 18:03 szepeviktor

Looks like we are in general agreement with the bulk of the changes. I am going to merge this PR now to reduce the PR backlog. We can always take incremental changes.

PingXie avatar Mar 31 '24 19:03 PingXie