aasvg 1.0.0

Convert ASCII art diagrams to SVG with automatic light/dark mode support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! # aasvg - ASCII Art to SVG
//!
//! Convert ASCII art diagrams to SVG with automatic light/dark mode support.
//!
//! This library renders ASCII diagrams using CSS variables, so the output
//! automatically adapts to the user's color scheme preference.
//!
//! ## Example
//!
//! ```rust
//! use aasvg::render;
//!
//! let diagram = r#"
//!     +-----+
//!     |     |
//!     +-----+
//! "#;
//!
//! let svg = render(diagram);
//! println!("{}", svg);
//! ```
//!
//! ## Supported Elements
//!
//! - **Lines**: `-`, `|`, `/`, `\`, `=`, `~`, `_`
//! - **Vertices**: `+`, `.`, `'`, `,`, `` ` ``
//! - **Arrows**: `>`, `<`, `^`, `v`, `V`
//! - **Points**: `o`, `*`, `●`, `○`, `◍`, `◌`, `⊕`
//! - **Jumps**: `(`, `)` for line crossings
//! - **Text**: Any other characters are rendered as text
//!
//! ## Light/Dark Mode
//!
//! The generated SVG includes CSS that uses `prefers-color-scheme` to
//! automatically switch colors based on the user's system preference.

mod chars;
mod decoration;
mod finder;
mod grid;
mod path;
mod svg;

pub use svg::RenderOptions;

use decoration::DecorationSet;
use finder::{find_decorations, find_paths};
use grid::Grid;
use path::PathSet;
use svg::generate_svg;

/// Render an ASCII art diagram to SVG.
///
/// The output SVG uses CSS variables for colors, so it automatically
/// adapts to light and dark color schemes.
///
/// # Example
///
/// ```rust
/// use aasvg::render;
///
/// let svg = render("+--+\n|  |\n+--+");
/// assert!(svg.contains("<svg"));
/// assert!(svg.contains("prefers-color-scheme"));
/// ```
pub fn render(input: &str) -> String {
    render_with_options(input, &RenderOptions::default())
}

/// Render an ASCII art diagram to SVG with custom options.
///
/// # Example
///
/// ```rust
/// use aasvg::{render_with_options, RenderOptions};
///
/// let options = RenderOptions::new()
///     .with_backdrop(true)
///     .with_spaces(0);
///
/// let svg = render_with_options("+--+\n|  |\n+--+", &options);
/// assert!(svg.contains("var(--aasvg-bg)"));
/// ```
pub fn render_with_options(input: &str, options: &RenderOptions) -> String {
    let mut grid = Grid::new(input);
    let mut paths = PathSet::new();
    let mut decorations = DecorationSet::new();

    find_paths(&mut grid, &mut paths);
    find_decorations(&mut grid, &paths, &mut decorations);

    generate_svg(&mut grid, &paths, &decorations, options)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_simple_box() {
        let svg = render("+--+\n|  |\n+--+");
        assert!(svg.starts_with("<svg"));
        assert!(svg.ends_with("</svg>"));
        assert!(svg.contains("path"));
    }

    #[test]
    fn test_arrow() {
        let svg = render("-->");
        assert!(svg.contains("polygon"));
    }

    #[test]
    fn test_css_variables() {
        let svg = render("-");
        assert!(svg.contains("--aasvg-stroke"));
        assert!(svg.contains("--aasvg-fill"));
        assert!(svg.contains("--aasvg-bg"));
        assert!(svg.contains("--aasvg-text"));
    }

    #[test]
    fn test_dark_mode_support() {
        let svg = render("-");
        assert!(svg.contains("prefers-color-scheme: dark"));
    }

    #[test]
    fn test_with_backdrop() {
        let options = RenderOptions::new().with_backdrop(true);
        let svg = render_with_options("-", &options);
        assert!(svg.contains(r#"fill="var(--aasvg-bg)"#));
    }

    #[test]
    fn test_text_rendering() {
        let svg = render("Hello");
        assert!(svg.contains("<text"));
        assert!(svg.contains("Hello"));
    }

    #[test]
    fn test_disable_text() {
        let options = RenderOptions::new().with_disable_text(true);
        let svg = render_with_options("Hello", &options);
        assert!(!svg.contains("Hello"));
    }
}