(nodejs plugin) add support for automatically shimming package manage…

…rs with `corepack enable` (#1118) * feat: support RTX_NODE_COREPACK_ENABLE * chore: lint e2e/test_nodejs * refactor(node): RTX_NODE_COREPACK_ENABLE -> RTX_NODE_COREPACK * refactor(node): remove unnecessary `test_corepack` --------- Co-authored-by: jdx <[email protected]>
jdx · Dec 8, 2023 · f0c1b8f · f0c1b8f
1 parent 1c6adf8
commit f0c1b8f
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/docs/node.md b/docs/node.md
@@ -36,6 +36,7 @@ required system dependencies.
 - `RTX_NODE_CONFIGURE_OPTS` [string]: Additional `./configure` options.
 - `RTX_NODE_MAKE_OPTS` [string]: Additional `make` options.
 - `RTX_NODE_MAKE_INSTALL_OPTS` [string]: Additional `make install` options.
+- `RTX_NODE_COREPACK` [bool]: Installs the default corepack shims after installing any node version that ships with [corepack](https://github.com/nodejs/corepack).
 
 ## Default node packages
 

diff --git a/e2e/test_nodejs b/e2e/test_nodejs
@@ -36,3 +36,8 @@ assert "rtx x -- node --version" "v20.0.0"
 # rtx uninstall node
 # RTX_NODE_COMPILE=1 rtx i node
 # assert "rtx x -- node --version" "v20.0.0"
+
+export RTX_NODE_COREPACK=1
+rtx uninstall node
+rtx i node
+assert_contains "rtx x node -- which yarn" "yarn"
diff --git a/src/env.rs b/src/env.rs
@@ -167,6 +167,7 @@ pub static RTX_NODE_DEFAULT_PACKAGES_FILE: Lazy<PathBuf> = Lazy::new(|| {
         HOME.join(".default-npm-packages")
     })
 });
+pub static RTX_NODE_COREPACK: Lazy<bool> = Lazy::new(|| var_is_true("RTX_NODE_COREPACK"));
 pub static NVM_DIR: Lazy<PathBuf> =
     Lazy::new(|| var_path("NVM_DIR").unwrap_or_else(|| HOME.join(".nvm")));
 pub static NODENV_ROOT: Lazy<PathBuf> =

diff --git a/src/plugins/core/node.rs b/src/plugins/core/node.rs
@@ -171,6 +171,10 @@ impl NodePlugin {
         tv.install_path().join("bin/npm")
     }
 
+    fn corepack_path(&self, tv: &ToolVersion) -> PathBuf {
+        tv.install_path().join("bin/corepack")
+    }
+
     fn install_default_packages(
         &self,
         config: &Config,
@@ -204,6 +208,22 @@ impl NodePlugin {
         Ok(())
     }
 
+    fn enable_default_corepack_shims(
+        &self,
+        config: &Config,
+        tv: &ToolVersion,
+        pr: &ProgressReport,
+    ) -> Result<()> {
+        pr.set_message("enabling corepack shims");
+        let corepack = self.corepack_path(tv);
+        CmdLineRunner::new(&config.settings, corepack)
+            .with_pr(pr)
+            .arg("enable")
+            .env("PATH", CorePlugin::path_env_with_tv_path(tv)?)
+            .execute()?;
+        Ok(())
+    }
+
     fn test_node(&self, config: &Config, tv: &ToolVersion, pr: &ProgressReport) -> Result<()> {
         pr.set_message("node -v");
         CmdLineRunner::new(&config.settings, self.node_path(tv))
@@ -295,6 +315,10 @@ impl Plugin for NodePlugin {
         self.install_npm_shim(&ctx.tv)?;
         self.test_npm(ctx.config, &ctx.tv, &ctx.pr)?;
         self.install_default_packages(ctx.config, &ctx.tv, &ctx.pr)?;
+        if *env::RTX_NODE_COREPACK && self.corepack_path(&ctx.tv).exists() {
+            self.enable_default_corepack_shims(ctx.config, &ctx.tv, &ctx.pr)?;
+        }
+
         Ok(())
     }
 }