@dormer/vite-plugin 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @dormer/vite-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Vite configuration a Dormer renderer needs, packaged as one plugin.
+
+```ts
+// renderer/vite.config.ts
+import { defineConfig } from "vite";
+import { dormer } from "@dormer/vite-plugin";
+
+export default defineConfig({ plugins: [dormer()] });
+```
+
+What it sets (and why):
+
+| Setting | Value | Reason |
+|---|---|---|
+| `base` | `"./"` | assets are loaded relative to `index.html` under `dormer://app/` |
+| `build.target` | `"es2022"` | supported by WKWebView, WebView2 and WebKitGTK; smaller output |
+| `build.outDir` | `<appRoot>/dist/renderer` | where `dormer build` and the host look for the renderer |
+| `build.emptyOutDir` | `true` | the out dir is outside the Vite root |
+| `define` | `import.meta.env.DORMER = true` | lets shared code know it is built for Dormer |
+| `server.strictPort` (dev) | `true` | `dormer dev` passes the chosen URL to the host as `--dev-url` |
+| `server.ws.host` (dev; `server.hmr.host` before Vite 8) | `"localhost"` | HMR websocket target the dev Content-Security-Policy allows |
+
+It injects nothing into the HTML: the native host injects the `window.dormer` bridge at document
+start, and `@dormer/renderer` wraps it.
+
+`appRoot` is the nearest ancestor of the Vite root containing `dormer.config.json` (normally the
+parent of `renderer/`). Options: `dormer({ appRoot, outDir, hmrHost })`.
+
+Types for `import.meta.env.DORMER`: add `/// <reference types="@dormer/vite-plugin/client" />` to
+your renderer's `vite-env.d.ts`.

package/client.d.ts

@@ -0,0 +1,10 @@
+// Type augmentation for renderers built with `@dormer/vite-plugin`.
+// Reference it from your renderer's env declaration file:
+//   /// <reference types="@dormer/vite-plugin/client" />
+interface ImportMetaEnv {
+  /** `true` when the page is built or served through `@dormer/vite-plugin`. */
+  readonly DORMER: boolean;
+}
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/dist/index.js

@@ -0,0 +1,39 @@
+// src/index.ts
+import fs from "node:fs";
+import path from "node:path";
+function findAppRoot(start) {
+  let dir = path.resolve(start);
+  for (; ; ) {
+    if (fs.existsSync(path.join(dir, "dormer.config.json"))) return dir;
+    const parent = path.dirname(dir);
+    if (parent === dir) return path.resolve(start);
+    dir = parent;
+  }
+}
+function dormer(options = {}) {
+  return {
+    name: "dormer",
+    config(userConfig, env) {
+      const viteRoot = path.resolve(userConfig.root ?? process.cwd());
+      const appRoot = options.appRoot ? path.resolve(options.appRoot) : findAppRoot(viteRoot);
+      const outDir = path.resolve(appRoot, options.outDir ?? "dist/renderer");
+      const config = {
+        base: "./",
+        build: { target: "es2022", outDir, emptyOutDir: true },
+        define: { "import.meta.env.DORMER": "true" }
+      };
+      if (env.command === "serve") {
+        const viteMajor = Number((this?.meta?.viteVersion ?? "0").split(".")[0]);
+        const host = options.hmrHost ?? "localhost";
+        config.server = { strictPort: true, ...viteMajor >= 8 ? { ws: { host } } : { hmr: { host } } };
+      }
+      return config;
+    }
+  };
+}
+var index_default = dormer;
+export {
+  index_default as default,
+  dormer,
+  findAppRoot
+};

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@dormer/vite-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Vite plugin for Dormer renderers: relative base, es2022 target, dist/renderer output, import.meta.env.DORMER",
+  "type": "module",
+  "license": "Apache-2.0 OR MIT",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./client.d.ts"
+    }
+  },
+  "files": [
+    "README.md",
+    "client.d.ts",
+    "dist",
+    "src"
+  ],
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/veerareddyvishal144/dormer.git",
+    "directory": "packages/vite-plugin"
+  },
+  "scripts": {
+    "build": "node build.mjs",
+    "prepare": "node build.mjs"
+  },
+  "devDependencies": {
+    "esbuild": "^0.28.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,64 @@
+// @dormer/vite-plugin: the Vite configuration a Dormer renderer needs, as one plugin.
+//
+// Dormer serves the built renderer from `dormer://app/` (production) or from the Vite dev server
+// (`dormer dev`). The plugin only sets configuration; it injects nothing into the HTML because
+// the host injects the `window.dormer` bridge itself at document start.
+//
+//   base: "./"               assets resolve relative to index.html under dormer://app/
+//   build.target: "es2022"   all three system WebViews support it; keeps output small
+//   build.outDir             <appRoot>/dist/renderer, where `dormer build` and the host expect it
+//   define                   import.meta.env.DORMER === true
+//   server (dev only)        strictPort so `dormer dev` can hand the host a stable --dev-url,
+//                            HMR websocket pinned to a host name the dev CSP allows
+//                            (server.ws.host on Vite 8+, server.hmr.host before)
+import fs from "node:fs";
+import path from "node:path";
+import type { Plugin, UserConfig } from "vite";
+
+export interface DormerPluginOptions {
+  /**
+   * Directory containing `dormer.config.json`. Default: the nearest ancestor of the Vite root
+   * that has one (usually `..` when the renderer lives in `<app>/renderer`), else the Vite root.
+   */
+  appRoot?: string;
+  /** Renderer output directory, relative to `appRoot`. Default `dist/renderer`. */
+  outDir?: string;
+  /** Host name the HMR websocket connects to in dev. Default `localhost`. */
+  hmrHost?: string;
+}
+
+/** Walks up from `start` looking for a directory that contains `dormer.config.json`. */
+export function findAppRoot(start: string): string {
+  let dir = path.resolve(start);
+  for (;;) {
+    if (fs.existsSync(path.join(dir, "dormer.config.json"))) return dir;
+    const parent = path.dirname(dir);
+    if (parent === dir) return path.resolve(start);
+    dir = parent;
+  }
+}
+
+export function dormer(options: DormerPluginOptions = {}): Plugin {
+  return {
+    name: "dormer",
+    config(userConfig, env): UserConfig {
+      const viteRoot = path.resolve(userConfig.root ?? process.cwd());
+      const appRoot = options.appRoot ? path.resolve(options.appRoot) : findAppRoot(viteRoot);
+      const outDir = path.resolve(appRoot, options.outDir ?? "dist/renderer");
+      const config: UserConfig = {
+        base: "./",
+        build: { target: "es2022", outDir, emptyOutDir: true },
+        define: { "import.meta.env.DORMER": "true" },
+      };
+      if (env.command === "serve") {
+        // Vite 8 renamed the HMR websocket options from server.hmr.* to server.ws.*.
+        const viteMajor = Number(((this as unknown as { meta?: { viteVersion?: string } })?.meta?.viteVersion ?? "0").split(".")[0]);
+        const host = options.hmrHost ?? "localhost";
+        config.server = { strictPort: true, ...(viteMajor >= 8 ? { ws: { host } } : { hmr: { host } }) } as UserConfig["server"];
+      }
+      return config;
+    },
+  };
+}
+
+export default dormer;