gitignore-in 0.2.1

A command line tool for managing .gitignore files with gitignore.in
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

const HEADER_LINES: [&str; 5] = [
    "# DO NOT EDIT THIS FILE",
    "# Generated by gitignore.in",
    "# See https://gitignore.in/",
    "# Edit .gitignore.in instead of this file",
    "# Run `gitignore.in` to build .gitignore",
];

const SEPARATOR: &str =
    "# -----------------------------------------------------------------------------";

pub(crate) fn restore(text: &str) -> String {
    let mut result = Vec::new();
    let mut lines = text.lines().peekable();

    while let Some(line) = lines.next() {
        if HEADER_LINES.contains(&line) {
            continue;
        }

        if line == SEPARATOR {
            let Some(section_head) = lines.next() else {
                break;
            };

            if let Some(target) = section_head.strip_prefix("# gibo dump ") {
                result.push(format!("gibo dump {target}"));
                skip_generated_section(&mut lines);
                continue;
            }

            if let Some(target) = section_head.strip_prefix("# gi ") {
                result.push(format!("gi {target}"));
                skip_generated_section(&mut lines);
                continue;
            }

            if !section_head.is_empty() {
                result.push(format!("echo {}", shell_quote(section_head)));
            }

            continue;
        }

        if line.is_empty() {
            result.push(line.to_string());
            continue;
        }

        if let Some(comment) = restore_comment_line(line) {
            result.push(comment);
            continue;
        }

        result.push(format!("echo {}", shell_quote(line)));
    }

    result.join("\n") + "\n"
}

pub(crate) fn looks_generated(text: &str) -> bool {
    HEADER_LINES.iter().all(|line| text.contains(line))
}

fn skip_generated_section<'a, I>(lines: &mut std::iter::Peekable<I>)
where
    I: Iterator<Item = &'a str>,
{
    while let Some(next) = lines.peek() {
        if *next == SEPARATOR {
            break;
        }
        lines.next();
    }
}

fn restore_comment_line(line: &str) -> Option<String> {
    line.strip_prefix("# #")
        .map(|comment| format!("#{comment}"))
}

fn shell_quote(text: &str) -> String {
    format!("'{}'", text.replace('\'', r#"'\''"#))
}

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

    #[test]
    fn restores_generated_gitignore() {
        let text = r#"# DO NOT EDIT THIS FILE
# Generated by gitignore.in
# See https://gitignore.in/
# Edit .gitignore.in instead of this file
# Run `gitignore.in` to build .gitignore
# # project comment
# -----------------------------------------------------------------------------
# gibo dump Linux
### Generated by gibo
foo
# -----------------------------------------------------------------------------
# gi Rust
### Created by gitignore.io
bar
# -----------------------------------------------------------------------------
!.env
"#;

        let expected = "# project comment\ngibo dump Linux\ngi Rust\necho '!.env'\n";
        assert_eq!(restore(text), expected);
    }

    #[test]
    fn quotes_echo_content() {
        let text = "# -----------------------------------------------------------------------------\na'b\n";
        assert_eq!(restore(text), "echo 'a'\\''b'\n");
    }

    #[test]
    fn restores_mixed_content_sections() {
        let text = r#"# DO NOT EDIT THIS FILE
# Generated by gitignore.in
# See https://gitignore.in/
# Edit .gitignore.in instead of this file
# Run `gitignore.in` to build .gitignore
# # keep this comment
# -----------------------------------------------------------------------------
plain-entry
# -----------------------------------------------------------------------------
!important.txt
# trailing note
"#;

        let expected =
            "# keep this comment\necho 'plain-entry'\necho '!important.txt'\necho '# trailing note'\n";
        assert_eq!(restore(text), expected);
    }

    #[test]
    fn round_trips_generated_comment_shape() {
        let restored = restore("# # original comment\n");
        assert_eq!(restored, "# original comment\n");
    }
}