use std::fmt::Write as FmtWrite; use std::io::{self, Write}; use std::thread; use std::time::Duration; use crossterm::cursor::{MoveToColumn, RestorePosition, SavePosition}; use crossterm::style::{Color, Print, ResetColor, SetForegroundColor, Stylize}; use crossterm::terminal::{Clear, ClearType}; use crossterm::{execute, queue}; use pulldown_cmark::{CodeBlockKind, Event, Options, Parser, Tag, TagEnd}; use syntect::easy::HighlightLines; use syntect::highlighting::{Theme, ThemeSet}; use syntect::parsing::SyntaxSet; use syntect::util::{as_24_bit_terminal_escaped, LinesWithEndings}; #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct ColorTheme { heading: Color, emphasis: Color, strong: Color, inline_code: Color, link: Color, quote: Color, table_border: Color, spinner_active: Color, spinner_done: Color, spinner_failed: Color, } impl Default for ColorTheme { fn default() -> Self { Self { heading: Color::Cyan, emphasis: Color::Magenta, strong: Color::Yellow, inline_code: Color::Green, link: Color::Blue, quote: Color::DarkGrey, table_border: Color::DarkCyan, spinner_active: Color::Blue, spinner_done: Color::Green, spinner_failed: Color::Red, } } } #[derive(Debug, Default, Clone, PartialEq, Eq)] pub struct Spinner { frame_index: usize, } impl Spinner { const FRAMES: [&str; 10] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]; #[must_use] pub fn new() -> Self { Self::default() } pub fn tick( &mut self, label: &str, theme: &ColorTheme, out: &mut impl Write, ) -> io::Result<()> { let frame = Self::FRAMES[self.frame_index % Self::FRAMES.len()]; self.frame_index += 1; queue!( out, SavePosition, MoveToColumn(0), Clear(ClearType::CurrentLine), SetForegroundColor(theme.spinner_active), Print(format!("{frame} {label}")), ResetColor, RestorePosition )?; out.flush() } pub fn finish( &mut self, label: &str, theme: &ColorTheme, out: &mut impl Write, ) -> io::Result<()> { self.frame_index = 0; execute!( out, MoveToColumn(0), Clear(ClearType::CurrentLine), SetForegroundColor(theme.spinner_done), Print(format!("✔ {label}\n")), ResetColor )?; out.flush() } pub fn fail( &mut self, label: &str, theme: &ColorTheme, out: &mut impl Write, ) -> io::Result<()> { self.frame_index = 0; execute!( out, MoveToColumn(0), Clear(ClearType::CurrentLine), SetForegroundColor(theme.spinner_failed), Print(format!("✘ {label}\n")), ResetColor )?; out.flush() } } #[derive(Debug, Clone, PartialEq, Eq)] enum ListKind { Unordered, Ordered { next_index: u64 }, } #[derive(Debug, Default, Clone, PartialEq, Eq)] struct TableState { headers: Vec, rows: Vec>, current_row: Vec, 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)] struct RenderState { emphasis: usize, strong: usize, quote: usize, list_stack: Vec, table: Option, } impl RenderState { fn style_text(&self, text: &str, theme: &ColorTheme) -> String { let mut styled = text.to_string(); if self.strong > 0 { styled = format!("{}", styled.bold().with(theme.strong)); } if self.emphasis > 0 { styled = format!("{}", styled.italic().with(theme.emphasis)); } 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 { output } } } #[derive(Debug)] pub struct TerminalRenderer { syntax_set: SyntaxSet, syntax_theme: Theme, color_theme: ColorTheme, } impl Default for TerminalRenderer { fn default() -> Self { let syntax_set = SyntaxSet::load_defaults_newlines(); let syntax_theme = ThemeSet::load_defaults() .themes .remove("base16-ocean.dark") .unwrap_or_default(); Self { syntax_set, syntax_theme, color_theme: ColorTheme::default(), } } } impl TerminalRenderer { #[must_use] pub fn new() -> Self { Self::default() } #[must_use] pub fn color_theme(&self) -> &ColorTheme { &self.color_theme } #[must_use] pub fn render_markdown(&self, markdown: &str) -> String { let mut output = String::new(); let mut state = RenderState::default(); let mut code_language = String::new(); let mut code_buffer = String::new(); let mut in_code_block = false; for event in Parser::new_ext(markdown, Options::all()) { self.render_event( event, &mut state, &mut output, &mut code_buffer, &mut code_language, &mut in_code_block, ); } output.trim_end().to_string() } #[allow(clippy::too_many_lines)] fn render_event( &self, event: Event<'_>, state: &mut RenderState, output: &mut String, code_buffer: &mut String, code_language: &mut String, in_code_block: &mut bool, ) { match event { Event::Start(Tag::Heading { level, .. }) => self.start_heading(level as u8, output), Event::End(TagEnd::Heading(..) | TagEnd::Paragraph) => output.push_str("\n\n"), Event::Start(Tag::BlockQuote(..)) => self.start_quote(state, output), Event::End(TagEnd::BlockQuote(..)) => { state.quote = state.quote.saturating_sub(1); output.push('\n'); } 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(..)) => { state.list_stack.pop(); output.push('\n'); } Event::Start(Tag::Item) => Self::start_item(state, output), Event::Start(Tag::CodeBlock(kind)) => { *in_code_block = true; *code_language = match kind { CodeBlockKind::Indented => String::from("text"), CodeBlockKind::Fenced(lang) => lang.to_string(), }; code_buffer.clear(); self.start_code_block(code_language, output); } Event::End(TagEnd::CodeBlock) => { self.finish_code_block(code_buffer, code_language, output); *in_code_block = false; code_language.clear(); code_buffer.clear(); } Event::Start(Tag::Emphasis) => state.emphasis += 1, Event::End(TagEnd::Emphasis) => state.emphasis = state.emphasis.saturating_sub(1), Event::Start(Tag::Strong) => state.strong += 1, Event::End(TagEnd::Strong) => state.strong = state.strong.saturating_sub(1), Event::Code(code) => { let rendered = format!("{}", format!("`{code}`").with(self.color_theme.inline_code)); state.capture_target_mut(output).push_str(&rendered); } Event::Rule => output.push_str("---\n"), Event::Text(text) => { self.push_text(text.as_ref(), state, output, code_buffer, *in_code_block); } Event::Html(html) | Event::InlineHtml(html) => { state.capture_target_mut(output).push_str(&html); } 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::Start(Tag::Link { dest_url, .. }) => { let rendered = format!( "{}", format!("[{dest_url}]") .underlined() .with(self.color_theme.link) ); state.capture_target_mut(output).push_str(&rendered); } Event::Start(Tag::Image { dest_url, .. }) => { let rendered = format!( "{}", format!("[image:{dest_url}]").with(self.color_theme.link) ); state.capture_target_mut(output).push_str(&rendered); } Event::Start(Tag::Table(..)) => state.table = Some(TableState::default()), Event::End(TagEnd::Table) => { if let Some(table) = state.table.take() { output.push_str(&self.render_table(&table)); output.push_str("\n\n"); } } Event::Start(Tag::TableHead) => { if let Some(table) = state.table.as_mut() { table.in_head = true; } } Event::End(TagEnd::TableHead) => { if let Some(table) = state.table.as_mut() { table.finish_row(); table.in_head = false; } } 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(..) | _) => {} } } fn start_heading(&self, level: u8, output: &mut String) { output.push('\n'); let prefix = match level { 1 => "# ", 2 => "## ", 3 => "### ", _ => "#### ", }; let _ = write!(output, "{}", prefix.bold().with(self.color_theme.heading)); } fn start_quote(&self, state: &mut RenderState, output: &mut String) { state.quote += 1; let _ = write!(output, "{}", "│ ".with(self.color_theme.quote)); } fn start_item(state: &mut RenderState, output: &mut String) { let depth = state.list_stack.len().saturating_sub(1); 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) { if !code_language.is_empty() { let _ = writeln!( output, "{}", format!("╭─ {code_language}").with(self.color_theme.heading) ); } } fn finish_code_block(&self, code_buffer: &str, code_language: &str, output: &mut String) { output.push_str(&self.highlight_code(code_buffer, code_language)); if !code_language.is_empty() { let _ = write!(output, "{}", "╰─".with(self.color_theme.heading)); } output.push_str("\n\n"); } fn push_text( &self, text: &str, state: &mut RenderState, output: &mut String, code_buffer: &mut String, in_code_block: bool, ) { if in_code_block { code_buffer.push_str(text); } else { 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::>(); let border = format!("{}", "│".with(self.color_theme.table_border)); let separator = widths .iter() .map(|width| "─".repeat(*width + 2)) .collect::>() .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] pub fn highlight_code(&self, code: &str, language: &str) -> String { let syntax = self .syntax_set .find_syntax_by_token(language) .unwrap_or_else(|| self.syntax_set.find_syntax_plain_text()); let mut syntax_highlighter = HighlightLines::new(syntax, &self.syntax_theme); let mut colored_output = String::new(); for line in LinesWithEndings::from(code) { match syntax_highlighter.highlight_line(line, &self.syntax_set) { Ok(ranges) => { colored_output.push_str(&as_24_bit_terminal_escaped(&ranges[..], false)); } Err(_) => colored_output.push_str(line), } } colored_output } pub fn stream_markdown(&self, markdown: &str, out: &mut impl Write) -> io::Result<()> { let rendered_markdown = self.render_markdown(markdown); for chunk in rendered_markdown.split_inclusive(char::is_whitespace) { write!(out, "{chunk}")?; out.flush()?; thread::sleep(Duration::from_millis(8)); } writeln!(out) } } fn visible_width(input: &str) -> usize { strip_ansi(input).chars().count() } fn strip_ansi(input: &str) -> String { let mut output = String::new(); let mut chars = input.chars().peekable(); while let Some(ch) = chars.next() { if ch == '\u{1b}' { if chars.peek() == Some(&'[') { chars.next(); for next in chars.by_ref() { if next.is_ascii_alphabetic() { break; } } } } else { output.push(ch); } } output } #[cfg(test)] mod tests { use super::{strip_ansi, Spinner, TerminalRenderer}; #[test] fn renders_markdown_with_styling_and_lists() { let terminal_renderer = TerminalRenderer::new(); let markdown_output = terminal_renderer .render_markdown("# Heading\n\nThis is **bold** and *italic*.\n\n- item\n\n`code`"); assert!(markdown_output.contains("Heading")); assert!(markdown_output.contains("• item")); assert!(markdown_output.contains("code")); assert!(markdown_output.contains('\u{1b}')); } #[test] fn highlights_fenced_code_blocks() { let terminal_renderer = TerminalRenderer::new(); let markdown_output = terminal_renderer.render_markdown("```rust\nfn hi() { println!(\"hi\"); }\n```"); let plain_text = strip_ansi(&markdown_output); assert!(plain_text.contains("╭─ rust")); assert!(plain_text.contains("fn hi")); 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::>(); 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] fn spinner_advances_frames() { let terminal_renderer = TerminalRenderer::new(); let mut spinner = Spinner::new(); let mut out = Vec::new(); spinner .tick("Working", terminal_renderer.color_theme(), &mut out) .expect("tick succeeds"); spinner .tick("Working", terminal_renderer.color_theme(), &mut out) .expect("tick succeeds"); let output = String::from_utf8_lossy(&out); assert!(output.contains("Working")); } }