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

mod ops;
mod ops_get_set;
mod ser;

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

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

#[cfg(test)]
#[path = "ops_temp_tests.rs"]
mod ops_temp_tests;
use serde::{Deserialize, Serialize};

use crate::ttl::Ttl;

/// Top-level configuration for the worktree CLI.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct Config {
    /// Editor configuration.
    pub editor: EditorConfig,
    /// Workspace open behavior.
    pub open: OpenConfig,
    /// Hook scripts run around the open command.
    pub hooks: HooksConfig,
    /// Workspace lifecycle configuration.
    pub workspace: WorkspaceConfig,
}

/// Workspace lifecycle configuration.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct WorkspaceConfig {
    /// Maximum age of a workspace before it is considered expired.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ttl: Option<Ttl>,
    /// When true, expired worktrees are pruned each time `open` is invoked.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub auto_prune: bool,
    /// When true, worktrees are stored under the OS temp directory.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub temp: bool,
}

/// Shell scripts executed before and after opening a workspace.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct HooksConfig {
    /// Script run before opening the workspace.
    #[serde(rename = "pre:open", skip_serializing_if = "Option::is_none", default)]
    pub pre_open: Option<String>,
    /// Script run after opening the workspace.
    #[serde(rename = "post:open", skip_serializing_if = "Option::is_none", default)]
    pub post_open: Option<String>,
}

/// Editor-related configuration.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(default)]
pub struct EditorConfig {
    /// Command to launch the editor, e.g. "code ." or "nvim ."
    pub command: Option<String>,
    /// When true, the editor opens in the background (fire-and-forget).
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub background: bool,
}

/// Controls how the workspace is opened.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct OpenConfig {
    /// Whether to launch the configured editor when opening a workspace.
    pub editor: bool,
}

impl Default for OpenConfig {
    fn default() -> Self {
        Self { editor: true }
    }
}

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