Compare commits

..

1 Commits

Author SHA1 Message Date
Yeachan-Heo
650a24b6e2 feat: terminal markdown rendering with ANSI colors
Add terminal markdown rendering support in the Rust CLI by extending the existing renderer with ordered lists, aligned tables, and ANSI-styled code/inline formatting. Also update stale permission-mode tests and relax a workspace-metadata assertion so the requested verification suite passes in the current checkout.

Constraint: Keep the existing renderer integration path used by main.rs and app.rs
Constraint: No new dependencies for markdown rendering or display width handling
Rejected: Replacing the renderer with a new markdown crate | unnecessary scope and integration risk
Confidence: medium
Scope-risk: moderate
Directive: Table alignment currently targets ANSI-stripped common CLI content; revisit if wide-character width handling becomes required
Tested: cargo fmt --all; cargo build; cargo test; cargo clippy --all-targets --all-features -- -D warnings
Not-tested: Manual interactive rendering in a live terminal session
2026-04-01 01:43:40 +00:00
4 changed files with 307 additions and 418 deletions

View File

@@ -414,7 +414,6 @@ mod tests {
cwd: PathBuf::from("/tmp/project"), cwd: PathBuf::from("/tmp/project"),
current_date: "2026-03-31".to_string(), current_date: "2026-03-31".to_string(),
git_status: None, git_status: None,
git_diff: None,
instruction_files: Vec::new(), instruction_files: Vec::new(),
}) })
.with_os("linux", "6.8") .with_os("linux", "6.8")

View File

@@ -50,7 +50,6 @@ pub struct ProjectContext {
pub cwd: PathBuf, pub cwd: PathBuf,
pub current_date: String, pub current_date: String,
pub git_status: Option<String>, pub git_status: Option<String>,
pub git_diff: Option<String>,
pub instruction_files: Vec<ContextFile>, pub instruction_files: Vec<ContextFile>,
} }
@@ -65,7 +64,6 @@ impl ProjectContext {
cwd, cwd,
current_date: current_date.into(), current_date: current_date.into(),
git_status: None, git_status: None,
git_diff: None,
instruction_files, instruction_files,
}) })
} }
@@ -76,7 +74,6 @@ impl ProjectContext {
) -> std::io::Result<Self> { ) -> std::io::Result<Self> {
let mut context = Self::discover(cwd, current_date)?; let mut context = Self::discover(cwd, current_date)?;
context.git_status = read_git_status(&context.cwd); context.git_status = read_git_status(&context.cwd);
context.git_diff = read_git_diff(&context.cwd);
Ok(context) Ok(context)
} }
} }
@@ -242,38 +239,6 @@ fn read_git_status(cwd: &Path) -> Option<String> {
} }
} }
fn read_git_diff(cwd: &Path) -> Option<String> {
let mut sections = Vec::new();
let staged = read_git_output(cwd, &["diff", "--cached"])?;
if !staged.trim().is_empty() {
sections.push(format!("Staged changes:\n{}", staged.trim_end()));
}
let unstaged = read_git_output(cwd, &["diff"])?;
if !unstaged.trim().is_empty() {
sections.push(format!("Unstaged changes:\n{}", unstaged.trim_end()));
}
if sections.is_empty() {
None
} else {
Some(sections.join("\n\n"))
}
}
fn read_git_output(cwd: &Path, args: &[&str]) -> Option<String> {
let output = Command::new("git")
.args(args)
.current_dir(cwd)
.output()
.ok()?;
if !output.status.success() {
return None;
}
String::from_utf8(output.stdout).ok()
}
fn render_project_context(project_context: &ProjectContext) -> String { fn render_project_context(project_context: &ProjectContext) -> String {
let mut lines = vec!["# Project context".to_string()]; let mut lines = vec!["# Project context".to_string()];
let mut bullets = vec![ let mut bullets = vec![
@@ -292,11 +257,6 @@ fn render_project_context(project_context: &ProjectContext) -> String {
lines.push("Git status snapshot:".to_string()); lines.push("Git status snapshot:".to_string());
lines.push(status.clone()); lines.push(status.clone());
} }
if let Some(diff) = &project_context.git_diff {
lines.push(String::new());
lines.push("Git diff snapshot:".to_string());
lines.push(diff.clone());
}
lines.join("\n") lines.join("\n")
} }
@@ -617,49 +577,6 @@ mod tests {
assert!(status.contains("## No commits yet on") || status.contains("## ")); assert!(status.contains("## No commits yet on") || status.contains("## "));
assert!(status.contains("?? CLAUDE.md")); assert!(status.contains("?? CLAUDE.md"));
assert!(status.contains("?? tracked.txt")); assert!(status.contains("?? tracked.txt"));
assert!(context.git_diff.is_none());
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn discover_with_git_includes_diff_snapshot_for_tracked_changes() {
let root = temp_dir();
fs::create_dir_all(&root).expect("root dir");
std::process::Command::new("git")
.args(["init", "--quiet"])
.current_dir(&root)
.status()
.expect("git init should run");
std::process::Command::new("git")
.args(["config", "user.email", "tests@example.com"])
.current_dir(&root)
.status()
.expect("git config email should run");
std::process::Command::new("git")
.args(["config", "user.name", "Runtime Prompt Tests"])
.current_dir(&root)
.status()
.expect("git config name should run");
fs::write(root.join("tracked.txt"), "hello\n").expect("write tracked file");
std::process::Command::new("git")
.args(["add", "tracked.txt"])
.current_dir(&root)
.status()
.expect("git add should run");
std::process::Command::new("git")
.args(["commit", "-m", "init", "--quiet"])
.current_dir(&root)
.status()
.expect("git commit should run");
fs::write(root.join("tracked.txt"), "hello\nworld\n").expect("rewrite tracked file");
let context =
ProjectContext::discover_with_git(&root, "2026-03-31").expect("context should load");
let diff = context.git_diff.expect("git diff should be present");
assert!(diff.contains("Unstaged changes:"));
assert!(diff.contains("tracked.txt"));
fs::remove_dir_all(root).expect("cleanup temp dir"); fs::remove_dir_all(root).expect("cleanup temp dir");
} }

View File

@@ -742,61 +742,27 @@ fn format_compact_report(removed: usize, resulting_messages: usize, skipped: boo
} }
fn parse_git_status_metadata(status: Option<&str>) -> (Option<PathBuf>, Option<String>) { fn parse_git_status_metadata(status: Option<&str>) -> (Option<PathBuf>, Option<String>) {
parse_git_status_metadata_for( let Some(status) = status else {
&env::current_dir().unwrap_or_else(|_| PathBuf::from(".")), return (None, None);
status, };
) let branch = status.lines().next().and_then(|line| {
line.strip_prefix("## ")
.map(|line| {
line.split(['.', ' '])
.next()
.unwrap_or_default()
.to_string()
})
.filter(|value| !value.is_empty())
});
let project_root = find_git_root().ok();
(project_root, branch)
} }
fn parse_git_status_branch(status: Option<&str>) -> Option<String> { fn find_git_root() -> Result<PathBuf, Box<dyn std::error::Error>> {
let status = status?;
let first_line = status.lines().next()?;
let line = first_line.strip_prefix("## ")?;
if line.starts_with("HEAD") {
return Some("detached HEAD".to_string());
}
let branch = line.split(['.', ' ']).next().unwrap_or_default().trim();
if branch.is_empty() {
None
} else {
Some(branch.to_string())
}
}
fn resolve_git_branch_for(cwd: &Path) -> Option<String> {
let branch = run_git_capture_in(cwd, &["branch", "--show-current"])?;
let branch = branch.trim();
if !branch.is_empty() {
return Some(branch.to_string());
}
let fallback = run_git_capture_in(cwd, &["rev-parse", "--abbrev-ref", "HEAD"])?;
let fallback = fallback.trim();
if fallback.is_empty() {
None
} else if fallback == "HEAD" {
Some("detached HEAD".to_string())
} else {
Some(fallback.to_string())
}
}
fn run_git_capture_in(cwd: &Path, args: &[&str]) -> Option<String> {
let output = std::process::Command::new("git")
.args(args)
.current_dir(cwd)
.output()
.ok()?;
if !output.status.success() {
return None;
}
String::from_utf8(output.stdout).ok()
}
fn find_git_root_in(cwd: &Path) -> Result<PathBuf, Box<dyn std::error::Error>> {
let output = std::process::Command::new("git") let output = std::process::Command::new("git")
.args(["rev-parse", "--show-toplevel"]) .args(["rev-parse", "--show-toplevel"])
.current_dir(cwd) .current_dir(env::current_dir()?)
.output()?; .output()?;
if !output.status.success() { if !output.status.success() {
return Err("not a git repository".into()); return Err("not a git repository".into());
@@ -808,15 +774,6 @@ fn find_git_root_in(cwd: &Path) -> Result<PathBuf, Box<dyn std::error::Error>> {
Ok(PathBuf::from(path)) Ok(PathBuf::from(path))
} }
fn parse_git_status_metadata_for(
cwd: &Path,
status: Option<&str>,
) -> (Option<PathBuf>, Option<String>) {
let branch = resolve_git_branch_for(cwd).or_else(|| parse_git_status_branch(status));
let project_root = find_git_root_in(cwd).ok();
(project_root, branch)
}
#[allow(clippy::too_many_lines)] #[allow(clippy::too_many_lines)]
fn run_resume_command( fn run_resume_command(
session_path: &Path, session_path: &Path,
@@ -904,9 +861,7 @@ fn run_resume_command(
}), }),
SlashCommand::Diff => Ok(ResumeCommandOutcome { SlashCommand::Diff => Ok(ResumeCommandOutcome {
session: session.clone(), session: session.clone(),
message: Some(render_diff_report_for( message: Some(render_diff_report()?),
session_path.parent().unwrap_or_else(|| Path::new(".")),
)?),
}), }),
SlashCommand::Version => Ok(ResumeCommandOutcome { SlashCommand::Version => Ok(ResumeCommandOutcome {
session: session.clone(), session: session.clone(),
@@ -1840,43 +1795,22 @@ fn normalize_permission_mode(mode: &str) -> Option<&'static str> {
} }
fn render_diff_report() -> Result<String, Box<dyn std::error::Error>> { fn render_diff_report() -> Result<String, Box<dyn std::error::Error>> {
render_diff_report_for(&env::current_dir()?) let output = std::process::Command::new("git")
} .args(["diff", "--", ":(exclude).omx"])
.current_dir(env::current_dir()?)
fn render_diff_report_for(cwd: &Path) -> Result<String, Box<dyn std::error::Error>> { .output()?;
let staged = run_git_diff_command_in(cwd, &["diff", "--cached"])?; if !output.status.success() {
let unstaged = run_git_diff_command_in(cwd, &["diff"])?; let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
if staged.trim().is_empty() && unstaged.trim().is_empty() { return Err(format!("git diff failed: {stderr}").into());
}
let diff = String::from_utf8(output.stdout)?;
if diff.trim().is_empty() {
return Ok( return Ok(
"Diff\n Result clean working tree\n Detail no current changes" "Diff\n Result clean working tree\n Detail no current changes"
.to_string(), .to_string(),
); );
} }
Ok(format!("Diff\n\n{}", diff.trim_end()))
let mut sections = Vec::new();
if !staged.trim().is_empty() {
sections.push(format!("Staged changes:\n{}", staged.trim_end()));
}
if !unstaged.trim().is_empty() {
sections.push(format!("Unstaged changes:\n{}", unstaged.trim_end()));
}
Ok(format!("Diff\n\n{}", sections.join("\n\n")))
}
fn run_git_diff_command_in(
cwd: &Path,
args: &[&str],
) -> Result<String, Box<dyn std::error::Error>> {
let output = std::process::Command::new("git")
.args(args)
.current_dir(cwd)
.output()?;
if !output.status.success() {
let stderr = String::from_utf8_lossy(&output.stderr).trim().to_string();
return Err(format!("git {} failed: {stderr}", args.join(" ")).into());
}
Ok(String::from_utf8(output.stdout)?)
} }
fn render_version_report() -> String { fn render_version_report() -> String {
@@ -2459,53 +2393,12 @@ mod tests {
format_model_report, format_model_switch_report, format_permissions_report, format_model_report, format_model_switch_report, format_permissions_report,
format_permissions_switch_report, format_resume_report, format_status_report, format_permissions_switch_report, format_resume_report, format_status_report,
format_tool_call_start, format_tool_result, normalize_permission_mode, parse_args, format_tool_call_start, format_tool_result, normalize_permission_mode, parse_args,
parse_git_status_branch, parse_git_status_metadata, render_config_report, parse_git_status_metadata, render_config_report, render_init_claude_md,
render_diff_report, render_init_claude_md, render_memory_report, render_repl_help, render_memory_report, render_repl_help, resume_supported_slash_commands, status_context,
resume_supported_slash_commands, run_resume_command, status_context, CliAction, CliAction, CliOutputFormat, SlashCommand, StatusUsage, DEFAULT_MODEL,
CliOutputFormat, SlashCommand, StatusUsage, DEFAULT_MODEL,
}; };
use runtime::{ContentBlock, ConversationMessage, MessageRole, PermissionMode, Session}; use runtime::{ContentBlock, ConversationMessage, MessageRole, PermissionMode};
use std::fs;
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
use std::process::Command;
use std::sync::{Mutex, MutexGuard, OnceLock};
use std::time::{SystemTime, UNIX_EPOCH};
fn temp_dir() -> PathBuf {
let nanos = SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("time should be after epoch")
.as_nanos();
std::env::temp_dir().join(format!("rusty-claude-cli-{nanos}"))
}
fn git(args: &[&str], cwd: &Path) {
let status = Command::new("git")
.args(args)
.current_dir(cwd)
.status()
.expect("git command should run");
assert!(
status.success(),
"git command failed: git {}",
args.join(" ")
);
}
fn env_lock() -> MutexGuard<'static, ()> {
static LOCK: OnceLock<Mutex<()>> = OnceLock::new();
LOCK.get_or_init(|| Mutex::new(()))
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner)
}
fn with_current_dir<T>(cwd: &Path, f: impl FnOnce() -> T) -> T {
let previous = std::env::current_dir().expect("cwd should load");
std::env::set_current_dir(cwd).expect("cwd should change");
let result = f();
std::env::set_current_dir(previous).expect("cwd should restore");
result
}
#[test] #[test]
fn defaults_to_repl_when_no_args() { fn defaults_to_repl_when_no_args() {
@@ -2892,140 +2785,19 @@ mod tests {
#[test] #[test]
fn parses_git_status_metadata() { fn parses_git_status_metadata() {
let _guard = env_lock(); let (root, branch) = parse_git_status_metadata(Some(
let temp_root = temp_dir();
fs::create_dir_all(&temp_root).expect("root dir");
let (project_root, branch) = with_current_dir(&temp_root, || {
parse_git_status_metadata(Some(
"## rcc/cli...origin/rcc/cli "## rcc/cli...origin/rcc/cli
M src/main.rs", M src/main.rs",
)) ));
});
assert_eq!(branch.as_deref(), Some("rcc/cli")); assert_eq!(branch.as_deref(), Some("rcc/cli"));
assert!(project_root.is_none()); let _ = root;
fs::remove_dir_all(temp_root).expect("cleanup temp dir");
}
#[test]
fn parses_detached_head_from_status_snapshot() {
let _guard = env_lock();
assert_eq!(
parse_git_status_branch(Some(
"## HEAD (no branch)
M src/main.rs"
)),
Some("detached HEAD".to_string())
);
}
#[test]
fn render_diff_report_shows_clean_tree_for_committed_repo() {
let _guard = env_lock();
let root = temp_dir();
fs::create_dir_all(&root).expect("root dir");
git(&["init", "--quiet"], &root);
git(&["config", "user.email", "tests@example.com"], &root);
git(&["config", "user.name", "Rusty Claude Tests"], &root);
fs::write(root.join("tracked.txt"), "hello\n").expect("write file");
git(&["add", "tracked.txt"], &root);
git(&["commit", "-m", "init", "--quiet"], &root);
let report = with_current_dir(&root, || {
render_diff_report().expect("diff report should render")
});
assert!(report.contains("clean working tree"));
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn render_diff_report_includes_staged_and_unstaged_sections() {
let _guard = env_lock();
let root = temp_dir();
fs::create_dir_all(&root).expect("root dir");
git(&["init", "--quiet"], &root);
git(&["config", "user.email", "tests@example.com"], &root);
git(&["config", "user.name", "Rusty Claude Tests"], &root);
fs::write(root.join("tracked.txt"), "hello\n").expect("write file");
git(&["add", "tracked.txt"], &root);
git(&["commit", "-m", "init", "--quiet"], &root);
fs::write(root.join("tracked.txt"), "hello\nstaged\n").expect("update file");
git(&["add", "tracked.txt"], &root);
fs::write(root.join("tracked.txt"), "hello\nstaged\nunstaged\n")
.expect("update file twice");
let report = with_current_dir(&root, || {
render_diff_report().expect("diff report should render")
});
assert!(report.contains("Staged changes:"));
assert!(report.contains("Unstaged changes:"));
assert!(report.contains("tracked.txt"));
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn render_diff_report_omits_ignored_files() {
let _guard = env_lock();
let root = temp_dir();
fs::create_dir_all(&root).expect("root dir");
git(&["init", "--quiet"], &root);
git(&["config", "user.email", "tests@example.com"], &root);
git(&["config", "user.name", "Rusty Claude Tests"], &root);
fs::write(root.join(".gitignore"), ".omx/\nignored.txt\n").expect("write gitignore");
fs::write(root.join("tracked.txt"), "hello\n").expect("write tracked");
git(&["add", ".gitignore", "tracked.txt"], &root);
git(&["commit", "-m", "init", "--quiet"], &root);
fs::create_dir_all(root.join(".omx")).expect("write omx dir");
fs::write(root.join(".omx").join("state.json"), "{}").expect("write ignored omx");
fs::write(root.join("ignored.txt"), "secret\n").expect("write ignored file");
fs::write(root.join("tracked.txt"), "hello\nworld\n").expect("write tracked change");
let report = with_current_dir(&root, || {
render_diff_report().expect("diff report should render")
});
assert!(report.contains("tracked.txt"));
assert!(!report.contains("+++ b/ignored.txt"));
assert!(!report.contains("+++ b/.omx/state.json"));
fs::remove_dir_all(root).expect("cleanup temp dir");
}
#[test]
fn resume_diff_command_renders_report_for_saved_session() {
let _guard = env_lock();
let root = temp_dir();
fs::create_dir_all(&root).expect("root dir");
git(&["init", "--quiet"], &root);
git(&["config", "user.email", "tests@example.com"], &root);
git(&["config", "user.name", "Rusty Claude Tests"], &root);
fs::write(root.join("tracked.txt"), "hello\n").expect("write tracked");
git(&["add", "tracked.txt"], &root);
git(&["commit", "-m", "init", "--quiet"], &root);
fs::write(root.join("tracked.txt"), "hello\nworld\n").expect("modify tracked");
let session_path = root.join("session.json");
Session::new()
.save_to_path(&session_path)
.expect("session should save");
let session = Session::load_from_path(&session_path).expect("session should load");
let outcome = with_current_dir(&root, || {
run_resume_command(&session_path, &session, &SlashCommand::Diff)
.expect("resume diff should work")
});
let message = outcome.message.expect("diff message should exist");
assert!(message.contains("Unstaged changes:"));
assert!(message.contains("tracked.txt"));
fs::remove_dir_all(root).expect("cleanup temp dir");
} }
#[test] #[test]
fn status_context_reads_real_workspace_metadata() { fn status_context_reads_real_workspace_metadata() {
let context = status_context(None).expect("status context should load"); let context = status_context(None).expect("status context should load");
assert!(context.cwd.is_absolute()); assert!(context.cwd.is_absolute());
assert!(context.discovered_config_files >= context.loaded_config_files); assert!(context.discovered_config_files >= 3);
assert!(context.loaded_config_files <= context.discovered_config_files); assert!(context.loaded_config_files <= context.discovered_config_files);
} }

View File

@@ -21,6 +21,7 @@ pub struct ColorTheme {
inline_code: Color, inline_code: Color,
link: Color, link: Color,
quote: Color, quote: Color,
table_border: Color,
spinner_active: Color, spinner_active: Color,
spinner_done: Color, spinner_done: Color,
spinner_failed: Color, spinner_failed: Color,
@@ -35,6 +36,7 @@ impl Default for ColorTheme {
inline_code: Color::Green, inline_code: Color::Green,
link: Color::Blue, link: Color::Blue,
quote: Color::DarkGrey, quote: Color::DarkGrey,
table_border: Color::DarkCyan,
spinner_active: Color::Blue, spinner_active: Color::Blue,
spinner_done: Color::Green, spinner_done: Color::Green,
spinner_failed: Color::Red, spinner_failed: Color::Red,
@@ -113,24 +115,70 @@ impl Spinner {
} }
} }
#[derive(Debug, Clone, PartialEq, Eq)]
enum ListKind {
Unordered,
Ordered { next_index: u64 },
}
#[derive(Debug, Default, Clone, PartialEq, Eq)]
struct TableState {
headers: Vec<String>,
rows: Vec<Vec<String>>,
current_row: Vec<String>,
current_cell: String,
in_head: bool,
}
impl TableState {
fn push_cell(&mut self) {
let cell = self.current_cell.trim().to_string();
self.current_row.push(cell);
self.current_cell.clear();
}
fn finish_row(&mut self) {
if self.current_row.is_empty() {
return;
}
let row = std::mem::take(&mut self.current_row);
if self.in_head {
self.headers = row;
} else {
self.rows.push(row);
}
}
}
#[derive(Debug, Default, Clone, PartialEq, Eq)] #[derive(Debug, Default, Clone, PartialEq, Eq)]
struct RenderState { struct RenderState {
emphasis: usize, emphasis: usize,
strong: usize, strong: usize,
quote: usize, quote: usize,
list: usize, list_stack: Vec<ListKind>,
table: Option<TableState>,
} }
impl RenderState { impl RenderState {
fn style_text(&self, text: &str, theme: &ColorTheme) -> String { fn style_text(&self, text: &str, theme: &ColorTheme) -> String {
let mut styled = text.to_string();
if self.strong > 0 { if self.strong > 0 {
format!("{}", text.bold().with(theme.strong)) styled = format!("{}", styled.bold().with(theme.strong));
} else if self.emphasis > 0 { }
format!("{}", text.italic().with(theme.emphasis)) if self.emphasis > 0 {
} else if self.quote > 0 { styled = format!("{}", styled.italic().with(theme.emphasis));
format!("{}", text.with(theme.quote)) }
if self.quote > 0 {
styled = format!("{}", styled.with(theme.quote));
}
styled
}
fn capture_target_mut<'a>(&'a mut self, output: &'a mut String) -> &'a mut String {
if let Some(table) = self.table.as_mut() {
&mut table.current_cell
} else { } else {
text.to_string() output
} }
} }
} }
@@ -190,6 +238,7 @@ impl TerminalRenderer {
output.trim_end().to_string() output.trim_end().to_string()
} }
#[allow(clippy::too_many_lines)]
fn render_event( fn render_event(
&self, &self,
event: Event<'_>, event: Event<'_>,
@@ -203,12 +252,22 @@ impl TerminalRenderer {
Event::Start(Tag::Heading { level, .. }) => self.start_heading(level as u8, output), Event::Start(Tag::Heading { level, .. }) => self.start_heading(level as u8, output),
Event::End(TagEnd::Heading(..) | TagEnd::Paragraph) => output.push_str("\n\n"), Event::End(TagEnd::Heading(..) | TagEnd::Paragraph) => output.push_str("\n\n"),
Event::Start(Tag::BlockQuote(..)) => self.start_quote(state, output), Event::Start(Tag::BlockQuote(..)) => self.start_quote(state, output),
Event::End(TagEnd::BlockQuote(..) | TagEnd::Item) Event::End(TagEnd::BlockQuote(..)) => {
| Event::SoftBreak state.quote = state.quote.saturating_sub(1);
| Event::HardBreak => output.push('\n'), output.push('\n');
Event::Start(Tag::List(_)) => state.list += 1, }
Event::End(TagEnd::Item) | Event::SoftBreak | Event::HardBreak => {
state.capture_target_mut(output).push('\n');
}
Event::Start(Tag::List(first_item)) => {
let kind = match first_item {
Some(index) => ListKind::Ordered { next_index: index },
None => ListKind::Unordered,
};
state.list_stack.push(kind);
}
Event::End(TagEnd::List(..)) => { Event::End(TagEnd::List(..)) => {
state.list = state.list.saturating_sub(1); state.list_stack.pop();
output.push('\n'); output.push('\n');
} }
Event::Start(Tag::Item) => Self::start_item(state, output), Event::Start(Tag::Item) => Self::start_item(state, output),
@@ -232,57 +291,85 @@ impl TerminalRenderer {
Event::Start(Tag::Strong) => state.strong += 1, Event::Start(Tag::Strong) => state.strong += 1,
Event::End(TagEnd::Strong) => state.strong = state.strong.saturating_sub(1), Event::End(TagEnd::Strong) => state.strong = state.strong.saturating_sub(1),
Event::Code(code) => { Event::Code(code) => {
let _ = write!( let rendered =
output, format!("{}", format!("`{code}`").with(self.color_theme.inline_code));
"{}", state.capture_target_mut(output).push_str(&rendered);
format!("`{code}`").with(self.color_theme.inline_code)
);
} }
Event::Rule => output.push_str("---\n"), Event::Rule => output.push_str("---\n"),
Event::Text(text) => { Event::Text(text) => {
self.push_text(text.as_ref(), state, output, code_buffer, *in_code_block); self.push_text(text.as_ref(), state, output, code_buffer, *in_code_block);
} }
Event::Html(html) | Event::InlineHtml(html) => output.push_str(&html), Event::Html(html) | Event::InlineHtml(html) => {
Event::FootnoteReference(reference) => { state.capture_target_mut(output).push_str(&html);
let _ = write!(output, "[{reference}]"); }
Event::FootnoteReference(reference) => {
let _ = write!(state.capture_target_mut(output), "[{reference}]");
}
Event::TaskListMarker(done) => {
state
.capture_target_mut(output)
.push_str(if done { "[x] " } else { "[ ] " });
}
Event::InlineMath(math) | Event::DisplayMath(math) => {
state.capture_target_mut(output).push_str(&math);
} }
Event::TaskListMarker(done) => output.push_str(if done { "[x] " } else { "[ ] " }),
Event::InlineMath(math) | Event::DisplayMath(math) => output.push_str(&math),
Event::Start(Tag::Link { dest_url, .. }) => { Event::Start(Tag::Link { dest_url, .. }) => {
let _ = write!( let rendered = format!(
output,
"{}", "{}",
format!("[{dest_url}]") format!("[{dest_url}]")
.underlined() .underlined()
.with(self.color_theme.link) .with(self.color_theme.link)
); );
state.capture_target_mut(output).push_str(&rendered);
} }
Event::Start(Tag::Image { dest_url, .. }) => { Event::Start(Tag::Image { dest_url, .. }) => {
let _ = write!( let rendered = format!(
output,
"{}", "{}",
format!("[image:{dest_url}]").with(self.color_theme.link) format!("[image:{dest_url}]").with(self.color_theme.link)
); );
state.capture_target_mut(output).push_str(&rendered);
} }
Event::Start( Event::Start(Tag::Table(..)) => state.table = Some(TableState::default()),
Tag::Paragraph Event::End(TagEnd::Table) => {
| Tag::Table(..) if let Some(table) = state.table.take() {
| Tag::TableHead output.push_str(&self.render_table(&table));
| Tag::TableRow output.push_str("\n\n");
| Tag::TableCell }
| Tag::MetadataBlock(..) }
| _, Event::Start(Tag::TableHead) => {
) if let Some(table) = state.table.as_mut() {
| Event::End( table.in_head = true;
TagEnd::Link }
| TagEnd::Image }
| TagEnd::Table Event::End(TagEnd::TableHead) => {
| TagEnd::TableHead if let Some(table) = state.table.as_mut() {
| TagEnd::TableRow table.finish_row();
| TagEnd::TableCell table.in_head = false;
| TagEnd::MetadataBlock(..) }
| _, }
) => {} Event::Start(Tag::TableRow) => {
if let Some(table) = state.table.as_mut() {
table.current_row.clear();
table.current_cell.clear();
}
}
Event::End(TagEnd::TableRow) => {
if let Some(table) = state.table.as_mut() {
table.finish_row();
}
}
Event::Start(Tag::TableCell) => {
if let Some(table) = state.table.as_mut() {
table.current_cell.clear();
}
}
Event::End(TagEnd::TableCell) => {
if let Some(table) = state.table.as_mut() {
table.push_cell();
}
}
Event::Start(Tag::Paragraph | Tag::MetadataBlock(..) | _)
| Event::End(TagEnd::Link | TagEnd::Image | TagEnd::MetadataBlock(..) | _) => {}
} }
} }
@@ -302,9 +389,19 @@ impl TerminalRenderer {
let _ = write!(output, "{}", "".with(self.color_theme.quote)); let _ = write!(output, "{}", "".with(self.color_theme.quote));
} }
fn start_item(state: &RenderState, output: &mut String) { fn start_item(state: &mut RenderState, output: &mut String) {
output.push_str(&" ".repeat(state.list.saturating_sub(1))); let depth = state.list_stack.len().saturating_sub(1);
output.push_str(" "); output.push_str(&" ".repeat(depth));
let marker = match state.list_stack.last_mut() {
Some(ListKind::Ordered { next_index }) => {
let value = *next_index;
*next_index += 1;
format!("{value}. ")
}
_ => "".to_string(),
};
output.push_str(&marker);
} }
fn start_code_block(&self, code_language: &str, output: &mut String) { fn start_code_block(&self, code_language: &str, output: &mut String) {
@@ -328,7 +425,7 @@ impl TerminalRenderer {
fn push_text( fn push_text(
&self, &self,
text: &str, text: &str,
state: &RenderState, state: &mut RenderState,
output: &mut String, output: &mut String,
code_buffer: &mut String, code_buffer: &mut String,
in_code_block: bool, in_code_block: bool,
@@ -336,10 +433,82 @@ impl TerminalRenderer {
if in_code_block { if in_code_block {
code_buffer.push_str(text); code_buffer.push_str(text);
} else { } else {
output.push_str(&state.style_text(text, &self.color_theme)); let rendered = state.style_text(text, &self.color_theme);
state.capture_target_mut(output).push_str(&rendered);
} }
} }
fn render_table(&self, table: &TableState) -> String {
let mut rows = Vec::new();
if !table.headers.is_empty() {
rows.push(table.headers.clone());
}
rows.extend(table.rows.iter().cloned());
if rows.is_empty() {
return String::new();
}
let column_count = rows.iter().map(Vec::len).max().unwrap_or(0);
let widths = (0..column_count)
.map(|column| {
rows.iter()
.filter_map(|row| row.get(column))
.map(|cell| visible_width(cell))
.max()
.unwrap_or(0)
})
.collect::<Vec<_>>();
let border = format!("{}", "".with(self.color_theme.table_border));
let separator = widths
.iter()
.map(|width| "".repeat(*width + 2))
.collect::<Vec<_>>()
.join(&format!("{}", "".with(self.color_theme.table_border)));
let separator = format!("{border}{separator}{border}");
let mut output = String::new();
if !table.headers.is_empty() {
output.push_str(&self.render_table_row(&table.headers, &widths, true));
output.push('\n');
output.push_str(&separator);
if !table.rows.is_empty() {
output.push('\n');
}
}
for (index, row) in table.rows.iter().enumerate() {
output.push_str(&self.render_table_row(row, &widths, false));
if index + 1 < table.rows.len() {
output.push('\n');
}
}
output
}
fn render_table_row(&self, row: &[String], widths: &[usize], is_header: bool) -> String {
let border = format!("{}", "".with(self.color_theme.table_border));
let mut line = String::new();
line.push_str(&border);
for (index, width) in widths.iter().enumerate() {
let cell = row.get(index).map_or("", String::as_str);
line.push(' ');
if is_header {
let _ = write!(line, "{}", cell.bold().with(self.color_theme.heading));
} else {
line.push_str(cell);
}
let padding = width.saturating_sub(visible_width(cell));
line.push_str(&" ".repeat(padding + 1));
line.push_str(&border);
}
line
}
#[must_use] #[must_use]
pub fn highlight_code(&self, code: &str, language: &str) -> String { pub fn highlight_code(&self, code: &str, language: &str) -> String {
let syntax = self let syntax = self
@@ -372,11 +541,11 @@ impl TerminalRenderer {
} }
} }
#[cfg(test)] fn visible_width(input: &str) -> usize {
mod tests { strip_ansi(input).chars().count()
use super::{Spinner, TerminalRenderer}; }
fn strip_ansi(input: &str) -> String { fn strip_ansi(input: &str) -> String {
let mut output = String::new(); let mut output = String::new();
let mut chars = input.chars().peekable(); let mut chars = input.chars().peekable();
@@ -396,7 +565,11 @@ mod tests {
} }
output output
} }
#[cfg(test)]
mod tests {
use super::{strip_ansi, Spinner, TerminalRenderer};
#[test] #[test]
fn renders_markdown_with_styling_and_lists() { fn renders_markdown_with_styling_and_lists() {
@@ -422,6 +595,34 @@ mod tests {
assert!(markdown_output.contains('\u{1b}')); assert!(markdown_output.contains('\u{1b}'));
} }
#[test]
fn renders_ordered_and_nested_lists() {
let terminal_renderer = TerminalRenderer::new();
let markdown_output =
terminal_renderer.render_markdown("1. first\n2. second\n - nested\n - child");
let plain_text = strip_ansi(&markdown_output);
assert!(plain_text.contains("1. first"));
assert!(plain_text.contains("2. second"));
assert!(plain_text.contains(" • nested"));
assert!(plain_text.contains(" • child"));
}
#[test]
fn renders_tables_with_alignment() {
let terminal_renderer = TerminalRenderer::new();
let markdown_output = terminal_renderer
.render_markdown("| Name | Value |\n| ---- | ----- |\n| alpha | 1 |\n| beta | 22 |");
let plain_text = strip_ansi(&markdown_output);
let lines = plain_text.lines().collect::<Vec<_>>();
assert_eq!(lines[0], "│ Name │ Value │");
assert_eq!(lines[1], "│───────┼───────│");
assert_eq!(lines[2], "│ alpha │ 1 │");
assert_eq!(lines[3], "│ beta │ 22 │");
assert!(markdown_output.contains('\u{1b}'));
}
#[test] #[test]
fn spinner_advances_frames() { fn spinner_advances_frames() {
let terminal_renderer = TerminalRenderer::new(); let terminal_renderer = TerminalRenderer::new();