feat: add support for bun (#87)

.github/workflows/autofix.yml

@@ -14,13 +14,15 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: corepack enable
+      - uses: oven-sh/setup-bun@v1
       - uses: actions/setup-node@v3
         with:
           node-version: 18
           cache: "pnpm"
       - run: pnpm install
       - name: Fix lint issues
         run: pnpm run lint:fix && pnpm vitest run --update
+      - run: git checkout HEAD test/fixtures/bun
       - uses: autofix-ci/action@8caa572fd27b0019a65e4c695447089c8d3138b9
         with:
           commit-message: "chore: apply automated lint fixes"

.github/workflows/ci.yml

@@ -17,6 +17,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: corepack enable
+      - uses: oven-sh/setup-bun@v1
+        if: ${{ matrix.os != 'windows-latest' }}
       - uses: actions/setup-node@v3
         with:
           node-version: 18

README.md

@@ -11,31 +11,31 @@
 
 ## What does **nypm** do?
 
-✅ Supports **npm, yarn and pnpm** out of the box with a unified API
+✅ Supports **npm, yarn, pnpm and bun** out of the box with a unified API
 
 ✅ Provides an **API interface** to interact with package managers
 
 ✅ **Autodetects** project's package manager using package.json and known lockfiles
 
-✅ **Auto-installs and use exactly expected version** of package manager using [nodejs/corepack](https://github.com/nodejs/corepack)
+✅ **Auto-installs and use exactly expected version** of supported package managers using [nodejs/corepack](https://github.com/nodejs/corepack)
 
 ✅ **Minimal** implementation
 
 nypm, detects package manager type and version and converts command into package manager CLI arguments. It then uses corepack to execute package manager's command (and download it if necessary).
 
 ```
-  +------------------------------------+
-  |                nypm                |
-  +------------------------------------+
-  +------------------------------------+
-  |              Corepack              |
-  +------------------------------------+
-  +---------+  +---------+   +---------+
-  |   npm   |  |  yarn   |   |  pnpm   |
-  +---------+  +---------+   +---------+
-  +------------------------------------+
-  |         Node.js project            |
-  +------------------------------------+
+  +------------------------------------------------+
+  |                nypm                            |
+  +------------------------------------------------+
+  +-----------------------------------+
+  |              Corepack             |
+  +-----------------------------------+
+  +---------+  +---------+  +---------+  +---------+
+  |   npm   |  |  yarn   |  |  pnpm   |  |  bun    |
+  +---------+  +---------+  +---------+  +---------+
+  +------------------------------------------------+
+  |                Node.js project                 |
+  +------------------------------------------------+
 ```
 
 ## CLI Usage
@@ -55,6 +55,9 @@ pnpm install nypm
 
 # yarn
 yarn add nypm
+
+# bun
+bun install nypm
 ```
 
 Import:

package.json

@@ -43,6 +43,7 @@
     "jiti": "^1.19.1",
     "pathe": "^1.1.1",
     "prettier": "^3.0.2",
+    "std-env": "^3.4.3",
     "typescript": "^5.1.6",
     "unbuild": "^1.2.1",
     "vitest": "^0.34.1"

src/_utils.ts

@@ -35,7 +35,9 @@ export async function executeCommand(
   // work around issue with segmentation fault when using corepack with npm
   // on ubuntu-latest
   const execaArgs: [string, string[]] =
-    command === "npm" ? [command, args] : ["corepack", [command, ...args]];
+    command === "npm" || command === "bun"
+      ? [command, args]
+      : ["corepack", [command, ...args]];
 
   await execa(execaArgs[0], execaArgs[1], {
     cwd: resolve(options.cwd || process.cwd()),
@@ -102,6 +104,10 @@ export function getWorkspaceArgs(
       return ["-F", options.workspace];
     }
 
+    case "bun": {
+      return [];
+    }
+
     case "yarn": {
       return ["workspace", options.workspace];
     }

src/package-manager.ts

@@ -35,6 +35,11 @@ const _packageManagers: PackageManager[] = [
     lockFile: "pnpm-lock.yaml",
     files: ["pnpm-workspace.yaml"],
   },
+  {
+    name: "bun",
+    command: "bun",
+    lockFile: "bun.lockb",
+  },
   {
     name: "yarn",
     command: "yarn",

src/types.ts

@@ -1,4 +1,4 @@
-export type PackageManagerName = "npm" | "yarn" | "pnpm";
+export type PackageManagerName = "npm" | "yarn" | "pnpm" | "bun";
 
 export type PackageManager = {
   name: PackageManagerName;

test/fixtures/bun/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "fixture-bun",
+  "version": "0.0.0",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ]
+}

test/fixtures/bun/packages/workspace-a/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "fixture-bun/workspace-a",
+  "private": true,
+  "version": "0.0.0",
+  "devDependencies": {
+    "ufo": "^1.1.1"
+  }
+}

test/index.test.ts

@@ -1,5 +1,6 @@
 import { fileURLToPath } from "node:url";
 import { expect, it, describe, vi } from "vitest";
+import { isWindows } from "std-env";
 import {
   installDependencies,
   addDependency,
@@ -32,6 +33,10 @@ const fixtures = [
     name: "pnpm",
     packageManager: "pnpm",
   },
+  {
+    name: "bun",
+    packageManager: "bun",
+  },
   {
     name: "yarn-classic",
     packageManager: "yarn",
@@ -123,6 +128,11 @@ describe("detectPackageManager", () => {
 
 describe("api", () => {
   for (const fixture of fixtures) {
+    // bun is not yet supported on Windows
+    if (isWindows && fixture.name === "bun") {
+      continue;
+    }
+
     describe(fixture.name, () => {
       const fixtureDirectory = resolveFixtureDirectory(fixture.name);