cargo_e/
lib.rs

1#![doc = include_str!("../README.md")]
2
3// Re-export std common modules
4pub mod prelude {
5    pub use std::env;
6    pub use std::error::Error;
7    pub use std::fs;
8    pub use std::io;
9    pub use std::path::{Path, PathBuf};
10    pub use std::process::exit;
11    pub use std::process::Child;
12    pub use std::process::Command;
13    pub use std::process::Stdio;
14    pub use std::sync::mpsc;
15    pub use std::sync::{Arc, Mutex};
16    pub use std::time::Instant;
17    //pub use tracing::{debug, error, info};
18    pub use log::{debug, error, info, log_enabled, Level};
19}
20
21pub mod e_findmain;
22pub use e_findmain::*;
23pub mod e_bacon;
24pub mod e_types;
25pub use e_bacon::*;
26pub mod e_cli;
27pub use e_cli::Cli;
28pub mod e_manifest;
29pub use e_manifest::{collect_workspace_members, locate_manifest};
30pub mod e_parser;
31pub use e_parser::parse_available;
32pub mod e_autosense;
33pub mod e_cargocommand_ext;
34pub mod e_collect;
35pub mod e_command_builder;
36pub mod e_diagnostics_dispatchers;
37pub mod e_discovery;
38pub mod e_eventdispatcher;
39pub mod e_features;
40pub mod e_fmt;
41pub mod e_installer;
42pub mod e_prebuild;
43pub mod e_processmanager;
44pub mod e_prompts;
45pub mod e_reports;
46pub mod e_runall;
47pub mod e_runner;
48pub mod e_target;
49pub mod e_tui;
50pub mod e_workspace;
51#[cfg(feature = "uses_tts")]
52use once_cell::sync::OnceCell;
53
54#[cfg(feature = "uses_tts")]
55pub static GLOBAL_TTS: OnceCell<std::sync::Mutex<tts::Tts>> = OnceCell::new();
56pub static GLOBAL_MANAGER: OnceCell<std::sync::Arc<e_processmanager::ProcessManager>> =
57    OnceCell::new();
58pub static GLOBAL_CLI: OnceCell<Cli> = OnceCell::new();
59// Plugin system modules
60/// Extension API: unified CLI+targets for embedding cargo-e
61pub mod ext;
62#[cfg(feature = "uses_plugins")]
63pub mod plugins;
64
65#[allow(unused_macros)]
66macro_rules! doc_with_joke {
67    (
68        $(#[$attr:meta])*
69        $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
70    ) => {
71        $(#[$attr])*                           // Re-emit external doc attributes.
72        #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
73        $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
74    };
75}
76
77// Define the helper macro.
78// macro_rules! doc_with_funny {
79//     ($doc:expr) => {
80//         #[doc = concat!($doc, "\n\nSee also the [Guide for You To Read](index.html) for more details.")]
81//     };
82// }
83
84// Define the helper macro that captures external attributes and injects an extra doc attribute.
85// macro_rules! doc_with_funny {
86//     (
87//         $(#[$attr:meta])*
88//         $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
89//     ) => {
90//         $(#[$attr])*                           // Re-emit external doc attributes.
91//         #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
92//         $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
93//     };
94// }
95
96// #[doc = include_str!("../documents/guide.md")]
97// pub mod a_guide {
98//     /// An example constant to force module inclusion.
99//     doc_with_guide!("This function does something important.");
100//     pub const a_const: () = ();
101
102//     /// An example function to force module inclusion.
103//     pub fn a_function() {}
104
105//     /// An example struct to force module inclusion.
106//     pub struct AStruct;
107
108//     /// An example enum to force module inclusion.
109//     pub enum AEnum {
110//         AVariant,
111//     }
112
113//     /// An example trait to force module inclusion.
114//     pub trait ATrait {}
115
116//     /// An example type alias to force module inclusion.
117//     pub type AType = ();
118// }
119
120// // Re-export so the module shows in the public API.
121// pub use a_guide as __THE_GUIDE;
122
123#[macro_use]
124pub mod a_funny_docs;
125
126#[doc = include_str!("../documents/guide.md")]
127pub mod a_guide {
128    // A constant with a humorous aside
129    #[doc = "A wacky constant that reminds you of the fleeting nature of existence—because constants, like our dreams, never change."]
130    #[doc = "Imagine staring into the abyss of an unchanging value and laughing at the cosmic joke: even when everything is fixed, there’s always room for a little absurdity. In a world of mutable chaos, this constant stands as a monument to the absurdity of permanence."]
131    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE MYSTERIES OF CONSTANTS."]
132    pub const A_CONST: () = ();
133    // A function with a humorous aside
134    #[doc = "An eccentric function that performs its task with a whimsical twist."]
135    #[doc = "Picture a function that cracks jokes as it runs—each call a mini stand-up routine where recursion becomes a humorous loop and error handling turns into a comedy of exceptions. This function reminds you that even in logic there is laughter."]
136    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE ART OF FUNCTIONAL HUMOR."]
137    pub fn a_function() {}
138
139    // A struct with a humorous aside
140    #[doc = "A delightfully absurd struct that encapsulates the essence of lighthearted programming."]
141    #[doc = "Think of it as the punchline to a well-crafted joke: simple on the surface yet bursting with hidden layers of wit. This struct is the blueprint for designing data structures that know how to have a good time even when they’re being strictly typed."]
142    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON STRUCTURING YOUR HUMOR."]
143    pub struct AStruct;
144
145    // An enum with a humorous aside
146    #[doc = "An enum whose variants are as unpredictable as the punchline of an offbeat comedy routine."]
147    #[doc = "Each variant is a different flavor of chaos—a reminder that sometimes, even in the binary world of enums, you need a twist of fate and a pinch of absurdity. Embrace the randomness with a hearty chuckle."]
148    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ENUMERATING THE LAUGHTER."]
149    //#[doc = doc_with_funny!("**ENUMERATE THE LAUGHTER:** This enum's variants are as surprising as a punchline in the middle of a monologue. Discover the unexpected twist in every variant.")]
150    pub enum AEnum {
151        #[doc = "A variant that boldly goes where no variant has gone before—capturing the essence of unexpected hilarity."]
152        AVariant,
153    }
154
155    // A trait with a humorous aside
156    #[doc = "A quirky trait that defines behaviors with a tongue-in-cheek twist."]
157    #[doc = "Imagine a trait written by a stand-up comedian: each method is a punchline, each implementation an opportunity for subtle humor. Types implementing this trait are expected not just to act, but to entertain—blending functionality with a dash of wit."]
158    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON TRAIT-ORIENTED COMEDY."]
159    pub trait ATrait {}
160
161    // A type alias with a humorous aside
162    #[doc = "A type alias that serves as a humorous shortcut to a more verbose reality."]
163    #[doc = "Sometimes types need nicknames too. This alias is like that clever one-liner you whisper at a party—short, memorable, and unexpectedly delightful. It’s the wink in the midst of an otherwise serious type system."]
164    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ALIASING THE ORDINARY INTO THE EXTRAORDINARY."]
165    pub type AType = ();
166}
167
168/// If you didn't get it the first time, then look again!  
169/// Check out the **[GUIDE FOR YOU TO READ](theSeachIsOver/index.html)** for all the brilliant details you missed.
170pub use a_guide as theSeachIsOver;
cargo_e/lib.rs

cargo_e/
lib.rs
