path: root/mingling/src/lib.rs

//! Mingling
//!
//! # Intro
//! A Rust CLI framework for many subcmds & complex workflows, reduces boilerplate via proc macros, focus on biz logic
//!
//! # Use
//!
//! ```rust
//! use mingling::macros::{dispatcher, gen_program, r_println, renderer};
//!
//! fn main() {
//!     let mut program = ThisProgram::new();
//!     program.with_dispatcher(HelloCommand);
//!
//!     // Execute
//!     program.exec();
//! }
//!
//! // Define command: "<bin> hello"
//! dispatcher!("hello", HelloCommand => HelloEntry);
//!
//! // Render HelloEntry
//! #[renderer]
//! fn render_hello_world(_prev: HelloEntry) {
//!     r_println!("Hello, World!")
//! }
//!
//! // Fallbacks
//! #[renderer]
//! fn fallback_dispatcher_not_found(prev: DispatcherNotFound) {
//!     r_println!("Dispatcher not found for command `{}`", prev.join(", "))
//! }
//!
//! #[renderer]
//! fn fallback_renderer_not_found(prev: RendererNotFound) {
//!     r_println!("Renderer not found `{}`", *prev)
//! }
//!
//! // Collect renderers and chains to generate ThisProgram
//! gen_program!();
//! ```
//!
// Output:
//!
//! ```text
//! > mycmd hello
//! Hello, World!
//! > mycmd hallo
//! Dispatcher not found for command `hallo`
//! ```
//!
//! # Features
//! - `async` enables async runtime support for command execution, see [example](_mingling_examples/example_async/index.html) for details
//! - `comp` enables command completion functionality, see [example](_mingling_examples/example_completion/index.html) for details
//! - `parser` enables the `mingling::parser` module, see [example](_mingling_examples/example_picker/index.html) for details
//! - `general_renderer` adds support for serialized output formats such as JSON and YAML, see [example](_mingling_examples/example_general_renderer/index.html) for details
//!
//!
//! # Examples
//! `Mingling` provides detailed usage examples for your reference.
//! See [Examples](_mingling_examples/index.html)

mod example_docs;

// Re-export Core lib
pub use mingling::*;
pub use mingling_core as mingling;

/// `Mingling` argument parser
#[cfg(feature = "parser")]
pub mod parser;

/// Re-export from `mingling_macros`
#[allow(unused_imports)]
pub mod macros {
    /// Used to generate a struct implementing the `Chain` trait via a method
    pub use mingling_macros::chain;
    /// Used to generate completion entry
    #[cfg(feature = "comp")]
    pub use mingling_macros::completion;
    /// Used to create a dispatcher that routes to a `Chain`
    pub use mingling_macros::dispatcher;
    /// Used to create a dispatcher with clap argument parsing
    #[cfg(feature = "clap")]
    pub use mingling_macros::dispatcher_clap;
    /// Used to collect data and create a command-line context
    pub use mingling_macros::gen_program;
    /// Used to generate a struct implementing the `HelpRequest` trait via a method
    pub use mingling_macros::help;
    /// Used to create a `Node` struct via a literal
    pub use mingling_macros::node;
    /// Used to create a wrapper type for use with `Chain` and `Renderer`
    pub use mingling_macros::pack;
    #[cfg(feature = "comp")]
    /// Internal macro for 'gen_program' used to finally generate the completion structure
    pub use mingling_macros::program_comp_gen;
    /// Internal macro for 'gen_program' used to finally generate the fallback
    pub use mingling_macros::program_fallback_gen;
    /// Internal macro for 'gen_program' used to finally generate the program
    pub use mingling_macros::program_final_gen;
    /// Used to generate program setup
    pub use mingling_macros::program_setup;
    /// Used to print content within a `Renderer` context
    pub use mingling_macros::r_print;
    /// Used to print content with a newline within a `Renderer` context
    pub use mingling_macros::r_println;
    /// Used to register a chain
    pub use mingling_macros::register_chain;
    /// Used to register a dispatcher for dispatch_tree feature
    pub use mingling_macros::register_dispatcher;
    /// Used to register a help
    pub use mingling_macros::register_help;
    /// Used to register a renderer
    pub use mingling_macros::register_renderer;
    /// Used to register a type into the context
    pub use mingling_macros::register_type;
    /// Used to generate a struct implementing the `Renderer` trait via a method
    pub use mingling_macros::renderer;
    /// Used to generate a route that either returns a successful result or early returns an error.
    pub use mingling_macros::route;
    #[cfg(feature = "comp")]
    /// Used to generate suggestions
    pub use mingling_macros::suggest;
    #[cfg(feature = "comp")]
    /// Used to generate enum suggestions
    pub use mingling_macros::suggest_enum;
}

/// derive macro EnumTag
pub use mingling_macros::EnumTag;

/// derive macro Groupped
pub use mingling_macros::Groupped;

/// Example projects for `Mingling`, for learning how to use `Mingling`
pub mod _mingling_examples {
    pub use crate::example_docs::*;
}

mod features;

/// Module for checking which features are enabled at compile time.
///
/// Each constant re-exported from this module corresponds to a Cargo feature flag.
/// They can be used for conditional compilation or runtime branching based on
/// feature availability.
pub mod feature {
    /// Whether the `async` feature is enabled
    pub use crate::features::MINGLING_ASYNC;

    /// Whether the `clap` feature is enabled
    pub use crate::features::MINGLING_CLAP;

    /// Whether the `comp` feature is enabled
    pub use crate::features::MINGLING_COMP;

    /// Whether the `debug` feature is enabled
    pub use crate::features::MINGLING_DEBUG;

    /// Whether the `dispatch_tree` feature is enabled
    pub use crate::features::MINGLING_DISPATCH_TREE;

    /// Whether the `general_renderer` feature is enabled
    pub use crate::features::MINGLING_GENERAL_RENDERER;

    /// Whether the `nightly` feature is enabled
    pub use crate::features::MINGLING_NIGHTLY;

    /// Whether the `parser` feature is enabled
    pub use crate::features::MINGLING_PARSER;

    /// Whether the `repl` feature is enabled
    pub use crate::features::MINGLING_REPL;

    /// Whether the `json_serde_fmt` feature is enabled
    pub use crate::features::MINGLING_JSON_SERDE_FMT;

    /// Whether the `ron_serde_fmt` feature is enabled
    pub use crate::features::MINGLING_RON_SERDE_FMT;

    /// Whether the `toml_serde_fmt` feature is enabled
    pub use crate::features::MINGLING_TOML_SERDE_FMT;

    /// Whether the `yaml_serde_fmt` feature is enabled
    pub use crate::features::MINGLING_YAML_SERDE_FMT;
}

mod setups;

/// Setups provided by Mingling, which can extend command-line programs.
pub mod setup {
    pub use crate::setups::*;
}

/// Mutable global resources provided within Mingling
pub mod res;

/// The prelude module provides convenient re-exports of commonly used macros and traits.
///
/// Importing this module brings the essential components of Mingling into scope,
/// reducing boilerplate when defining commands, dispatchers, renderers, and the
/// program entry point.
///
/// # Examples
///
/// ```rust
/// use mingling::prelude::*;
/// ```
pub mod prelude {
    /// Re-export of the `chain` macro for defining a chain of commands.
    pub use crate::macros::chain;
    /// Re-export of the `dispatcher` macro for routing commands.
    pub use crate::macros::dispatcher;
    /// Re-export of the `gen_program` macro for generating the program entry point.
    pub use crate::macros::gen_program;
    /// Re-export of the `pack` macro for creating wrapper types.
    pub use crate::macros::pack;
    /// Re-export of the `r_print` macro for printing within a renderer context.
    pub use crate::macros::r_print;
    /// Re-export of the `r_println` macro for printing with a newline within a renderer
    /// context.
    pub use crate::macros::r_println;
    /// Re-export of the `renderer` macro for defining renderer functions.
    pub use crate::macros::renderer;

    /// Re-export of the `completion` macro for generating completion entries.
    #[cfg(feature = "comp")]
    pub use crate::macros::completion;

    /// Re-export of the `AsPicker` trait for picker functionality.
    #[cfg(feature = "parser")]
    pub use crate::parser::AsPicker;
}