submodule-kit 0.2.2

A CLI toolkit for managing git submodules
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
99

#![allow(dead_code)]

// ── file paths ────────────────────────────────────────────────────────────────
pub const GITMODULES_FILE: &str = ".gitmodules";

// ── .gitmodules parsing tokens ────────────────────────────────────────────────
pub const SUBMODULE_SECTION_CHECK: &str = "[submodule ";
pub const SUBMODULE_SECTION_PREFIX: &str = "[submodule \"";
pub const SUBMODULE_SECTION_SUFFIX: &str = "\"]";
pub const KEY_PATH: &str = "path = ";
pub const KEY_URL: &str = "url = ";
pub const KEY_BRANCH: &str = "branch = ";

// ── git refs ──────────────────────────────────────────────────────────────────
pub const REFS_HEADS_PREFIX: &str = "refs/heads/";

// ── status labels ─────────────────────────────────────────────────────────────
pub const STATUS_UP_TO_DATE: &str = "up-to-date";
pub const STATUS_BEHIND: &str = "behind";
pub const STATUS_POPULATED: &str = "populated";
pub const STATUS_MISSING: &str = "missing";
pub const STATUS_CLEAN: &str = "clean";
pub const STATUS_DIRTY: &str = "dirty";
pub const STATUS_SYNCED: &str = "synced";
pub const STATUS_OUT_OF_SYNC: &str = "out-of-sync";
pub const STATUS_ON_BRANCH: &str = "on-branch";
pub const STATUS_DETACHED_HEAD: &str = "detached-HEAD";
pub const STATUS_WRONG_BRANCH: &str = "wrong-branch";
pub const STATUS_NOT_POPULATED_SKIPPED: &str = "not-populated (skipped)";

// ── column labels ─────────────────────────────────────────────────────────────
pub const LABEL_PARENT: &str = "parent";
pub const LABEL_REMOTE: &str = "remote";
pub const LABEL_RECORDED: &str = "recorded";
pub const LABEL_LOCAL: &str = "local";
pub const LABEL_CURRENT: &str = "current";
pub const LABEL_EXPECTED: &str = "expected";
pub const LABEL_UNKNOWN: &str = "(unknown)";

// ── error messages ────────────────────────────────────────────────────────────
pub fn err_read_gitmodules(e: &impl std::fmt::Display) -> String {
    format!("Failed to read .gitmodules: {e}")
}

pub fn err_missing_path(name: &str) -> String {
    format!("submodule '{name}' is missing 'path =' in .gitmodules")
}

pub fn err_missing_url(name: &str) -> String {
    format!("submodule '{name}' is missing 'url =' in .gitmodules")
}

pub fn err_missing_branch(path: &str) -> String {
    format!("submodule '{path}' is missing 'branch =' in .gitmodules")
}

pub fn err_open_index(e: &impl std::fmt::Display) -> String {
    format!("failed to open index: {e}")
}

pub fn err_not_in_index(path: &str) -> String {
    format!("submodule '{path}' not found in index")
}

pub fn err_create_remote(url: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to create remote for {url}: {e}")
}

pub fn err_connect_remote(url: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to connect to {url}: {e}")
}

pub fn err_list_refs(url: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to list refs at {url}: {e}")
}

pub fn err_ref_not_found(refspec: &str, url: &str) -> String {
    format!("ref {refspec} not found at {url}")
}

pub fn err_open_repo(e: &impl std::fmt::Display) -> String {
    format!("failed to open git repository: {e}")
}

pub fn err_open_submodule(path: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to open submodule '{path}': {e}")
}

pub fn err_get_status(path: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to get status for '{path}': {e}")
}

pub fn err_read_head(path: &str, e: &impl std::fmt::Display) -> String {
    format!("failed to read HEAD of '{path}': {e}")
}

#[cfg(test)]
#[path = "strings_tests.rs"]
mod tests;