basecoat-macros 0.2.1

rsx! proc-macro for basecoat-rs (rstml-based DSL)
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

//! Static tables of known component prop field names and related helpers.
//!
//! The macro must route attribute names to either a typed builder setter
//! (for known fields like `variant`, `class`, `size`, ...) or to the `AttrMap`
//! (for unknown / data-* / aria-* attrs).  Since we cannot depend on
//! `basecoat-core` at proc-macro expansion time, we hard-code the table here.
//!
//! **Must be kept in sync with `crates/basecoat-core/src/props/`.**

/// Void HTML elements that must not have children.
pub const VOID_ELEMENTS: &[&str] = &[
    "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "param", "source",
    "track", "wbr",
];

/// Convert a PascalCase component name to the snake_case function name used in
/// `::basecoat_components`.
///
/// Algorithm:
/// 1. Lowercase the first character.
/// 2. For each subsequent uppercase ASCII letter, prepend `_` and lowercase.
///
/// ```text
/// "Button"              → "button"
/// "DialogContent"       → "dialog_content"
/// "TabsList"            → "tabs_list"
/// "AlertDialogOverlay"  → "alert_dialog_overlay"
/// ```
pub fn component_fn_name(pascal: &str) -> String {
    let mut out = String::with_capacity(pascal.len() + 4);
    for (i, c) in pascal.chars().enumerate() {
        if c.is_ascii_uppercase() {
            if i > 0 {
                out.push('_');
            }
            out.push(c.to_ascii_lowercase());
        } else {
            out.push(c);
        }
    }
    out
}

/// Return the list of field names that should be routed to **typed setters**
/// on the builder for the given component.
///
/// Any attribute key NOT in this list (and not `"children"`) is routed to
/// `AttrMap` via `__attrs.push(key, value)`.
///
/// The special field `"attrs"` is never a valid attribute key (it's the
/// catch-all AttrMap field itself).  The field `"children"` is populated from
/// the tag body, never from attributes.
pub fn known_typed_setters(component: &str) -> &'static [&'static str] {
    match component {
        "Button" => &["variant", "size", "class"],
        "Badge" => &["variant", "class"],
        "Alert" => &["variant", "class"],
        "Input" => &["class"],
        "Label" => &["class", "for"],
        "Textarea" => &["class"],
        "Card" => &["class"],
        "Separator" => &["orientation", "class"],
        "Dialog" => &[
            "id",
            "title",
            "description",
            "close_button",
            "close_on_overlay_click",
            "class",
        ],
        "Tabs" => &["id", "tabsets", "default_tab_index", "orientation", "class"],
        "Toast" => &["category", "title", "description", "class"],
        "Toaster" => &["id", "class"],
        "Tooltip" => &["content", "side", "class"],
        // Unknown component — no typed setters, everything goes to AttrMap.
        _ => &[],
    }
}

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

    #[test]
    fn pascal_to_snake() {
        assert_eq!(component_fn_name("Button"), "button");
        assert_eq!(component_fn_name("DialogContent"), "dialog_content");
        assert_eq!(component_fn_name("TabsList"), "tabs_list");
        assert_eq!(
            component_fn_name("AlertDialogOverlay"),
            "alert_dialog_overlay"
        );
        assert_eq!(component_fn_name("Toaster"), "toaster");
    }

    #[test]
    fn void_elements_list() {
        assert!(VOID_ELEMENTS.contains(&"br"));
        assert!(VOID_ELEMENTS.contains(&"img"));
        assert!(VOID_ELEMENTS.contains(&"input"));
        assert!(!VOID_ELEMENTS.contains(&"div"));
    }
}