worktree-io 0.17.6

A CLI tool to open GitHub issues as git worktree workspaces
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
100

use std::fmt::Write as _;

use super::Config;

/// Wrap a string value in TOML basic-string quotes, escaping special characters.
///
/// When the value contains newlines, a TOML multiline basic string (`"""..."""`) is
/// used so that hook scripts remain human-readable in the config file.
fn toml_quoted(s: &str) -> String {
    if s.contains('\n') {
        let escaped = s.replace('\\', "\\\\").replace('"', "\\\"");
        return format!("\"\"\"\n{escaped}\"\"\"");
    }
    let escaped = s
        .replace('\\', "\\\\")
        .replace('"', "\\\"")
        .replace('\r', "\\r")
        .replace('\t', "\\t");
    format!("\"{escaped}\"")
}

impl Config {
    /// Serialize the config to a TOML string with inline documentation comments.
    ///
    /// Each section header and field is preceded by a `#` comment that matches
    /// the doc-comment on the corresponding struct field.  The resulting string
    /// round-trips cleanly through [`toml::from_str`].
    #[must_use]
    pub fn to_toml_with_comments(&self) -> String {
        let mut out = String::new();

        // Website header comment
        out.push_str("# runner \u{2014} https://worktree.io\n\n");

        // [editor] ------------------------------------------------------------
        out.push_str("# Editor configuration.\n");
        out.push_str("[editor]\n");
        if let Some(cmd) = &self.editor.command {
            out.push_str("# Command to launch the editor, e.g. \"code .\" or \"nvim .\"\n");
            writeln!(out, "command = {}", toml_quoted(cmd)).unwrap();
        }
        if self.editor.background {
            out.push_str("# When true, the editor opens in the background (fire-and-forget).\n");
            writeln!(out, "background = {}", self.editor.background).unwrap();
        }
        out.push('\n');

        // [open] --------------------------------------------------------------
        out.push_str("# Workspace open behavior.\n");
        out.push_str("[open]\n");
        out.push_str("# Whether to launch the configured editor when opening a workspace.\n");
        writeln!(out, "editor = {}", self.open.editor).unwrap();
        out.push('\n');

        // [hooks] -------------------------------------------------------------
        out.push_str("# Hook scripts run around the open command.\n");
        out.push_str("[hooks]\n");
        if let Some(pre) = &self.hooks.pre_open {
            out.push_str("# Script run before opening the workspace.\n");
            writeln!(out, "\"pre:open\" = {}", toml_quoted(pre)).unwrap();
        }
        if let Some(post) = &self.hooks.post_open {
            out.push_str("# Script run after opening the workspace.\n");
            writeln!(out, "\"post:open\" = {}", toml_quoted(post)).unwrap();
        }
        out.push('\n');

        // [workspace] ---------------------------------------------------------
        out.push_str("# Workspace lifecycle configuration.\n");
        out.push_str("[workspace]\n");
        if let Some(ttl) = &self.workspace.ttl {
            out.push_str("# Maximum age of a workspace before it is considered expired.\n");
            writeln!(out, "ttl = {}", toml_quoted(&ttl.to_string())).unwrap();
        }
        if self.workspace.auto_prune {
            out.push_str(
                "# When true, expired worktrees are pruned each time `open` is invoked.\n",
            );
            writeln!(out, "auto_prune = {}", self.workspace.auto_prune).unwrap();
        }
        if self.workspace.temp {
            out.push_str("# When true, worktrees are stored under the OS temp directory.\n");
            writeln!(out, "temp = {}", self.workspace.temp).unwrap();
        }

        out
    }
}

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

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

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