Rename --dep-kinds to --edges and fold in --graph-features.

Author: ehuss

src/bin/cargo/commands/tree.rs

@@ -1,7 +1,7 @@
 use crate::command_prelude::*;
 use anyhow::{bail, format_err};
 use cargo::core::dependency::DepKind;
-use cargo::ops::tree;
+use cargo::ops::tree::{self, EdgeKind};
 use cargo::util::CargoResult;
 use std::collections::HashSet;
 use std::str::FromStr;
@@ -32,12 +32,13 @@ pub fn cli() -> App {
                 .hidden(true),
         )
         .arg(
-            opt(
-                "dep-kinds",
-                "Dependency kinds to display \
-                 (normal, build, dev, no-dev, no-build, no-normal, all)",
+            multi_opt(
+                "edges",
+                "KINDS",
+                "The kinds of dependencies to display \
+                 (features, normal, build, dev, all, no-dev, no-build, no-normal)",
             )
-            .value_name("KINDS"),
+            .short("e"),
         )
         .arg(opt("invert", "Invert the tree direction").short("i"))
         .arg(Arg::with_name("no-indent").long("no-indent").hidden(true))
@@ -79,7 +80,6 @@ pub fn cli() -> App {
                 .short("f")
                 .default_value("{p}"),
         )
-        .arg(opt("graph-features", "Include features in the tree"))
 }
 
 pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
@@ -116,15 +116,8 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
     };
     let target = tree::Target::from_cli(target);
 
-    let dep_kinds = if args.is_present("no-dev-dependencies") {
-        config
-            .shell()
-            .warn("the --no-dev-dependencies flag has changed to --dep-kinds=no-dev")?;
-        Some("no-dev")
-    } else {
-        args.value_of("dep-kinds")
-    };
-    let dep_kinds = parse_dep_kinds(dep_kinds)?;
+    let edge_kinds = parse_edge_kinds(config, args)?;
+    let graph_features = edge_kinds.contains(&EdgeKind::Feature);
 
     let ws = args.workspace(config)?;
     let charset = tree::Charset::from_str(args.value_of("charset").unwrap())
@@ -135,44 +128,57 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
         no_default_features: args.is_present("no-default-features"),
         packages: args.packages_from_flags()?,
         target,
-        dep_kinds,
+        edge_kinds,
         invert: args.is_present("invert"),
         prefix,
         no_dedupe: args.is_present("no-dedupe"),
         duplicates: args.is_present("duplicates"),
         charset,
         format: args.value_of("format").unwrap().to_string(),
-        graph_features: args.is_present("graph-features"),
+        graph_features,
     };
 
     tree::build_and_print(&ws, &opts)?;
     Ok(())
 }
 
-fn parse_dep_kinds(kinds: Option<&str>) -> CargoResult<HashSet<DepKind>> {
-    let kinds: Vec<&str> = kinds.unwrap_or("all").split(',').collect();
+fn parse_edge_kinds(config: &Config, args: &ArgMatches<'_>) -> CargoResult<HashSet<EdgeKind>> {
+    let mut kinds: Vec<&str> = args
+        .values_of("edges")
+        .map_or_else(|| Vec::new(), |es| es.flat_map(|e| e.split(',')).collect());
+    if args.is_present("no-dev-dependencies") {
+        config
+            .shell()
+            .warn("the --no-dev-dependencies flag has changed to -e=no-dev")?;
+        kinds.push("no-dev");
+    }
+    if kinds.len() == 0 {
+        kinds.extend(&["normal", "build", "dev"]);
+    }
+
     let mut result = HashSet::new();
-    let insert_all = |result: &mut HashSet<DepKind>| {
-        result.insert(DepKind::Normal);
-        result.insert(DepKind::Build);
-        result.insert(DepKind::Development);
+    let insert_defaults = |result: &mut HashSet<EdgeKind>| {
+        result.insert(EdgeKind::Dep(DepKind::Normal));
+        result.insert(EdgeKind::Dep(DepKind::Build));
+        result.insert(EdgeKind::Dep(DepKind::Development));
     };
     let unknown = |k| {
         bail!(
-            "unknown dependency kind `{}`, valid values are \
+            "unknown edge kind `{}`, valid values are \
                 \"normal\", \"build\", \"dev\", \
                 \"no-normal\", \"no-build\", \"no-dev\", \
-                or \"all\"",
+                \"features\", or \"all\"",
             k
         )
     };
     if kinds.iter().any(|k| k.starts_with("no-")) {
-        insert_all(&mut result);
+        insert_defaults(&mut result);
         for kind in &kinds {
             match *kind {
-                "no-normal" => result.remove(&DepKind::Normal),
-                "no-build" => result.remove(&DepKind::Build),
-                "no-dev" => result.remove(&DepKind::Development),
+                "no-normal" => result.remove(&EdgeKind::Dep(DepKind::Normal)),
+                "no-build" => result.remove(&EdgeKind::Dep(DepKind::Build)),
+                "no-dev" => result.remove(&EdgeKind::Dep(DepKind::Development)),
+                "features" => result.insert(EdgeKind::Feature),
                 "normal" | "build" | "dev" | "all" => {
                     bail!("`no-` dependency kinds cannot be mixed with other dependency kinds")
                 }
@@ -181,20 +187,29 @@ fn parse_dep_kinds(kinds: Option<&str>) -> CargoResult<HashSet<DepKind>> {
         }
         return Ok(result);
     }
-    for kind in kinds {
-        match kind {
-            "all" => insert_all(&mut result),
+    for kind in &kinds {
+        match *kind {
+            "all" => {
+                insert_defaults(&mut result);
+                result.insert(EdgeKind::Feature);
+            }
+            "features" => {
+                result.insert(EdgeKind::Feature);
+            }
             "normal" => {
-                result.insert(DepKind::Normal);
+                result.insert(EdgeKind::Dep(DepKind::Normal));
             }
             "build" => {
-                result.insert(DepKind::Build);
+                result.insert(EdgeKind::Dep(DepKind::Build));
             }
             "dev" => {
-                result.insert(DepKind::Development);
+                result.insert(EdgeKind::Dep(DepKind::Development));
             }
             k => return unknown(k),
         }
     }
+    if kinds.len() == 1 && kinds[0] == "features" {
+        insert_defaults(&mut result);
+    }
     Ok(result)
 }

src/cargo/ops/tree/graph.rs

@@ -333,7 +333,7 @@ fn add_pkg(
                     return false;
                 }
                 // Filter out dev-dependencies if requested.
-                if !opts.dep_kinds.contains(&dep.kind()) {
+                if !opts.edge_kinds.contains(&EdgeKind::Dep(dep.kind())) {
                     return false;
                 }
                 if dep.is_optional() {

src/cargo/ops/tree/mod.rs

@@ -26,7 +26,7 @@ pub struct TreeOptions {
     /// The platform to filter for.
     pub target: Target,
     /// The dependency kinds to display.
-    pub dep_kinds: HashSet<DepKind>,
+    pub edge_kinds: HashSet<EdgeKind>,
     pub invert: bool,
     /// The style of prefix for each line.
     pub prefix: Prefix,
@@ -124,7 +124,7 @@ static ASCII_SYMBOLS: Symbols = Symbols {
 /// Entry point for the `cargo tree` command.
 pub fn build_and_print(ws: &Workspace<'_>, opts: &TreeOptions) -> CargoResult<()> {
     if opts.graph_features && opts.duplicates {
-        bail!("the `--graph-features` flag does not support `--duplicates`");
+        bail!("the `-e features` flag does not support `--duplicates`");
     }
     let requested_target = match &opts.target {
         Target::All | Target::Host => None,
@@ -141,7 +141,10 @@ pub fn build_and_print(ws: &Workspace<'_>, opts: &TreeOptions) -> CargoResult<()
         opts.all_features,
         !opts.no_default_features,
     );
-    let has_dev = if opts.dep_kinds.contains(&DepKind::Development) {
+    let has_dev = if opts
+        .edge_kinds
+        .contains(&EdgeKind::Dep(DepKind::Development))
+    {
         HasDevUnits::Yes
     } else {
         HasDevUnits::No

src/doc/man/cargo-tree.adoc

@@ -14,7 +14,8 @@ cargo-tree - Display a tree visualization of a dependency graph
 
 == DESCRIPTION
 
-This command will display a tree of dependencies to the terminal. An example of a simple project that depends on the "rand" package:
+This command will display a tree of dependencies to the terminal. An example
+of a simple project that depends on the "rand" package:
 
 ----
 myproject v0.1.0 (/myproject)
@@ -36,6 +37,24 @@ Packages marked with `(*)` have been "de-duplicated". The dependencies for the
 package have already been shown elswhere in the graph, and so are not
 repeated. Use the `--no-dedupe` option to repeat the duplicates.
 
+The `-e` flag can be used to select the dependency kinds to display. The
+"features" kind changes the output to display the features enabled by
+each dependency. For example, `cargo tree -e features`:
+
+----
+myproject v0.1.0 (/myproject)
+└── log feature "serde"
+    └── log v0.4.8
+        ├── serde v1.0.106
+        └── cfg-if feature "default"
+            └── cfg-if v0.1.10
+----
+
+In this tree, `myproject` depends on `log` with the `serde` feature. `log` in
+turn depends on `cfg-if` with "default" features. When using `-e features` it
+can be helpful to use `-i` and `-p` flags to show how the features flow into a
+package. See the examples below for more detail.
+
 == OPTIONS
 
 === Tree Options
@@ -63,31 +82,30 @@ packages. You can then investigate if the package that depends on the
 duplicate with the older version can be updated to the newer version so that
 only one instance is built.
 
-*--dep-kinds* KINDS::
+*-e* _KINDS_::
+*--edges* _KINDS_::
     The dependency kinds to display. Takes a comma separated list of values:
-
-        - `all` (default) — Show all dependency kinds.
++
+        - `all` — Show all edge kinds.
         - `normal` — Show normal dependencies.
         - `build` — Show build dependencies.
         - `dev` — Show development dependencies.
+        - `features` — Show features enabled by each dependency. If this is
+          the only kind given, then it will automatically include the other
+          dependency kinds.
         - `no-normal` — Do not include normal dependencies.
         - `no-build` — Do not include build dependencies.
         - `no-dev` — Do not include development dependencies.
 +
-The `no-` prefixed options cannot be mixed with the other kinds.
+The `no-` prefixed options cannot be mixed with the other dependency kinds.
++
+The default is `normal,build,dev`.
 
 *--target* _TRIPLE_::
     Filter dependencies matching the given target-triple.
     The default is the host platform. Use the value `all` to include *all*
     targets.
 
-*--graph-features*::
-    Runs in a special mode where features are included as individual nodes.
-    This is intended to be used to help explain why a feature is enabled on
-    any particular package. It is recommended to use with the `-p` and `-i`
-    flags to show how the features flow into the package. See the examples
-    below for more detail.
-
 === Tree Formatting Options
 
 *--charset* _CHARSET_::
@@ -158,9 +176,11 @@ include::section-exit-status.adoc[]
 
 . Explain why features are enabled for the given package:
 
-    cargo tree --graph-features -i -p syn
+    cargo tree -e features -i -p syn
 +
-An example of what this would display:
+The `-e features` flag is used to show features. The `-i` flag is used to
+invert the graph so that it displays the packages that depend on `syn` (not
+what `syn` depends on). An example of what this would display:
 +
 ----
 syn v1.0.17
@@ -187,9 +207,9 @@ syn v1.0.17
 ----
 +
 To read this graph, you can follow the chain for each feature from the root to
-see why it was included. For example, the "full" feature was added by the
-`rustversion` crate which was included from `myproject` (with the default
-features), and `myproject` was the package selected on the command-line. All
+see why it is included. For example, the "full" feature is added by the
+`rustversion` crate which is included from `myproject` (with the default
+features), and `myproject` is the package selected on the command-line. All
 of the other `syn` features are added by the "default" feature ("quote" is
 added by "printing" and "proc-macro", both of which are default features).
 +