fix(npm): set up node_modules/.bin/ entries for package that provide bin entrypoints

cli/Cargo.toml

@@ -123,6 +123,7 @@ once_cell.workspace = true
 open = "5.0.1"
 os_pipe.workspace = true
 p256.workspace = true
+pathdiff = "0.2.1"
 percent-encoding.workspace = true
 phf.workspace = true
 pin-project.workspace = true

cli/npm/managed/resolvers/local.rs

@@ -7,6 +7,7 @@ use std::cmp::Ordering;
 use std::collections::HashMap;
 use std::collections::HashSet;
 use std::fs;
+use std::os::unix::fs::symlink;
 use std::path::Path;
 use std::path::PathBuf;
 use std::sync::Arc;
@@ -24,6 +25,7 @@ use deno_ast::ModuleSpecifier;
 use deno_core::anyhow::bail;
 use deno_core::anyhow::Context;
 use deno_core::error::AnyError;
+use deno_core::parking_lot::Mutex;
 use deno_core::unsync::spawn;
 use deno_core::unsync::JoinHandle;
 use deno_core::url::Url;
@@ -267,6 +269,10 @@ async fn sync_resolution_with_fs(
   fs::create_dir_all(&deno_node_modules_dir).with_context(|| {
     format!("Creating '{}'", deno_local_registry_dir.display())
   })?;
+  let bin_node_modules_dir_path = root_node_modules_dir_path.join(".bin");
+  fs::create_dir_all(&bin_node_modules_dir_path).with_context(|| {
+    format!("Creating '{}'", bin_node_modules_dir_path.display())
+  })?;
 
   let single_process_lock = LaxSingleProcessFsFlag::lock(
     deno_local_registry_dir.join(".deno.lock"),
@@ -291,6 +297,7 @@ async fn sync_resolution_with_fs(
     Vec::with_capacity(package_partitions.packages.len());
   let mut newest_packages_by_name: HashMap<&String, &NpmResolutionPackage> =
     HashMap::with_capacity(package_partitions.packages.len());
+  let bin_entries_to_setup = Arc::new(Mutex::new(Vec::with_capacity(16)));
   for package in &package_partitions.packages {
     if let Some(current_pkg) =
       newest_packages_by_name.get_mut(&package.id.nv.name)
@@ -319,6 +326,7 @@ async fn sync_resolution_with_fs(
       let cache = cache.clone();
       let registry_url = registry_url.clone();
       let package = package.clone();
+      let bin_entries_to_setup = bin_entries_to_setup.clone();
       let handle = spawn(async move {
         cache
           .ensure_package(&package.id.nv, &package.dist, &registry_url)
@@ -342,6 +350,13 @@ async fn sync_resolution_with_fs(
         }
         // write out a file that indicates this folder has been initialized
         fs::write(initialized_file, "")?;
+
+        if package.bin.is_some() {
+          bin_entries_to_setup
+            .lock()
+            .push((package.clone(), package_path));
+        }
+
         // finally stop showing the progress bar
         drop(pb_guard); // explicit for clarity
         Ok(())
@@ -472,6 +487,47 @@ async fn sync_resolution_with_fs(
     }
   }
 
+  // 6. Set up `node_modules/.bin` entries for packages that need it.
+  {
+    let bin_entries = bin_entries_to_setup.lock();
+    if !bin_entries.is_empty() && !bin_node_modules_dir_path.exists() {
+      fs::create_dir_all(&bin_node_modules_dir_path).with_context(|| {
+        format!("Creating '{}'", bin_node_modules_dir_path.display())
+      })?;
+    }
+    for (package, package_path) in &*bin_entries {
+      let package = snapshot.package_from_id(&package.id).unwrap();
+      if let Some(bin_entries) = &package.bin {
+        match bin_entries {
+          deno_npm::registry::NpmPackageVersionBinEntry::String(script) => {
+            let name = package
+              .id
+              .nv
+              .name
+              .rsplit_once('/')
+              .map_or(package.id.nv.name.as_str(), |(_, name)| name);
+            symlink_bin_entry(
+              name,
+              script,
+              package_path,
+              &bin_node_modules_dir_path,
+            )?;
+          }
+          deno_npm::registry::NpmPackageVersionBinEntry::Map(entries) => {
+            for (name, script) in entries {
+              symlink_bin_entry(
+                name,
+                script,
+                package_path,
+                &bin_node_modules_dir_path,
+              )?;
+            }
+          }
+        }
+      }
+    }
+  }
+
   setup_cache.save();
   drop(single_process_lock);
   drop(pb_clear_guard);
@@ -648,6 +704,61 @@ fn get_package_folder_id_from_folder_name(
   })
 }
 
+fn symlink_bin_entry(
+  bin_name: &str,
+  bin_script: &str,
+  package_path: &Path,
+  bin_node_modules_dir_path: &Path,
+) -> Result<(), AnyError> {
+  let link = bin_node_modules_dir_path.join(bin_name);
+  let original = package_path.join(bin_script);
+
+  // Don't bother setting up another link if it already exists
+  if link.exists() {
+    let resolved = std::fs::read_link(&link).ok();
+    if let Some(resolved) = resolved {
+      if resolved != original {
+        log::warn!(
+          "{} Trying to set up '{}' bin for \"{}\", but an entry pointing to \"{}\" already exists. Skipping...", 
+          deno_terminal::colors::yellow("Warning"), 
+          bin_name,
+          resolved.display(),
+          original.display()
+        );
+        return Ok(());
+      }
+    }
+  }
+
+  #[cfg(target_family = "windows")]
+  {
+    todo!();
+  }
+  #[cfg(target_family = "unix")]
+  {
+    use std::os::unix::fs::PermissionsExt;
+    let mut perms = std::fs::metadata(&original).unwrap().permissions();
+    if perms.mode() & 0o111 == 0 {
+      // if the original file is not executable, make it executable
+      perms.set_mode(perms.mode() | 0o111);
+      std::fs::set_permissions(&original, perms).with_context(|| {
+        format!("Setting permissions on '{}'", original.display())
+      })?;
+    }
+    let original_relative =
+      pathdiff::diff_paths(&original, bin_node_modules_dir_path)
+        .unwrap_or(original);
+    symlink(&original_relative, &link).with_context(|| {
+      format!(
+        "Can't set up '{}' bin at {}",
+        bin_name,
+        original_relative.display()
+      )
+    })?;
+  }
+  Ok(())
+}
+
 fn symlink_package_dir(
   old_path: &Path,
   new_path: &Path,

tests/registry/npm/@denotest/bin/1.0.0/cli.mjs

@@ -1,3 +1,5 @@
+#!/usr/bin/env -S node
+
 import process from "node:process";
 
 for (const arg of process.argv.slice(2)) {

tests/specs/task/bin_package/__test__.jsonc

@@ -0,0 +1,22 @@
+{
+  "tempDir": true,
+  "steps": [
+    // {"commandName": "npm", "args": "install", "output": "\nadded 1 package in [WILDCARD]\n"},
+    {
+      "args": "task sayhi",
+      "output": "task.out"
+    },
+    {
+      "if": "unix",
+      "commandName": "./node_modules/.bin/cli-esm",
+      "args": "hi hello",
+      "output": "hi\nhello\n"
+    },
+
+    {
+      "commandName": "npm",
+      "args": "run sayhi",
+      "output": "npm-run.out"
+    }
+  ]
+}

tests/specs/task/bin_package/deno.json

@@ -0,0 +1,3 @@
+{
+  "nodeModulesDir": true
+}

tests/specs/task/bin_package/npm-run.out

@@ -0,0 +1,6 @@
+
+> sayhi
+> cli-esm hi hello
+
+hi
+hello

tests/specs/task/bin_package/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "bin_package",
+  "devDependencies": {
+    "@denotest/bin": "1.0.0"
+  },
+  "scripts": {
+    "sayhi": "cli-esm hi hello"
+  }
+}

tests/specs/task/bin_package/task.out

@@ -0,0 +1,6 @@
+Download http://localhost:4260/@denotest/bin
+Download http://localhost:4260/@denotest/bin/1.0.0.tgz
+Initialize @denotest/bin@1.0.0
+Task sayhi cli-esm hi hello
+hi
+hello