Skip to main content

vtcode_commons/ui_protocol/
markdown.rs

1//! Shared markdown rendering types.
2//!
3//! The actual rendering implementation lives in `vtcode-ui`.  These structs
4//! define the output format so that `vtcode-core` can work with rendered
5//! markdown lines regardless of whether the TUI crate is compiled in.
6
7use anstyle::Style;
8
9/// A styled segment inside a rendered markdown line.
10#[derive(Clone, Debug)]
11pub struct MarkdownSegment {
12    pub style: Style,
13    pub text: String,
14    pub link_target: Option<String>,
15}
16
17/// A single rendered markdown line made up of styled segments.
18#[derive(Clone, Debug, Default)]
19pub struct MarkdownLine {
20    pub segments: Vec<MarkdownSegment>,
21}
22
23impl MarkdownLine {
24    pub fn is_empty(&self) -> bool {
25        self.segments.iter().all(|segment| segment.text.trim().is_empty())
26    }
27}
28
29/// Options for the markdown rendering pipeline.
30#[derive(Debug, Clone, Copy, Default)]
31pub struct RenderMarkdownOptions {
32    pub preserve_code_indentation: bool,
33    pub disable_code_block_table_reparse: bool,
34    /// Maximum width for tables. When set, tables wider than this will have
35    /// their column widths proportionally scaled and cell text wrapped.
36    /// Only effective in TUI mode.
37    pub table_max_width: Option<usize>,
38}
39
40/// A syntax-highlighted text segment.
41#[derive(Clone, Debug)]
42pub struct HighlightedSegment {
43    pub style: Style,
44    pub text: String,
45}