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

Add typos #422

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Add typos #422

merged 1 commit into from
Mar 27, 2024

Conversation

jayvdb
Copy link
Contributor

@jayvdb jayvdb commented Mar 26, 2024

https://github.com/crate-ci/typos is installable via binstall via QuickInstall as "typos-cli".

I am not sure what criteria is used for adding binaries directly to install-action . Justification is this is becoming a very popular tool to use in Rust crates due to very low noise.

Also should this be called "typos", which is the binary name , or stick with the crate name "typos-cli".

@jayvdb jayvdb marked this pull request as ready for review March 26, 2024 10:14
@taiki-e
Copy link
Owner

taiki-e commented Mar 27, 2024

Also should this be called "typos", which is the binary name , or stick with the crate name "typos-cli".

I feel calling it "typos" instead of *-cli is consistent with crate, which uses similar patterns like wasmtime and wasm-bindgen

@taiki-e
Copy link
Owner

taiki-e commented Mar 27, 2024

It seems you have opened two PRs on spellchecking tools, do you need both?

@jayvdb
Copy link
Contributor Author

jayvdb commented Mar 27, 2024

We use both. typos is much better for a first pass, as it recommends correct fixes most of thev time, helping get the right spellings quickly. cargo-spellcheck runs after, then typically picks up the rest of the problems, but its recommendations are not as good, its dicts are incomplete, and whitelisting invovles the more complex myspell dic/aff format. We're also going to add cspell-cli, probably after typos but before cargo-spellcheck. And maybe LanguageTool aa a final later.

Copy link
Owner

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@taiki-e taiki-e merged commit a9f98a0 into taiki-e:main Mar 27, 2024
26 checks passed
@taiki-e
Copy link
Owner

taiki-e commented Mar 27, 2024

Published this and #423 in 2.31.0.

@jayvdb jayvdb deleted the typos branch June 9, 2024 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants