fix: Make auto-fix note work with clippy
#11399
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @ehuss (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
the
S-waiting-on-review
ehuss
reviewed
Nov 21, 2022
src/cargo/core/compiler/job_queue.rs
Outdated
| // check if `RUSTC_WORKSPACE_WRAPPER` is set. `clippy` sets | ||
| // this when being ran so it can partially be identified | ||
| // when this is set. | ||
| let command = if rustc_workspace_wrapper.is_some() { |
There was a problem hiding this comment.
Unfortunately clippy isn't the only tool which sets RUSTC_WORKSPACE_WRAPPER. I think some other approach will be needed here.
There was a problem hiding this comment.
I was worried about that, I was hoping it would be fine since it was used before. The only thing I can think of is using CLIPPY_ARGS, which appears to pass the test I wrote. I will update it to that.
There was a problem hiding this comment.
After some discussion, it was decided that RUSTC_WORKSPACE_WRAPPER would be better as it is already agreed upon by clippy and cargo. Since other things can use RUSTC_WORKSPACE_WRAPPER, we look for a wrapper named clippy-driver.
Muscraft
force-pushed
the
autofix-for-clippy
branch
2 times, most recently
from
e8e9b8b
to
12f0c8a
Compare
weihanglo
approved these changes
Dec 13, 2022
src/cargo/core/compiler/job_queue.rs
Outdated
Comment on lines
1255
to
1297
| let command = match rustc_workspace_wrapper { | ||
| #[cfg(windows)] | ||
| Some(wrapper) if wrapper.ends_with("clippy-driver.exe") => { | ||
| "cargo clippy --fix" | ||
| } | ||
| #[cfg(not(windows))] | ||
| Some(wrapper) if wrapper.ends_with("clippy-driver") => "cargo clippy --fix", | ||
| _ => "cargo fix", | ||
| }; |
There was a problem hiding this comment.
(nit)
Suggested change
| let command = match rustc_workspace_wrapper { | |
| #[cfg(windows)] | |
| Some(wrapper) if wrapper.ends_with("clippy-driver.exe") => { | |
| "cargo clippy --fix" | |
| } | |
| #[cfg(not(windows))] | |
| Some(wrapper) if wrapper.ends_with("clippy-driver") => "cargo clippy --fix", | |
| _ => "cargo fix", | |
| }; | |
| let clippy = std::ffi::OsStr::new("clippy-driver"); | |
| let command = match rustc_workspace_wrapper.as_ref().and_then(|x| x.file_stem()) | |
| { | |
| Some(wrapper) if wrapper == clippy => "cargo clippy --fix", | |
| _ => "cargo fix", | |
| }; | |
src/cargo/core/compiler/job_queue.rs
Outdated
Comment on lines
1284
to
1322
| " (run `{} --{}` to apply {})", | ||
| command, args, suggestions |
There was a problem hiding this comment.
(nit)
Suggested change
| " (run `{} --{}` to apply {})", | |
| command, args, suggestions | |
| " (run `{command} --{args}` to apply {suggestions})" |
Muscraft
force-pushed
the
autofix-for-clippy
branch
from
12f0c8a
to
857aa32
Compare
Muscraft
force-pushed
the
autofix-for-clippy
branch
from
857aa32
to
33c3208
Compare
|
Thanks! @bors r |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
weihanglo
added a commit
to weihanglo/rust
that referenced
this pull request
Dec 18, 2022
11 commits in cc0a320879c17207bbfb96b5d778e28a2c62030d..c994a4a638370bc7e0ffcbb0e2865afdfa7d4415 2022-12-14 14:46:57 0000 to 2022-12-18 21:50:58 0000 - Fix examples of proc-macro crates being scraped for examples (rust-lang/cargo#11497) - Enable triagebot's relabel functionality (rust-lang/cargo#11498) - Revert "temporarily disable test `lto::test_profile`" (rust-lang/cargo#11495) - Bump to 0.69.0, update changelog (rust-lang/cargo#11493) - Fix typo (rust-lang/cargo#11491) - Display CPU info in CI (rust-lang/cargo#11488) - Fix collision_doc_profile test error (rust-lang/cargo#11489) - fix: Make auto-fix note work with `clippy` (rust-lang/cargo#11399) - fix(add): use the possessive in error message (rust-lang/cargo#11483) - Document home crate in contrib docs (rust-lang/cargo#11481) - Split up registry documentation into multiple sections (rust-lang/cargo#11480)
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 19, 2022
Update cargo 11 commits in cc0a320879c17207bbfb96b5d778e28a2c62030d..c994a4a638370bc7e0ffcbb0e2865afdfa7d4415 2022-12-14 14:46:57 0000 to 2022-12-18 21:50:58 0000 - Fix examples of proc-macro crates being scraped for examples (rust-lang/cargo#11497) - Enable triagebot's relabel functionality (rust-lang/cargo#11498) - Revert "temporarily disable test `lto::test_profile`" (rust-lang/cargo#11495) - Bump to 0.69.0, update changelog (rust-lang/cargo#11493) - Fix typo (rust-lang/cargo#11491) - Display CPU info in CI (rust-lang/cargo#11488) - Fix collision_doc_profile test error (rust-lang/cargo#11489) - fix: Make auto-fix note work with `clippy` (rust-lang/cargo#11399) - fix(add): use the possessive in error message (rust-lang/cargo#11483) - Document home crate in contrib docs (rust-lang/cargo#11481) - Split up registry documentation into multiple sections (rust-lang/cargo#11480) r? `@ghost`
bors
added a commit
that referenced
this pull request
Jan 22, 2023
feat: stabilize auto fix note A note that some warnings could be fixed by running a `cargo fix` command was added in #10989 and made to work with `clippy` in #11399. It has only been turned on for `nightly` builds so far; this PR would make it show on `stable`. The original motivation for making this note `nightly` only, was to [allow for iteration](#10976 (comment)) on the message output. There has yet to be any feedback on the message format in the time that it has been on `nightly`. This was brought up in a recent cargo team meeting and it was thought that we should move forward with showing this on `stable`. close #10976
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Someone pointed out that the suggestion to run
cargo --fixdid not work properly forcargo clippy. This makes sure the correct command to run is output when running undercargo clippy.This is done by checking if the
RUSTC_WORKSPACE_WRAPPERenvironment variable is set, sinceclippysets this every run. Since other things can useRUSTC_WORKSPACE_WRAPPER, we look for a wrapper namedclippy-driver.Since
clippymight not be available everywherecargois tested, this is tested using arustcwrapper.