Skip to main content

aft/
config.rs

1use std::collections::{HashMap, HashSet};
2use std::path::PathBuf;
3
4use serde::{Deserialize, Serialize};
5
6use crate::harness::Harness;
7
8/// Runtime configuration for the aft process.
9///
10/// Holds project-scoped settings and tuning knobs. Values are set at startup
11/// and remain immutable for the lifetime of the process.
12#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
13#[serde(rename_all = "snake_case")]
14pub enum SemanticBackend {
15    Fastembed,
16    #[serde(rename = "openai_compatible")]
17    OpenAiCompatible,
18    Ollama,
19}
20
21impl SemanticBackend {
22    pub const fn as_str(&self) -> &'static str {
23        match self {
24            Self::Fastembed => "fastembed",
25            Self::OpenAiCompatible => "openai_compatible",
26            Self::Ollama => "ollama",
27        }
28    }
29
30    pub fn from_name(name: &str) -> Option<Self> {
31        match name {
32            "fastembed" => Some(Self::Fastembed),
33            "openai_compatible" => Some(Self::OpenAiCompatible),
34            "ollama" => Some(Self::Ollama),
35            _ => None,
36        }
37    }
38}
39
40#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
41pub struct SemanticBackendConfig {
42    pub backend: SemanticBackend,
43    pub model: String,
44    pub base_url: Option<String>,
45    pub api_key_env: Option<String>,
46    pub timeout_ms: u64,
47    pub max_batch_size: usize,
48    /// Maximum number of project files to semantically index. Guards local
49    /// fastembed memory (model + embeddings + batch buffers) on huge project
50    /// roots; remote backends that embed server-side can raise it freely.
51    pub max_files: usize,
52}
53
54#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
55pub struct UserServerDef {
56    pub id: String,
57    pub extensions: Vec<String>,
58    pub binary: String,
59    pub args: Vec<String>,
60    pub root_markers: Vec<String>,
61    pub env: HashMap<String, String>,
62    pub initialization_options: Option<serde_json::Value>,
63    pub disabled: bool,
64}
65
66impl Default for SemanticBackendConfig {
67    fn default() -> Self {
68        Self {
69            backend: SemanticBackend::Fastembed,
70            model: DEFAULT_SEMANTIC_MODEL.to_string(),
71            base_url: None,
72            api_key_env: None,
73            // Keep the default below the plugin bridge timeout to avoid bridge-killed
74            // semantic_search requests when callers do not set an explicit timeout.
75            timeout_ms: 25_000,
76            max_batch_size: 64,
77            max_files: 20_000,
78        }
79    }
80}
81
82#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
83#[serde(default)]
84pub struct InspectConfig {
85    pub enabled: bool,
86}
87
88impl Default for InspectConfig {
89    fn default() -> Self {
90        Self { enabled: true }
91    }
92}
93
94pub const DEFAULT_SEMANTIC_MODEL: &str = "all-MiniLM-L6-v2";
95
96impl Config {
97    pub fn semantic_backend_label(&self) -> &'static str {
98        self.semantic.backend.as_str()
99    }
100}
101
102#[derive(Debug, Clone, Serialize, Deserialize)]
103#[serde(default)]
104pub struct Config {
105    /// Root directory of the project being analyzed. `None` if not scoped.
106    pub project_root: Option<PathBuf>,
107    /// How many levels of call-graph edges to follow during validation (default: 1).
108    pub validation_depth: u32,
109    /// Hours before a checkpoint expires and is eligible for cleanup (default: 24).
110    pub checkpoint_ttl_hours: u32,
111    /// Maximum depth for recursive symbol resolution (default: 10).
112    pub max_symbol_depth: u32,
113    /// Seconds before killing a formatter subprocess (default: 10).
114    pub formatter_timeout_secs: u32,
115    /// Seconds before killing a type-checker subprocess (default: 30).
116    pub type_checker_timeout_secs: u32,
117    /// Whether to auto-format files after edits (default: true).
118    pub format_on_edit: bool,
119    /// Whether to auto-validate files after edits (default: false).
120    /// When "syntax", only tree-sitter parse check. When "full", runs type checker.
121    pub validate_on_edit: Option<String>,
122    /// Per-language formatter overrides. Keys: "typescript", "python", "rust", "go".
123    /// Values: "biome", "oxfmt", "prettier", "deno", "ruff", "black", "rustfmt", "goimports", "gofmt", "none".
124    pub formatter: HashMap<String, String>,
125    /// Per-language type checker overrides. Keys: "typescript", "python", "rust", "go".
126    /// Values: "tsc", "tsgo", "biome", "pyright", "ruff", "cargo", "go", "staticcheck", "none".
127    pub checker: HashMap<String, String>,
128    /// Whether to restrict file operations to within `project_root` (default: false).
129    /// When true, write-capable commands reject paths outside the project root.
130    pub restrict_to_project_root: bool,
131    /// Enable the trigram search index (default: false).
132    pub search_index: bool,
133    /// Enable semantic search (default: false).
134    pub semantic_search: bool,
135    /// Whether the plugin registered the `aft_search` tool for this surface
136    /// (default: false). Forwarded by the plugin's resolved registration
137    /// predicate (semantic on + not minimal + not disabled). Used only to pick
138    /// the grep-rewrite footer: when true the footer steers to `aft_search`,
139    /// otherwise to the `grep` tool. Not a capability gate.
140    pub aft_search_registered: bool,
141    /// Enable the persisted callgraph store substrate (default: false).
142    pub callgraph_store: bool,
143    /// Enable experimental bash command rewriting (default: false).
144    pub experimental_bash_rewrite: bool,
145    /// Enable experimental bash command compression (default: false).
146    pub experimental_bash_compress: bool,
147    /// Enable experimental bash background execution (default: false).
148    pub experimental_bash_background: bool,
149    /// Maximum number of background bash tasks allowed to run concurrently (default: 8).
150    pub max_background_bash_tasks: usize,
151    /// Emit reminders for long-running bash tasks (default: true).
152    pub bash_long_running_reminder_enabled: bool,
153    /// Milliseconds between long-running bash reminders (default: 10 minutes).
154    pub bash_long_running_reminder_interval_ms: u64,
155    /// Enable OpenCode-style bash permission prompts (default: false).
156    pub bash_permissions: bool,
157    /// Maximum file size to fully index in bytes (default: 1MB).
158    pub search_index_max_file_size: u64,
159    /// Maximum number of source files allowed for legacy in-memory call-graph operations
160    /// (`trace_data`, symbol move analysis, and dead-code snapshots). Store-backed
161    /// edge-query commands (`callers`, `call_tree`, `impact`, `trace_to`,
162    /// `trace_to_symbol`) are not capped by this setting. Does not affect
163    /// `grep`, `glob`, `read`, `edit`, or other non-callgraph features.
164    /// Default: 5_000 (matches measured per-op cost ceilings; raise for
165    /// very large projects if you accept multi-minute per-call latency).
166    pub max_callgraph_files: usize,
167    pub semantic: SemanticBackendConfig,
168    pub inspect: InspectConfig,
169    /// Enable Astral ty as an experimental Python LSP server (default: false).
170    pub experimental_lsp_ty: bool,
171    /// User-defined LSP servers registered by the OpenCode plugin.
172    pub lsp_servers: Vec<UserServerDef>,
173    /// Lowercase LSP server IDs disabled by user config.
174    pub disabled_lsp: HashSet<String>,
175    /// Extra directories to search when resolving LSP binaries.
176    /// The plugin populates these from its own auto-install cache (e.g.
177    /// `~/.cache/aft/lsp-packages/<pkg>/node_modules/.bin/`) so a binary AFT
178    /// installed itself is discoverable without needing it on PATH.
179    /// Resolution order: `<project_root>/node_modules/.bin/<bin>` →
180    /// `lsp_paths_extra/<bin>` (in order) → PATH via `which`.
181    pub lsp_paths_extra: Vec<PathBuf>,
182    /// Binary names the hosting plugin knows how to auto-install.
183    ///
184    /// Built-in LSPs discovered from files only emit missing-binary warnings
185    /// when their binary is in this set. User-configured `lsp_servers` keep
186    /// warning unconditionally.
187    pub lsp_auto_install_binaries: HashSet<String>,
188    /// Binary names with plugin-managed auto-installs currently in flight.
189    ///
190    /// Missing-binary warnings are suppressed while the install is actively
191    /// running; install failure reporting is handled by the plugin after the
192    /// background work settles.
193    pub lsp_inflight_installs: HashSet<String>,
194    /// Persistent storage directory for indexes (trigram, semantic).
195    /// Set by the plugin to the XDG-compliant path (e.g. ~/.local/share/opencode/storage/plugin/aft/).
196    /// Falls back to ~/.cache/aft/ if not set.
197    pub storage_dir: Option<PathBuf>,
198    /// Allow URL-fetch commands to access private network hosts.
199    /// Default false; hosting plugins only forward this from user-level config.
200    pub url_fetch_allow_private: bool,
201    /// Hosting harness identity supplied by configure.
202    #[serde(default)]
203    pub harness: Option<Harness>,
204    /// Maximum number of (server, file) entries kept in the in-memory
205    /// diagnostic cache. Older entries are evicted in LRU order when the
206    /// cap is exceeded. Set to 0 to disable the cap entirely.
207    /// Default: 5000 (covers very large monorepos with bounded memory).
208    pub diagnostic_cache_size: usize,
209}
210
211impl Default for Config {
212    fn default() -> Self {
213        Config {
214            project_root: None,
215            validation_depth: 1,
216            checkpoint_ttl_hours: 24,
217            max_symbol_depth: 10,
218            formatter_timeout_secs: 10,
219            type_checker_timeout_secs: 30,
220            format_on_edit: true,
221            validate_on_edit: None,
222            formatter: HashMap::new(),
223            checker: HashMap::new(),
224            // Default to false to match OpenCode's existing permission-based model.
225            // The plugin opts into root restriction explicitly when desired.
226            restrict_to_project_root: false,
227            search_index: false,
228            semantic_search: false,
229            aft_search_registered: false,
230            callgraph_store: false,
231            experimental_bash_rewrite: false,
232            experimental_bash_compress: false,
233            experimental_bash_background: false,
234            max_background_bash_tasks: 8,
235            bash_long_running_reminder_enabled: true,
236            bash_long_running_reminder_interval_ms: 600_000,
237            bash_permissions: false,
238            search_index_max_file_size: 1_048_576,
239            // Projects larger than this skip legacy in-memory reverse-index construction.
240            //
241            // The previous default (20_000) was set by hand-wave to "fits under
242            // the 30 s bridge timeout" without measurement. Direct benchmarks
243            // showed the cost is super-linear (tree-sitter parse + reverse-index
244            // build per file): a 6.8K-file Rust project took 41 s — already past
245            // the 60 s per-callgraph-op timeout. At 10 K extrapolated cost is
246            // ~80–100 s; at 20 K it's 5+ minutes. So the old default routinely
247            // produced "timed out, restarting bridge" rather than a clean
248            // `project_too_large` rejection.
249            //
250            // 5_000 reflects measured reality: at this size, callgraph
251            // operations on a real Rust/TS project complete in roughly 30–40 s,
252            // matching the per-op timeout budget. Users with bigger projects
253            // can raise this knob, but the default should not advertise
254            // capabilities that fail in practice. Read/edit/grep/glob/outline/
255            // semantic_search/AST/LSP and the store-backed callgraph edge ops all
256            // remain unaffected by this cap — it gates legacy `trace_data`,
257            // dead-code snapshots, and `aft_refactor op="move"`.
258            max_callgraph_files: 5_000,
259            semantic: SemanticBackendConfig::default(),
260            inspect: InspectConfig::default(),
261            experimental_lsp_ty: false,
262            lsp_servers: Vec::new(),
263            disabled_lsp: HashSet::new(),
264            lsp_paths_extra: Vec::new(),
265            lsp_auto_install_binaries: HashSet::new(),
266            lsp_inflight_installs: HashSet::new(),
267            storage_dir: None,
268            url_fetch_allow_private: false,
269            harness: None,
270            diagnostic_cache_size: 5000,
271        }
272    }
273}