vize_musea 0.178.0

Musea - Component gallery and documentation for Vize Vue components
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! Documentation generation for Art files.
//!
//! This module generates Markdown documentation from Art descriptors,
//! including component catalogs, variant listings, and searchable indexes.
//!
//! # Example
//!
//! ```rust
//! use vize_carton::Bump;
//! use vize_musea::{parse_art, ArtParseOptions};
//! use vize_musea::docs::{generate_component_doc, DocOptions};
//!
//! let allocator = Bump::new();
//! let source = r#"
//! <art title="Button" description="A button component" category="atoms">
//!   <variant name="Primary" default>
//!     <Button>Click me</Button>
//!   </variant>
//! </art>
//! "#;
//!
//! let art = parse_art(&allocator, source, ArtParseOptions::default()).unwrap();
//! let output = generate_component_doc(&art, &DocOptions::default());
//! println!("{}", output.markdown);
//! ```

mod catalog;
mod markdown;

pub use catalog::{CatalogEntry, generate_catalog, generate_category_index, generate_tags_index};
pub use markdown::{generate_component_doc, generate_variant_doc};

use serde::{Deserialize, Serialize};
use vize_carton::String;

/// Options for documentation generation.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DocOptions {
    /// Include source code snippets in documentation.
    #[serde(default)]
    pub include_source: bool,

    /// Include variant templates in documentation.
    #[serde(default = "default_true")]
    pub include_templates: bool,

    /// Include metadata (tags, category, status) in documentation.
    #[serde(default = "default_true")]
    pub include_metadata: bool,

    /// Include table of contents for components with many variants.
    #[serde(default = "default_true")]
    pub include_toc: bool,

    /// Minimum number of variants to show table of contents.
    #[serde(default = "default_toc_threshold")]
    pub toc_threshold: usize,

    /// Base path for component links.
    #[serde(default)]
    pub base_path: String,

    /// Custom title for the documentation.
    #[serde(default)]
    pub title: Option<String>,

    /// Include timestamp in generated documentation.
    #[serde(default)]
    pub include_timestamp: bool,
}

fn default_true() -> bool {
    true
}

fn default_toc_threshold() -> usize {
    5
}

/// Output of documentation generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DocOutput {
    /// Generated Markdown content.
    pub markdown: String,

    /// Suggested filename for the documentation.
    pub filename: String,

    /// Title extracted from the art file.
    pub title: String,

    /// Category if present.
    pub category: Option<String>,

    /// Number of variants documented.
    pub variant_count: usize,
}

/// Output of catalog generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CatalogOutput {
    /// Generated Markdown content.
    pub markdown: String,

    /// Suggested filename.
    pub filename: String,

    /// Number of components in catalog.
    pub component_count: usize,

    /// Categories found.
    pub categories: Vec<String>,

    /// All tags found.
    pub tags: Vec<String>,
}

#[cfg(test)]
mod tests {
    use super::{CatalogEntry, DocOptions, generate_catalog, generate_component_doc};
    use crate::{ArtParseOptions, parse_art};
    use vize_carton::Bump;

    #[test]
    fn test_generate_component_doc() {
        let allocator = Bump::new();
        let source = r#"
<art title="Button" description="A versatile button" category="atoms" tags="ui,input">
  <variant name="Primary" default>
    <Button variant="primary">Click</Button>
  </variant>
  <variant name="Secondary">
    <Button variant="secondary">Click</Button>
  </variant>
</art>
"#;

        let art = parse_art(&allocator, source, ArtParseOptions::default()).unwrap();
        let output = generate_component_doc(&art, &DocOptions::default());

        insta::assert_debug_snapshot!(output);
    }

    #[test]
    fn test_generate_catalog() {
        let allocator = Bump::new();
        let sources = [
            r#"<art title="Button" category="atoms"><variant name="Default"><div></div></variant></art>"#,
            r#"<art title="Card" category="molecules"><variant name="Default"><div></div></variant></art>"#,
        ];

        let entries: Vec<_> = sources
            .iter()
            .map(|s| {
                let art = parse_art(&allocator, s, ArtParseOptions::default()).unwrap();
                CatalogEntry::from_descriptor(&art, "")
            })
            .collect();

        let output = generate_catalog(&entries, &DocOptions::default());

        insta::assert_debug_snapshot!(output);
    }
}