Change --no-indent and --prefix-depth to a single --prefix option.

Author: ehuss

src/bin/cargo/commands/tree.rs

@@ -22,14 +22,21 @@ pub fn cli() -> App {
         ))
         .arg(opt("no-dev-dependencies", "Skip dev dependencies"))
         .arg(opt("invert", "Invert the tree direction").short("i"))
-        .arg(opt(
-            "no-indent",
-            "Display the dependencies as a list (rather than a tree)",
-        ))
-        .arg(opt(
-            "prefix-depth",
-            "Display the dependencies as a list (rather than a tree), but prefixed with the depth",
-        ))
+        .arg(Arg::with_name("no-indent").long("no-indent").hidden(true))
+        .arg(
+            Arg::with_name("prefix-depth")
+                .long("prefix-depth")
+                .hidden(true),
+        )
+        .arg(
+            opt(
+                "prefix",
+                "Change the prefix (indentation) of how each entry is displayed",
+            )
+            .value_name("PREFIX")
+            .possible_values(&["depth", "indent", "none"])
+            .default_value("indent"),
+        )
         .arg(opt(
             "no-dedupe",
             "Do not de-duplicate (repeats all shared dependencies)",
@@ -58,9 +65,22 @@ pub fn cli() -> App {
 }
 
 pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
+    if args.is_present("no-indent") {
+        return Err(
+            anyhow::format_err!("the --no-indent flag has been changed to --prefix=none").into(),
+        );
+    }
+    if args.is_present("prefix-depth") {
+        return Err(anyhow::format_err!(
+            "the --prefix-depth flag has been changed to --prefix=depth"
+        )
+        .into());
+    }
     let ws = args.workspace(config)?;
     let charset = tree::Charset::from_str(args.value_of("charset").unwrap())
         .map_err(|e| anyhow::anyhow!("{}", e))?;
+    let prefix = tree::Prefix::from_str(args.value_of("prefix").unwrap())
+        .map_err(|e| anyhow::anyhow!("{}", e))?;
     let opts = tree::TreeOptions {
         features: values(args, "features"),
         all_features: args.is_present("all-features"),
@@ -70,8 +90,7 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
         no_filter_targets: args.is_present("no-filter-targets"),
         no_dev_dependencies: args.is_present("no-dev-dependencies"),
         invert: args.is_present("invert"),
-        no_indent: args.is_present("no-indent"),
-        prefix_depth: args.is_present("prefix-depth"),
+        prefix,
         no_dedupe: args.is_present("no-dedupe"),
         duplicates: args.is_present("duplicates"),
         charset,

src/cargo/ops/tree/mod.rs

@@ -30,10 +30,8 @@ pub struct TreeOptions {
     pub no_filter_targets: bool,
     pub no_dev_dependencies: bool,
     pub invert: bool,
-    /// Displays a list, with no indentation.
-    pub no_indent: bool,
-    /// Displays a list, with a number indicating the depth instead of using indentation.
-    pub prefix_depth: bool,
+    /// The style of prefix for each line.
+    pub prefix: Prefix,
     /// If `true`, duplicates will be repeated.
     /// If `false`, duplicates will be marked with `*`, and their dependencies
     /// won't be shown.
@@ -68,12 +66,25 @@ impl FromStr for Charset {
 }
 
 #[derive(Clone, Copy)]
-enum Prefix {
+pub enum Prefix {
     None,
     Indent,
     Depth,
 }
 
+impl FromStr for Prefix {
+    type Err = &'static str;
+
+    fn from_str(s: &str) -> Result<Prefix, &'static str> {
+        match s {
+            "none" => Ok(Prefix::None),
+            "indent" => Ok(Prefix::Indent),
+            "depth" => Ok(Prefix::Depth),
+            _ => Err("invalid prefix"),
+        }
+    }
+}
+
 struct Symbols {
     down: &'static str,
     tee: &'static str,
@@ -174,14 +185,6 @@ fn print(opts: &TreeOptions, roots: Vec<usize>, graph: &Graph<'_>) -> CargoResul
         Charset::Ascii => &ASCII_SYMBOLS,
     };
 
-    let prefix = if opts.prefix_depth {
-        Prefix::Depth
-    } else if opts.no_indent {
-        Prefix::None
-    } else {
-        Prefix::Indent
-    };
-
     // The visited deps is used to display a (*) whenever a dep has
     // already been printed (ignored with --no-dedupe).
     let mut visited_deps = HashSet::new();
@@ -203,7 +206,7 @@ fn print(opts: &TreeOptions, roots: Vec<usize>, graph: &Graph<'_>) -> CargoResul
             root_index,
             &format,
             symbols,
-            prefix,
+            opts.prefix,
             opts.no_dedupe,
             &mut visited_deps,
             &mut levels_continue,

src/doc/man/cargo-tree.adoc

@@ -99,12 +99,12 @@ strings will be replaced with the corresponding value:
 - `{r}` — The package repository URL.
 - `{f}` — Comma-separated list of package features that are enabled.
 
-*--no-indent*::
-    Display the dependencies as a list (rather than a tree).
-
-*--prefix-depth*::
-    Display the dependencies as a list (rather than a tree), but prefixed with
-    the depth.
+*--prefix* _PREFIX_::
+    Sets how each line is displayed. The _PREFIX_ value can be one of:
++
+- `indent` (default) — Shows each line indented as a tree.
+- `depth` — Show as a list, with the numeric depth printed before each entry.
+- `none` — Show as a flat list.
 
 === Package Selection
 

src/doc/man/generated/cargo-tree.html

@@ -133,14 +133,22 @@ <h3 id="cargo_tree_tree_formatting_options">Tree Formatting Options</h3>
 </ul>
 </div>
 </dd>
-<dt class="hdlist1"><strong>--no-indent</strong></dt>
+<dt class="hdlist1"><strong>--prefix</strong> <em>PREFIX</em></dt>
 <dd>
-<p>Display the dependencies as a list (rather than a tree).</p>
-</dd>
-<dt class="hdlist1"><strong>--prefix-depth</strong></dt>
-<dd>
-<p>Display the dependencies as a list (rather than a tree), but prefixed with
-the depth.</p>
+<p>Sets how each line is displayed. The <em>PREFIX</em> value can be one of:</p>
+<div class="ulist">
+<ul>
+<li>
+<p><code>indent</code> (default) — Shows each line indented as a tree.</p>
+</li>
+<li>
+<p><code>depth</code> — Show as a list, with the numeric depth printed before each entry.</p>
+</li>
+<li>
+<p><code>none</code> — Show as a flat list.</p>
+</li>
+</ul>
+</div>
 </dd>
 </dl>
 </div>

src/etc/man/cargo-tree.1

@@ -2,12 +2,12 @@
 .\"     Title: cargo-tree
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 2.0.10
-.\"      Date: 2020-03-30
+.\"      Date: 2020-04-02
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-TREE" "1" "2020-03-30" "\ \&" "\ \&"
+.TH "CARGO\-TREE" "1" "2020-04-02" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -172,15 +172,42 @@ strings will be replaced with the corresponding value:
 .RE
 .RE
 .sp
-\fB\-\-no\-indent\fP
+\fB\-\-prefix\fP \fIPREFIX\fP
 .RS 4
-Display the dependencies as a list (rather than a tree).
+Sets how each line is displayed. The \fIPREFIX\fP value can be one of:
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.  sp -1
+.  IP \(bu 2.3
+.\}
+\fBindent\fP (default) — Shows each line indented as a tree.
 .RE
 .sp
-\fB\-\-prefix\-depth\fP
 .RS 4
-Display the dependencies as a list (rather than a tree), but prefixed with
-the depth.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.  sp -1
+.  IP \(bu 2.3
+.\}
+\fBdepth\fP — Show as a list, with the numeric depth printed before each entry.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.  sp -1
+.  IP \(bu 2.3
+.\}
+\fBnone\fP — Show as a flat list.
+.RE
 .RE
 .SS "Package Selection"
 .sp

tests/testsuite/tree.rs

@@ -630,7 +630,7 @@ common v1.0.0
 fn no_indent() {
     let p = make_simple_proj();
 
-    p.cargo("tree --no-indent")
+    p.cargo("tree --prefix=none")
         .with_stdout(
             "\
 foo v0.1.0 ([..]/foo)
@@ -651,7 +651,7 @@ b v1.0.0 (*)
 fn prefix_depth() {
     let p = make_simple_proj();
 
-    p.cargo("tree --prefix-depth")
+    p.cargo("tree --prefix=depth")
         .with_stdout(
             "\
 0foo v0.1.0 ([..]/foo)