vize_musea 0.1.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

//! Types for variant auto-generation.

use serde::{Deserialize, Serialize};

/// Configuration for variant auto-generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AutogenConfig {
    /// Maximum number of variants to generate.
    #[serde(default = "default_max_variants")]
    pub max_variants: usize,

    /// Include a "Default" variant with all default values.
    #[serde(default = "default_true")]
    pub include_default: bool,

    /// Include boolean toggle variants.
    #[serde(default = "default_true")]
    pub include_boolean_toggles: bool,

    /// Include enum/union variants (one per value).
    #[serde(default = "default_true")]
    pub include_enum_variants: bool,

    /// Include boundary value variants for numbers.
    #[serde(default)]
    pub include_boundary_values: bool,

    /// Include empty string variants for optional strings.
    #[serde(default)]
    pub include_empty_strings: bool,
}

impl Default for AutogenConfig {
    fn default() -> Self {
        Self {
            max_variants: 20,
            include_default: true,
            include_boolean_toggles: true,
            include_enum_variants: true,
            include_boundary_values: false,
            include_empty_strings: false,
        }
    }
}

fn default_max_variants() -> usize {
    20
}

fn default_true() -> bool {
    true
}

/// A prop definition used as input for variant generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PropDefinition {
    /// Prop name.
    pub name: String,
    /// Prop type string (e.g., "string", "number", "'primary' | 'secondary'").
    pub prop_type: String,
    /// Whether the prop is required.
    pub required: bool,
    /// Default value as JSON.
    pub default_value: Option<serde_json::Value>,
}

/// A generated variant definition.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GeneratedVariant {
    /// Variant name (e.g., "Default", "Primary", "Disabled").
    pub name: String,
    /// Whether this should be the default variant.
    pub is_default: bool,
    /// Props to apply to the component.
    pub props: serde_json::Map<String, serde_json::Value>,
    /// Description of what this variant tests.
    pub description: Option<String>,
}

/// Output of variant auto-generation.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AutogenOutput {
    /// Generated variants.
    pub variants: Vec<GeneratedVariant>,
    /// Generated `.art.vue` file content.
    pub art_file_content: String,
    /// Component name extracted from path.
    pub component_name: String,
}