setup typos check in CI #134006
setup typos check in CI #134006
Conversation
|
r? @nnethercote rustbot has assigned @nnethercote. Use |
rustbot
added
S-waiting-on-review
|
Some changes occurred in exhaustiveness checking cc @Nadrieril Some changes occurred to the CTFE machinery cc @rust-lang/wg-const-eval Some changes occurred in match checking cc @Nadrieril This PR changes MIR cc @oli-obk, @RalfJung, @JakobDegen, @davidtwco, @celinval, @vakaras Some changes occurred to MIR optimizations cc @rust-lang/wg-mir-opt |
This comment has been minimized.
This comment has been minimized.
klensy
force-pushed
the
typos
branch
2 times, most recently
from
f01ec3c to
5b7daa7
Compare
This comment has been minimized.
This comment has been minimized.
|
The Miri subtree was changed cc @rust-lang/miri |
| // token is an identifier, it's probably a misspelled keyword. | ||
| // This handles code like `async Move {}`, misspelled `if` in match guard, misspelled `else` in `if`-`else` | ||
| // and mispelled `where` in a where clause. | ||
| // and misspelled `where` in a where clause. |
There was a problem hiding this comment.
they misspelled "misspelled" 😀
| //! | ||
| //! Note 1: variable bindings (like the `x` in `Some(x)`) match anything, so we treat them as wildcards. | ||
| //! Note 2: this only applies to matcheable values. For example a value of type `Rc<u64>` can't be | ||
| //! Note 2: this only applies to matchable values. For example a value of type `Rc<u64>` can't be |
There was a problem hiding this comment.
Didn't you add an exception for this in typos.toml? I don't know which is correct but if there's an exception this should be kept, presumably.
There was a problem hiding this comment.
Doesn't seem to be reverted. ;)
There was a problem hiding this comment.
Here #134006 (comment) reviewer said that this is not valid word, so i removed exception somewhere here 199e4e7.
|
I seem to recall a previous attempt at having typo-checks in CI that had a ton of false positives, this is much nicer, thanks. I can't approve the CI addition myself (does this require an FCP maybe?), but I looked through the typo fixes and they all look good to me. |
This comment has been minimized.
This comment has been minimized.
rustbot
added
the
A-meta
maybe an MCP? |
| # Add exclusions here, lines should be like `x = "x"`, where `x` is excluded word. | ||
| # | ||
| # Also see docs: https://github.com/crate-ci/typos/blob/v1.28.2/docs/reference.md |
There was a problem hiding this comment.
Based on the documentation these aren't exclusions, they're custom additions to the dictionary.
There was a problem hiding this comment.
Yes, but it is one of the ways to silence linter, so i wrote as exclusions, to simplify wording.
rustbot
added
O-unix
|
Some changes occurred to the intrinsics. Make sure the CTFE / Miri interpreter cc @rust-lang/miri, @rust-lang/wg-const-eval Some changes occurred to the platform-builtins intrinsics. Make sure the cc @antoyo, @GuillaumeGomez, @bjorn3, @calebzulawski, @programmerjake |
bors
added
the
S-waiting-on-bors
|
FYI: This PR integrated typo checking into CI incorrectly by merely adding a new workflow job instead of properly integrating it into our merge CI. This caused the tree to break (#t-infra > Spellcheck workflow now fails on all PRs (tree bad?)) because a PR with a typo was merged after this PR was merged. This is something our CI is designed to prevent via the no rocket science rule, but that only works when the jobs run on merge CI as intended. Any changes to CI should always go through the infra team to help prevent such mistakes. |
|
Sorry for the bustage! Judging by this comment there was some infra team awareness, and the sub-optimal config was similar to how tidy had worked in the past, which explains why it wasn't flagged as a problem. I.e. the situation was a bit complicated. |
|
You're right, as pointed out in the Zulip thread later this is actually more standard than I imagined, which surprised me :D |
|
Sounds like work is underway to tighten things up, so maybe we'll have a happy outcome :) |
14 participants
This allows to check typos in CI, currently for compiler only (to reduce commit size with fixes). With current setup, exclude list is quite short, so it worth trying?
Also includes commits with actual typo fixes.
MCP: rust-lang/compiler-team#817
typos check currently turned for:
After merging, PRs which enables checks for other crates (tools) can be implemented too.
Found typos will not break other jobs immediately: (tests, building compiler for perf run). Job will be marked as red on completion in ~ 20 secs, so you will not forget to fix it whenever you want, before merging pr.
Check typos:
python x.py test tidy --extra-checks=spellcheckApply typo fixes:
python x.py test tidy --extra-checks=spellcheck:fix(in case if there only 1 suggestion of each typo)Current fail in this pr is expected and shows how typo errors emitted. Commit with error will be removed after r+.