lux-cli 0.28.9

A luxurious package manager for Lua
Documentation
use clap::Subcommand;
use eyre::Result;
use lux_lib::{
    config::Config,
    path::{BinPath, PackagePath, Paths},
};
use strum_macros::{Display, EnumString, VariantNames};

use clap::{Args, ValueEnum};

use crate::utils::project::current_project_or_user_tree;

#[derive(Args)]
pub struct Path {
    #[command(subcommand)]
    cmd: Option<PathCmd>,

    /// Prepend the rocks tree paths to the system paths.
    #[clap(default_value_t = false)]
    #[arg(long)]
    prepend: bool,
}

#[derive(Subcommand, PartialEq, Eq, Debug, Clone)]
#[clap(rename_all = "kebab_case")]
enum PathCmd {
    /// Generate an export statement for all paths
    /// (formatted as a shell command). [Default]
    Full(FullArgs),
    /// Generate a `LUA_PATH` expression for `lua` libraries in the lux tree.
    /// (not formatted as a shell command)
    Lua,
    /// Generate a `LUA_CPATH` expression for native `lib` libraries in the lux tree.
    /// (not formatted as a shell command)
    C,
    /// Generate a `PATH` expression for `bin` executables in the lux tree.
    /// (not formatted as a shell command)
    Bin,
    /// Generate a `LUA_INIT` expression for the lux loader.
    /// (not formatted as a shell command)
    Init,
}

impl Default for PathCmd {
    fn default() -> Self {
        Self::Full(FullArgs::default())
    }
}

#[derive(Args, PartialEq, Eq, Debug, Clone, Default)]
struct FullArgs {
    /// Do not export `PATH` (`bin` paths).
    #[clap(default_value_t = false)]
    #[arg(long)]
    no_bin: bool,

    /// Do not add `require('lux').loader()` to `LUA_INIT`.
    /// If a rock has conflicting transitive dependencies,
    /// disabling the Lux loader may result in the wrong modules being loaded.
    #[clap(default_value_t = false)]
    #[arg(long)]
    no_loader: bool,

    /// The shell to format for.
    #[clap(default_value_t = Shell::default())]
    #[arg(long)]
    shell: Shell,
}

#[derive(EnumString, VariantNames, Display, ValueEnum, PartialEq, Eq, Debug, Clone)]
#[strum(serialize_all = "lowercase")]
#[derive(Default)]
enum Shell {
    #[default]
    Posix,
    Fish,
    Nu,
}

pub async fn path(path_data: Path, config: Config) -> Result<()> {
    let tree = current_project_or_user_tree(&config)?;
    let paths = Paths::new(&tree)?;
    let cmd = path_data.cmd.unwrap_or_default();
    let prepend = path_data.prepend;
    match cmd {
        PathCmd::Full(args) => {
            let mut result = String::new();
            let no_loader = args.no_loader || {
                if tree.version().lux_lib_dir().is_none() {
                    eprintln!(
                        "⚠️ WARNING: lux-lua library not found.
Cannot use the `lux.loader`.
To suppress this warning, run `lx path full --no-loader`.
                "
                    );
                    true
                } else {
                    false
                }
            };
            let shell = args.shell;
            let package_path = mk_package_path(&paths, prepend);
            if !package_path.is_empty() {
                result.push_str(format_export(&shell, "LUA_PATH", &package_path).as_str());
                result.push('\n')
            }
            let package_cpath = mk_package_cpath(&paths, prepend);
            if !package_cpath.is_empty() {
                result.push_str(format_export(&shell, "LUA_CPATH", &package_cpath).as_str());
                result.push('\n')
            }
            if !args.no_bin {
                let path = mk_bin_path(&paths, prepend)?;
                if !path.is_empty() {
                    result.push_str(format_export(&shell, "PATH", &path).as_str());
                    result.push('\n')
                }
            }
            if !no_loader {
                result.push_str(format_export(&shell, "LUA_INIT", &paths.init()).as_str());
                result.push('\n')
            }
            println!("{}", &result);
        }
        PathCmd::Lua => println!("{}", &mk_package_path(&paths, prepend)),
        PathCmd::C => println!("{}", &mk_package_cpath(&paths, prepend)),
        PathCmd::Bin => println!("{}", &mk_bin_path(&paths, prepend)?),
        PathCmd::Init => println!("{}", paths.init()),
    }
    Ok(())
}

fn mk_package_path(paths: &Paths, prepend: bool) -> PackagePath {
    if prepend {
        paths.package_path_prepended()
    } else {
        paths.package_path().clone()
    }
}

fn mk_package_cpath(paths: &Paths, prepend: bool) -> PackagePath {
    if prepend {
        paths.package_cpath_prepended()
    } else {
        paths.package_cpath().clone()
    }
}

fn mk_bin_path(paths: &Paths, prepend: bool) -> Result<BinPath> {
    let mut result = if prepend {
        BinPath::from_env()
    } else {
        BinPath::default()
    };
    result.prepend(paths.path());
    Ok(result)
}

fn format_export<D>(shell: &Shell, var_name: &str, var: &D) -> String
where
    D: std::fmt::Display,
{
    match shell {
        Shell::Posix => format!("export {var_name}='{var}';"),
        Shell::Fish => format!("set -x {var_name} \"{var}\";"),
        Shell::Nu => format!("$env.{var_name} = \"{var}\";"),
    }
}