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")]
55static GLOBAL_TTS: OnceCell<std::sync::Mutex<tts::Tts>> = OnceCell::new();
56
57// Plugin system modules
58/// Extension API: unified CLI+targets for embedding cargo-e
59pub mod ext;
60#[cfg(feature = "uses_plugins")]
61pub mod plugins;
62
63#[allow(unused_macros)]
64macro_rules! doc_with_joke {
65    (
66        $(#[$attr:meta])*
67        $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
68    ) => {
69        $(#[$attr])*                           // Re-emit external doc attributes.
70        #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
71        $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
72    };
73}
74
75// Define the helper macro.
76// macro_rules! doc_with_funny {
77//     ($doc:expr) => {
78//         #[doc = concat!($doc, "\n\nSee also the [Guide for You To Read](index.html) for more details.")]
79//     };
80// }
81
82// Define the helper macro that captures external attributes and injects an extra doc attribute.
83// macro_rules! doc_with_funny {
84//     (
85//         $(#[$attr:meta])*
86//         $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
87//     ) => {
88//         $(#[$attr])*                           // Re-emit external doc attributes.
89//         #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
90//         $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
91//     };
92// }
93
94// #[doc = include_str!("../documents/guide.md")]
95// pub mod a_guide {
96//     /// An example constant to force module inclusion.
97//     doc_with_guide!("This function does something important.");
98//     pub const a_const: () = ();
99
100//     /// An example function to force module inclusion.
101//     pub fn a_function() {}
102
103//     /// An example struct to force module inclusion.
104//     pub struct AStruct;
105
106//     /// An example enum to force module inclusion.
107//     pub enum AEnum {
108//         AVariant,
109//     }
110
111//     /// An example trait to force module inclusion.
112//     pub trait ATrait {}
113
114//     /// An example type alias to force module inclusion.
115//     pub type AType = ();
116// }
117
118// // Re-export so the module shows in the public API.
119// pub use a_guide as __THE_GUIDE;
120
121#[macro_use]
122pub mod a_funny_docs;
123
124#[doc = include_str!("../documents/guide.md")]
125pub mod a_guide {
126    // A constant with a humorous aside
127    #[doc = "A wacky constant that reminds you of the fleeting nature of existence—because constants, like our dreams, never change."]
128    #[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."]
129    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE MYSTERIES OF CONSTANTS."]
130    pub const A_CONST: () = ();
131    // A function with a humorous aside
132    #[doc = "An eccentric function that performs its task with a whimsical twist."]
133    #[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."]
134    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE ART OF FUNCTIONAL HUMOR."]
135    pub fn a_function() {}
136
137    // A struct with a humorous aside
138    #[doc = "A delightfully absurd struct that encapsulates the essence of lighthearted programming."]
139    #[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."]
140    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON STRUCTURING YOUR HUMOR."]
141    pub struct AStruct;
142
143    // An enum with a humorous aside
144    #[doc = "An enum whose variants are as unpredictable as the punchline of an offbeat comedy routine."]
145    #[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."]
146    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ENUMERATING THE LAUGHTER."]
147    //#[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.")]
148    pub enum AEnum {
149        #[doc = "A variant that boldly goes where no variant has gone before—capturing the essence of unexpected hilarity."]
150        AVariant,
151    }
152
153    // A trait with a humorous aside
154    #[doc = "A quirky trait that defines behaviors with a tongue-in-cheek twist."]
155    #[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."]
156    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON TRAIT-ORIENTED COMEDY."]
157    pub trait ATrait {}
158
159    // A type alias with a humorous aside
160    #[doc = "A type alias that serves as a humorous shortcut to a more verbose reality."]
161    #[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."]
162    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ALIASING THE ORDINARY INTO THE EXTRAORDINARY."]
163    pub type AType = ();
164}
165
166/// If you didn't get it the first time, then look again!  
167/// Check out the **[GUIDE FOR YOU TO READ](theSeachIsOver/index.html)** for all the brilliant details you missed.
168pub use a_guide as theSeachIsOver;
cargo_e/lib.rs

cargo_e/
lib.rs
