Skip to content

Commit df8cda0

Browse files
borsbors
committed
Auto merge of #10107 - hi-rustin:rustin-patch-install, r=ehuss
Add --message-format for install command close #10104
2 parents 934bc61 + 890b0e8 commit df8cda0

File tree

6 files changed

+174
-0
lines changed

6 files changed

+174
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ pub fn cli() -> App {
7171
.requires("crate")
7272
.conflicts_with_all(&["git", "path", "index"]),
7373
)
74+
.arg_message_format()
7475
.after_help("Run `cargo help install` for more detailed information.\n")
7576
}
7677

‎src/doc/man/cargo-install.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,9 @@ See also the `--profile` option for choosing a specific profile by name.
185185

186186
{{#options}}
187187
{{> options-display }}
188+
189+
{{> options-message-format }}
190+
188191
{{/options}}
189192

190193
{{> section-options-common }}

‎src/doc/man/generated_txt/cargo-install.txt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,34 @@ OPTIONS
262262
May also be specified with the term.color config value
263263
<https://doc.rust-lang.org/cargo/reference/config.html>.
264264

265+
--message-format fmt
266+
The output format for diagnostic messages. Can be specified multiple
267+
times and consists of comma-separated values. Valid values:
268+
269+
o human (default): Display in a human-readable text format.
270+
Conflicts with short and json.
271+
272+
o short: Emit shorter, human-readable text messages. Conflicts with
273+
human and json.
274+
275+
o json: Emit JSON messages to stdout. See the reference
276+
<https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
277+
for more details. Conflicts with human and short.
278+
279+
o json-diagnostic-short: Ensure the rendered field of JSON messages
280+
contains the "short" rendering from rustc. Cannot be used with
281+
human or short.
282+
283+
o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
284+
messages contains embedded ANSI color codes for respecting
285+
rustc's default color scheme. Cannot be used with human or short.
286+
287+
o json-render-diagnostics: Instruct Cargo to not include rustc
288+
diagnostics in in JSON messages printed, but instead Cargo itself
289+
should render the JSON diagnostics coming from rustc. Cargo's own
290+
JSON diagnostics and others coming from rustc are still emitted.
291+
Cannot be used with human or short.
292+
265293
Common Options
266294
+toolchain
267295
If Cargo has been installed with rustup, and the first argument to

‎src/doc/src/commands/cargo-install.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,31 @@ terminal.</li>
307307
<a href="../reference/config.html">config value</a>.</dd>
308308

309309

310+
311+
<dt class="option-term" id="option-cargo-install---message-format"><a class="option-anchor" href="#option-cargo-install---message-format"></a><code>--message-format</code> <em>fmt</em></dt>
312+
<dd class="option-desc">The output format for diagnostic messages. Can be specified multiple times
313+
and consists of comma-separated values. Valid values:</p>
314+
<ul>
315+
<li><code>human</code> (default): Display in a human-readable text format. Conflicts with
316+
<code>short</code> and <code>json</code>.</li>
317+
<li><code>short</code>: Emit shorter, human-readable text messages. Conflicts with <code>human</code>
318+
and <code>json</code>.</li>
319+
<li><code>json</code>: Emit JSON messages to stdout. See
320+
<a href="../reference/external-tools.html#json-messages">the reference</a>
321+
for more details. Conflicts with <code>human</code> and <code>short</code>.</li>
322+
<li><code>json-diagnostic-short</code>: Ensure the <code>rendered</code> field of JSON messages contains
323+
the &quot;short&quot; rendering from rustc. Cannot be used with <code>human</code> or <code>short</code>.</li>
324+
<li><code>json-diagnostic-rendered-ansi</code>: Ensure the <code>rendered</code> field of JSON messages
325+
contains embedded ANSI color codes for respecting rustc's default color
326+
scheme. Cannot be used with <code>human</code> or <code>short</code>.</li>
327+
<li><code>json-render-diagnostics</code>: Instruct Cargo to not include rustc diagnostics in
328+
in JSON messages printed, but instead Cargo itself should render the
329+
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
330+
coming from rustc are still emitted. Cannot be used with <code>human</code> or <code>short</code>.</li>
331+
</ul></dd>
332+
333+
334+
310335
</dl>
311336

312337
### Common Options

‎src/etc/man/cargo-install.1‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,46 @@ terminal.
342342
May also be specified with the \fBterm.color\fR
343343
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
344344
.RE
345+
.sp
346+
\fB\-\-message\-format\fR \fIfmt\fR
347+
.RS 4
348+
The output format for diagnostic messages. Can be specified multiple times
349+
and consists of comma\-separated values. Valid values:
350+
.sp
351+
.RS 4
352+
\h'-04'\(bu\h'+02'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
353+
\fBshort\fR and \fBjson\fR\&.
354+
.RE
355+
.sp
356+
.RS 4
357+
\h'-04'\(bu\h'+02'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
358+
and \fBjson\fR\&.
359+
.RE
360+
.sp
361+
.RS 4
362+
\h'-04'\(bu\h'+02'\fBjson\fR: Emit JSON messages to stdout. See
363+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
364+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
365+
.RE
366+
.sp
367+
.RS 4
368+
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
369+
the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
370+
.RE
371+
.sp
372+
.RS 4
373+
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
374+
contains embedded ANSI color codes for respecting rustc's default color
375+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
376+
.RE
377+
.sp
378+
.RS 4
379+
\h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in
380+
in JSON messages printed, but instead Cargo itself should render the
381+
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
382+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
383+
.RE
384+
.RE
345385
.SS "Common Options"
346386
.sp
347387
\fB+\fR\fItoolchain\fR

‎tests/testsuite/install.rs‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,83 @@ fn simple() {
5454
assert_has_not_installed_exe(cargo_home(), "foo");
5555
}
5656

57+
#[cargo_test]
58+
fn simple_with_message_format() {
59+
pkg("foo", "0.0.1");
60+
61+
cargo_process("install foo --message-format=json")
62+
.with_stderr(
63+
"\
64+
[UPDATING] `[..]` index
65+
[DOWNLOADING] crates ...
66+
[DOWNLOADED] foo v0.0.1 (registry [..])
67+
[INSTALLING] foo v0.0.1
68+
[COMPILING] foo v0.0.1
69+
[FINISHED] release [optimized] target(s) in [..]
70+
[INSTALLING] [CWD]/home/.cargo/bin/foo[EXE]
71+
[INSTALLED] package `foo v0.0.1` (executable `foo[EXE]`)
72+
[WARNING] be sure to add `[..]` to your PATH to be able to run the installed binaries
73+
",
74+
)
75+
.with_json(
76+
r#"
77+
{
78+
"reason": "compiler-artifact",
79+
"package_id": "foo 0.0.1 ([..])",
80+
"manifest_path": "[..]",
81+
"target": {
82+
"kind": [
83+
"lib"
84+
],
85+
"crate_types": [
86+
"lib"
87+
],
88+
"name": "foo",
89+
"src_path": "[..]/foo-0.0.1/src/lib.rs",
90+
"edition": "2015",
91+
"doc": true,
92+
"doctest": true,
93+
"test": true
94+
},
95+
"profile": "{...}",
96+
"features": [],
97+
"filenames": "{...}",
98+
"executable": null,
99+
"fresh": false
100+
}
101+
102+
{
103+
"reason": "compiler-artifact",
104+
"package_id": "foo 0.0.1 ([..])",
105+
"manifest_path": "[..]",
106+
"target": {
107+
"kind": [
108+
"bin"
109+
],
110+
"crate_types": [
111+
"bin"
112+
],
113+
"name": "foo",
114+
"src_path": "[..]/foo-0.0.1/src/main.rs",
115+
"edition": "2015",
116+
"doc": true,
117+
"doctest": false,
118+
"test": true
119+
},
120+
"profile": "{...}",
121+
"features": [],
122+
"filenames": "{...}",
123+
"executable": "[..]",
124+
"fresh": false
125+
}
126+
127+
{"reason":"build-finished","success":true}
128+
"#,
129+
)
130+
.run();
131+
assert_has_installed_exe(cargo_home(), "foo");
132+
}
133+
57134
#[cargo_test]
58135
fn with_index() {
59136
pkg("foo", "0.0.1");

0 commit comments

Comments
 (0)