🏁 Add bun tests

Author: elbywan

.github/workflows/bun.yml

@@ -0,0 +1,24 @@
+name: Bun compatibility test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - dev
+  workflow_dispatch:
+
+jobs:
+  bun-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: moonrepo/setup-toolchain@v0
+        with:
+          auto-install: true
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Test Bun compatibility
+        run: npm run test:bun

.prototools

@@ -1,3 +1,4 @@
 node = "lts"
 npm = "latest"
 deno = "latest"
+bun = "latest"

CONTRIBUTING.md

@@ -15,7 +15,7 @@ cd wretch
 
 ### 2 - Setup toolchain
 
-This project uses [proto](https://moonrepo.dev/proto) to manage tool versions (Node.js, npm, Deno). Install proto:
+This project uses [proto](https://moonrepo.dev/proto) to manage tool versions (Node.js, npm, Deno, Bun). Install proto:
 
 ```bash
 # macOS/Linux

README.md

@@ -31,7 +31,7 @@
 - 💡 **Intuitive** - lean API, handles errors, headers and (de)serialization
 - 🧊 **Immutable** - every call creates a cloned instance that can then be reused safely
 - 🔌 **Modular** - plug addons to add new features, and middlewares to intercept requests
-- 🧩 **Isomorphic** - compatible with modern browsers, Node.js 22+ and Deno
+- 🧩 **Isomorphic** - compatible with modern browsers, Node.js 22+, Deno and Bun
 - 🦺 **Type safe** - strongly typed, written in TypeScript
 - ✅ **Proven** - fully covered by unit tests and widely used
 - 💓 **Maintained** - alive and well for many years
@@ -236,6 +236,21 @@ const text = await wretch("https://httpbun.org").get("/status/200").text();
 console.log(text); // -> { "code": 200, "description": "OK" }
 ```
 
+## Bun
+
+Works with [Bun](https://bun.sh/) out of the box.
+
+```bash
+bun add wretch
+```
+
+```ts
+import wretch from "wretch";
+
+const text = await wretch("https://httpbun.org").get("/status/200").text();
+console.log(text); // -> { "code": 200, "description": "OK" }
+```
+
 # Usage
 
 ## Import

package.json

@@ -121,6 +121,7 @@
     "test:browser": "concurrently --success first -k 'npm run mock:wait && web-test-runner' 'npm run mock'",
     "test:browser:watch": "concurrently --success first -k 'npm run mock:wait && web-test-runner --watch' 'npm run mock'",
     "test:deno": "concurrently --success first -k 'npm run mock:wait && deno test --allow-net --allow-read --no-check --sloppy-imports --config test/deno/deno.json test/deno/wretch.spec.ts' 'npm run mock'",
+    "test:bun": "concurrently --success first -k 'npm run mock:wait && bun test test/bun/wretch.spec.ts' 'npm run mock'",
     "test:snippets:generate": "node --import tsx scripts/generateSnippetTests.ts",
     "test:snippets": "npm run test:snippets:generate && node --experimental-vm-modules --import tsx --test test/generated/snippets.spec.ts",
     "test:snippets:skip-failing": "node --import tsx scripts/addSkipComments.ts",

test/bun/helpers.ts

@@ -0,0 +1,35 @@
+import { expect as bunExpect } from "bun:test"
+
+export const expect = (actual: any) => ({
+  toBe: (expected: unknown) => bunExpect(actual).toBe(expected),
+  toEqual: (expected: unknown) => bunExpect(actual).toEqual(expected),
+  toBeNull: () => bunExpect(actual).toBeNull(),
+  toBeTruthy: () => bunExpect(actual).toBeTruthy(),
+  toBeUndefined: () => bunExpect(actual).toBeUndefined(),
+  toBeGreaterThanOrEqual: (expected: any) => bunExpect(actual).toBeGreaterThanOrEqual(expected),
+  toStrictEqual: (expected: unknown) => bunExpect(actual).toStrictEqual(expected),
+  toMatchObject: (expected: any) => bunExpect(actual).toMatchObject(expected),
+})
+
+export const assert = {
+  rejects: async (
+    fn: () => Promise<unknown>,
+    validator?: (error: unknown) => boolean
+  ) => {
+    try {
+      await fn()
+      throw new Error("Expected promise to reject")
+    } catch (error) {
+      if (validator && !validator(error)) {
+        throw new Error("Validator returned false")
+      }
+    }
+  }
+}
+
+export const fs = {
+  openAsBlob: async (path: string) => {
+    const file = Bun.file(path)
+    return file
+  }
+}

test/bun/wretch.spec.ts

@@ -0,0 +1,27 @@
+import { describe, it, beforeEach } from "bun:test"
+import { expect, assert, fs } from "./helpers"
+import { createWretchTests, createMixTests } from "../shared/wretch.spec"
+
+const duckImagePath = new URL("../assets/duck.jpg", import.meta.url).pathname
+const duckImage = await Bun.file(duckImagePath).arrayBuffer().then(buf => new Uint8Array(buf))
+
+createWretchTests({
+  describe,
+  it,
+  beforeEach,
+  assert,
+  expect,
+  fs,
+  duckImage,
+  duckImagePath,
+})
+
+createMixTests({
+  describe,
+  it,
+  assert,
+  expect,
+  fs,
+  duckImage,
+  duckImagePath,
+})

test/shared/wretch.spec.ts

@@ -21,6 +21,7 @@ const isSafari =
   navigator.userAgent.indexOf("Chrome") < 0
 const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined"
 const isDeno = typeof globalThis.Deno !== "undefined"
+const isBun = typeof globalThis.Bun !== "undefined"
 
 const allRoutes = <T>(
   obj: Wretch,
@@ -562,7 +563,7 @@ export function createWretchTests(ctx: TestContext): void {
     })
 
     it("should retrieve performance timings associated with a fetch request", async function () {
-      if (isSafari || isDeno)
+      if (isSafari || isDeno || isBun)
         return
 
       const w = wretch()
@@ -799,7 +800,7 @@ export function createWretchTests(ctx: TestContext): void {
     })
 
     it("should program resolvers", async function () {
-      if(isSafari || isDeno)
+      if(isSafari || isDeno || isBun)
         return
 
       let check = 0