alba 0.2.1

Alba, the Beamfile task runner: parallel beams, caching, watch mode, and an interactive interface
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
99

//! `alba check`: validate the Beamfile without running anything.
//!
//! Loading already happened in `main.rs` by the time this runs — a load
//! failure never reaches here, it is rendered and reported by the caller
//! instead (see `commands` module doc comment). Beyond that, this is the
//! one place static validation happens *before* a beam ever runs: every
//! embedded-shell beam with no parameters has its `run` templates
//! rendered and parsed the same way [`alba_shell::parse`] would at
//! schedule time, so unsupported syntax is caught here instead of first
//! showing up mid-run.

use std::path::Path;

use alba_core::{ExecutorKind, Project, render_template};

use crate::exit::EXIT_ALBA_ERROR;
use crate::render::LineSink;

/// Validates every beam that can be validated statically, then prints
/// `✓ Beamfile: N beam(s)` (or `✓ Beamfile: N beam(s), M hook(s)` when the
/// Beamfile declares hooks) and returns `0` — or, if any beam's embedded
/// shell command failed to parse, prints that beam's diagnostic instead
/// and returns [`EXIT_ALBA_ERROR`] without the success line.
///
/// When hooks are declared but `core.hooksPath` does not point at
/// `.alba/hooks`, a warning goes to stderr suggesting `alba hooks
/// install`. This is the one place `check` may spawn git — a project with
/// no hooks never does, keeping the laziness the rest of the binary holds
/// to.
///
/// Only beams running on the embedded shell (`ExecutorKind::Shell`, the
/// default) with no parameters are checked: a parameterized beam's `run`
/// template cannot be rendered until its arguments arrive, and
/// `system_shell`/`docker`/plugin beams do not speak this grammar at all
/// (the `!= ExecutorKind::Shell` filter below covers plugin beams too, with
/// no separate case needed). A template that fails to render here is
/// skipped silently — rendering failures are load's concern, and load
/// already checked everything that can be checked without parameters.
///
/// Written through a [`LineSink`] rather than `println!`/`eprintln!`:
/// `alba check | head -1` (or any consumer that closes its end without
/// reading) closes the stream before every line lands, and the macros
/// panic on a closed pipe.
pub fn run(project: &Project, beamfile: &Path) -> i32 {
    let mut err = LineSink::stderr();
    let mut failed = false;

    for beam in &project.beams {
        if beam.executor != ExecutorKind::Shell || !beam.params.is_empty() {
            continue;
        }
        for template in &beam.run {
            let Ok(command) = render_template(template, &beam.scope) else {
                continue;
            };
            if let Err(error) = alba_shell::parse(&command) {
                failed = true;
                err.line(&format!(
                    "beam `{}`: invalid embedded shell command",
                    beam.id.0
                ));
                for line in error.render(&command).lines() {
                    err.line(line);
                }
            }
        }
    }

    if failed {
        return EXIT_ALBA_ERROR;
    }

    if !project.hooks.is_empty() {
        let root = alba_engine::beamfile_dir(beamfile);
        let installed = super::hooks::expected_hooks_path(beamfile)
            .ok()
            .zip(alba_core::git::hooks_path(&root).ok().flatten())
            .is_some_and(|(expected, current)| expected == current);
        if !installed {
            let count = project.hooks.len();
            let noun = if count == 1 { "hook" } else { "hooks" };
            err.line(&format!(
                "\u{26a0} {count} {noun} declared, run 'alba hooks install'"
            ));
        }
    }

    let beam_count = project.beams.len();
    let beam_noun = if beam_count == 1 { "beam" } else { "beams" };
    let summary = if project.hooks.is_empty() {
        format!("\u{2713} Beamfile: {beam_count} {beam_noun}")
    } else {
        let hook_count = project.hooks.len();
        let hook_noun = if hook_count == 1 { "hook" } else { "hooks" };
        format!("\u{2713} Beamfile: {beam_count} {beam_noun}, {hook_count} {hook_noun}")
    };
    LineSink::stdout().line(&summary);
    0
}