homeboy 0.50.1

CLI for multi-component deployment and development workflow automation
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

//! Project cleanup system for identifying config drift, stale state, and hygiene issues.
//!
//! This module provides project-level health checks that only Homeboy can see:
//! 1. Config health - broken paths, dead version targets, unused modules
//! 2. Future: git staleness, orphan detection, unused registrations

pub mod config;

use serde::Serialize;

use crate::component::Component;
use crate::Result;

/// Summary counts for the cleanup report.
#[derive(Debug, Clone, Serialize)]
pub struct CleanupSummary {
    pub config_issues: usize,
}

/// Result of running cleanup checks on a component.
#[derive(Debug, Clone, Serialize)]
pub struct CleanupResult {
    pub component_id: String,
    pub summary: CleanupSummary,
    pub config_issues: Vec<config::ConfigIssue>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub hints: Vec<String>,
}

/// Run all cleanup checks on a component.
pub fn cleanup_component(component_id: &str) -> Result<CleanupResult> {
    let comp = crate::component::load(component_id)?;
    let config_issues = config::check_config(&comp);

    let mut hints = Vec::new();
    if config_issues.is_empty() {
        hints.push("No config issues found.".to_string());
    } else {
        hints.push(format!(
            "{} config issue(s) found. Review and fix with `homeboy component set`.",
            config_issues.len()
        ));
    }

    Ok(CleanupResult {
        component_id: component_id.to_string(),
        summary: CleanupSummary {
            config_issues: config_issues.len(),
        },
        config_issues,
        hints,
    })
}

/// Run cleanup checks across ALL registered components.
pub fn cleanup_all() -> Result<Vec<CleanupResult>> {
    let components: Vec<Component> = crate::component::list().unwrap_or_default();
    let mut results = Vec::new();

    for comp in &components {
        let config_issues = config::check_config(comp);
        let issue_count = config_issues.len();

        let mut hints = Vec::new();
        if config_issues.is_empty() {
            hints.push("No config issues found.".to_string());
        } else {
            hints.push(format!(
                "{} config issue(s) found. Review and fix with `homeboy component set`.",
                issue_count
            ));
        }

        results.push(CleanupResult {
            component_id: comp.id.clone(),
            summary: CleanupSummary {
                config_issues: issue_count,
            },
            config_issues,
            hints,
        });
    }

    Ok(results)
}