Emit JSON errors #30711

nrc · Jan 5, 2016

The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output.

Closes #10492, closes #14863.

rust-highfive · Jan 5, 2016

r? @sfackler

(rust_highfive has picked a reviewer for you, use r? to override)

huonw · Jan 5, 2016

huonw reviewed Jan 5, 2016

View changes

huonw · Jan 5, 2016

src/librustc/session/config.rs

@@ -855,6 +866,7 @@ pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
                 "NAME=PATH"),
        opt::opt("", "sysroot", "Override the system root", "PATH"),
        opt::multi("Z", "", "Set internal debugging options", "FLAG"),
+        opt::opt_u("", "output", "How errors and other mesasges are produced", "tty|json"),


I suspect we should have --output as the long form of -o, so maybe this could be --error-format or something? Also, the "tty" format might be better as "human", since e.g. json can go to a tty and the human-readable version can go to a file.

("Mesasges" is spelt wrong.)

huonw · Jan 5, 2016

This can probably close #10492 (edit: and #14863).

nrc · Jan 6, 2016

r? @huonw (comment addressed)

huonw · Jan 7, 2016

huonw reviewed Jan 7, 2016

View changes

huonw · Jan 7, 2016

src/test/run-make/json-errors/Makefile

+	cp foo.rs $(TMPDIR)
+	cd $(TMPDIR)
+	$(RUSTC) -Z unstable-options --output=json foo.rs 2>foo.log || true
+	grep -q '{"message":"unresolved name `y`","code":{"code":"E0425","explanation":"\\nAn unresolved name was used. Example of erroneous codes.*"},"level":"error","span":{"file_name":"foo.rs","byte_start":523,"byte_end":524,"line_start":14,"line_end":14,"column_start":18,"column_end":19},"children":\[\]}' foo.log


Maybe there could be an example with suberrors too?

huonw · Jan 7, 2016

huonw reviewed Jan 7, 2016

View changes

huonw · Jan 7, 2016

src/librustc/session/config.rs

@@ -14,7 +14,6 @@
 pub use self::EntryFnType::*;
 pub use self::CrateType::*;
 pub use self::Passes::*;
-pub use self::OptLevel::*;


Should this [breaking-change] be mentioned in the commit message?

huonw · Jan 7, 2016

huonw reviewed Jan 7, 2016

View changes

huonw · Jan 7, 2016

src/librustc/session/config.rs

@@ -855,6 +866,7 @@ pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
                 "NAME=PATH"),
        opt::opt("", "sysroot", "Override the system root", "PATH"),
        opt::multi("Z", "", "Set internal debugging options", "FLAG"),
+        opt::opt_u("", "err-format", "How errors and other messages are produced", "human|json"),


The abbreviation of err instead of just using error doesn't seem worth it to me; thoughts?

Hmm, I started with error-format, and it just looked really long for an option. I agree err-format is not much better though

nrc · Jan 11, 2016

@huonw comments addessed

huonw · Jan 11, 2016

@bors r+

I'm someone concerned about defacto stabilisation of the format, but it is under -Z unstable-options so it probably won't be a problem...

bors · Jan 11, 2016

📌 Commit 4be8667 has been approved by huonw

bors · Jan 11, 2016

⌛️ Testing commit 4be8667 with merge 0af09ca...

bors · Jan 11, 2016

💔 Test failed - auto-win-msvc-64-opt

nrc · Jan 11, 2016

@bors retry

bors · Jan 11, 2016

⌛️ Testing commit 4be8667 with merge 14bc8e5...

bors · Jan 11, 2016

💔 Test failed - auto-mac-64-nopt-t

alexcrichton · Jan 11, 2016

@bors: retry

On Mon, Jan 11, 2016 at 4:40 PM, bors notifications@github.com wrote:

[image: 💔] Test failed - auto-mac-64-nopt-t
http://buildbot.rust-lang.org/builders/auto-mac-64-nopt-t/builds/7658

—
Reply to this email directly or view it on GitHub
#30711 (comment).

ticki · Jan 11, 2016

I'm not sure why bors failing. It compiles fine.

bors · Jan 12, 2016

⌛️ Testing commit 4be8667 with merge 2f2615f...

bors · Jan 12, 2016

💔 Test failed - auto-mac-64-nopt-t

nagisa · Jan 12, 2016

nagisa reviewed Jan 12, 2016

View changes

nagisa · Jan 12, 2016

src/test/run-make/json-errors/foo.rs

+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// ignore-tidy-linelength


whoops left over from an earlier version

nrc · Jan 14, 2016

@bors: r=huonw

bors · Jan 14, 2016

📌 Commit 68653e1 has been approved by huonw

bors · Jan 15, 2016

⌛️ Testing commit 68653e1 with merge 96511fe...

bors · Jan 15, 2016

💔 Test failed - auto-mac-64-nopt-t

nrc · Jan 15, 2016

@bors: r+

bors · Jan 15, 2016

📌 Commit 82f8e5c has been approved by nrc

nrc · Jan 15, 2016

@bors: r=huonw

bors · Jan 15, 2016

📌 Commit 82f8e5c has been approved by huonw

bors · Jan 15, 2016

⌛️ Testing commit 82f8e5c with merge d8869d3...

bors · Jan 15, 2016

💔 Test failed - auto-mac-32-opt

nrc · Jan 15, 2016

@bors retry

bors · Jan 15, 2016

⚡️ Previous build results for auto-linux-cross-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-msvc-32-opt are reusable. Rebuilding only auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-debug-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-linux-musl-64-opt, auto-mac-32-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-64-opt...

nagisa · Jan 15, 2016

Feel free to retry force this because its not landing gonna be causing
spurious errors for all other PRs.
On Jan 15, 2016 6:47 AM, "bors" notifications@github.com wrote:

[image: ⚡️] Previous build results for auto-linux-cross-opt
http://buildbot.rust-lang.org/builders/auto-linux-cross-opt/builds/871,
auto-mac-64-nopt-t
http://buildbot.rust-lang.org/builders/auto-mac-64-nopt-t/builds/7712,
auto-mac-64-opt
http://buildbot.rust-lang.org/builders/auto-mac-64-opt/builds/7676,
auto-win-msvc-32-opt
http://buildbot.rust-lang.org/builders/auto-win-msvc-32-opt/builds/1930
are reusable. Rebuilding only auto-linux-32-nopt-t
http://buildbot.rust-lang.org/builders/auto-linux-32-nopt-t/builds/7691,
auto-linux-32-opt
http://buildbot.rust-lang.org/builders/auto-linux-32-opt/builds/7712,
auto-linux-64-debug-opt
http://buildbot.rust-lang.org/builders/auto-linux-64-debug-opt/builds/962,
auto-linux-64-nopt-t
http://buildbot.rust-lang.org/b%20uilders/auto-linux-64-nopt-t/builds/7649,
auto-linux-64-opt
http://buildbot.rust-lang.org/builders/auto-linux-64-opt/builds/7666,
auto-linux-64-x-android-t
http://buildbot.rust-lang.org/builders/auto-linux-64-x-android-t/builds/7651,
auto-linux-musl-64-opt
http://buildbot.rust-lang.org/builders/auto-linux-musl-64-opt/builds/2821,
auto-mac-32-opt
http://buildbot.rust-lang.org/builders/auto-mac-32-opt/builds/7715,
auto-win-gnu-32-nopt-t
http://buildbot.rust-lang.org/builders/auto-win-gnu-32-nopt-t/builds/2694,
auto-win-gnu-32-opt
http://buildbot.rust-lang.org/builders/auto-win-gnu-32-opt/builds/2709,
auto-win-gnu-64-nopt-t
http://buildbot.rust-lang.org/builders/auto-win-gnu-64-nopt-t/builds/2709,
auto-win-gnu-64-opt
http://buildbot.rust-lang.org/builders/auto-win-gnu-64-opt/builds/2687,
auto-win-msvc-64-opt
http://buildbot.rust-lang.org/builders/auto-win-msvc-6%204-opt/builds/2691
...

—
Reply to this email directly or view it on GitHub
#30711 (comment).

bors · Jan 15, 2016

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-debug-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-linux-cross-opt, auto-linux-musl-64-opt, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-32-opt, auto-win-msvc-64-opt

bruno-medeiros · Mar 10, 2016

Interesting, definitely a welcome addition for the IDE world.

However, I've only found out about this by chance, from seeing #30701 on Rust Weekly. Could we aggregate all changes related to IDE development in some communication channel/method? I was about to suggest an Issues label, however there doesn't seem to be a way to follow one, plus there might be changes spanning from more than one Git project (Cargo and rust for example), so it wouldn't work well to put under one label.

Perhaps we could post about these changes on a tracker issue, like #31548 or a similar one?

rust-highfive assigned sfackler Jan 5, 2016

atsky referenced this pull request Jan 5, 2016
Closed
Error and warning messages in JSON format #202

nrc referenced this pull request Jan 6, 2016
Closed
JSON errors with suggestions are incomplete #30701

rust-highfive assigned huonw and unassigned sfackler Jan 6, 2016

killercup referenced this pull request Jan 7, 2016
Open
Rustc will offer JSON error logging #2

nrc force-pushed the nrc:json-errs branch from bb7e80b to 4be8667 Jan 11, 2016

bors added a commit that referenced this pull request Jan 11, 2016

Auto merge of #30711 - nrc:json-errs, r=huonw
The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output. Closes #10492, closes #14863.

0af09ca

bors added a commit that referenced this pull request Jan 11, 2016

Auto merge of #30711 - nrc:json-errs, r=huonw
The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output. Closes #10492, closes #14863.

14bc8e5

bors added a commit that referenced this pull request Jan 12, 2016

Auto merge of #30711 - nrc:json-errs, r=huonw
The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output. Closes #10492, closes #14863.

2f2615f

nrc force-pushed the nrc:json-errs branch from ddbeb1f to 68653e1 Jan 14, 2016

bors added a commit that referenced this pull request Jan 15, 2016

Auto merge of #30711 - nrc:json-errs, r=huonw
The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output. Closes #10492, closes #14863.

96511fe

Address reviewer comments
[breaking-change] `OptLevel` variants are no longer `pub use`ed by rust::session::config. If you are using these variants, you must change your code to prefix the variant name with `OptLevel`.

Loading status checks…

82f8e5c

nrc force-pushed the nrc:json-errs branch from 68653e1 to 82f8e5c Jan 15, 2016

bors added a commit that referenced this pull request Jan 15, 2016

Auto merge of #30711 - nrc:json-errs, r=huonw
The compiler can emit errors and warning in JSON format. This is a more easily machine readable form then the usual error output. Closes #10492, closes #14863.

d8869d3

bors merged commit 82f8e5c into rust-lang:master Jan 15, 2016
2 checks passed

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

homu Test successful
Details

nrc added the relnotes label Jan 19, 2016

Boddlnagg referenced this pull request Jan 25, 2016
Open
Make rustc output parsing more robust #113

Stebalien referenced this pull request Feb 11, 2016
Closed
--color=always still checks for a terminal before printing colors #31546

oli-obk referenced this pull request Mar 4, 2016
Closed
Is it possible to get cargo's output as json? #1403

ticki referenced this pull request Apr 8, 2016
Merged
Overhaul borrowck error messages and compiler error formatting generally #32756
4 of 4 tasks complete

bruno-medeiros referenced this pull request May 12, 2016
Open
TRACKER for important Rust and Cargo toolchain issues #112

rust-lang/rust

Join GitHub today

Emit JSON errors #30711

Conversation

nrc commented Jan 5, 2016

rust-highfive assigned sfackler Jan 5, 2016

This comment has been minimized.

rust-highfive commented Jan 5, 2016

huonw reviewed Jan 5, 2016 View changes

This comment has been minimized.

This comment has been minimized.

huonw commented Jan 5, 2016

atsky referenced this pull request Jan 5, 2016

nrc referenced this pull request Jan 6, 2016

This comment has been minimized.

nrc commented Jan 6, 2016

rust-highfive assigned huonw and unassigned sfackler Jan 6, 2016

huonw reviewed Jan 7, 2016 View changes

This comment has been minimized.

huonw reviewed Jan 7, 2016 View changes

This comment has been minimized.

huonw reviewed Jan 7, 2016 View changes

This comment has been minimized.

This comment has been minimized.

killercup referenced this pull request Jan 7, 2016

nrc force-pushed the nrc:json-errs branch from bb7e80b to 4be8667 Jan 11, 2016

This comment has been minimized.

nrc commented Jan 11, 2016

This comment has been minimized.

huonw commented Jan 11, 2016

This comment has been minimized.

bors commented Jan 11, 2016

bors added a commit that referenced this pull request Jan 11, 2016

This comment has been minimized.

bors commented Jan 11, 2016

This comment has been minimized.

bors commented Jan 11, 2016

This comment has been minimized.

nrc commented Jan 11, 2016

bors added a commit that referenced this pull request Jan 11, 2016

This comment has been minimized.

bors commented Jan 11, 2016

This comment has been minimized.

bors commented Jan 11, 2016

This comment has been minimized.

alexcrichton commented Jan 11, 2016

This comment has been minimized.

ticki commented Jan 11, 2016

This comment has been minimized.

bors commented Jan 12, 2016

bors added a commit that referenced this pull request Jan 12, 2016

This comment has been minimized.

bors commented Jan 12, 2016

nagisa reviewed Jan 12, 2016 View changes

This comment has been minimized.

This comment has been minimized.

nrc added some commits Dec 31, 2015

nrc force-pushed the nrc:json-errs branch from ddbeb1f to 68653e1 Jan 14, 2016

This comment has been minimized.

nrc commented Jan 14, 2016

This comment has been minimized.

bors commented Jan 14, 2016

This comment has been minimized.

bors commented Jan 15, 2016

bors added a commit that referenced this pull request Jan 15, 2016

This comment has been minimized.

bors commented Jan 15, 2016

nrc force-pushed the nrc:json-errs branch from 68653e1 to 82f8e5c Jan 15, 2016

This comment has been minimized.

nrc commented Jan 15, 2016

This comment has been minimized.

bors commented Jan 15, 2016

This comment has been minimized.

nrc commented Jan 15, 2016

This comment has been minimized.

bors commented Jan 15, 2016

This comment has been minimized.

bors commented Jan 15, 2016

bors added a commit that referenced this pull request Jan 15, 2016

This comment has been minimized.

huonw reviewed Jan 5, 2016

View changes

huonw reviewed Jan 7, 2016

View changes

huonw reviewed Jan 7, 2016

View changes

huonw reviewed Jan 7, 2016

View changes

nrc force-pushed the nrc:json-errs branch from `bb7e80b` to `4be8667` Jan 11, 2016

nagisa reviewed Jan 12, 2016

View changes

nrc force-pushed the nrc:json-errs branch from `ddbeb1f` to `68653e1` Jan 14, 2016

nrc force-pushed the nrc:json-errs branch from `68653e1` to `82f8e5c` Jan 15, 2016

bors merged commit `82f8e5c` into rust-lang:master Jan 15, 2016
2 checks passed