diff --git a/codex-rs/Cargo.lock b/codex-rs/Cargo.lock index 7b12b654ef..5358065cd5 100644 --- a/codex-rs/Cargo.lock +++ b/codex-rs/Cargo.lock @@ -629,8 +629,12 @@ dependencies = [ "codex-core", "color-eyre", "crossterm", + "lazy_static", "mcp-types", + "path-clean", + "pretty_assertions", "ratatui", + "regex", "serde_json", "shlex", "strum 0.27.1", @@ -2468,6 +2472,12 @@ dependencies = [ "path-dedot", ] +[[package]] +name = "path-clean" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "17359afc20d7ab31fdb42bb844c8b3bb1dabd7dcf7e68428492da7f16966fcef" + [[package]] name = "path-dedot" version = "3.1.1" diff --git a/codex-rs/README.md b/codex-rs/README.md index 9fe9827bff..64341c00dd 100644 --- a/codex-rs/README.md +++ b/codex-rs/README.md @@ -310,6 +310,19 @@ To disable this behavior, configure `[history]` as follows: persistence = "none" # "save-all" is the default value ``` +### file_opener + +Identifies the editor/URI scheme to use for hyperlinking citations in model output. If set, citations to files in the model output will be hyperlinked using the specified URI scheme so they can be ctrl/cmd-clicked from the terminal to open them. + +For example, if the model output includes a reference such as `【F:/home/user/project/main.py†L42-L50】`, then this would be rewritten to link to the URI `vscode://file/home/user/project/main.py:42`. + +Note this is **not** a general editor setting (like `$EDITOR`), as it only accepts a fixed set of values: + +- `vscode` (default) +- `vscode-insiders` +- `windsurf` +- `cursor` + ### project_doc_max_bytes Maximum number of bytes to read from an `AGENTS.md` file to include in the instructions sent with the first turn of a session. Defaults to 32 KiB. diff --git a/codex-rs/core/src/config.rs b/codex-rs/core/src/config.rs index b63b51e036..b285a9ddf3 100644 --- a/codex-rs/core/src/config.rs +++ b/codex-rs/core/src/config.rs @@ -84,6 +84,10 @@ pub struct Config { /// Settings that govern if and what will be written to `~/.codex/history.jsonl`. pub history: History, + + /// Optional URI-based file opener. If set, citations to files in the model + /// output will be hyperlinked using the specified URI scheme. + pub file_opener: Option, } /// Settings that govern if and what will be written to `~/.codex/history.jsonl`. @@ -97,7 +101,7 @@ pub struct History { pub max_bytes: Option, } -#[derive(Deserialize, Debug, Clone, PartialEq, Default)] +#[derive(Deserialize, Debug, Copy, Clone, PartialEq, Default)] #[serde(rename_all = "kebab-case")] pub enum HistoryPersistence { /// Save all history entries to disk. @@ -107,6 +111,21 @@ pub enum HistoryPersistence { None, } +#[derive(Deserialize, Debug, Copy, Clone, PartialEq)] +pub enum UriBasedFileOpener { + #[serde(rename = "vscode")] + VsCode, + + #[serde(rename = "vscode-insiders")] + VsCodeInsiders, + + #[serde(rename = "windsurf")] + Windsurf, + + #[serde(rename = "cursor")] + Cursor, +} + /// Base config deserialized from ~/.codex/config.toml. #[derive(Deserialize, Debug, Clone, Default)] pub struct ConfigToml { @@ -158,6 +177,10 @@ pub struct ConfigToml { /// Settings that govern if and what will be written to `~/.codex/history.jsonl`. #[serde(default)] pub history: Option, + + /// Optional URI-based file opener. If set, citations to files in the model + /// output will be hyperlinked using the specified URI scheme. + pub file_opener: Option, } impl ConfigToml { @@ -351,6 +374,9 @@ impl Config { project_doc_max_bytes: cfg.project_doc_max_bytes.unwrap_or(PROJECT_DOC_MAX_BYTES), codex_home, history, + // TODO(mbolin): Check if user has VS Code installed before + // defaulting to it? + file_opener: cfg.file_opener.or(Some(UriBasedFileOpener::VsCode)), }; Ok(config) } @@ -686,6 +712,7 @@ disable_response_storage = true project_doc_max_bytes: PROJECT_DOC_MAX_BYTES, codex_home: fixture.codex_home(), history: History::default(), + file_opener: Some(UriBasedFileOpener::VsCode), }, o3_profile_config ); @@ -721,6 +748,7 @@ disable_response_storage = true project_doc_max_bytes: PROJECT_DOC_MAX_BYTES, codex_home: fixture.codex_home(), history: History::default(), + file_opener: Some(UriBasedFileOpener::VsCode), }; assert_eq!(expected_gpt3_profile_config, gpt3_profile_config); @@ -771,6 +799,7 @@ disable_response_storage = true project_doc_max_bytes: PROJECT_DOC_MAX_BYTES, codex_home: fixture.codex_home(), history: History::default(), + file_opener: Some(UriBasedFileOpener::VsCode), }; assert_eq!(expected_zdr_profile_config, zdr_profile_config); diff --git a/codex-rs/tui/Cargo.toml b/codex-rs/tui/Cargo.toml index fa075ada4a..c09baf28fa 100644 --- a/codex-rs/tui/Cargo.toml +++ b/codex-rs/tui/Cargo.toml @@ -22,11 +22,14 @@ codex-core = { path = "../core" } codex-common = { path = "../common", features = ["cli", "elapsed"] } color-eyre = "0.6.3" crossterm = { version = "0.28.1", features = ["bracketed-paste"] } +lazy_static = "1" mcp-types = { path = "../mcp-types" } +path-clean = "1.0.1" ratatui = { version = "0.29.0", features = [ "unstable-widget-ref", "unstable-rendered-line-info", ] } +regex = "1" serde_json = "1" shlex = "1.3.0" strum = "0.27.1" @@ -44,4 +47,7 @@ tracing-subscriber = { version = "0.3.19", features = ["env-filter"] } tui-input = "0.11.1" tui-markdown = "0.3.3" tui-textarea = "0.7.0" -uuid = { version = "1" } +uuid = "1" + +[dev-dependencies] +pretty_assertions = "1" diff --git a/codex-rs/tui/src/chatwidget.rs b/codex-rs/tui/src/chatwidget.rs index 6771adb1fa..24d37c4c0a 100644 --- a/codex-rs/tui/src/chatwidget.rs +++ b/codex-rs/tui/src/chatwidget.rs @@ -209,11 +209,13 @@ impl ChatWidget<'_> { self.request_redraw(); } EventMsg::AgentMessage(AgentMessageEvent { message }) => { - self.conversation_history.add_agent_message(message); + self.conversation_history + .add_agent_message(&self.config, message); self.request_redraw(); } EventMsg::AgentReasoning(AgentReasoningEvent { text }) => { - self.conversation_history.add_agent_reasoning(text); + self.conversation_history + .add_agent_reasoning(&self.config, text); self.request_redraw(); } EventMsg::TaskStarted => { diff --git a/codex-rs/tui/src/citation_regex.rs b/codex-rs/tui/src/citation_regex.rs new file mode 100644 index 0000000000..7cda1ef11f --- /dev/null +++ b/codex-rs/tui/src/citation_regex.rs @@ -0,0 +1,22 @@ +#![allow(clippy::expect_used)] + +use regex::Regex; + +// This is defined in its own file so we can limit the scope of +// `allow(clippy::expect_used)` because we cannot scope it to the `lazy_static!` +// macro. +lazy_static::lazy_static! { + /// Regular expression that matches Codex-style source file citations such as: + /// + /// ```text + /// 【F:src/main.rs†L10-L20】 + /// ``` + /// + /// Capture groups: + /// 1. file path (anything except the dagger `†` symbol) + /// 2. start line number (digits) + /// 3. optional end line (digits or `?`) + pub(crate) static ref CITATION_REGEX: Regex = Regex::new( + r"【F:([^†]+)†L(\d+)(?:-L(\d+|\?))?】" + ).expect("failed to compile citation regex"); +} diff --git a/codex-rs/tui/src/conversation_history_widget.rs b/codex-rs/tui/src/conversation_history_widget.rs index 3d2d1cd59b..16fc3f4874 100644 --- a/codex-rs/tui/src/conversation_history_widget.rs +++ b/codex-rs/tui/src/conversation_history_widget.rs @@ -183,12 +183,12 @@ impl ConversationHistoryWidget { self.add_to_history(HistoryCell::new_user_prompt(message)); } - pub fn add_agent_message(&mut self, message: String) { - self.add_to_history(HistoryCell::new_agent_message(message)); + pub fn add_agent_message(&mut self, config: &Config, message: String) { + self.add_to_history(HistoryCell::new_agent_message(config, message)); } - pub fn add_agent_reasoning(&mut self, text: String) { - self.add_to_history(HistoryCell::new_agent_reasoning(text)); + pub fn add_agent_reasoning(&mut self, config: &Config, text: String) { + self.add_to_history(HistoryCell::new_agent_reasoning(config, text)); } pub fn add_background_event(&mut self, message: String) { diff --git a/codex-rs/tui/src/history_cell.rs b/codex-rs/tui/src/history_cell.rs index 066ed335df..fab9432724 100644 --- a/codex-rs/tui/src/history_cell.rs +++ b/codex-rs/tui/src/history_cell.rs @@ -155,19 +155,19 @@ impl HistoryCell { HistoryCell::UserPrompt { lines } } - pub(crate) fn new_agent_message(message: String) -> Self { + pub(crate) fn new_agent_message(config: &Config, message: String) -> Self { let mut lines: Vec> = Vec::new(); lines.push(Line::from("codex".magenta().bold())); - append_markdown(&message, &mut lines); + append_markdown(&message, &mut lines, config); lines.push(Line::from("")); HistoryCell::AgentMessage { lines } } - pub(crate) fn new_agent_reasoning(text: String) -> Self { + pub(crate) fn new_agent_reasoning(config: &Config, text: String) -> Self { let mut lines: Vec> = Vec::new(); lines.push(Line::from("thinking".magenta().italic())); - append_markdown(&text, &mut lines); + append_markdown(&text, &mut lines, config); lines.push(Line::from("")); HistoryCell::AgentReasoning { lines } diff --git a/codex-rs/tui/src/lib.rs b/codex-rs/tui/src/lib.rs index 5e3ed9b6a0..a6849f62fb 100644 --- a/codex-rs/tui/src/lib.rs +++ b/codex-rs/tui/src/lib.rs @@ -19,6 +19,7 @@ mod app_event; mod app_event_sender; mod bottom_pane; mod chatwidget; +mod citation_regex; mod cli; mod conversation_history_widget; mod exec_command; diff --git a/codex-rs/tui/src/markdown.rs b/codex-rs/tui/src/markdown.rs index 9837f3e20c..df427019e8 100644 --- a/codex-rs/tui/src/markdown.rs +++ b/codex-rs/tui/src/markdown.rs @@ -1,8 +1,35 @@ +use codex_core::config::Config; +use codex_core::config::UriBasedFileOpener; use ratatui::text::Line; use ratatui::text::Span; +use std::path::Path; -pub(crate) fn append_markdown(markdown_source: &str, lines: &mut Vec>) { - let markdown = tui_markdown::from_str(markdown_source); +use crate::citation_regex::CITATION_REGEX; + +pub(crate) fn append_markdown( + markdown_source: &str, + lines: &mut Vec>, + config: &Config, +) { + append_markdown_with_opener_and_cwd(markdown_source, lines, config.file_opener, &config.cwd); +} + +fn append_markdown_with_opener_and_cwd( + markdown_source: &str, + lines: &mut Vec>, + file_opener: Option, + cwd: &Path, +) { + // Perform citation rewrite *before* feeding the string to the markdown + // renderer. When `file_opener` is absent we bypass the transformation to + // avoid unnecessary allocations. + let processed_markdown: std::borrow::Cow<'_, str> = if let Some(scheme) = file_opener { + std::borrow::Cow::Owned(rewrite_file_citations(markdown_source, scheme, cwd)) + } else { + std::borrow::Cow::Borrowed(markdown_source) + }; + + let markdown = tui_markdown::from_str(&processed_markdown); // `tui_markdown` returns a `ratatui::text::Text` where every `Line` borrows // from the input `message` string. Since the `HistoryCell` stores its lines @@ -28,3 +55,112 @@ pub(crate) fn append_markdown(markdown_source: &str, lines: &mut Vec://file: +/// ``` +fn rewrite_file_citations(src: &str, file_opener: UriBasedFileOpener, cwd: &Path) -> String { + // Map enum values to the corresponding URI scheme strings. + let scheme: &str = match file_opener { + UriBasedFileOpener::VsCode => "vscode", + UriBasedFileOpener::VsCodeInsiders => "vscode-insiders", + UriBasedFileOpener::Windsurf => "windsurf", + UriBasedFileOpener::Cursor => "cursor", + }; + + CITATION_REGEX + .replace_all(src, |caps: ®ex::Captures<'_>| { + let file = &caps[1]; + let start_line = &caps[2]; + + // Resolve the path against `cwd` when it is relative. + let absolute_path = { + let p = Path::new(file); + let absolute_path = if p.is_absolute() { + path_clean::clean(p) + } else { + path_clean::clean(cwd.join(p)) + }; + // VS Code expects forward slashes even on Windows because URIs use + // `/` as the path separator. + absolute_path.to_string_lossy().replace('\\', "/") + }; + + // Render as a normal markdown link so the downstream renderer emits + // the hyperlink escape sequence (when supported by the terminal). + // + // In practice, sometimes multiple citations for the same file, but with a + // different line number, are shown sequentially, so we: + // - include the line number in the label to disambiguate them + // - add a space after the link to make it easier to read + format!("[{file}:{start_line}]({scheme}://file{absolute_path}:{start_line}) ") + }) + .into_owned() +} + +#[cfg(test)] +mod tests { + use super::*; + use pretty_assertions::assert_eq; + + #[test] + fn citation_is_rewritten_with_absolute_path() { + let markdown = "See 【F:/src/main.rs†L42-L50】 for details."; + let cwd = Path::new("/workspace"); + let result = rewrite_file_citations(markdown, UriBasedFileOpener::VsCode, cwd); + + assert_eq!( + "See [/src/main.rs:42](vscode://file/src/main.rs:42) for details.", + result + ); + } + + #[test] + fn citation_is_rewritten_with_relative_path() { + let markdown = "Refer to 【F:lib/mod.rs†L5】 here."; + let cwd = Path::new("/home/user/project"); + let result = rewrite_file_citations(markdown, UriBasedFileOpener::Windsurf, cwd); + + assert_eq!( + "Refer to [lib/mod.rs:5](windsurf://file/home/user/project/lib/mod.rs:5) here.", + result + ); + } + + #[test] + fn citation_followed_by_space_so_they_do_not_run_together() { + let markdown = "TODOs on lines 【F:src/foo.rs†L24】【F:src/foo.rs†L42】"; + let cwd = Path::new("/home/user/project"); + let result = rewrite_file_citations(markdown, UriBasedFileOpener::VsCode, cwd); + + assert_eq!( + "TODOs on lines [src/foo.rs:24](vscode://file/home/user/project/src/foo.rs:24) [src/foo.rs:42](vscode://file/home/user/project/src/foo.rs:42) ", + result + ); + } + + #[test] + fn citation_unchanged_without_file_opener() { + let markdown = "Look at 【F:file.rs†L1】."; + let cwd = Path::new("/"); + let unchanged = rewrite_file_citations(markdown, UriBasedFileOpener::VsCode, cwd); + // The helper itself always rewrites – this test validates behaviour of + // append_markdown when `file_opener` is None. + let mut out = Vec::new(); + append_markdown_with_opener_and_cwd(markdown, &mut out, None, cwd); + // Convert lines back to string for comparison. + let rendered: String = out + .iter() + .flat_map(|l| l.spans.iter()) + .map(|s| s.content.clone()) + .collect::>() + .join(""); + assert_eq!(markdown, rendered); + // Ensure helper rewrites. + assert_ne!(markdown, unchanged); + } +}