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

cargo_e/
lib.rs
