nu-config 0.115.0

Nushell configuration infrastructure - path resolution and config file management
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

/// Metadata about the two kinds of Nushell configuration files.
///
/// Each variant knows its file name, its embedded default content, and
/// its scaffold template.
///
/// This was moved here from `nu-utils` because it is config infrastructure,
/// not a general utility.
#[derive(Clone, Copy, Debug, PartialEq, Eq, derive_more::Display)]
#[display("{}", self.name())]
pub enum ConfigFileKind {
    Config,
    Env,
}

impl ConfigFileKind {
    /// The compiled-in default content (evaluated before the user's file).
    pub const fn default(self) -> &'static str {
        match self {
            Self::Config => include_str!("../default_files/default_config.nu"),
            Self::Env => include_str!("../default_files/default_env.nu"),
        }
    }

    /// The scaffold content written when the file does not exist on first
    /// startup.
    pub const fn scaffold(self) -> &'static str {
        match self {
            Self::Config => include_str!("../default_files/scaffold_config.nu"),
            Self::Env => include_str!("../default_files/scaffold_env.nu"),
        }
    }

    /// The full doc-commented template written by `config nu` / `config env`.
    pub const fn doc(self) -> &'static str {
        match self {
            Self::Config => include_str!("../default_files/doc_config.nu"),
            Self::Env => include_str!("../default_files/doc_env.nu"),
        }
    }

    /// Human-readable name: `"Config"` or `"Environment config"`.
    pub const fn name(self) -> &'static str {
        match self {
            Self::Config => "Config",
            Self::Env => "Environment config",
        }
    }

    /// File name: `"config.nu"` or `"env.nu"`.
    pub const fn path(self) -> &'static str {
        match self {
            Self::Config => "config.nu",
            Self::Env => "env.nu",
        }
    }

    /// Compiled-in default file name: `"default_config.nu"` or
    /// `"default_env.nu"`.
    pub const fn default_path(self) -> &'static str {
        match self {
            Self::Config => "default_config.nu",
            Self::Env => "default_env.nu",
        }
    }
}