bun.sh compatibility & bun CI

.github/workflows/pages.yml

@@ -33,8 +33,8 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - name: Build
         run: |
-          yarn install
-          yarn workspace megalodon doc
+          corepack enable && pnpm install
+          pnpm --filter megalodon doc
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

.github/workflows/release.yml

@@ -21,12 +21,12 @@ jobs:
         cp LICENSE.txt ./megalodon/
     - name: Install dependencies
       run: |
-        yarn install
+        corepack enable && pnpm install
     - name: Build
       run: |
-        yarn workspace megalodon run build
+        pnpm --filter megalodon run build
     - name: Publish
       run: |
-        yarn workspace megalodon publish
+        pnpm --filter megalodon publish
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/reviewdog.yml

@@ -21,20 +21,20 @@ jobs:
         registry-url: 'https://registry.npmjs.org'
     - name: Install dependencies
       run: |
-        yarn install
+        corepack enable && pnpm install
     - uses: reviewdog/action-setup@v1
     - name: megalodon eslint
       env:
         REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
-        yarn workspace megalodon lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true
+        pnpm --filter megalodon lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true
     - name: example/typescript eslint
       env:
         REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
-        yarn workspace example lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true
+        pnpm --filter example lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true
     - name: example/browser eslint
       env:
         REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
-        yarn workspace browser lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true
+        pnpm --filter browser lint | reviewdog -f=eslint -reporter=github-pr-review -fail-on-error=true

.github/workflows/test.yml

@@ -10,12 +10,12 @@ on:
   pull_request:
 
 jobs:
-  test:
+  test-node:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -25,20 +25,45 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: |
-          yarn install
+          corepack enable && pnpm install
       - name: Build
         run: |
-          yarn workspace megalodon run build
+          pnpm --filter megalodon run build
       - name: Testing
         run: |
-          yarn workspace megalodon run test
+          pnpm --filter megalodon run test
+
+  test-bun:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        bun-version: ['latest']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: ${{ matrix.bun-version }}
+      - name: Install dependencies
+        run: |
+          bun install
+      - name: Build (Bun)
+        run: cd megalodon && bun run build:bun
+      - name: Testing (Bun)
+        run: cd megalodon && bun run test
+      # - name: Browser example (Bun)
+      #   run: cd example/browser && bun run build
+      - name: Typescript example (Bun)
+        run: |
+          cd megalodon && bun run test
 
   example:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -48,22 +73,50 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: |
-          yarn install
-      - name: Build
+          corepack enable && pnpm install
+      - name: Build library
         run: |
-          yarn workspace megalodon run build
-      - name: Browser example
+          pnpm --filter megalodon run build
+      - name: Build examples
         run: |
-          yarn workspace browser run build
+          pnpm --filter !megalodon run build
       - name: Typescript example
         env:
           MASTODON_URL: https://fedibird.com
           PLEROMA_URL: https://pleroma.io
-          FIREFISH_URL: https://cybre.club
+          FIREFISH_URL: https://fedi.software
           FRIENDICA_URL: https://squeet.me
         run: |
-          yarn workspace example run build
+          pnpm --filter example run build
           node example/typescript/dist/mastodon/instance.js
           node example/typescript/dist/pleroma/instance.js
           node example/typescript/dist/firefish/instance.js
           node example/typescript/dist/friendica/instance.js
+
+
+  example-bun:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        bun-version: ['latest']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: ${{ matrix.bun-version }}
+      - name: Install dependencies
+        run: |
+          bun install
+      - name: Build (Bun)
+        run: cd megalodon && bun run build:bun
+      - name: Testing (Bun)
+        run: cd megalodon && bun run test
+      - name: Typescript example (Bun)
+        run: |
+          cd example/typescript && bun run build:bun
+          (env URL=https://fedibird.com bun run dist/detector.js | grep -q 'mastodon' && exit 0 || exit 1)
+          (env URL=https://pleroma.io bun run dist/detector.js | grep -q 'pleroma' && exit 0 || exit 1)
+          (env URL=https://fedi.software bun run dist/detector.js | grep -q 'firefish' && exit 0 || exit 1)
+          (env URL=https://squeet.me bun run dist/detector.js | grep -q 'friendica' && exit 0 || exit 1)

README.md

@@ -6,7 +6,7 @@
 [![npm](https://img.shields.io/npm/dm/megalodon)](https://www.npmjs.com/package/megalodon)
 [![NPM](https://img.shields.io/npm/l/megalodon)](/LICENSE.txt)
 
-Megalodon is a Fediverse API client library for [NodeJS](https://nodejs.org) and browsers.
+Megalodon is a Fediverse API client library for [NodeJS](https://nodejs.org), [Bun](https://bun.sh), and browsers.
 This library allows for interfacing with [Mastodon](https://joinmastodon.org), [Pleroma](https://pleroma.social), [Friendica](https://friendi.ca), and [Firefish](https://joinfirefish.org) servers all with the same interface, providing REST API and streaming methods.
 
 The Rust version is [megalodon-rs](https://github.com/h3poteto/megalodon-rs).
@@ -26,7 +26,7 @@ The Rust version is [megalodon-rs](https://github.com/h3poteto/megalodon-rs).
 - [x] WebSocket for streaming
 - [x] Promisified methods
 - [x] Proxy support
-- [x] NodeJS and browser support
+- [x] NodeJS, Bun, and browser support
 - [x] Written in TypeScript
 
 ## Install
@@ -38,6 +38,9 @@ npm install -S megalodon
 # pnpm
 pnpm add megalodon
 
+# bun
+bun add megalodon
+
 # yarn
 yarn add megalodon
 ```

example/browser/index.html

@@ -4,7 +4,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>Megalodon</title>
-    <script src="./dist/main.js"></script>
+    <script type="module" src="./src/index.ts"></script>
   </head>
   <body>
   </body>

example/browser/package.json

@@ -3,16 +3,19 @@
   "version": "4.0.0",
   "private": true,
   "scripts": {
-    "build": "webpack",
+    "build": "vite build",
     "start": "http-server -p 8000 -s index.html",
-    "lint": "eslint --ext .js,.ts src"
+    "lint": "eslint --ext .js,.ts src",
+    "serve": "vite",
+    "preview": "vite preview"
   },
   "author": "Akira Fukushima <[email protected]> (https://github.com/h3poteto)",
   "license": "MIT",
   "dependencies": {
     "megalodon": "*"
   },
   "devDependencies": {
+    "@originjs/vite-plugin-commonjs": "^1.0.1",
     "assert": "^2.1.0",
     "buffer": "^6.0.3",
     "crypto-browserify": "^3.12.0",
@@ -27,7 +30,8 @@
     "ts-loader": "^9.4.4",
     "typescript": "5.2.2",
     "url": "^0.11.3",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4"
+    "vite": "^2.7.2",
+    "vite-plugin-env-compatible": "^1.1.1",
+    "vite-plugin-html": "3.2.0"
   }
-}
+}

example/browser/src/index.ts

@@ -1,4 +1,6 @@
-import generator, { Entity } from 'megalodon'
+import { Entity } from 'megalodon'
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const generator = require('megalodon').default
 
 const BASE_URL: string = process.env.MASTODON_URL!
 const ACCESS_TOKEN: string = process.env.MASTODON_ACCESS_TOKEN!

example/browser/vite.config.js

@@ -0,0 +1,38 @@
+import { defineConfig } from 'vite'
+import path from 'path'
+import envCompatible from 'vite-plugin-env-compatible'
+import { createHtmlPlugin } from 'vite-plugin-html'
+import { viteCommonjs } from '@originjs/vite-plugin-commonjs'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  resolve: {
+    alias: [
+      {
+        find: /^~/,
+        replacement: ''
+      },
+      {
+        find: '@',
+        replacement: path.resolve(__dirname, 'src')
+      }
+    ],
+    extensions: ['.mjs', '.js', '.ts']
+  },
+  plugins: [
+    viteCommonjs(),
+    envCompatible(),
+    createHtmlPlugin({
+      inject: {
+        data: {
+          title: 'browser'
+        }
+      }
+    })
+  ],
+  optimizeDeps: {
+    // https-proxy-agent and socks-proxy-agent is node library, so can't compile for browser.
+    exclude: ['https-proxy-agent', 'socks-proxy-agent']
+  },
+  build: {}
+})

example/typescript/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "scripts": {
     "build": "tsc -p ./",
+    "build:bun": "bun build ./src/detector.ts --outdir=dist --minify --target=bun",
     "lint": "eslint --ext .js,.ts src"
   },
   "author": "h3poteto",

megalodon/package.json

@@ -5,6 +5,8 @@
   "main": "./lib/src/index.js",
   "typings": "./lib/src/index.d.ts",
   "scripts": {
+    "build:bun-node": "bun build ./src --outdir=lib --minify --target=node",
+    "build:bun": "bun build ./src --outdir=lib --minify --target=bun",
     "build": "tsc -p ./",
     "lint": "eslint --ext .js,.ts src",
     "doc": "typedoc --out ../docs ./src",
@@ -76,6 +78,7 @@
     "@types/uuid": "^9.0.4",
     "@typescript-eslint/eslint-plugin": "^6.7.2",
     "@typescript-eslint/parser": "^6.7.2",
+    "bun-types": "^1.0.3",
     "eslint": "^8.49.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
@@ -85,5 +88,8 @@
     "prettier": "^3.0.3",
     "ts-jest": "^29.1.1",
     "typedoc": "^0.25.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
   }
-}
+}

package.json

@@ -1,5 +1,6 @@
 {
   "private": true,
+  "packageManager": "[email protected]",
   "workspaces": [
     "megalodon",
     "example/typescript",