1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Print out a dot representation of a subgraph, for formatting with graphviz.
//!
//! This example prints out a dot representation of the dependencies between all packages in a
//! workspace. It skips over any non-workspace packages.
//!
//! Try running this example with graphviz:
//!
//! ```text
//! cargo run --example print_dot > graph.dot
//! dot -Tpng graph.dot -o graph.png
//! ```
use guppy::{
CargoMetadata, Error,
graph::{DotWrite, PackageDotVisitor, PackageLink, PackageMetadata},
};
use std::fmt;
// Define a visitor, which specifies what strings to print out for the graph.
struct PackageNameVisitor;
impl PackageDotVisitor for PackageNameVisitor {
fn visit_package(&self, package: PackageMetadata<'_>, f: &mut DotWrite<'_, '_>) -> fmt::Result {
// Print out the name of the package. Other metadata can also be printed out.
//
// If you need to look at data for other packages, store a reference to the PackageGraph in
// the visitor.
write!(f, "{}", package.name())
}
fn visit_link(&self, link: PackageLink<'_>, f: &mut DotWrite<'_, '_>) -> fmt::Result {
if link.dev_only() {
write!(f, "dev-only")
} else {
// Don't print out anything if this isn't a dev-only link.
Ok(())
}
}
}
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()?;
// Non-workspace packages cannot depend on packages within the workspace, so the reverse
// transitive deps of workspace packages are exactly the set of workspace packages.
let query = package_graph.query_reverse(package_graph.workspace().member_ids())?;
let package_set = query.resolve();
// resolve.display_dot() implements `std::fmt::Display`, so it can be written out to a file, a
// string, stdout, etc.
println!("{}", package_set.display_dot(PackageNameVisitor));
Ok(())
}
|
