chore: migrate from esbuild to Bun

  - Replace esbuild with Bun as the build tool
  - Add bunfig.toml for Bun configuration
  - Update build process with new build.mjs script
  - Modernize GitHub Actions workflow for releases
  - Simplify release asset management
  - Remove package-lock.json in favor of bun.lock
  - Update documentation and contribution guides
  - Add local workflow testing instructions

Author: philoserf

.github/workflows/release.yml

@@ -8,51 +8,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: oven-sh/setup-bun@v1
         with:
-          node-version: "22"
+          bun-version: latest
 
       - run: |
-          npm install
-          npm run build
+          bun install
+          bun run build
 
-      - name: Package
-        run: |
-          mkdir dist
-          cp main.js manifest.json README.md dist/
-          zip -r release.zip dist/
-
-      - uses: actions/create-release@v1
-        id: create_release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Release and Upload Assets
+        uses: softprops/action-gh-release@v1
         with:
-          tag_name: ${{ github.ref }}
-          release_name: ${{ github.ref }}
-
-      - uses: actions/upload-release-asset@v1
+          name: ${{ github.ref }}
+          files: |
+            main.js
+            manifest.json
+            styles.css
+          fail_on_unmatched_files: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./release.zip
-          asset_name: release-${{ github.ref_name }}.zip
-          asset_content_type: application/zip
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./main.js
-          asset_name: main.js
-          asset_content_type: text/javascript
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./manifest.json
-          asset_name: manifest.json
-          asset_content_type: application/json

.gitignore

@@ -1,10 +1,14 @@
 # Build artifacts
-main.js
+**/*.js
 main.js.map
 
 # Dependencies
 node_modules/
 
+# Bun
+.bun/
+# bun.lock - We want to track the lock file
+
 # Test vault - plugins
 test-vault/.obsidian/plugins/*
 !test-vault/.obsidian/plugins/journals/.hotreload

CONTRIBUTING.md

@@ -9,16 +9,22 @@
 
 ## Development
 
+This project uses Bun as the build tool:
+
 1. Clone this repository `gh repo clone philoserf/obsidian-vault-changelog`.
-2. Install dependencies with `npm install`.
-3. Build the project with `npm run build`.
+2. Install Bun: [https://bun.sh/docs/installation](https://bun.sh/docs/installation)
+3. Install dependencies: `bun install`
+4. Format: `bun run format`
+5. Lint: `bun run lint`
+6. Development build with auto-refresh: `bun run dev`
+7. Production build: `bun run build`
 
 ### Using the test-vault
 
 The project includes a test-vault for development:
 
 1. Open the test-vault in Obsidian (`File > Open another vault > Open folder as vault` and select the `test-vault` directory)
-2. Build the plugin with hot-reload: `npm run dev`
+2. Build the plugin with hot-reload: `bun run dev`
 3. Changes will automatically be applied to the plugin in the test-vault
 
 ### Manual installation
@@ -27,3 +33,14 @@ Alternatively, you can manually install the plugin in your own vault:
 
 1. Copy `manifest.json` and `main.js` into your **Obsidian plugins folder** (`.obsidian/plugins/obsidian-vault-changelog`).
 2. Reload Obsidian and enable the plugin.
+
+## Test release
+
+```shell
+act \
+    --container-architecture linux/amd64 \
+    -W .github/workflows/release.yml \
+    -P ubuntu-latest=catthehacker/ubuntu:act-latest \
+    --pull=false \
+    -e <(echo '{"ref": "refs/tags/v1.0.0", "ref_name": "v1.0.0"}')
+```

build.mjs

@@ -0,0 +1,58 @@
+import { join } from "path";
+import { build, file, write } from "bun";
+import { mkdir } from "node:fs/promises";
+
+const production = process.argv[2] === "production";
+
+// Setup output paths
+const outDir = production
+	? "."
+	: "test-vault/.obsidian/plugins/obsidian-vault-changelog";
+
+// Ensure the directory exists
+await mkdir(outDir, { recursive: true });
+
+// Copy manifest.json and styles.css to output directory in dev mode
+if (!production) {
+	await write(
+		join(outDir, "manifest.json"),
+		await file("manifest.json").text(),
+	);
+	await write(join(outDir, "styles.css"), await file("styles.css").text());
+}
+
+const buildOptions = {
+	entrypoints: ["./src/main.ts"],
+	outdir: outDir,
+	outfile: join(outDir, "main.js"),
+	format: "cjs",
+	external: ["obsidian"],
+	target: "browser",
+	minify: production,
+	sourcemap: production ? "none" : "external",
+};
+
+async function runBuild() {
+	const result = await build(buildOptions);
+
+	if (!result.success) {
+		console.error("Build failed:", result.logs);
+		process.exit(1);
+	}
+
+	if (production) {
+		console.log("Production build completed");
+		process.exit(0);
+	} else {
+		console.log("Development build completed. Watching for changes...");
+
+		// Use Node's fs.watch for file changes
+		const { watch } = await import("node:fs");
+		watch("./src", { recursive: true }, async (eventType, filename) => {
+			console.log(`File ${filename} changed, rebuilding...`);
+			await build(buildOptions);
+		});
+	}
+}
+
+runBuild();