use-nuxt 0.0.1

Nuxt app structure metadata primitives for RustUse
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// Nuxt version-family labels.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum NuxtVersionFamily {
    Nuxt2,
    Nuxt3,
    Nuxt4,
}

impl NuxtVersionFamily {
    /// Returns the version-family label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Nuxt2 => "nuxt2",
            Self::Nuxt3 => "nuxt3",
            Self::Nuxt4 => "nuxt4",
        }
    }
}

/// Common Nuxt directory labels.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum NuxtDirectoryKind {
    Pages,
    Components,
    Composables,
    Layouts,
    Middleware,
    Plugins,
    Server,
    Content,
    Assets,
    Public,
}

impl NuxtDirectoryKind {
    /// Returns the directory label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Pages => "pages",
            Self::Components => "components",
            Self::Composables => "composables",
            Self::Layouts => "layouts",
            Self::Middleware => "middleware",
            Self::Plugins => "plugins",
            Self::Server => "server",
            Self::Content => "content",
            Self::Assets => "assets",
            Self::Public => "public",
        }
    }
}

/// Nuxt rendering mode labels.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum NuxtRenderingMode {
    Ssr,
    Spa,
    Static,
    Hybrid,
}

impl NuxtRenderingMode {
    /// Returns the rendering mode label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Ssr => "ssr",
            Self::Spa => "spa",
            Self::Static => "static",
            Self::Hybrid => "hybrid",
        }
    }
}

/// Common Nuxt config file labels.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum NuxtConfigFile {
    JavaScript,
    TypeScript,
    Mjs,
    Mts,
}

impl NuxtConfigFile {
    /// Returns the config file label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::JavaScript => "nuxt.config.js",
            Self::TypeScript => "nuxt.config.ts",
            Self::Mjs => "nuxt.config.mjs",
            Self::Mts => "nuxt.config.mts",
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{NuxtConfigFile, NuxtDirectoryKind, NuxtRenderingMode, NuxtVersionFamily};

    #[test]
    fn exposes_nuxt_labels() {
        assert_eq!(NuxtVersionFamily::Nuxt3.as_str(), "nuxt3");
        assert_eq!(NuxtDirectoryKind::Composables.as_str(), "composables");
        assert_eq!(NuxtRenderingMode::Ssr.as_str(), "ssr");
        assert_eq!(NuxtConfigFile::TypeScript.as_str(), "nuxt.config.ts");
    }
}