From 4645305f14b205cf0b63f7a5c8f295292be45ac1 Mon Sep 17 00:00:00 2001
From: "Marvin A. Ruder" <signed@mruder.dev>
Date: Sat, 11 Nov 2023 16:36:19 +0000
Subject: [PATCH] Add Bun as package manager to `npm` extension

* Auto-detect Bun by looking for `bun.lockb` lockfile
* Extend `npm.packageManager` setting
* Update documentation

Signed-off-by: Marvin A. Ruder <signed@mruder.dev>
---
 extensions/npm/README.md           |  2 +-
 extensions/npm/package.json        |  6 ++++--
 extensions/npm/package.nls.json    |  1 +
 extensions/npm/src/preferred-pm.ts | 14 ++++++++++++++
 4 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/extensions/npm/README.md b/extensions/npm/README.md
index 296bf03f73e..215ca927ff4 100644
--- a/extensions/npm/README.md
+++ b/extensions/npm/README.md
@@ -34,7 +34,7 @@ The extension fetches data from <https://registry.npmjs.org> and <https://regist
 
 - `npm.autoDetect` - Enable detecting scripts as tasks, the default is `on`.
 - `npm.runSilent` - Run npm script with the `--silent` option, the default is `false`.
-- `npm.packageManager` - The package manager used to run the scripts: `auto`, `npm`, `yarn` or `pnpm`, the default is `auto`, which detects your package manager based on your files.
+- `npm.packageManager` - The package manager used to run the scripts: `auto`, `npm`, `yarn`, `pnpm` or `bun`. The default is `auto`, which detects your package manager based on files in your workspace.
 - `npm.exclude` - Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the **absolute path** of the package.json. For example, to exclude all test folders use '&ast;&ast;/test/&ast;&ast;'.
 - `npm.enableScriptExplorer` - Enable an explorer view for npm scripts.
 - `npm.scriptExplorerAction` - The default click action: `open` or `run`, the default is `open`.
diff --git a/extensions/npm/package.json b/extensions/npm/package.json
index 624e2c91a13..d2c0a28b8cc 100644
--- a/extensions/npm/package.json
+++ b/extensions/npm/package.json
@@ -237,13 +237,15 @@
             "auto",
             "npm",
             "yarn",
-            "pnpm"
+            "pnpm",
+            "bun"
           ],
           "enumDescriptions": [
             "%config.npm.packageManager.auto%",
             "%config.npm.packageManager.npm%",
             "%config.npm.packageManager.yarn%",
-            "%config.npm.packageManager.pnpm%"
+            "%config.npm.packageManager.pnpm%",
+            "%config.npm.packageManager.bun%"
           ],
           "default": "auto",
           "description": "%config.npm.packageManager%"
diff --git a/extensions/npm/package.nls.json b/extensions/npm/package.nls.json
index 1b2e87874a3..ff8581bde17 100644
--- a/extensions/npm/package.nls.json
+++ b/extensions/npm/package.nls.json
@@ -9,6 +9,7 @@
 	"config.npm.packageManager.npm": "Use npm as the package manager for running scripts.",
 	"config.npm.packageManager.yarn": "Use yarn as the package manager for running scripts.",
 	"config.npm.packageManager.pnpm": "Use pnpm as the package manager for running scripts.",
+	"config.npm.packageManager.bun": "Use bun as the package manager for running scripts.",
 	"config.npm.packageManager.auto": "Auto-detect which package manager to use for running scripts based on lock files and installed package managers.",
 	"config.npm.exclude": "Configure glob patterns for folders that should be excluded from automatic script detection.",
 	"config.npm.enableScriptExplorer": "Enable an explorer view for npm scripts when there is no top-level 'package.json' file.",
diff --git a/extensions/npm/src/preferred-pm.ts b/extensions/npm/src/preferred-pm.ts
index 92fcdfc8033..0c5b383c6a6 100644
--- a/extensions/npm/src/preferred-pm.ts
+++ b/extensions/npm/src/preferred-pm.ts
@@ -23,6 +23,14 @@ async function pathExists(filePath: string) {
 	return true;
 }
 
+async function isBunPreferred(pkgPath: string): Promise<PreferredProperties> {
+	if (await pathExists(path.join(pkgPath, 'bun.lockb'))) {
+		return { isPreferred: true, hasLockfile: true };
+	}
+
+	return { isPreferred: false, hasLockfile: false };
+}
+
 async function isPNPMPreferred(pkgPath: string): Promise<PreferredProperties> {
 	if (await pathExists(path.join(pkgPath, 'pnpm-lock.yaml'))) {
 		return { isPreferred: true, hasLockfile: true };
@@ -78,6 +86,12 @@ export async function findPreferredPM(pkgPath: string): Promise<{ name: string;
 		detectedPackageManagerProperties.push(yarnPreferred);
 	}
 
+	const bunPreferred = await isBunPreferred(pkgPath);
+	if (bunPreferred.isPreferred) {
+		detectedPackageManagerNames.push('bun');
+		detectedPackageManagerProperties.push(bunPreferred);
+	}
+
 	const pmUsedForInstallation: { name: string } | null = await whichPM(pkgPath);
 
 	if (pmUsedForInstallation && !detectedPackageManagerNames.includes(pmUsedForInstallation.name)) {