alef 0.25.0

Opinionated polyglot binding generator for Rust libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! alef — polyglot binding generator.
//!
//! Top-level module re-exports for the consolidated `alef` crate.
//! Each module corresponds to one of the former workspace member crates
//! (alef-core, alef-codegen, ...). See README and CHANGELOG (v0.18.0)
//! for the consolidation rationale.
//!
//! ## Extension API
//!
//! Consumers who need domain-specific codegen (e.g. HTTP service bindings)
//! implement [`Extension`] and call [`run_with_extensions`] instead of `main`:
//!
//! ```rust,no_run
//! fn main() -> std::process::ExitCode {
//!     alef::run_with_extensions(vec![])
//! }
//! ```

#![allow(missing_docs)]

pub mod adapters;
pub mod backends;
pub mod bin_cli;
pub mod cli;
pub mod codegen;
pub mod core;
pub mod docs;
pub mod e2e;
pub mod extensions;
pub mod extract;
pub mod publish;
pub mod readme;
pub mod scaffold;
pub mod snippets;

pub use core::extension::{Extension, ExtensionConfig};
pub use core::template_env::TemplateEnv;
pub use extensions::template::TemplateExtension;

/// Run the alef CLI, threading the given extensions through the pipeline.
///
/// The built-in [`TemplateExtension`] is always prepended so consumers who
/// pass `vec![]` still get `[[extensions.template]]` block support.
///
/// # Example
///
/// ```rust,no_run
/// fn main() -> std::process::ExitCode {
///     alef::run_with_extensions(vec![])
/// }
/// ```
pub fn run_with_extensions(mut extensions: Vec<Box<dyn Extension>>) -> std::process::ExitCode {
    use clap::Parser;

    // Always prepend the built-in TemplateExtension.
    extensions.insert(0, Box::new(TemplateExtension));

    let cli = bin_cli::args::Cli::parse();
    bin_cli::helpers::init_tracing(cli.verbose, cli.quiet, cli.no_color);

    if cli.jobs > 0 {
        rayon::ThreadPoolBuilder::new()
            .num_threads(cli.jobs)
            .build_global()
            .ok();
    }

    // Store extensions in thread-local so the pipeline can access them
    // without threading them through every call site in this release.
    EXTENSIONS.with(|cell| {
        *cell.borrow_mut() = extensions;
    });

    match bin_cli::dispatch::run(cli) {
        Ok(()) => std::process::ExitCode::SUCCESS,
        Err(e) => {
            eprintln!("error: {e:#}");
            std::process::ExitCode::FAILURE
        }
    }
}

thread_local! {
    /// Active extensions for the current pipeline run.
    ///
    /// Populated by [`run_with_extensions`] before dispatch; accessed by
    /// pipeline stages via [`with_extensions`].
    pub(crate) static EXTENSIONS: std::cell::RefCell<Vec<Box<dyn Extension>>> =
        const { std::cell::RefCell::new(Vec::new()) };
}

/// Run `f` with an immutable reference to the active extensions list.
pub(crate) fn with_extensions<F, R>(f: F) -> R
where
    F: FnOnce(&[Box<dyn Extension>]) -> R,
{
    EXTENSIONS.with(|cell| f(&cell.borrow()))
}