guppy 0.5.0-rc.1

// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Remove all dependency links that are dev-only.
//!
//! Dev-only dependencies are typically not included in release builds, so it's useful to be able
//! to filter out those links.

use guppy::graph::{DependencyDirection, PackageLink};
use guppy::{CargoMetadata, Error};
use std::iter;

fn main() -> Result<(), Error> {
    // `guppy` accepts `cargo metadata` JSON output. Use a pre-existing fixture for these examples.
    let metadata =
        CargoMetadata::parse_json(include_str!("../../fixtures/large/metadata_libra.json"))?;
    let package_graph = metadata.build_graph()?;

    // Pick an important binary package and compute the number of dependencies.
    //
    // A clone is typically not required but in this case we're mutating the graph, so we need to
    // release the immutatable borrow.
    let libra_node_id = package_graph
        .workspace()
        .member_by_path("libra-node")
        .unwrap()
        .id()
        .clone();

    let before_count = package_graph
        .query_forward(iter::once(&libra_node_id))?
        .resolve()
        .package_ids(DependencyDirection::Forward)
        .count();
    println!("number of packages before: {}", before_count);

    let resolver_fn = |link: PackageLink<'_>| {
        if link.dev_only() {
            println!(
                "*** filtering out dev-only link: {} -> {}",
                link.from().name(),
                link.to().name()
            );
            return false;
        }
        true
    };

    let query = package_graph.query_forward(iter::once(&libra_node_id))?;
    // Use `resolve_with` to filter out dev-only links.
    let resolve_with_len = query
        .clone()
        .resolve_with_fn(|_query, link| {
            // A package resolver allows for fine-grained control over which links are followed. In general,
            // it is anything that implements the `PackageResolver` trait.
            //
            // Functions with signature FnMut(&PackageQuery<'_>, PackageLink<'_>) -> bool can be
            // used with `resolve_with_fn`.
            resolver_fn(link)
        })
        .package_ids(DependencyDirection::Forward)
        .len();
    println!("number of packages after: {}", resolve_with_len);

    Ok(())
}