lux-lib 0.63.1

Library for the lux package manager for Lua
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

use serde::{Deserialize, Serialize};
use std::path::PathBuf;

/// Template configuration for a rock's tree layout
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
pub struct RockLayoutConfig {
    /// The root for relocated directories (etc, src).
    /// If unset (the default), directories are placed in the package directory.
    /// If set, it is a directory relative to the given Lua version's install tree root.
    /// With the `--nvim` preset, this is `site/pack/lux`.
    #[serde(alias = "etc_root")]
    pub root: Option<PathBuf>,
    /// The `etc` directory for non-optional packages
    /// Default: `etc` With the `--nvim` preset, this is `start`
    /// Note: If `root` is set, the package ID is appended.
    pub etc: PathBuf,
    /// The `etc` directory for optional packages
    /// Default: `etc`
    /// With the `--nvim` preset, this is `opt`
    /// Note: If `root` is set, the package ID is appended.
    pub opt_etc: PathBuf,
    /// The `src` directory name
    /// Default: `src`
    /// With the `--nvim` preset, this is `lua`
    pub src: PathBuf,
    /// The `lib` directory name
    /// Default: `lib`
    pub lib: PathBuf,
    /// The `conf` directory name
    /// Default: `conf`
    pub conf: PathBuf,
    /// The `doc` directory name
    /// Default: `doc`
    pub doc: PathBuf,
}

impl RockLayoutConfig {
    /// Creates a `RockLayoutConfig` for use with Neovim
    /// - `root`: `site/pack/lux`
    /// - `etc`: `start`
    /// - `opt_etc`: `opt`
    /// - `src`: `lua`
    /// - `lib`: `lib`
    pub fn new_nvim_layout() -> Self {
        Self {
            root: Some("site/pack/lux".into()),
            etc: "start".into(),
            opt_etc: "opt".into(),
            src: "lua".into(),
            lib: "lib".into(),
            conf: "conf".into(),
            doc: "doc".into(),
        }
    }

    pub(crate) fn is_default(&self) -> bool {
        &Self::default() == self
    }
}

impl Default for RockLayoutConfig {
    fn default() -> Self {
        Self {
            root: None,
            etc: "etc".into(),
            opt_etc: "etc".into(),
            src: "src".into(),
            lib: "lib".into(),
            conf: "conf".into(),
            doc: "doc".into(),
        }
    }
}