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

use std::path::PathBuf;

/// Errors that can occur during config-path resolution.
///
/// These are deliberately **not** `ShellError` — this crate sits below
/// `nu-protocol` in the dependency graph. Callers convert to `ShellError` at
/// the boundary.
///
/// Non-fatal XDG issues are **not** errors — they are [`ConfigWarning`]s.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum ConfigError {
    /// No config directory could be resolved (no XDG env var and the platform
    /// fallback returned `None`).
    #[error("Could not determine a config directory")]
    ConfigDirNotFound,

    /// No home directory could be found via the platform home-dir lookup.
    #[error("Could not determine the home directory")]
    NoHomeDir,
}

/// Non-fatal warnings produced during config-path resolution.
#[derive(Debug, Clone, PartialEq, Eq, derive_more::Display)]
pub enum ConfigWarning {
    /// `$XDG_CONFIG_HOME` was set to a non-absolute value and was ignored; the
    /// platform default was used instead. Not emitted when `--config-home`
    /// simply overrides a valid XDG value.
    #[display(
        "$env.XDG_CONFIG_HOME ({xdg}) is set to a non-absolute path, \
        using default config directory instead: {}", 
        resolved.display(),
    )]
    XdgConfigIgnored { xdg: String, resolved: PathBuf },

    /// The old config directory (platform default) has files but the new
    /// XDG_CONFIG_HOME directory is empty — the user may have forgotten to
    /// migrate.
    #[display(
        "WARNING: XDG_CONFIG_HOME has been set but {} is empty.\n\
        Nushell will not move your configuration files from {}", 
        new.display(),
        old.display(),
    )]
    OldConfigDirHasFiles { old: PathBuf, new: PathBuf },
}