feat: set up bun plugin

Author: thedanchez

.nvmrc

@@ -1,62 +1,90 @@
 <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-jsx" alt="bun-plugin-solid-jsx">
 </p>
 
-# Template: SolidJS Library
+# bun-plugin-solid-jsx
 
-Template for [SolidJS](https://www.solidjs.com/) library package. Bundling of the library is managed by [tsup](https://tsup.egoist.dev/).
+> 🧩 A Bun plugin for transforming SolidJS JSX/TSX files at runtime or build time using Babel. Supports SSR and DOM output.
 
-Other things configured include:
+> ⚠️ **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.
 
-- 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)
+## Features
 
-## Getting Started
+- ✅ Works in both `bun run` and `bun build` contexts
+- 🎯 Supports SSR (`generate: "ssr"`) and DOM (`generate: "dom"`) output
+- 💧 Hydratable output toggle for SSR
+- 🪄 Minimal and explicit configuration surface
+- 🧱 Designed to be invoked via `preload` or setup scripts
 
-Some pre-requisites before install dependencies:
+## Installation
 
-- 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
-  ```
+```bash
+bun add -d bun-plugin-solid-jsx @babel/core @babel/preset-typescript babel-preset-solid
+```
 
-### Installing Dependencies
+> Note: `@babel/core`, `@babel/preset-typescript` and `babel-preset-solid` are **peer dependencies** and must be installed separately.
 
-```bash
-nvm use
-bun install
+---
+
+## Usage
+
+### Runtime via Bun Preload Script
+
+This use-case applies to development workflows. Create a preload file:
+
+```ts
+// solid-preload.ts
+import solidJSXPlugin from "bun-plugin-solid-jsx";
+
+await solidJSXPlugin({
+  generate: "ssr",
+  hydratable: true,
+});
 ```
 
-### Local Development Build
+Update your `bunfig.toml`:
 
-```bash
-bun start
+```toml
+jsx = "solid"
+jsxFactory = "solid-js"
+preload = ["./solid-preload.ts"]
 ```
 
-### Linting & Formatting
+---
 
-```bash
-bun run lint    # checks source for lint violations
-bun run format  # checks source for format violations
+### With `Bun.build`
+
+```ts
+// build.ts
+import solidJSXPlugin from "bun-plugin-solid-jsx";
+
+await solidJSXPlugin({
+  generate: "ssr",
+  hydratable: true,
+});
+
+await Bun.build({
+  entrypoints: ["./src/index.ts"],
+  outdir: "./dist",
+  target: "bun",
+  format: "esm",
+});
+```
+
+---
+
+## Plugin Options
 
-bun run lint:fix    # fixes lint violations
-bun run format:fix  # fixes format violations
+```ts
+type SolidJSXPluginOptions = {
+  generate?: "dom" | "ssr"; // default: "ssr"
+  hydratable?: boolean; // default: true
+  sourceMaps?: boolean | "inline"; // default: "inline"
+};
 ```
 
-### Contributing
+---
 
-The only requirements when contributing are:
+## License
 
-- 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`
+MIT

README.md

@@ -0,0 +1,21 @@
+const result = await Bun.build({
+  entrypoints: ["src/index.ts"],
+  outdir: "dist",
+  target: "bun",
+  format: "esm",
+  minify: true,
+  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 {};

build.ts

@@ -1,6 +1,5 @@
 import js from "@eslint/js";
 import simpleImportSort from "eslint-plugin-simple-import-sort";
-import solid from "eslint-plugin-solid/configs/typescript";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 
@@ -20,43 +19,11 @@ export default tseslint.config(
       "simple-import-sort/exports": "error",
     },
   },
-  {
-    files: ["**/*.ts", "**/*.tsx"],
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        sourceType: "module",
-        project: "./tsconfig.json",
-        ecmaFeatures: {
-          jsx: true,
-        },
-      },
-      globals: {
-        ...globals.browser,
-        ...globals.es2022,
-      },
-    },
-    plugins: solid.plugins,
-    rules: {
-      ...solid.rules,
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          varsIgnorePattern: "^_",
-          argsIgnorePattern: "^_",
-          destructuredArrayIgnorePattern: "^_",
-        },
-      ],
-    },
-  },
   {
     files: ["__tests__/**/*.ts", "__tests__/**/*.tsx"],
     languageOptions: {
       globals: {
         ...globals.node,
-        ...globals.vitest,
       },
     },
   },

bun.lock

@@ -1,66 +1,52 @@
 {
-  "name": "template-solidjs-library",
-  "version": "0.0.0",
-  "description": "Template for SolidJS library using tsup for bundling. Configured with Bun, NVM, TypeScript, ESLint, Prettier, Vitest, and GHA",
-  "type": "module",
-  "author": "Daniel Sanchez <dsanc89@icloud.com>",
+  "name": "@danchez/bun-plugin-solid-jsx",
+  "description": "A Bun plugin for transforming SolidJS JSX files at runtime or build time using Babel. Supports SSR and DOM output.",
+  "version": "1.0.0",
+  "author": "Daniel Sanchez",
   "license": "MIT",
-  "homepage": "https://github.com/thedanchez/template-solidjs-library#readme",
-  "bugs": {
-    "url": "https://github.com/thedanchez/template-solidjs-library/issues"
-  },
-  "files": [
-    "dist"
-  ],
+  "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "browser": {},
-  "exports": {
-    "solid": "./dist/index.jsx",
-    "import": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
-  },
-  "typesVersions": {},
+  "keywords": [
+    "bun",
+    "plugin",
+    "solid",
+    "solidjs",
+    "jsx",
+    "ssr",
+    "babel",
+    "tsx"
+  ],
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "dev": "vite",
-    "format": "prettier . --check",
-    "format:fix": "prettier . --write",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "serve": "vite preview",
-    "start": "vite",
-    "test": "vitest run",
-    "test:cov": "vitest run --coverage",
-    "typecheck": "tsc --noEmit"
+    "build": "bun build.ts && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "lint:fix": "eslint --fix .",
+    "format:fix": "prettier --write ."
+  },
+  "peerDependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/preset-typescript": "^7.24.0",
+    "babel-preset-solid": "^1.8.10"
   },
   "devDependencies": {
-    "@solidjs/testing-library": "^0.8.10",
-    "@testing-library/jest-dom": "^6.6.3",
-    "@types/bun": "^1.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.25.0",
-    "@typescript-eslint/parser": "^8.25.0",
-    "@vitest/coverage-istanbul": "^3.0.7",
-    "eslint": "^9.21.0",
+    "@babel/core": "^7.24.0",
+    "@babel/preset-typescript": "^7.24.0",
+    "babel-preset-solid": "^1.8.10",
+    "eslint": "^9.25.1",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-solid": "^0.14.5",
     "globals": "^16.0.0",
-    "jiti": "^2.4.2",
-    "jsdom": "^26.0.0",
-    "prettier": "^3.5.2",
-    "tsup": "^8.3.6",
-    "tsup-preset-solid": "^2.2.0",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.25.0",
-    "vite": "^6.2.0",
-    "vite-plugin-solid": "^2.11.2",
-    "vitest": "^3.0.7"
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3"
   },
-  "peerDependencies": {
-    "solid-js": "^1.9.4"
-  }
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "browser": {},
+  "typesVersions": {}
 }