compmd 0.3.0

The CompMD processor: parses, validates and expands CompMD (Component Markdown) documents. In development.
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

//! The host languages of version 1's bindings (spec §7, §7.6), and the runtimes each takes.

use crate::named::named;

named! {
    /// A host language a binding covers: the first word of a definition fence, or a component file's extension.
    pub enum Language {
        /// JSX, for React or Preact.
        Jsx = "jsx",
        /// TSX, for React or Preact.
        Tsx = "tsx",
        /// Svelte 5.
        Svelte = "svelte",
        /// Plain JavaScript.
        Js = "js",
        /// Plain TypeScript.
        Ts = "ts",
    }
}

impl Language {
    /// The runtimes its binding runs, the default first; none for plain JavaScript, which takes no `runtime`.
    #[must_use]
    pub fn runtimes(self) -> &'static [&'static str] {
        match self {
            Self::Jsx | Self::Tsx => &["react@19", "preact@10"],
            Self::Svelte => &["svelte@5"],
            Self::Js | Self::Ts => &[],
        }
    }

    /// Whether its binding runs `runtime`, or the default when it is `None`.
    #[must_use]
    pub fn runs(self, runtime: Option<&str>) -> bool {
        runtime.is_none_or(|runtime| self.runtimes().contains(&runtime))
    }

    /// The runtime a component in it runs on: `runtime` as written, or the binding's default; none for plain
    /// JavaScript.
    #[must_use]
    pub fn runtime(self, runtime: Option<&str>) -> Option<&str> {
        runtime.or_else(|| self.runtimes().first().copied())
    }

    /// Whether a component in it should name its runtime when exported, since the default may move (W117).
    #[must_use]
    pub fn has_runtimes(self) -> bool {
        !self.runtimes().is_empty()
    }
}

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

    #[test]
    fn each_binding_runs_its_runtimes() {
        assert!(Language::Jsx.runs(None));
        assert!(Language::Tsx.runs(Some("preact@10")));
        assert!(!Language::Svelte.runs(Some("svelte@4")));
        assert!(!Language::Js.runs(Some("react@19")));
        assert!(Language::Svelte.has_runtimes());
        assert!(!Language::Ts.has_runtimes());
        assert_eq!(Language::Jsx.runtime(None), Some("react@19"));
        assert_eq!(Language::Tsx.runtime(Some("preact@10")), Some("preact@10"));
        assert_eq!(Language::Js.runtime(None), None);
        assert_eq!(Language::from_name("vue"), None);
    }
}