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

Can this be used to spellcheck symbol names in code, not just documentation and comments? #196

Closed
Keavon opened this issue Jul 22, 2021 · 3 comments
Assignees

Comments

@Keavon
Copy link

Keavon commented Jul 22, 2021

For my project (written in Rust and a web component in TypeScript and Vue), I am interested in adding a CI checker to detect spelling errors in the variable/function/etc. names that people contribute, perhaps with a global whitelist file to squelch false positives. Is this tool capable of that, or does it only target documentation and comments as I could glean from the project description?

@drahnr
Copy link
Owner

drahnr commented Jul 22, 2021

Hey, thanks for reaching out!

This will eventually meander into scope of cargo-spellcheck, but this is not an easy problem. Variable names are not necessarily predictable and abbreviations are possible, i.e impl_foo. And that is the main issue for implementing that issue besides a general lack of time.

If you are interested, I'd be happy to mentor you implementing it!

@Keavon
Copy link
Author

Keavon commented Jul 27, 2021

Good to know where the project is headed. My hands are full so I unfortunately can't help with this, but I'll be sure to keep an eye on the project into the future. Thanks for creating it.

@drahnr
Copy link
Owner

drahnr commented Dec 10, 2021

Closing this in favor of #208

@drahnr drahnr closed this as completed Dec 10, 2021
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

No branches or pull requests

2 participants