gx 0.8.2

CLI to manage Github Actions dependencies
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

use crate::config::Config;
use crate::output::lines::Line as OutputLine;
use std::fmt::Debug;
use std::path::Path;

/// Trait for report types returned by commands.
#[expect(
    clippy::module_name_repetitions,
    reason = "CommandReport is the canonical name"
)]
pub trait CommandReport: Debug + Default {
    /// Render the report into output lines.
    fn render(&self) -> Vec<OutputLine>;

    /// Exit code to use after rendering; defaults to `0`.
    fn exit_code(&self) -> i32 {
        0
    }
}

/// Trait for command types that can be run.
pub trait Command {
    type Report: CommandReport;
    type Error: std::error::Error;

    /// Run the command and return a report.
    ///
    /// # Errors
    ///
    /// Returns `Self::Error` if the command fails.
    fn run(
        &self,
        repo_root: &Path,
        config: Config,
        on_progress: &mut dyn FnMut(&str),
    ) -> Result<Self::Report, Self::Error>;
}