C3: Add bun support (#4065)

* Adding bun to pm detection * Adding bun to pm e2e matrix * Install bun in CI setup action * Passing git flag through to nuxi * Change astro template to basics
cloudflare · Sep 29, 2023 · 55298d9 · 55298d9
1 parent 1d0b7ad
commit 55298d9
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 21 deletions.
diff --git a/.changeset/yellow-rules-lay.md b/.changeset/yellow-rules-lay.md
@@ -0,0 +1,5 @@
+---
+"create-cloudflare": minor
+---
+
+Add support for bun
diff --git a/.github/actions/install-dependencies/action.yml b/.github/actions/install-dependencies/action.yml
@@ -3,10 +3,12 @@ description: "Install dependencies, fetching from cache when possible"
 runs:
   using: "composite"
   steps:
-    - uses: pnpm/action-setup@v2
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
       with:
         version: 8
-    - name: Use Node.js ${{ env.node-version }}
+
+    - name: Install Node.js ${{ env.node-version }}
       uses: actions/setup-node@v3
       with:
         node-version: ${{ env.node-version }}

diff --git a/.github/workflows/test-c3.yml b/.github/workflows/test-c3.yml
@@ -7,14 +7,13 @@ on:
 
 env:
   node-version: 18.17.1
+  bun-version: 1.0.3
 
 jobs:
   check:
     name: "Checks"
     strategy:
       matrix:
-        # TODO: add back windows
-        # os: [ubuntu-latest, windows-latest, macos-latest]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -63,7 +62,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        pm: [npm, pnpm]
+        pm: [npm, pnpm, bun]
         quarantine: [true, false]
     runs-on: ${{ matrix.os }}
     steps:
@@ -75,6 +74,11 @@ jobs:
       - name: Install Dependencies
         uses: ./.github/actions/install-dependencies
 
+      - name: Install Bun ${{ env.bun-version }}
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: ${{ env.bun-version }}
+
       - name: E2E Tests
         run: pnpm run --filter create-cloudflare test:e2e:${{matrix.pm}}
         env:
@@ -137,7 +141,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        pm: [npm, pnpm]
+        pm: [npm, pnpm, bun]
         quarantine: [true, false]
     runs-on: ${{ matrix.os }}
     steps:
@@ -149,6 +153,11 @@ jobs:
       - name: Install Dependencies
         uses: ./.github/actions/install-dependencies
 
+      - name: Install Bun ${{ env.bun-version }}
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: ${{ env.bun-version }}
+
       - name: E2E Tests
         run: pnpm run --filter create-cloudflare test:e2e:${{matrix.pm}}
         env:

diff --git a/packages/create-cloudflare/e2e-tests/pages.test.ts b/packages/create-cloudflare/e2e-tests/pages.test.ts
@@ -140,7 +140,7 @@ describe.concurrent(`E2E: Web frameworks`, () => {
 	// These are ordered based on speed and reliability for ease of debugging
 	const frameworkTests: Record<string, FrameworkTestConfig> = {
 		astro: {
-			expectResponseToContain: "Hello, Astronaut!",
+			expectResponseToContain: "Welcome to Astro",
 			testCommitMessage: true,
 		},
 		hono: {
@@ -175,15 +175,6 @@ describe.concurrent(`E2E: Web frameworks`, () => {
 		},
 		nuxt: {
 			expectResponseToContain: "Welcome to Nuxt!",
-			promptHandlers: [
-				{
-					matcher: /Which package manager would you like to use\?/,
-					input: [
-						...(process.env.TEST_PM === "pnpm" ? [keys.down] : []),
-						keys.enter,
-					],
-				},
-			],
 			overrides: {
 				packageScripts: {
 					build: "NITRO_PRESET=cloudflare-pages nuxt build",

diff --git a/packages/create-cloudflare/package.json b/packages/create-cloudflare/package.json
@@ -34,6 +34,7 @@
 		"test:e2e:cleanup": "node -r esbuild-register scripts/e2eCleanup.ts",
 		"test:e2e:npm": "pnpm run build && TEST_PM=npm vitest run --config ./vitest-e2e.config.ts",
 		"test:e2e:pnpm": "pnpm run build && TEST_PM=pnpm vitest run --config ./vitest-e2e.config.ts",
+		"test:e2e:bun": "pnpm run build && TEST_PM=bun vitest run --config ./vitest-e2e.config.ts",
 		"test:unit": "vitest run --config ./vitest.config.ts",
 		"test:unit:watch": "vitest --config ./vitest.config.ts",
 		"watch": "node -r esbuild-register scripts/build.ts --watch"

diff --git a/packages/create-cloudflare/src/frameworks/astro/index.ts b/packages/create-cloudflare/src/frameworks/astro/index.ts
@@ -49,7 +49,7 @@ const config: FrameworkConfig = {
 		"--no-install",
 		"--no-git",
 		"--template",
-		"blog",
+		"basics",
 		"--typescript",
 		"strict",
 	],

diff --git a/packages/create-cloudflare/src/frameworks/nuxt/index.ts b/packages/create-cloudflare/src/frameworks/nuxt/index.ts
@@ -6,12 +6,16 @@ import { detectPackageManager } from "helpers/packages";
 import { getFrameworkCli } from "../index";
 import type { PagesGeneratorContext, FrameworkConfig } from "types";
 
-const { dlx } = detectPackageManager();
+const { npm, dlx } = detectPackageManager();
 
 const generate = async (ctx: PagesGeneratorContext) => {
 	const cli = getFrameworkCli(ctx);
+	const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
 
-	await runFrameworkGenerator(ctx, `${dlx} ${cli} init ${ctx.project.name}`);
+	await runFrameworkGenerator(
+		ctx,
+		`${dlx} ${cli} init ${ctx.project.name} --packageManager ${npm} ${gitFlag}`
+	);
 
 	logRaw(""); // newline
 };
@@ -28,8 +32,8 @@ const config: FrameworkConfig = {
 	displayName: "Nuxt",
 	packageScripts: {
 		build: (cmd) => `NITRO_PRESET=cloudflare-pages ${cmd}`,
-		"pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- npm run dev`,
-		"pages:deploy": "npm run build && wrangler pages deploy ./dist",
+		"pages:dev": `wrangler pages dev ${compatDateFlag()} --proxy 3000 -- ${npm} run dev`,
+		"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
 	},
 };
 export default config;
diff --git a/packages/create-cloudflare/src/helpers/command.ts b/packages/create-cloudflare/src/helpers/command.ts
@@ -216,6 +216,10 @@ export const installPackages = async (
 			cmd = "add";
 			saveFlag = config.dev ? "-D" : "";
 			break;
+		case "bun":
+			cmd = "add";
+			saveFlag = config.dev ? "-d" : "";
+			break;
 		case "npm":
 		case "pnpm":
 		default:

diff --git a/packages/create-cloudflare/src/helpers/packages.ts b/packages/create-cloudflare/src/helpers/packages.ts
@@ -24,6 +24,10 @@ export const detectPackageManager = () => {
 				name = "yarn";
 				version = devDependencies["yarn"].replace("^", "");
 				break;
+			case "bun":
+				name = "bun";
+				version = "1.0.0";
+				break;
 			case "npm":
 				name = "npm";
 				version = "0.0.0";
@@ -66,6 +70,15 @@ export const detectPackageManager = () => {
 				npx: "yarn",
 				dlx: "yarn",
 			};
+		case "bun":
+			return {
+				name,
+				version,
+				npm: "bun",
+				npx: "bunx",
+				dlx: "bunx",
+			};
+
 		case "npm":
 		default:
 			return {