feat: add support for Bun

.github/workflows/ci.yml

@@ -22,6 +22,9 @@ jobs:
     - run: npm i -g npm@8
     - run: npm i -g yarn@1
     - run: npm i -g pnpm@7
+    # https://github.com/oven-sh/bun/issues/43
+    - run: npm i -g bun@1
+      if: matrix.os != 'windows-latest'
     - run: npm ci
     - run: npx playwright install-deps
     - run: npm run build

package.json

@@ -22,8 +22,8 @@
     "prepublish": "npm run build"
   },
   "devDependencies": {
-    "@playwright/test": "^1.38.1",
-    "@types/node": "^16.11.11",
+    "@playwright/test": "^1.41.0-alpha-1704968142000",
+    "@types/node": "^18.19.6",
     "ansi-colors": "^4.1.1",
     "enquirer": "^2.3.6",
     "esbuild": "^0.14.25",

playwright.config.ts

@@ -16,7 +16,7 @@
 import { defineConfig } from '@playwright/test';
 import type { TestFixtures } from './tests/baseFixtures';
 
-export default defineConfig<TestFixtures>({
+const config = defineConfig<TestFixtures>({
   timeout: 120 * 1000,
   testDir: './tests',
   reporter: 'list',
@@ -42,3 +42,15 @@ export default defineConfig<TestFixtures>({
     },
   ]
 });
+
+// https://github.com/oven-sh/bun/issues/43
+if (process.platform !== 'win32') {
+  config.projects?.push({
+    name: 'bun',
+    use: {
+      packageManager: 'bun'
+    }
+  })
+}
+
+export default config;

src/packageManager.ts

@@ -102,12 +102,43 @@ class PNPM implements PackageManager {
   }
 }
 
+class Bun implements PackageManager {
+  name = 'Bun'
+  cli = 'bun'
+
+  init(): string {
+    return 'bun init -y'
+  }
+
+  npx(command: string, args: string): string {
+    return `bun --bun x ${command} ${args}`
+  }
+
+  ci(): string {
+    return 'bun install'
+  }
+
+  installDevDependency(name: string): string {
+    return `bun install --dev ${name}`
+  }
+
+  runPlaywrightTest(args: string): string {
+    return this.npx('playwright', `test${args ? (' ' + args) : ''}`);
+  }
+
+  run(script: string): string {
+    return `bun run ${script}`;
+  }
+}
+
 export function determinePackageManager(rootDir: string): PackageManager {
   if (process.env.npm_config_user_agent) {
     if (process.env.npm_config_user_agent.includes('yarn'))
       return new Yarn();
     if (process.env.npm_config_user_agent.includes('pnpm'))
       return new PNPM(fs.existsSync(path.resolve(rootDir, 'pnpm-workspace.yaml')));
+    if (process.env.npm_config_user_agent.includes('bun'))
+      return new Bun();
     return new NPM();
   }
   return new NPM();

tests/baseFixtures.ts

@@ -20,7 +20,7 @@ import path from 'path';
 import fs from 'fs';
 import type { PromptOptions } from '../src/generator';
 
-export type PackageManager = 'npm' | 'pnpm' | 'yarn';
+export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun';
 
 export type TestFixtures = {
   packageManager: PackageManager;
@@ -82,14 +82,27 @@ export const test = base.extend<TestFixtures>({
         cwd: dir,
         env: {
           ...process.env,
-          'npm_config_user_agent': packageManager === 'yarn' ? 'yarn' : packageManager === 'pnpm' ? 'pnpm/0.0.0' : undefined,
+          'npm_config_user_agent': packageManagerToNpmConfigUserAgent(packageManager),
           'TEST_OPTIONS': JSON.stringify(options),
         },
       });
     });
   },
 });
 
+function packageManagerToNpmConfigUserAgent(packageManager: PackageManager): string {
+  switch (packageManager) {
+    case 'npm':
+      return 'npm/10.2.4 node/v20.11.0 linux x64 workspaces/false'
+    case 'yarn':
+      return 'yarn/1.22.21 npm/? node/v20.11.0 linux x64';
+    case 'pnpm':
+      return 'pnpm/8.14.1 npm/? node/v20.11.0 linux x64';
+    case 'bun':
+      return 'bun/1.0.22 npm/? node/v20.8.0 linux x64'  
+  }
+}
+
 export function assertLockFilesExist(dir: string, packageManager: PackageManager) {
   expect(fs.existsSync(path.join(dir, 'package.json'))).toBeTruthy();
   if (packageManager === 'npm')
@@ -98,6 +111,8 @@ export function assertLockFilesExist(dir: string, packageManager: PackageManager
     expect(fs.existsSync(path.join(dir, 'yarn.lock'))).toBeTruthy();
   else if (packageManager === 'pnpm')
     expect(fs.existsSync(path.join(dir, 'pnpm-lock.yaml'))).toBeTruthy();
+  else if (packageManager === 'bun')
+    expect(fs.existsSync(path.join(dir, 'bun.lockb'))).toBeTruthy();
 }
 
 export function packageManagerToNpxCommand(packageManager: PackageManager): string {
@@ -108,7 +123,10 @@ export function packageManagerToNpxCommand(packageManager: PackageManager): stri
       return 'yarn';
     case 'pnpm':
       return 'pnpm dlx';
+    case 'bun':
+      return 'bun --bun x';
   }
+  throw new Error(`Unsupported package manager: ${packageManager}!`);
 }
 
 export const expect = test.expect;

tests/integration.spec.ts

@@ -41,6 +41,10 @@ test('should generate a project in the current directory', async ({ run, dir, pa
     expect(stdout).toContain('pnpm init'); // pnpm command outputs name in different case, hence we are not testing the whole string
     expect(stdout).toContain('Installing Playwright Test (pnpm add --save-dev @playwright/test)…');
     expect(stdout).toContain('Installing Types (pnpm add --save-dev @types/node)…');
+  } else if (packageManager === 'bun') {
+    expect(stdout).toContain('Initializing Bun project (bun init -y)…');
+    expect(stdout).toContain('Installing Playwright Test (bun install --dev @playwright/test)…');
+    expect(stdout).toContain('Installing Types (bun install --dev @types/node)…');
   }
   expect(stdout).toContain('npx playwright install' + process.platform === 'linux' ? ' --with-deps' : '');
 });