clap_cargo/lib.rs
1//! **clap-cargo**: Re-usable CLI flags for `cargo` plugins
2//!
3//! ## Examples
4//!
5//! ```rust,no_run
6//! # #[cfg(feature = "clap")] {
7//! # #[cfg(feature = "cargo_metadata")] {
8//! use clap::Parser;
9//!
10//! // ...
11//! #[derive(Debug, Parser)]
12//! struct Cli {
13//! #[command(flatten)]
14//! manifest: clap_cargo::Manifest,
15//! #[command(flatten)]
16//! workspace: clap_cargo::Workspace,
17//! #[command(flatten)]
18//! features: clap_cargo::Features,
19//! }
20//!
21//! let cli = // ...
22//! # Cli::parse_from(["app"]);
23//! let mut metadata = cli.manifest.metadata();
24//! cli.features.forward_metadata(&mut metadata);
25//! let metadata = metadata.exec().unwrap();
26//! let (selected, excluded) = cli.workspace.partition_packages(&metadata);
27//! # }
28//! # }
29//! ```
30//!
31//! ## Relevant crates
32//!
33//! Other crates that might be useful for cargo plugins:
34//! * [escargot][escargot] for wrapping `cargo-build`, `carg-run`, `cargo-test`, etc.
35//! * [cargo_metadata][cargo_metadata] for getting crate information.
36//! * [clap-verbosity][clap-verbosity] for adding logging to your CLI.
37//!
38//! [escargot]: https://crates.io/crates/escargot
39//! [cargo_metadata]: https://crates.io/crates/cargo_metadata
40//! [clap-verbosity]: https://crates.io/crates/clap-verbosity-flag
41
42#![cfg_attr(docsrs, feature(doc_auto_cfg))]
43#![warn(clippy::print_stderr)]
44#![warn(clippy::print_stdout)]
45
46mod features;
47mod manifest;
48mod workspace;
49
50pub mod style;
51
52pub use features::*;
53pub use manifest::*;
54pub use workspace::*;