Skip to main content

lux_cli/
pin.rs

1use clap::Args;
2use itertools::Itertools;
3use lux_lib::config::Config;
4use lux_lib::lockfile::PinnedState;
5use lux_lib::lua_version::LuaVersion;
6use lux_lib::operations;
7use lux_lib::package::PackageName;
8use lux_lib::package::PackageReq;
9use lux_lib::rockspec::lua_dependency;
10use lux_lib::tree::RockMatches;
11use lux_lib::workspace::Workspace;
12
13use miette::miette;
14use miette::Context;
15use miette::Result;
16
17#[derive(Args)]
18pub struct ChangePin {
19    /// Installed package or dependency to pin.
20    /// If pinning a dependency in a project, this should
21    /// be the package name.
22    package_req: Vec<PackageReq>,
23
24    /// Pin a development dependency.
25    /// Also called `dev`.
26    #[arg(short, long, alias = "dev", visible_short_aliases = ['d', 'b'])]
27    build: Option<Vec<PackageName>>,
28
29    /// Pin a test dependency.
30    #[arg(short, long)]
31    test: Option<Vec<PackageName>>,
32
33    /// Project to modify.
34    #[arg(short, long, visible_short_alias = 'p')]
35    pub(crate) package: Option<PackageName>,
36}
37
38pub async fn set_pinned_state(data: ChangePin, config: Config, pin: PinnedState) -> Result<()> {
39    match Workspace::current()? {
40        Some(mut workspace) => {
41            let project = workspace.single_member_or_select_mut(&data.package)?;
42
43            if data
44                .package_req
45                .iter()
46                .any(|pkg| !pkg.version_req().is_any())
47            {
48                return Err(miette!(
49                    help = "if pinning a dependency in a project, specify the package name",
50                    "cannot pin project dependencies using version constraints."
51                ));
52            }
53            let packages = data
54                .package_req
55                .iter()
56                .map(|pkg| pkg.name())
57                .cloned()
58                .collect_vec();
59            if !packages.is_empty() {
60                project
61                    .set_pinned_state(
62                        lua_dependency::LuaDependencyType::Regular(packages.iter().collect()),
63                        pin,
64                    )
65                    .await?;
66            }
67            let build_packages = data.build.unwrap_or_default();
68            if !build_packages.is_empty() {
69                project
70                    .set_pinned_state(
71                        lua_dependency::LuaDependencyType::Build(build_packages.iter().collect()),
72                        pin,
73                    )
74                    .await?;
75            }
76            let test_packages = data.test.unwrap_or_default();
77            if !test_packages.is_empty() {
78                project
79                    .set_pinned_state(
80                        lua_dependency::LuaDependencyType::Test(test_packages.iter().collect()),
81                        pin,
82                    )
83                    .await?;
84            }
85            if !packages.is_empty() {
86                operations::Sync::new(&workspace, &config)
87                    .sync_dependencies()
88                    .await
89                    .wrap_err("syncing dependencies with the project lockfile failed.")?;
90            }
91            if !build_packages.is_empty() {
92                operations::Sync::new(&workspace, &config)
93                    .sync_build_dependencies()
94                    .await
95                    .wrap_err("syncing build dependencies with the project lockfile failed.")?;
96            }
97            if !test_packages.is_empty() {
98                operations::Sync::new(&workspace, &config)
99                    .sync_test_dependencies()
100                    .await
101                    .wrap_err("syncing test dependencies with the project lockfile failed.")?;
102            }
103        }
104        None => {
105            let tree = config.user_tree(LuaVersion::from(&config)?.clone())?;
106
107            for package in &data.package_req {
108                match tree.match_rocks_and(package, |package| pin != package.pinned())? {
109                    RockMatches::Single(rock) => {
110                        operations::set_pinned_state(&rock, &tree, pin)?;
111                    }
112                    RockMatches::Many(_) => {
113                        return Err(miette!(
114                            help = "narrow down the version constraint",
115                            "multiple packages found that match '{}'",
116                            package
117                        ));
118                    }
119                    RockMatches::NotFound(_) => return Err(miette!("rock {} not found!", package)),
120                }
121            }
122        }
123    }
124    Ok(())
125}