bake 0.18.0

Composable, typed development tasks for Rust projects
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

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use crate::{Arguments, Context, Parameter, Result, Value};

/// A function's command metadata and generated invocation adapter.
pub struct Task {
    pub(crate) name: String,
    pub(crate) description: String,
    pub(crate) parameters: Vec<Parameter>,
    pub(crate) invoke: fn(&mut Context, &Arguments) -> Result<Value>,
    pub(crate) handles_output: bool,
    pub(crate) builtin: bool,
}

impl Task {
    pub fn new(
        name: impl Into<String>,
        description: impl Into<String>,
        parameters: Vec<Parameter>,
        invoke: fn(&mut Context, &Arguments) -> Result<Value>,
    ) -> Self {
        Self {
            name: name.into(),
            description: description.into(),
            parameters,
            invoke,
            handles_output: false,
            builtin: false,
        }
    }

    /// Mark a task as responsible for its own user-facing output.
    pub fn handles_output(mut self) -> Self {
        self.handles_output = true;
        self
    }

    pub(crate) fn builtin(mut self) -> Self {
        self.builtin = true;
        self
    }

    pub fn name(&self) -> &str {
        &self.name
    }
    pub fn description(&self) -> &str {
        &self.description
    }
    pub fn parameters(&self) -> &[Parameter] {
        &self.parameters
    }
    pub fn produces_output(&self) -> bool {
        self.handles_output
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn handler(_: &mut Context, _: &Arguments) -> Result<Value> {
        Ok(Value::Null)
    }

    #[test]
    fn exposes_task_metadata_and_output_behavior() {
        let parameter = Parameter::new::<String>("name");
        let task = Task::new("greet", "Greet someone.", vec![parameter], handler);
        assert_eq!(task.name(), "greet");
        assert_eq!(task.description(), "Greet someone.");
        assert_eq!(task.parameters()[0].name(), "name");
        assert!(!task.produces_output());

        let mut context = crate::Registry::new().context(".");
        (task.invoke)(&mut context, &Arguments::default()).unwrap();

        let output_task = task.handles_output();
        assert!(output_task.produces_output());
    }
}