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

cargo_e/
lib.rs
