Skip to content

Commit 506eea7

Browse files
borsbors
committed
Auto merge of #5723 - alexcrichton:cargo-fix, r=ehuss
Import `cargo fix` directly in to Cargo This commit imports the `cargo fix` subcommand in rust-lang-nursery/rustfix directly into Cargo as a subcommand. This should allow us to ease our distribution story of `cargo fix` as we prepare for the upcoming 2018 edition release. It's been attempted here to make the code as idiomatic as possible for Cargo's own codebase. Additionally all tests from cargo-fix were imported into Cargo's test suite as well. After this lands and is published in nightly the `cargo-fix` command in rust-lang-nursery/rustfix will likely be removed. cc rust-lang/rust#52272
2 parents 558eee4 + b02ba37 commit 506eea7

File tree

20 files changed

+1984
-40
lines changed

20 files changed

+1984
-40
lines changed

‎Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ libc = "0.2"
4040
libgit2-sys = "0.7.1"
4141
log = "0.4"
4242
num_cpus = "1.0"
43+
rustfix = "0.4"
4344
same-file = "1"
4445
semver = { version = "0.9.0", features = ["serde"] }
4546
serde = "1.0"

‎src/bin/cargo/commands/fix.rs

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
use command_prelude::*;
2+
3+
use cargo::ops;
4+
5+
pub fn cli() -> App {
6+
subcommand("fix")
7+
.about("Automatically fix lint warnings reported by rustc")
8+
.arg_package_spec(
9+
"Package(s) to fix",
10+
"Fix all packages in the workspace",
11+
"Exclude packages from the fixes",
12+
)
13+
.arg_jobs()
14+
.arg_targets_all(
15+
"Fix only this package's library",
16+
"Fix only the specified binary",
17+
"Fix all binaries",
18+
"Fix only the specified example",
19+
"Fix all examples",
20+
"Fix only the specified test target",
21+
"Fix all tests",
22+
"Fix only the specified bench target",
23+
"Fix all benches",
24+
"Fix all targets (lib and bin targets by default)",
25+
)
26+
.arg_release("Fix artifacts in release mode, with optimizations")
27+
.arg(opt("profile", "Profile to build the selected target for").value_name("PROFILE"))
28+
.arg_features()
29+
.arg_target_triple("Fix for the target triple")
30+
.arg_target_dir()
31+
.arg_manifest_path()
32+
.arg_message_format()
33+
.arg(
34+
Arg::with_name("broken-code")
35+
.long("broken-code")
36+
.help("Fix code even if it already has compiler errors"),
37+
)
38+
.arg(
39+
Arg::with_name("edition")
40+
.long("prepare-for")
41+
.help("Fix warnings in preparation of an edition upgrade")
42+
.takes_value(true)
43+
.possible_values(&["2018"]),
44+
)
45+
.arg(
46+
Arg::with_name("allow-no-vcs")
47+
.long("allow-no-vcs")
48+
.help("Fix code even if a VCS was not detected"),
49+
)
50+
.arg(
51+
Arg::with_name("allow-dirty")
52+
.long("allow-dirty")
53+
.help("Fix code even if the working directory is dirty"),
54+
)
55+
.after_help(
56+
"\
57+
This Cargo subcommmand will automatically take rustc's suggestions from
58+
diagnostics like warnings and apply them to your source code. This is intended
59+
to help automate tasks that rustc itself already knows how to tell you to fix!
60+
The `cargo fix` subcommand is also being developed for the Rust 2018 edition
61+
to provide code the ability to easily opt-in to the new edition without having
62+
to worry about any breakage.
63+
64+
Executing `cargo fix` will under the hood execute `cargo check`. Any warnings
65+
applicable to your crate will be automatically fixed (if possible) and all
66+
remaining warnings will be displayed when the check process is finished. For
67+
example if you'd like to prepare for the 2018 edition, you can do so by
68+
executing:
69+
70+
cargo fix --prepare-for 2018
71+
72+
Note that this is not guaranteed to fix all your code as it only fixes code that
73+
`cargo check` would otherwise compile. For example unit tests are left out
74+
from this command, but they can be checked with:
75+
76+
cargo fix --prepare-for 2018 --all-targets
77+
78+
which behaves the same as `cargo check --all-targets`. Similarly if you'd like
79+
to fix code for different platforms you can do:
80+
81+
cargo fix --prepare-for 2018 --target x86_64-pc-windows-gnu
82+
83+
or if your crate has optional features:
84+
85+
cargo fix --prepare-for 2018 --no-default-features --features foo
86+
87+
If you encounter any problems with `cargo fix` or otherwise have any questions
88+
or feature requests please don't hesitate to file an issue at
89+
https://github.com/rust-lang/cargo
90+
",
91+
)
92+
}
93+
94+
pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
95+
let ws = args.workspace(config)?;
96+
let test = match args.value_of("profile") {
97+
Some("test") => true,
98+
None => false,
99+
Some(profile) => {
100+
let err = format_err!(
101+
"unknown profile: `{}`, only `test` is \
102+
currently supported",
103+
profile
104+
);
105+
return Err(CliError::new(err, 101));
106+
}
107+
};
108+
let mode = CompileMode::Check { test };
109+
ops::fix(&ws, &mut ops::FixOptions {
110+
edition: args.value_of("edition"),
111+
compile_opts: args.compile_options(config, mode)?,
112+
allow_dirty: args.is_present("allow-dirty"),
113+
allow_no_vcs: args.is_present("allow-no-vcs"),
114+
broken_code: args.is_present("broken-code"),
115+
})?;
116+
Ok(())
117+
}

‎src/bin/cargo/commands/mod.rs

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ pub fn builtin() -> Vec<App> {
88
clean::cli(),
99
doc::cli(),
1010
fetch::cli(),
11+
fix::cli(),
1112
generate_lockfile::cli(),
1213
git_checkout::cli(),
1314
init::cli(),
@@ -42,6 +43,7 @@ pub fn builtin_exec(cmd: &str) -> Option<fn(&mut Config, &ArgMatches) -> CliResu
4243
"clean" => clean::exec,
4344
"doc" => doc::exec,
4445
"fetch" => fetch::exec,
46+
"fix" => fix::exec,
4547
"generate-lockfile" => generate_lockfile::exec,
4648
"git-checkout" => git_checkout::exec,
4749
"init" => init::exec,
@@ -76,6 +78,7 @@ pub mod check;
7678
pub mod clean;
7779
pub mod doc;
7880
pub mod fetch;
81+
pub mod fix;
7982
pub mod generate_lockfile;
8083
pub mod git_checkout;
8184
pub mod init;

‎src/bin/cargo/main.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,14 @@ fn main() {
3535
}
3636
};
3737

38-
let result = {
39-
init_git_transports(&mut config);
40-
let _token = cargo::util::job::setup();
41-
cli::main(&mut config)
38+
let result = match cargo::ops::fix_maybe_exec_rustc() {
39+
Ok(true) => Ok(()),
40+
Ok(false) => {
41+
init_git_transports(&mut config);
42+
let _token = cargo::util::job::setup();
43+
cli::main(&mut config)
44+
}
45+
Err(e) => Err(CliError::from(e)),
4246
};
4347

4448
match result {

‎src/cargo/core/compiler/build_config.rs

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
use std::path::Path;
2-
use util::{CargoResult, CargoResultExt, Config};
2+
use std::cell::RefCell;
3+
4+
use util::{CargoResult, CargoResultExt, Config, RustfixDiagnosticServer};
35

46
/// Configuration information for a rustc build.
57
#[derive(Debug)]
@@ -16,6 +18,13 @@ pub struct BuildConfig {
1618
pub message_format: MessageFormat,
1719
/// Output a build plan to stdout instead of actually compiling.
1820
pub build_plan: bool,
21+
/// Use Cargo itself as the wrapper around rustc, only used for `cargo fix`
22+
pub cargo_as_rustc_wrapper: bool,
23+
/// Extra env vars to inject into rustc commands
24+
pub extra_rustc_env: Vec<(String, String)>,
25+
/// Extra args to inject into rustc commands
26+
pub extra_rustc_args: Vec<String>,
27+
pub rustfix_diagnostic_server: RefCell<Option<RustfixDiagnosticServer>>,
1928
}
2029

2130
impl BuildConfig {
@@ -71,6 +80,10 @@ impl BuildConfig {
7180
mode,
7281
message_format: MessageFormat::Human,
7382
build_plan: false,
83+
cargo_as_rustc_wrapper: false,
84+
extra_rustc_env: Vec::new(),
85+
extra_rustc_args: Vec::new(),
86+
rustfix_diagnostic_server: RefCell::new(None),
7487
})
7588
}
7689

‎src/cargo/core/compiler/compilation.rs

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
use std::collections::{BTreeSet, HashMap, HashSet};
2+
use std::env;
23
use std::ffi::OsStr;
34
use std::path::PathBuf;
45

@@ -80,8 +81,24 @@ pub struct Compilation<'cfg> {
8081
}
8182

8283
impl<'cfg> Compilation<'cfg> {
83-
pub fn new<'a>(bcx: &BuildContext<'a, 'cfg>) -> Compilation<'cfg> {
84-
Compilation {
84+
pub fn new<'a>(bcx: &BuildContext<'a, 'cfg>) -> CargoResult<Compilation<'cfg>> {
85+
let mut rustc = bcx.rustc.process();
86+
for (k, v) in bcx.build_config.extra_rustc_env.iter() {
87+
rustc.env(k, v);
88+
}
89+
for arg in bcx.build_config.extra_rustc_args.iter() {
90+
rustc.arg(arg);
91+
}
92+
if bcx.build_config.cargo_as_rustc_wrapper {
93+
let prog = rustc.get_program().to_owned();
94+
rustc.env("RUSTC", prog);
95+
rustc.program(env::current_exe()?);
96+
}
97+
let srv = bcx.build_config.rustfix_diagnostic_server.borrow();
98+
if let Some(server) = &*srv {
99+
server.configure(&mut rustc);
100+
}
101+
Ok(Compilation {
85102
libraries: HashMap::new(),
86103
native_dirs: BTreeSet::new(), // TODO: deprecated, remove
87104
root_output: PathBuf::from("/"),
@@ -96,11 +113,11 @@ impl<'cfg> Compilation<'cfg> {
96113
cfgs: HashMap::new(),
97114
rustdocflags: HashMap::new(),
98115
config: bcx.config,
99-
rustc_process: bcx.rustc.process(),
116+
rustc_process: rustc,
100117
host: bcx.host_triple().to_string(),
101118
target: bcx.target_triple().to_string(),
102119
target_runner: LazyCell::new(),
103-
}
120+
})
104121
}
105122

106123
/// See `process`.

‎src/cargo/core/compiler/context/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
118118

119119
Ok(Self {
120120
bcx,
121-
compilation: Compilation::new(bcx),
121+
compilation: Compilation::new(bcx)?,
122122
build_state: Arc::new(BuildState::new(&bcx.host_config, &bcx.target_config)),
123123
fingerprints: HashMap::new(),
124124
compiled: HashSet::new(),

‎src/cargo/core/compiler/job_queue.rs

+16-3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ use handle_error;
1515
use util::{internal, profile, CargoResult, CargoResultExt, ProcessBuilder};
1616
use util::{Config, DependencyQueue, Dirty, Fresh, Freshness};
1717
use util::{Progress, ProgressStyle};
18+
use util::diagnostic_server;
1819

1920
use super::job::Job;
2021
use super::{BuildContext, BuildPlan, CompileMode, Context, Kind, Unit};
@@ -64,6 +65,7 @@ enum Message<'a> {
6465
BuildPlanMsg(String, ProcessBuilder, Arc<Vec<OutputFile>>),
6566
Stdout(String),
6667
Stderr(String),
68+
FixDiagnostic(diagnostic_server::Message),
6769
Token(io::Result<Acquired>),
6870
Finish(Key<'a>, CargoResult<()>),
6971
}
@@ -134,9 +136,9 @@ impl<'a> JobQueue<'a> {
134136
self.queue.queue_finished();
135137

136138
// We need to give a handle to the send half of our message queue to the
137-
// jobserver helper thread. Unfortunately though we need the handle to be
138-
// `'static` as that's typically what's required when spawning a
139-
// thread!
139+
// jobserver and (optionally) diagnostic helper thread. Unfortunately
140+
// though we need the handle to be `'static` as that's typically what's
141+
// required when spawning a thread!
140142
//
141143
// To work around this we transmute the `Sender` to a static lifetime.
142144
// we're only sending "longer living" messages and we should also
@@ -148,12 +150,20 @@ impl<'a> JobQueue<'a> {
148150
// practice.
149151
let tx = self.tx.clone();
150152
let tx = unsafe { mem::transmute::<Sender<Message<'a>>, Sender<Message<'static>>>(tx) };
153+
let tx2 = tx.clone();
151154
let helper = cx.jobserver
152155
.clone()
153156
.into_helper_thread(move |token| {
154157
drop(tx.send(Message::Token(token)));
155158
})
156159
.chain_err(|| "failed to create helper thread for jobserver management")?;
160+
let _diagnostic_server = cx.bcx.build_config
161+
.rustfix_diagnostic_server
162+
.borrow_mut()
163+
.take()
164+
.map(move |srv| {
165+
srv.start(move |msg| drop(tx2.send(Message::FixDiagnostic(msg))))
166+
});
157167

158168
crossbeam::scope(|scope| self.drain_the_queue(cx, plan, scope, &helper))
159169
}
@@ -279,6 +289,9 @@ impl<'a> JobQueue<'a> {
279289
writeln!(cx.bcx.config.shell().err(), "{}", err)?;
280290
}
281291
}
292+
Message::FixDiagnostic(msg) => {
293+
msg.print_to(cx.bcx.config)?;
294+
}
282295
Message::Finish(key, result) => {
283296
info!("end: {:?}", key);
284297

‎src/cargo/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ extern crate libgit2_sys;
3030
#[macro_use]
3131
extern crate log;
3232
extern crate num_cpus;
33+
extern crate rustfix;
3334
extern crate same_file;
3435
extern crate semver;
3536
#[macro_use]

‎src/cargo/ops/cargo_new.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ pub fn init(opts: &NewOptions, config: &Config) -> CargoResult<()> {
409409
Ok(())
410410
}
411411

412-
fn existing_vcs_repo(path: &Path, cwd: &Path) -> bool {
412+
pub fn existing_vcs_repo(path: &Path, cwd: &Path) -> bool {
413413
GitRepo::discover(path, cwd).is_ok() || HgRepo::discover(path, cwd).is_ok()
414414
}
415415

0 commit comments

Comments
 (0)