create-dreamer-app 0.0.0-stage → 1.0.2

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Glorbicon
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,99 @@
-# Temporary Holding Version
+# create-dreamer-app
 
-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.
+Start building with **Disco Dreamer** in a few commands.
+
+Scaffold a starter app with TypeScript, TSX components, and Vite already configured. The CLI creates your project and installs its dependencies so you can get straight to your first scene.
+
+## Quick start
+
+```sh
+npx create-dreamer-app@latest my-dreamer-app
+cd my-dreamer-app
+npm run dev
+```
+
+Open the local URL printed by Vite. The development server uses port `3000` by default.
+
+**Requirements:** Node.js `20.19+` within the Node 20 release line, or `22.12+`, and npm.
+
+## What's included
+
+- **Disco Dreamer** with a starter scene and text component.
+- **TypeScript and TSX** with strict type checking.
+- **Vite** for local development and production builds.
+- **Source aliases** so you can import from `@/` instead of navigating relative paths.
+- A full-page canvas with basic styles.
+
+## Make it yours
+
+Start in `src/components/Message/index.tsx` to change the greeting:
+
+```tsx
+import { Text } from "discodreamer";
+
+export function Message() {
+  return <Text value="Hello, Dreamer!" />;
+}
+```
+
+Add components to `src/components/GameScreen/index.tsx` to build out your scene. Use the `@/` alias anywhere in your TypeScript source:
+
+```tsx
+import { Message } from "@/components/Message";
+```
+
+## Project structure
+
+```text
+my-dreamer-app/
+├── src/
+│   ├── assets/
+│   │   └── disco-dreamer.svg
+│   ├── components/
+│   │   ├── GameScreen/index.tsx
+│   │   └── Message/index.tsx
+│   ├── index.html       # HTML page and canvas
+│   ├── index.tsx        # Root scene component
+│   ├── main.ts          # App registration
+│   └── main.css         # Canvas and page styles
+├── package.json
+├── tsconfig.json
+└── vite.config.js
+```
+
+## Commands
+
+Run these inside your generated project:
+
+| Command | Description |
+| --- | --- |
+| `npm run dev` | Start the development server. |
+| `npm run typecheck` | Check TypeScript without emitting files. |
+| `npm run build` | Check types and build the app into `dist/`. |
+| `npm run preview` | Preview the production build locally after building. |
+
+## CLI options
+
+```sh
+npx create-dreamer-app@latest [directory] [--skip-install]
+```
+
+Omit the directory to choose a name interactively. The destination must be a new or empty directory.
+
+| Option | Description |
+| --- | --- |
+| `--skip-install` | Create the project without installing dependencies. |
+| `-h`, `--help` | Show usage information. |
+
+To install dependencies yourself:
+
+```sh
+npx create-dreamer-app@latest my-dreamer-app --skip-install
+cd my-dreamer-app
+npm install
+npm run dev
+```
+
+## License
+
+ISC

package/index.js

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const readline = require("node:readline/promises");
+const { spawnSync } = require("node:child_process");
+
+const usage = `Usage: create-dreamer-app [directory] [--skip-install]
+
+Create a Disco Dreamer app and install its dependencies.
+If no directory is supplied, you will be prompted for one.
+
+Options:
+  --skip-install  Create the project without running npm install
+  -h, --help      Show this help message
+
+Example:
+  npx create-dreamer-app my-dreamer-app`;
+
+async function main() {
+  const args = process.argv.slice(2);
+  if (args.includes("--help") || args.includes("-h")) {
+    console.log(usage);
+    return;
+  }
+
+  const unknownOption = args.find((arg) => arg.startsWith("-") && arg !== "--skip-install");
+  if (unknownOption) throw new Error(`Unknown option: ${unknownOption}\n\n${usage}`);
+  const directories = args.filter((arg) => arg !== "--skip-install");
+  if (directories.length > 1) throw new Error(`Supply only one project directory.\n\n${usage}`);
+
+  let directory = directories[0];
+  if (directory === undefined) {
+    if (!process.stdin.isTTY) throw new Error(`Supply a project directory.\n\n${usage}`);
+    const prompt = readline.createInterface({ input: process.stdin, output: process.stdout });
+    try {
+      directory = (await prompt.question("Project directory (my-dreamer-app): ")).trim() || "my-dreamer-app";
+    } finally {
+      prompt.close();
+    }
+  }
+  if (!directory.trim()) throw new Error("The project directory cannot be empty.");
+
+  const destination = path.resolve(directory);
+  const name = path.basename(destination).toLowerCase().replace(/[^a-z0-9._-]+/g, "-");
+  if (!/^[a-z0-9][a-z0-9._-]*$/.test(name) || name.length > 214 || ["node_modules", "favicon.ico"].includes(name)) {
+    throw new Error("Choose a directory whose name starts with a letter or number and can be used as an npm package name.");
+  }
+
+  // Refuse symlinks and nonempty directories before copying any files.
+  try {
+    const stat = await fs.lstat(destination);
+    if (!stat.isDirectory() || (await fs.readdir(destination)).length > 0) {
+      throw new Error(`Destination already exists and is not an empty directory: ${destination}`);
+    }
+  } catch (error) {
+    if (error.code !== "ENOENT") throw error;
+  }
+
+  console.log(`Creating ${name} in ${destination}...`);
+  await fs.cp(path.join(__dirname, "template"), destination, {
+    recursive: true,
+    force: false,
+    errorOnExist: true,
+    filter: (source) => ![".DS_Store", "node_modules", "dist"].includes(path.basename(source)),
+  });
+  const packagePath = path.join(destination, "package.json");
+  const manifest = JSON.parse(await fs.readFile(packagePath, "utf8"));
+  manifest.name = name;
+  await fs.writeFile(packagePath, `${JSON.stringify(manifest, null, 2)}\n`);
+
+  const skipInstall = args.includes("--skip-install");
+  if (!skipInstall) {
+    console.log("Installing dependencies...");
+    const result = spawnSync(process.platform === "win32" ? "npm.cmd" : "npm", ["install"], {
+      cwd: destination,
+      stdio: "inherit",
+      shell: process.platform === "win32",
+    });
+    if (result.error || result.status !== 0) {
+      throw new Error(`Dependency installation failed${result.error ? `: ${result.error.message}` : ""}. Your project files are saved in ${destination}. Run npm install there to retry.`);
+    }
+  }
+
+  console.log(`\nCreated ${name}!\n\nNext steps:`);
+  if (destination !== process.cwd()) console.log(`  cd ${JSON.stringify(path.relative(process.cwd(), destination))}`);
+  if (skipInstall) console.log("  npm install");
+  console.log("  npm run dev");
+}
+
+main().catch((error) => {
+  console.error(`\nError: ${error.message}`);
+  process.exitCode = 1;
+});

package/package.json

@@ -1,6 +1,14 @@
 {
   "name": "create-dreamer-app",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.2",
+  "description": "The scaffolding application for using Disco Dreamer.",
+  "main": "index.js",
+  "bin": {
+    "create-dreamer-app": "index.js"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/template/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "mydreamerapp",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "vite",
+    "typecheck": "tsc --noEmit",
+    "build": "npm run typecheck && vite build",
+    "preview": "vite preview"
+  },
+  "type": "module",
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^26.6.4",
+    "typescript": "^7.0.2",
+    "vite": "^8.3.2"
+  },
+  "dependencies": {
+    "discodreamer": "^1.0.0"
+  }
+}

package/template/src/assets/disco-dreamer.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="280" height="64" viewBox="0 0 280 64" role="img" aria-labelledby="title">
+  <title id="title">Disco Dreamer</title>
+  <text x="140" y="32" dominant-baseline="middle" text-anchor="middle" fill="#a78bfa" font-family="system-ui, sans-serif" font-size="32" font-weight="700">Disco Dreamer</text>
+</svg>

package/template/src/components/GameScreen/index.tsx

@@ -0,0 +1,10 @@
+import { Scene } from "discodreamer";
+import { Message } from "../Message";
+
+export function GameScreen() {
+    // Hello :D
+
+    return <Scene>
+        <Message />
+    </Scene>;
+}

package/template/src/components/Message/index.tsx

@@ -0,0 +1,6 @@
+import { Text } from "discodreamer";
+
+export function Message() {
+
+    return <Text value="Howdy" />;
+}

package/template/src/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>My Dreamer App!</title>
+    <link rel="stylesheet" href="./main.css">
+    <script type="module" src="./main.ts"></script>
+</head>
+<body>
+    <canvas id="c"></canvas>
+</body>
+</html>

package/template/src/index.tsx

@@ -0,0 +1,8 @@
+import { Scene } from "discodreamer";
+import { GameScreen } from "./components/GameScreen";
+
+export function Main() {
+    return <Scene>
+        <GameScreen />
+    </Scene>;
+};

package/template/src/main.css

@@ -0,0 +1,17 @@
+html, body {
+    margin: 0;
+    border: none;
+    padding: 0;
+}
+
+html, body {
+    width: 100vw;
+    height: 100vh;
+    overflow: hidden;
+}
+
+#c {
+    width: 100%;
+    height: 100%;
+    background-color: black;
+}

package/template/src/main.ts

@@ -0,0 +1,6 @@
+import { registerRoot } from "discodreamer";
+import { Main } from "./index.js";
+
+window.addEventListener("load", () => {
+    registerRoot(Main);
+});

package/template/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "noEmit": true,
+    "target": "esnext",
+    "lib": ["esnext", "DOM"],
+    "types": ["vite/client"],
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": false,
+    "strict": true,
+    "jsx": "preserve",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"]
+}

package/template/vite.config.js

@@ -0,0 +1,27 @@
+import { defineConfig } from "vite";
+import { fileURLToPath } from "node:url";
+
+export default defineConfig({
+    root: "src",
+    base: "./",
+    resolve: {
+        alias: {
+            "@": fileURLToPath(new URL("./src", import.meta.url)),
+        },
+    },
+    oxc: {
+        jsxInject: 'import { DreamFactory as __DreamFactory } from "discodreamer"',
+        jsx: {
+            runtime: "classic",
+            pragma: "__DreamFactory",
+            pure: false,
+        },
+    },
+    server: {
+        port: 3000,
+    },
+    build: {
+        outDir: "../dist",
+        emptyOutDir: true,
+    },
+});