vtcode-config 0.98.7

Config loader components shared across VT Code and downstream adopters
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use serde::{Deserialize, Serialize};

/// Editor URI scheme for clickable file citations.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum FileOpener {
    Cursor,
    #[default]
    None,
    Vscode,
    VscodeInsiders,
    Windsurf,
}

impl FileOpener {
    pub fn scheme(self) -> Option<&'static str> {
        match self {
            Self::None => None,
            Self::Vscode => Some("vscode"),
            Self::Cursor => Some("cursor"),
            Self::Windsurf => Some("windsurf"),
            Self::VscodeInsiders => Some("vscode-insiders"),
        }
    }
}

/// Local history persistence mode.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
pub enum HistoryPersistence {
    #[default]
    File,
    None,
}

/// Codex-compatible history persistence settings.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Deserialize, Serialize, Default)]
pub struct HistoryConfig {
    #[serde(default)]
    pub persistence: HistoryPersistence,
    #[serde(default)]
    pub max_bytes: Option<usize>,
}

/// Built-in TUI notification delivery method.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
pub enum TerminalNotificationMethod {
    #[default]
    Auto,
    Bel,
    Osc9,
}

/// Alternate-screen preference for the TUI.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum TuiAlternateScreen {
    Always,
    Never,
}

/// TUI notification filters compatible with Codex config.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub enum TuiNotificationEvent {
    AgentTurnComplete,
    ApprovalRequested,
}

/// Accept either `true`/`false` or an allowlist of event names.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(untagged)]
pub enum TuiNotificationsConfig {
    Enabled(bool),
    Events(Vec<TuiNotificationEvent>),
}

/// When to deliver desktop notifications relative to terminal focus.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Default)]
#[serde(rename_all = "snake_case")]
pub enum NotificationCondition {
    /// Only deliver when the terminal is unfocused (legacy behaviour).
    #[default]
    Unfocused,
    /// Always deliver regardless of focus state.
    Always,
}

/// Codex-compatible TUI settings.
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[derive(Debug, Clone, Deserialize, Serialize, Default)]
pub struct TuiConfig {
    #[serde(default)]
    pub notifications: Option<TuiNotificationsConfig>,
    #[serde(default)]
    pub notification_method: Option<TerminalNotificationMethod>,
    /// When to deliver desktop notifications relative to terminal focus.
    /// Defaults to `unfocused` (only deliver when terminal is not focused).
    /// Set to `always` to deliver notifications even when the terminal is focused.
    #[serde(default)]
    pub notification_condition: Option<NotificationCondition>,
    #[serde(default)]
    pub animations: Option<bool>,
    #[serde(default)]
    pub alternate_screen: Option<TuiAlternateScreen>,
    #[serde(default)]
    pub show_tooltips: Option<bool>,
}