feat: set up bun plugin

Author: thedanchez

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/ci.yaml

@@ -18,10 +18,14 @@ jobs:
       - name: Setup Bun
         uses: oven-sh/setup-bun@v1
         with:
-          bun-version: 1.2.3
+          bun-version: 1.2.12
       - name: Install Dependencies
         run: bun install --frozen-lockfile
+      - name: Type Check
+        run: bun run typecheck
       - name: Lint Check
         run: bun run lint
       - name: Format Check
         run: bun run format
+      - name: Run Tests
+        run: bun test:cov

.nvmrc

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Daniel Sanchez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1,62 +1,132 @@
 <p>
-  <img width="100%" src="https://assets.solidjs.com/banner?type=Ecosystem&background=tiles&project=library-name" alt="solid-create-script">
+  <img width="100%" src="https://assets.solidjs.com/banner?type=Ecosystem&background=tiles&project=bun-plugin-solid" alt="bun-plugin-solid">
 </p>
 
-# Template: SolidJS Library
+# @dschz/bun-plugin-solid
 
-Template for [SolidJS](https://www.solidjs.com/) library package. Bundling of the library is managed by [tsup](https://tsup.egoist.dev/).
+MIT Licensed
 
-Other things configured include:
+> 🧩 A Bun plugin for transforming SolidJS JSX/TSX files at runtime or build time using Babel. Supports SSR and DOM output.
 
-- Bun (for dependency management and running scripts)
-- TypeScript
-- ESLint / Prettier
-- Solid Testing Library + Vitest (for testing)
-- Playground app using library
-- GitHub Actions (for all CI/CD)
+> ⚠️ **Note**: This plugin is designed specifically for use with the [Bun runtime](https://bun.sh). It will not work in Node.js, Deno, or other JavaScript environments.
 
-## Getting Started
+## Features
 
-Some pre-requisites before install dependencies:
+- ✅ Works in both `bun run` (runtime) and `bun build` (build-time) contexts
+- 🎯 Supports SSR (`generate: "ssr"`) and DOM (`generate: "dom"`) output
+- 💧 Hydratable output toggle for SSR
+- 🧱 Designed to be invoked via `preload` or build plugins
+- 🪄 Minimal and explicit configuration surface
 
-- Install Node Version Manager (NVM)
-  ```bash
-  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
-  ```
-- Install Bun
-  ```bash
-  curl -fsSL https://bun.sh/install | bash
-  ```
-
-### Installing Dependencies
+## Installation
 
 ```bash
-nvm use
-bun install
+npm add -d @dschz/bun-plugin-solid @babel/core @babel/preset-typescript babel-preset-solid
+pnpm add -d @dschz/bun-plugin-solid @babel/core @babel/preset-typescript babel-preset-solid
+yarn add -d @dschz/bun-plugin-solid @babel/core @babel/preset-typescript babel-preset-solid
+bun add -d @dschz/bun-plugin-solid @babel/core @babel/preset-typescript babel-preset-solid
+```
+
+> These are **peer dependencies**, so they must be installed manually:
+>
+> - `@babel/core`
+> - `@babel/preset-typescript`
+> - `babel-preset-solid`
+
+## Plugin Options
+
+> Plugin options `generate` and `hydratable` are directly derived from [`babel-preset-solid`](https://github.com/solidjs/solid/blob/main/packages/babel-preset-solid/src/index.ts#L11-L18) and will be passed to it under the hood.
+
+```ts
+type SolidPluginOptions = {
+  /**
+   * Whether to generate DOM or SSR-compatible output.
+   * Defaults to "dom".
+   */
+  generate?: "dom" | "ssr";
+
+  /**
+   * Enables hydration code generation for SSR.
+   * Defaults to true.
+   */
+  hydratable?: boolean;
+
+  /**
+   * Controls source map generation:
+   * - false: no source maps
+   * - true: external .map file
+   * - "inline": base64-encoded inline source maps
+   *
+   * Defaults to "inline".
+   */
+  sourceMaps?: boolean | "inline";
+
+  /**
+   * Enable verbose debug logs during transform.
+   * Defaults to false.
+   */
+  debug?: boolean;
+};
 ```
 
-### Local Development Build
+## Usage
 
-```bash
-bun start
+### 🔧 Runtime (Development) via Preload Script
+
+Use this for runtime-based workflows like server-side rendering (SSR) with Elysia, Bun, or other Bun-native frameworks.
+
+#### `bunPreload.ts`:
+
+```ts
+import { plugin } from "bun";
+import { SolidPlugin } from "@dschz/bun-plugin-solid";
+
+// The `plugin` API automatically registers a BunPlugin
+await plugin(
+  SolidPlugin({
+    generate: "ssr",
+    hydratable: true,
+    debug: true,
+  }),
+);
 ```
 
-### Linting & Formatting
+#### `bunfig.toml`:
 
-```bash
-bun run lint    # checks source for lint violations
-bun run format  # checks source for format violations
+```toml
+jsx = "solid"
+jsxFactory = "solid-js"
+preload = ["./bunPreload.ts"]
+```
 
-bun run lint:fix    # fixes lint violations
-bun run format:fix  # fixes format violations
+#### Run:
+
+```bash
+bun run server.ts
 ```
 
-### Contributing
+---
 
-The only requirements when contributing are:
+### 📦 Build-Time Compilation with `Bun.build()`
 
-- You keep a clean git history in your branch
-  - rebasing `main` instead of making merge commits.
-- Using proper commit message formats that adhere to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
-  - Additionally, squashing (via rebase) commits that are not [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
-- CI checks pass before merging into `main`
+Use this in production workflows to pre-compile `.tsx` or `.jsx` files to JavaScript.
+
+#### `build.ts`:
+
+```ts
+import { SolidPlugin } from "@dschz/bun-plugin-solid";
+
+await Bun.build({
+  entrypoints: ["./src/index.ts"],
+  outdir: "./dist",
+  target: "bun",
+  format: "esm",
+  plugins: [
+    SolidPlugin({
+      generate: "ssr",
+      hydratable: true,
+      sourceMaps: false, // recommended for production
+    }),
+  ],
+});
+```

README.md

@@ -0,0 +1,20 @@
+const result = await Bun.build({
+  entrypoints: ["src/index.ts"],
+  outdir: "dist",
+  target: "bun",
+  format: "esm",
+  external: ["@babel/core", "@babel/preset-typescript", "babel-preset-solid"],
+});
+
+if (!result.success) {
+  console.error("❌ Build failed");
+  for (const log of result.logs) {
+    console.error(log);
+  }
+  process.exit(1);
+}
+
+console.log("✅ Build succeeded");
+
+// Export empty object to treat this file as a module
+export {};