Skip to content

Commit 0873893

Browse files
borsbors
authored
Auto merge of #3000 - matklad:error-format, r=alexcrichton
Add --message-format flag. Closes #2982 This adds a `--message-format` flag with values `human` or `json-v1` to commands that may trigger compilation. After the discussion in the issue I am no longer sure that this is a way to go: * Looks like it buys nothing compared to `RUST_FLAGS` approach: a flag is more useful on the command line, but from the tool point of view there should be no significant differences between a flag and an environmental variable. * Looks like we really want to wrap compiler's messages into our own json to tie them to particular compilation.
2 parents d3bad1a + b9ec2b1 commit 0873893

22 files changed

+311
-47
lines changed

‎src/bin/bench.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use cargo::core::Workspace;
2-
use cargo::ops;
2+
use cargo::ops::{self, MessageFormat};
33
use cargo::util::{CliResult, CliError, Human, Config, human};
44
use cargo::util::important_paths::{find_root_manifest_for_wd};
55

@@ -16,6 +16,7 @@ pub struct Options {
1616
flag_verbose: u32,
1717
flag_quiet: Option<bool>,
1818
flag_color: Option<String>,
19+
flag_message_format: MessageFormat,
1920
flag_lib: bool,
2021
flag_bin: Vec<String>,
2122
flag_example: Vec<String>,
@@ -50,6 +51,7 @@ Options:
5051
-v, --verbose ... Use verbose output
5152
-q, --quiet No output printed to stdout
5253
--color WHEN Coloring: auto, always, never
54+
--message-format FMT Error format: human, json [default: human]
5355
--frozen Require Cargo.lock and cache are up to date
5456
--locked Require Cargo.lock is up to date
5557
@@ -75,7 +77,6 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
7577
&options.flag_color,
7678
options.flag_frozen,
7779
options.flag_locked));
78-
7980
let ops = ops::TestOptions {
8081
no_run: options.flag_no_run,
8182
no_fail_fast: false,
@@ -96,6 +97,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
9697
&options.flag_test,
9798
&options.flag_example,
9899
&options.flag_bench),
100+
message_format: options.flag_message_format,
99101
target_rustdoc_args: None,
100102
target_rustc_args: None,
101103
},

‎src/bin/build.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
use std::env;
22

33
use cargo::core::Workspace;
4-
use cargo::ops::CompileOptions;
5-
use cargo::ops;
4+
use cargo::ops::{self, CompileOptions, MessageFormat};
65
use cargo::util::important_paths::{find_root_manifest_for_wd};
76
use cargo::util::{CliResult, Config};
87

@@ -18,6 +17,7 @@ pub struct Options {
1817
flag_verbose: u32,
1918
flag_quiet: Option<bool>,
2019
flag_color: Option<String>,
20+
flag_message_format: MessageFormat,
2121
flag_release: bool,
2222
flag_lib: bool,
2323
flag_bin: Vec<String>,
@@ -52,6 +52,7 @@ Options:
5252
-v, --verbose ... Use verbose output
5353
-q, --quiet No output printed to stdout
5454
--color WHEN Coloring: auto, always, never
55+
--message-format FMT Error format: human, json [default: human]
5556
--frozen Require Cargo.lock and cache are up to date
5657
--locked Require Cargo.lock is up to date
5758
@@ -92,6 +93,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
9293
&options.flag_test,
9394
&options.flag_example,
9495
&options.flag_bench),
96+
message_format: options.flag_message_format,
9597
target_rustdoc_args: None,
9698
target_rustc_args: None,
9799
};

‎src/bin/doc.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use cargo::core::Workspace;
2-
use cargo::ops;
2+
use cargo::ops::{self, MessageFormat};
33
use cargo::util::{CliResult, Config};
44
use cargo::util::important_paths::{find_root_manifest_for_wd};
55

@@ -17,6 +17,7 @@ pub struct Options {
1717
flag_verbose: u32,
1818
flag_quiet: Option<bool>,
1919
flag_color: Option<String>,
20+
flag_message_format: MessageFormat,
2021
flag_package: Vec<String>,
2122
flag_lib: bool,
2223
flag_bin: Vec<String>,
@@ -47,6 +48,7 @@ Options:
4748
-v, --verbose ... Use verbose output
4849
-q, --quiet No output printed to stdout
4950
--color WHEN Coloring: auto, always, never
51+
--message-format FMT Error format: human, json [default: human]
5052
--frozen Require Cargo.lock and cache are up to date
5153
--locked Require Cargo.lock is up to date
5254
@@ -85,6 +87,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
8587
&empty,
8688
&empty,
8789
&empty),
90+
message_format: options.flag_message_format,
8891
release: options.flag_release,
8992
mode: ops::CompileMode::Doc {
9093
deps: !options.flag_no_deps,

‎src/bin/install.rs

+1
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
114114
release: !options.flag_debug,
115115
filter: ops::CompileFilter::new(false, &options.flag_bin, &[],
116116
&options.flag_example, &[]),
117+
message_format: ops::MessageFormat::Human,
117118
target_rustc_args: None,
118119
target_rustdoc_args: None,
119120
};

‎src/bin/run.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use cargo::core::Workspace;
2-
use cargo::ops;
2+
use cargo::ops::{self, MessageFormat};
33
use cargo::util::{CliResult, CliError, Config, Human};
44
use cargo::util::important_paths::{find_root_manifest_for_wd};
55

@@ -16,6 +16,7 @@ pub struct Options {
1616
flag_verbose: u32,
1717
flag_quiet: Option<bool>,
1818
flag_color: Option<String>,
19+
flag_message_format: MessageFormat,
1920
flag_release: bool,
2021
flag_frozen: bool,
2122
flag_locked: bool,
@@ -42,6 +43,7 @@ Options:
4243
-v, --verbose ... Use verbose output
4344
-q, --quiet No output printed to stdout
4445
--color WHEN Coloring: auto, always, never
46+
--message-format FMT Error format: human, json [default: human]
4547
--frozen Require Cargo.lock and cache are up to date
4648
--locked Require Cargo.lock is up to date
4749
@@ -91,6 +93,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
9193
bins: &bins, examples: &examples,
9294
}
9395
},
96+
message_format: options.flag_message_format,
9497
target_rustdoc_args: None,
9598
target_rustc_args: None,
9699
};

‎src/bin/rustc.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
use std::env;
22

33
use cargo::core::Workspace;
4-
use cargo::ops::{CompileOptions, CompileMode};
5-
use cargo::ops;
4+
use cargo::ops::{self, CompileOptions, CompileMode, MessageFormat};
65
use cargo::util::important_paths::{find_root_manifest_for_wd};
76
use cargo::util::{CliResult, CliError, Config, human};
87

@@ -19,6 +18,7 @@ pub struct Options {
1918
flag_verbose: u32,
2019
flag_quiet: Option<bool>,
2120
flag_color: Option<String>,
21+
flag_message_format: MessageFormat,
2222
flag_release: bool,
2323
flag_lib: bool,
2424
flag_bin: Vec<String>,
@@ -55,6 +55,7 @@ Options:
5555
-v, --verbose ... Use verbose output
5656
-q, --quiet No output printed to stdout
5757
--color WHEN Coloring: auto, always, never
58+
--message-format FMT Error format: human, json [default: human]
5859
--frozen Require Cargo.lock and cache are up to date
5960
--locked Require Cargo.lock is up to date
6061
@@ -110,6 +111,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
110111
&options.flag_test,
111112
&options.flag_example,
112113
&options.flag_bench),
114+
message_format: options.flag_message_format,
113115
target_rustdoc_args: None,
114116
target_rustc_args: options.arg_opts.as_ref().map(|a| &a[..]),
115117
};

‎src/bin/rustdoc.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use cargo::core::Workspace;
2-
use cargo::ops;
2+
use cargo::ops::{self, MessageFormat};
33
use cargo::util::{CliResult, Config};
44
use cargo::util::important_paths::{find_root_manifest_for_wd};
55

@@ -17,6 +17,7 @@ pub struct Options {
1717
flag_release: bool,
1818
flag_quiet: Option<bool>,
1919
flag_color: Option<String>,
20+
flag_message_format: MessageFormat,
2021
flag_package: Option<String>,
2122
flag_lib: bool,
2223
flag_bin: Vec<String>,
@@ -52,6 +53,7 @@ Options:
5253
-v, --verbose ... Use verbose output
5354
-q, --quiet No output printed to stdout
5455
--color WHEN Coloring: auto, always, never
56+
--message-format FMT Error format: human, json [default: human]
5557
--frozen Require Cargo.lock and cache are up to date
5658
--locked Require Cargo.lock is up to date
5759
@@ -95,6 +97,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
9597
&options.flag_test,
9698
&options.flag_example,
9799
&options.flag_bench),
100+
message_format: options.flag_message_format,
98101
mode: ops::CompileMode::Doc { deps: false },
99102
target_rustdoc_args: Some(&options.arg_opts),
100103
target_rustc_args: None,

‎src/bin/test.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use cargo::core::Workspace;
2-
use cargo::ops;
2+
use cargo::ops::{self, MessageFormat};
33
use cargo::util::{CliResult, CliError, Human, human, Config};
44
use cargo::util::important_paths::{find_root_manifest_for_wd};
55

@@ -23,6 +23,7 @@ pub struct Options {
2323
flag_verbose: u32,
2424
flag_quiet: Option<bool>,
2525
flag_color: Option<String>,
26+
flag_message_format: MessageFormat,
2627
flag_release: bool,
2728
flag_no_fail_fast: bool,
2829
flag_frozen: bool,
@@ -55,6 +56,7 @@ Options:
5556
-v, --verbose ... Use verbose output
5657
-q, --quiet No output printed to stdout
5758
--color WHEN Coloring: auto, always, never
59+
--message-format FMT Error format: human, json [default: human]
5860
--no-fail-fast Run all tests regardless of failure
5961
--frozen Require Cargo.lock and cache are up to date
6062
--locked Require Cargo.lock is up to date
@@ -92,6 +94,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
9294
&options.flag_color,
9395
options.flag_frozen,
9496
options.flag_locked));
97+
9598
let root = try!(find_root_manifest_for_wd(options.flag_manifest_path, config.cwd()));
9699

97100
let empty = Vec::new();
@@ -124,6 +127,7 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
124127
release: options.flag_release,
125128
mode: mode,
126129
filter: filter,
130+
message_format: options.flag_message_format,
127131
target_rustdoc_args: None,
128132
target_rustc_args: None,
129133
},

‎src/cargo/lib.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,7 @@ pub fn version() -> String {
211211
})
212212
}
213213

214-
fn flags_from_args<T>(usage: &str, args: &[String],
215-
options_first: bool) -> CliResult<T>
214+
fn flags_from_args<T>(usage: &str, args: &[String], options_first: bool) -> CliResult<T>
216215
where T: Decodable
217216
{
218217
let docopt = Docopt::new(usage).unwrap()

‎src/cargo/ops/cargo_compile.rs

+10-1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ pub struct CompileOptions<'a> {
5959
pub release: bool,
6060
/// Mode for this compile.
6161
pub mode: CompileMode,
62+
/// `--error_format` flag for the compiler.
63+
pub message_format: MessageFormat,
6264
/// Extra arguments to be passed to rustdoc (for main crate and dependencies)
6365
pub target_rustdoc_args: Option<&'a [String]>,
6466
/// The specified target will be compiled with all the available arguments,
@@ -74,6 +76,12 @@ pub enum CompileMode {
7476
Doc { deps: bool },
7577
}
7678

79+
#[derive(Clone, Copy, PartialEq, Eq, RustcDecodable)]
80+
pub enum MessageFormat {
81+
Human,
82+
Json
83+
}
84+
7785
pub enum CompileFilter<'a> {
7886
Everything,
7987
Only {
@@ -150,7 +158,7 @@ pub fn compile_ws<'a>(ws: &Workspace<'a>,
150158
let root_package = try!(ws.current());
151159
let CompileOptions { config, jobs, target, spec, features,
152160
all_features, no_default_features,
153-
release, mode,
161+
release, mode, message_format,
154162
ref filter, ref exec_engine,
155163
ref target_rustdoc_args,
156164
ref target_rustc_args } = *options;
@@ -242,6 +250,7 @@ pub fn compile_ws<'a>(ws: &Workspace<'a>,
242250
build_config.exec_engine = exec_engine.clone();
243251
build_config.release = release;
244252
build_config.test = mode == CompileMode::Test;
253+
build_config.json_errors = message_format == MessageFormat::Json;
245254
if let CompileMode::Doc { deps } = mode {
246255
build_config.doc_all = deps;
247256
}

‎src/cargo/ops/cargo_package.rs

+1
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ fn run_verify(ws: &Workspace, tar: &File, opts: &PackageOpts) -> CargoResult<()>
295295
filter: ops::CompileFilter::Everything,
296296
exec_engine: None,
297297
release: false,
298+
message_format: ops::MessageFormat::Human,
298299
mode: ops::CompileMode::Build,
299300
target_rustdoc_args: None,
300301
target_rustc_args: None,

‎src/cargo/ops/cargo_rustc/custom_build.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ fn build_work<'a, 'cfg>(cx: &mut Context<'a, 'cfg>, unit: &Unit<'a>)
206206
state.running(&p);
207207
let cmd = p.into_process_builder();
208208
let output = try!(cmd.exec_with_streaming(
209-
&mut |out_line| state.stdout(out_line),
210-
&mut |err_line| state.stderr(err_line),
209+
&mut |out_line| { state.stdout(out_line); Ok(()) },
210+
&mut |err_line| { state.stderr(err_line); Ok(()) },
211211
).map_err(|mut e| {
212212
e.desc = format!("failed to run custom build command for `{}`\n{}",
213213
pkg_name, e.desc);

‎src/cargo/ops/cargo_rustc/mod.rs

+36-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ use std::fs;
55
use std::path::{self, PathBuf};
66
use std::sync::Arc;
77

8+
use rustc_serialize::json;
9+
810
use core::{Package, PackageId, PackageSet, Target, Resolve};
911
use core::{Profile, Profiles, Workspace};
1012
use core::shell::ColorConfig;
11-
use util::{self, CargoResult, human};
13+
use util::{self, CargoResult, human, machine_message};
1214
use util::{Config, internal, ChainError, profile, join_paths, short_hash};
1315

1416
use self::job::{Job, Work};
@@ -44,6 +46,7 @@ pub struct BuildConfig {
4446
pub release: bool,
4547
pub test: bool,
4648
pub doc_all: bool,
49+
pub json_errors: bool,
4750
}
4851

4952
#[derive(Clone, Default)]
@@ -213,7 +216,6 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
213216
}
214217
}
215218
let has_custom_args = unit.profile.rustc_args.is_some();
216-
let exec_engine = cx.exec_engine.clone();
217219

218220
let filenames = try!(cx.target_filenames(unit));
219221
let root = cx.out_dir(unit);
@@ -241,7 +243,9 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
241243
let cwd = cx.config.cwd().to_path_buf();
242244

243245
rustc.args(&try!(cx.rustflags_args(unit)));
244-
246+
let json_errors = cx.build_config.json_errors;
247+
let package_id = unit.pkg.package_id().clone();
248+
let target = unit.target.clone();
245249
return Ok(Work::new(move |state| {
246250
// Only at runtime have we discovered what the extra -L and -l
247251
// arguments are for native libraries, so we process those here. We
@@ -267,7 +271,31 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
267271
}
268272

269273
state.running(&rustc);
270-
try!(exec_engine.exec(rustc).chain_error(|| {
274+
let process_builder = rustc.into_process_builder();
275+
try!(if json_errors {
276+
process_builder.exec_with_streaming(
277+
&mut |line| if !line.is_empty() {
278+
Err(internal(&format!("compiler stdout is not empty: `{}`", line)))
279+
} else {
280+
Ok(())
281+
},
282+
&mut |line| {
283+
let compiler_message = try!(json::Json::from_str(line).map_err(|_| {
284+
internal(&format!("compiler produced invalid json: `{}`", line))
285+
}));
286+
287+
machine_message::FromCompiler::new(
288+
&package_id,
289+
&target,
290+
compiler_message
291+
).emit();
292+
293+
Ok(())
294+
},
295+
).map(|_| ())
296+
} else {
297+
process_builder.exec()
298+
}.chain_error(|| {
271299
human(format!("Could not compile `{}`.", name))
272300
}));
273301

@@ -496,6 +524,10 @@ fn build_base_args(cx: &Context,
496524
cmd.arg("--color").arg(&color_config.to_string());
497525
}
498526

527+
if cx.build_config.json_errors {
528+
cmd.arg("--error-format").arg("json");
529+
}
530+
499531
cmd.arg("--crate-name").arg(&unit.target.crate_name());
500532

501533
if !test {

0 commit comments

Comments
 (0)