Skip to content

Add typos for CI, include typos.toml #2664

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

miguelraz
Copy link

Addresses #2660

@rustbot rustbot added the S-waiting-on-review Status: waiting on a review label Apr 15, 2025
@ehuss
Copy link
Contributor

ehuss commented Apr 16, 2025

I don't really have much context here. Why are so many files being ignored?

Also, I would expect some documentation in the contributing guide. For example: What happens if it has a false positive? How do I run this locally?

@ehuss ehuss added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: waiting on a review labels Apr 19, 2025
@szabgab
Copy link
Contributor

szabgab commented Apr 20, 2025

Some of those ignored files had typos. I think at least one of those typos were fixed already.

@miguelraz
Copy link
Author

I'll look into which files still have typos tomorrow.

@miguelraz
Copy link
Author

miguelraz commented Apr 21, 2025

I've added a commit to the CONTRIBUTING.md to show how to install and run locally.

@ehuss The remaining files that are whitelisted are

  • svg files
  • minified js files
  • test input files (some in latin / Lorem Ipsum filler)

Which to me don't make sense to include into typechecking.

That leaves files like src/preprocessor/links.rs which does have a clash where it thinks typ is a typo.

I'd be happy to add a section that mentions whitelisting a word if it runs into a false positive, if people here feel that's the most appropriate way forward.

I can see this being annoying if certain coders are used to abbreviations in their style.

@miguelraz
Copy link
Author

@szabgab pinging since the label says it's waiting on me (author) but I've made changes that could benefit from feedback from reviewers.

@rustbot
Copy link
Collaborator

rustbot commented May 23, 2025

☔ The latest upstream changes (possibly 391ee3b) made this pull request unmergeable. Please resolve the merge conflicts.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants