@dormer/cli 0.0.0-stage → 0.1.3

package/templates/svelte/renderer/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vite";
+import { svelte, vitePreprocess } from "@sveltejs/vite-plugin-svelte";
+import { dormer } from "@dormer/vite-plugin";
+
+export default defineConfig({
+  plugins: [svelte({ preprocess: vitePreprocess() }), dormer()],
+});

package/templates/svelte/src/main.ts

@@ -0,0 +1,34 @@
+// {{name}} — backend. Runs in the Node.js sidecar; the native host owns windows and WebViews.
+import { app, BrowserWindow, ipcMain } from "@dormer/api";
+import type { PingReply } from "./shared.ts";
+
+const selftest = process.env.DORMER_SELFTEST === "1";
+const log = (kind: string, payload: Record<string, unknown>) => console.log(JSON.stringify({ kind, ...payload }));
+
+// Renderer → backend request/response: `await invoke("ping")` in the page resolves with this.
+ipcMain.handle("ping", (): PingReply => ({ reply: "pong", node: process.version, platform: process.platform, pid: process.pid, at: Date.now(), selftest }));
+
+// Fire-and-forget message from the renderer (`send("selftest:done", reply)`); used by the
+// automated template test (packages/cli/test/e2e-linux.sh) when DORMER_SELFTEST=1.
+ipcMain.on("selftest:done", (_event, result: PingReply) => {
+  if (!selftest) return;
+  const ok = result?.reply === "pong";
+  log("template-selftest", { ok, node: result?.node });
+  if (ok) app.quit(); else app.exit(1);
+});
+
+async function createWindow(): Promise<void> {
+  const win = new BrowserWindow({ width: 960, height: 640, title: "{{name}}", show: false, capabilities: ["app:default"] });
+  win.once("ready-to-show", () => win.show());
+  // `dormer dev` serves the renderer from Vite and passes its URL; production loads dormer://app/.
+  const devUrl = process.env.DORMER_DEV_URL;
+  if (devUrl) await win.loadURL(devUrl);
+  else await win.loadApp("index.html");
+  // Backend → renderer events: received in the page with `on("backend:tick", ...)`.
+  const tick = setInterval(() => win.webContents.send("backend:tick", { uptime: Math.round(process.uptime()) }), 1000);
+  win.on("closed", () => clearInterval(tick));
+}
+
+app.on("window-all-closed", () => { if (process.platform !== "darwin") app.quit(); });
+app.on("activate", () => { if (BrowserWindow.getAllWindows().length === 0) void createWindow(); });
+app.whenReady().then(createWindow);

package/templates/svelte/src/shared.ts

@@ -0,0 +1,10 @@
+// Types shared by the backend and the renderer (no Node.js imports here: the renderer's tsconfig
+// type-checks this file too, which is what gives the page autocompletion for backend replies).
+export interface PingReply {
+  reply: "pong";
+  node: string;
+  platform: string;
+  pid: number;
+  at: number;
+  selftest: boolean;
+}

package/templates/svelte/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true,
+    "types": ["node"]
+  },
+  "include": ["src"]
+}

package/templates/vanilla/README.md

@@ -0,0 +1,34 @@
+# {{name}}
+
+A [Dormer](https://github.com/dormer) desktop app: a Node.js backend (`src/main.ts`) and a
+vanilla TypeScript renderer (`renderer/`) shown in the operating system's WebView.
+
+```sh
+npm install
+npm run dev        # Vite dev server + native window; the backend is rebuilt on change
+npm run build      # dist/renderer, dist/main.js, dist/dormer-app.json
+npm run package    # installers (needs the dormer-bundle tool)
+npx dormer doctor  # checks Node, the host binary and platform prerequisites
+```
+
+## Layout
+
+```
+dormer.config.json   name, identifier, version, per-window capabilities, Node version pin
+src/main.ts          backend: one window, ipcMain.handle("ping"), window-all-closed → quit
+renderer/            Vite project: index.html, vite.config.ts (uses @dormer/vite-plugin), src/
+```
+
+## How the pieces talk
+
+* `invoke("ping")` in the renderer resolves with whatever `ipcMain.handle("ping", ...)` returns.
+* `on("backend:tick", fn)` receives events the backend pushes with `win.webContents.send(...)`.
+* `send("selftest:done", ...)` is a one-way message handled by `ipcMain.on(...)`.
+
+The renderer never has Node access; every call goes through the native host's capability gate.
+
+## Self-test
+
+With `DORMER_SELFTEST=1` the backend quits after the renderer reports the ping result and logs
+`{"kind":"template-selftest","ok":true}`. The Dormer repository's `packages/cli/test/e2e-linux.sh`
+uses this to verify the template headless.

package/templates/vanilla/_gitignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.dormer/
+*.log
+.DS_Store

package/templates/vanilla/dormer.config.json

@@ -0,0 +1,16 @@
+{
+  "name": "{{name}}",
+  "identifier": "{{identifier}}",
+  "version": "0.1.0",
+  "description": "A Dormer desktop app (vanilla template)",
+  "entry": "src/main.ts",
+  "renderer": "renderer",
+  "firstWindow": { "label": "main", "width": 960, "height": 640, "title": "{{name}}", "backgroundColor": "auto" },
+  "windows": {
+    "main": { "capabilities": ["app:default"] }
+  },
+  "capabilities": {
+    "app:default": { "description": "Everything the backend exposes, for the app's own windows only", "allow": ["ipc:*", "send:*"], "origins": ["local"] }
+  },
+  "node": { "version": "24" }
+}

package/templates/vanilla/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "{{name}}",
+  "private": true,
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "dormer dev",
+    "build": "dormer build",
+    "package": "dormer package",
+    "doctor": "dormer doctor",
+    "typecheck": "tsc -p . && tsc -p renderer"
+  },
+  "dependencies": {
+    "@dormer/api": "0.1.3",
+    "@dormer/renderer": "0.1.3"
+  },
+  "devDependencies": {
+    "@dormer/cli": "0.1.3",
+    "@dormer/vite-plugin": "0.1.3",
+    "@types/node": "^24.0.0",
+    "typescript": "^5.9.0",
+    "vite": "^8.3.0"
+  }
+}

package/templates/vanilla/renderer/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>{{name}}</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/templates/vanilla/renderer/src/main.ts

@@ -0,0 +1,31 @@
+import "./style.css";
+import { invoke, on, send, isDormer } from "@dormer/renderer";
+import type { PingReply } from "../../src/shared.ts";
+
+const root = document.querySelector<HTMLDivElement>("#app")!;
+root.innerHTML = `
+  <main>
+    <h1>{{name}}</h1>
+    <p class="muted">Vanilla TypeScript · Node.js backend · system WebView${import.meta.env.DORMER ? " · built with @dormer/vite-plugin" : ""}</p>
+    <button id="ping">Ping the backend</button>
+    <pre id="result">…</pre>
+    <p id="tick" class="muted"></p>
+  </main>`;
+const result = document.querySelector<HTMLPreElement>("#result")!;
+const tick = document.querySelector<HTMLParagraphElement>("#tick")!;
+
+async function ping(): Promise<void> {
+  // Request/response: page → host (capability check) → Node `ipcMain.handle("ping")` → back.
+  const reply = await invoke<PingReply>("ping");
+  result.textContent = JSON.stringify(reply, null, 2);
+  if (reply.selftest) send("selftest:done", reply); // one-way message, used by the automated test
+}
+
+if (isDormer()) {
+  document.querySelector("#ping")!.addEventListener("click", () => void ping());
+  // Events pushed by the backend with `win.webContents.send("backend:tick", ...)`.
+  on("backend:tick", (t: { uptime: number }) => { tick.textContent = `backend uptime: ${t.uptime} s`; });
+  void ping();
+} else {
+  result.textContent = "Not running inside Dormer. Start the app with `npm run dev`.";
+}

package/templates/vanilla/renderer/src/style.css

@@ -0,0 +1,8 @@
+:root { color-scheme: light dark; font-family: system-ui, sans-serif; line-height: 1.5; }
+body { margin: 0; }
+main { max-width: 720px; margin: 0 auto; padding: 32px 24px; }
+h1 { margin: 0 0 4px; font-size: 1.6rem; }
+.muted { opacity: 0.7; margin: 0 0 16px; }
+button { font: inherit; padding: 8px 14px; border-radius: 8px; border: 1px solid color-mix(in srgb, currentColor 30%, transparent); background: color-mix(in srgb, currentColor 8%, transparent); cursor: pointer; }
+button:hover { background: color-mix(in srgb, currentColor 16%, transparent); }
+pre { background: color-mix(in srgb, currentColor 8%, transparent); padding: 12px; border-radius: 8px; overflow: auto; min-height: 7em; font-size: 0.85rem; }

package/templates/vanilla/renderer/src/vite-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="vite/client" />
+/// <reference types="@dormer/vite-plugin/client" />

package/templates/vanilla/renderer/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "allowImportingTsExtensions": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/templates/vanilla/renderer/vite.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "vite";
+import { dormer } from "@dormer/vite-plugin";
+
+export default defineConfig({
+  plugins: [dormer()],
+});

package/templates/vanilla/src/main.ts

@@ -0,0 +1,34 @@
+// {{name}} — backend. Runs in the Node.js sidecar; the native host owns windows and WebViews.
+import { app, BrowserWindow, ipcMain } from "@dormer/api";
+import type { PingReply } from "./shared.ts";
+
+const selftest = process.env.DORMER_SELFTEST === "1";
+const log = (kind: string, payload: Record<string, unknown>) => console.log(JSON.stringify({ kind, ...payload }));
+
+// Renderer → backend request/response: `await invoke("ping")` in the page resolves with this.
+ipcMain.handle("ping", (): PingReply => ({ reply: "pong", node: process.version, platform: process.platform, pid: process.pid, at: Date.now(), selftest }));
+
+// Fire-and-forget message from the renderer (`send("selftest:done", reply)`); used by the
+// automated template test (packages/cli/test/e2e-linux.sh) when DORMER_SELFTEST=1.
+ipcMain.on("selftest:done", (_event, result: PingReply) => {
+  if (!selftest) return;
+  const ok = result?.reply === "pong";
+  log("template-selftest", { ok, node: result?.node });
+  if (ok) app.quit(); else app.exit(1);
+});
+
+async function createWindow(): Promise<void> {
+  const win = new BrowserWindow({ width: 960, height: 640, title: "{{name}}", show: false, capabilities: ["app:default"] });
+  win.once("ready-to-show", () => win.show());
+  // `dormer dev` serves the renderer from Vite and passes its URL; production loads dormer://app/.
+  const devUrl = process.env.DORMER_DEV_URL;
+  if (devUrl) await win.loadURL(devUrl);
+  else await win.loadApp("index.html");
+  // Backend → renderer events: received in the page with `on("backend:tick", ...)`.
+  const tick = setInterval(() => win.webContents.send("backend:tick", { uptime: Math.round(process.uptime()) }), 1000);
+  win.on("closed", () => clearInterval(tick));
+}
+
+app.on("window-all-closed", () => { if (process.platform !== "darwin") app.quit(); });
+app.on("activate", () => { if (BrowserWindow.getAllWindows().length === 0) void createWindow(); });
+app.whenReady().then(createWindow);

package/templates/vanilla/src/shared.ts

@@ -0,0 +1,10 @@
+// Types shared by the backend and the renderer (no Node.js imports here: the renderer's tsconfig
+// type-checks this file too, which is what gives the page autocompletion for backend replies).
+export interface PingReply {
+  reply: "pong";
+  node: string;
+  platform: string;
+  pid: number;
+  at: number;
+  selftest: boolean;
+}

package/templates/vanilla/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true,
+    "types": ["node"]
+  },
+  "include": ["src"]
+}

package/templates/vue/README.md

@@ -0,0 +1,34 @@
+# {{name}}
+
+A [Dormer](https://github.com/dormer) desktop app: a Node.js backend (`src/main.ts`) and a
+Vue renderer (`renderer/`) shown in the operating system's WebView.
+
+```sh
+npm install
+npm run dev        # Vite dev server + native window; the backend is rebuilt on change
+npm run build      # dist/renderer, dist/main.js, dist/dormer-app.json
+npm run package    # installers (needs the dormer-bundle tool)
+npx dormer doctor  # checks Node, the host binary and platform prerequisites
+```
+
+## Layout
+
+```
+dormer.config.json   name, identifier, version, per-window capabilities, Node version pin
+src/main.ts          backend: one window, ipcMain.handle("ping"), window-all-closed → quit
+renderer/            Vite project: index.html, vite.config.ts (@vitejs/plugin-vue + @dormer/vite-plugin), src/App.vue
+```
+
+## How the pieces talk
+
+* `invoke("ping")` in the renderer resolves with whatever `ipcMain.handle("ping", ...)` returns.
+* `on("backend:tick", fn)` receives events the backend pushes with `win.webContents.send(...)`.
+* `send("selftest:done", ...)` is a one-way message handled by `ipcMain.on(...)`.
+
+The renderer never has Node access; every call goes through the native host's capability gate.
+
+## Self-test
+
+With `DORMER_SELFTEST=1` the backend quits after the renderer reports the ping result and logs
+`{"kind":"template-selftest","ok":true}`. The Dormer repository's `packages/cli/test/e2e-linux.sh`
+uses this to verify the template headless.

package/templates/vue/_gitignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.dormer/
+*.log
+.DS_Store

package/templates/vue/dormer.config.json

@@ -0,0 +1,16 @@
+{
+  "name": "{{name}}",
+  "identifier": "{{identifier}}",
+  "version": "0.1.0",
+  "description": "A Dormer desktop app (vue template)",
+  "entry": "src/main.ts",
+  "renderer": "renderer",
+  "firstWindow": { "label": "main", "width": 960, "height": 640, "title": "{{name}}", "backgroundColor": "auto" },
+  "windows": {
+    "main": { "capabilities": ["app:default"] }
+  },
+  "capabilities": {
+    "app:default": { "description": "Everything the backend exposes, for the app's own windows only", "allow": ["ipc:*", "send:*"], "origins": ["local"] }
+  },
+  "node": { "version": "24" }
+}

package/templates/vue/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "{{name}}",
+  "private": true,
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "dormer dev",
+    "build": "dormer build",
+    "package": "dormer package",
+    "doctor": "dormer doctor",
+    "typecheck": "tsc -p . && vue-tsc -p renderer"
+  },
+  "dependencies": {
+    "@dormer/api": "0.1.3",
+    "@dormer/renderer": "0.1.3",
+    "vue": "^3.5.0"
+  },
+  "devDependencies": {
+    "@dormer/cli": "0.1.3",
+    "@dormer/vite-plugin": "0.1.3",
+    "@types/node": "^24.0.0",
+    "@vitejs/plugin-vue": "^6.0.0",
+    "typescript": "^5.9.0",
+    "vite": "^8.3.0",
+    "vue-tsc": "^3.0.0"
+  }
+}

package/templates/vue/renderer/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>{{name}}</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/templates/vue/renderer/src/App.vue

@@ -0,0 +1,36 @@
+<script setup lang="ts">
+import { onMounted, onUnmounted, ref } from "vue";
+import { invoke, on, send, isDormer } from "@dormer/renderer";
+import type { PingReply } from "../../src/shared.ts";
+
+const inside = isDormer();
+const builtWithPlugin = import.meta.env.DORMER;
+const reply = ref<PingReply | null>(null);
+const uptime = ref<number | null>(null);
+let off: (() => void) | undefined;
+
+async function ping() {
+  // Request/response: page → host (capability check) → Node `ipcMain.handle("ping")` → back.
+  const r = await invoke<PingReply>("ping");
+  reply.value = r;
+  if (r.selftest) send("selftest:done", r); // one-way message, used by the automated test
+}
+
+onMounted(() => {
+  if (!inside) return;
+  // Events pushed by the backend with `win.webContents.send("backend:tick", ...)`; `on` returns an unsubscribe.
+  off = on("backend:tick", (t: { uptime: number }) => { uptime.value = t.uptime; });
+  void ping();
+});
+onUnmounted(() => off?.());
+</script>
+
+<template>
+  <main>
+    <h1>{{name}}</h1>
+    <p class="muted">Vue · Node.js backend · system WebView<span v-if="builtWithPlugin"> · built with @dormer/vite-plugin</span></p>
+    <button :disabled="!inside" @click="ping()">Ping the backend</button>
+    <pre>{{ inside ? (reply ? JSON.stringify(reply, null, 2) : "…") : "Not running inside Dormer. Start the app with `npm run dev`." }}</pre>
+    <p class="muted">{{ uptime !== null ? `backend uptime: ${uptime} s` : "" }}</p>
+  </main>
+</template>

package/templates/vue/renderer/src/main.ts

@@ -0,0 +1,5 @@
+import { createApp } from "vue";
+import App from "./App.vue";
+import "./style.css";
+
+createApp(App).mount("#app");

package/templates/vue/renderer/src/style.css

@@ -0,0 +1,8 @@
+:root { color-scheme: light dark; font-family: system-ui, sans-serif; line-height: 1.5; }
+body { margin: 0; }
+main { max-width: 720px; margin: 0 auto; padding: 32px 24px; }
+h1 { margin: 0 0 4px; font-size: 1.6rem; }
+.muted { opacity: 0.7; margin: 0 0 16px; }
+button { font: inherit; padding: 8px 14px; border-radius: 8px; border: 1px solid color-mix(in srgb, currentColor 30%, transparent); background: color-mix(in srgb, currentColor 8%, transparent); cursor: pointer; }
+button:hover { background: color-mix(in srgb, currentColor 16%, transparent); }
+pre { background: color-mix(in srgb, currentColor 8%, transparent); padding: 12px; border-radius: 8px; overflow: auto; min-height: 7em; font-size: 0.85rem; }

package/templates/vue/renderer/src/vite-env.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="vite/client" />
+/// <reference types="@dormer/vite-plugin/client" />
+
+declare module "*.vue" {
+  import type { DefineComponent } from "vue";
+  const component: DefineComponent<Record<string, never>, Record<string, never>, unknown>;
+  export default component;
+}

package/templates/vue/renderer/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "preserve",
+    "strict": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "allowImportingTsExtensions": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/templates/vue/renderer/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vite";
+import vue from "@vitejs/plugin-vue";
+import { dormer } from "@dormer/vite-plugin";
+
+export default defineConfig({
+  plugins: [vue(), dormer()],
+});

package/templates/vue/src/main.ts

@@ -0,0 +1,34 @@
+// {{name}} — backend. Runs in the Node.js sidecar; the native host owns windows and WebViews.
+import { app, BrowserWindow, ipcMain } from "@dormer/api";
+import type { PingReply } from "./shared.ts";
+
+const selftest = process.env.DORMER_SELFTEST === "1";
+const log = (kind: string, payload: Record<string, unknown>) => console.log(JSON.stringify({ kind, ...payload }));
+
+// Renderer → backend request/response: `await invoke("ping")` in the page resolves with this.
+ipcMain.handle("ping", (): PingReply => ({ reply: "pong", node: process.version, platform: process.platform, pid: process.pid, at: Date.now(), selftest }));
+
+// Fire-and-forget message from the renderer (`send("selftest:done", reply)`); used by the
+// automated template test (packages/cli/test/e2e-linux.sh) when DORMER_SELFTEST=1.
+ipcMain.on("selftest:done", (_event, result: PingReply) => {
+  if (!selftest) return;
+  const ok = result?.reply === "pong";
+  log("template-selftest", { ok, node: result?.node });
+  if (ok) app.quit(); else app.exit(1);
+});
+
+async function createWindow(): Promise<void> {
+  const win = new BrowserWindow({ width: 960, height: 640, title: "{{name}}", show: false, capabilities: ["app:default"] });
+  win.once("ready-to-show", () => win.show());
+  // `dormer dev` serves the renderer from Vite and passes its URL; production loads dormer://app/.
+  const devUrl = process.env.DORMER_DEV_URL;
+  if (devUrl) await win.loadURL(devUrl);
+  else await win.loadApp("index.html");
+  // Backend → renderer events: received in the page with `on("backend:tick", ...)`.
+  const tick = setInterval(() => win.webContents.send("backend:tick", { uptime: Math.round(process.uptime()) }), 1000);
+  win.on("closed", () => clearInterval(tick));
+}
+
+app.on("window-all-closed", () => { if (process.platform !== "darwin") app.quit(); });
+app.on("activate", () => { if (BrowserWindow.getAllWindows().length === 0) void createWindow(); });
+app.whenReady().then(createWindow);

package/templates/vue/src/shared.ts

@@ -0,0 +1,10 @@
+// Types shared by the backend and the renderer (no Node.js imports here: the renderer's tsconfig
+// type-checks this file too, which is what gives the page autocompletion for backend replies).
+export interface PingReply {
+  reply: "pong";
+  node: string;
+  platform: string;
+  pid: number;
+  at: number;
+  selftest: boolean;
+}

package/templates/vue/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "noEmit": true,
+    "allowImportingTsExtensions": true,
+    "erasableSyntaxOnly": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true,
+    "types": ["node"]
+  },
+  "include": ["src"]
+}