kopular 0.4.0 → 0.5.0

package/LLM.md

@@ -8,7 +8,10 @@ not repeated here.
 
 Published as npm `kopular`. Entry points: `kopular` / `kopular/component` (Component),
 `kopular/router` (Router), `kopular/dom` (ambient DOM bindings), `kopular/directives`
-(If), `kopular/http` (Http).
+(If), `kopular/http` (Http). Also ships a bin, `kp` — `npx kp new <dir>` scaffolds a new
+project (the `extern` bindings below, plus the vendor/serve scripts needed to run in a
+browser) rather than requiring it be reconstructed by hand; prefer it over hand-writing
+the section below for a new project.
 
 ## Consuming Kopular from your own KopScript project
 

package/README.md

@@ -235,11 +235,34 @@ real global). It's the one file in this package not compiled from `.ks` — ever
 else avoids the problem by only wrapping JS APIs that take plain positional arguments
 (see `dom.ks`'s `addEventListener(string, handler)`, never an options-object-taking API).
 
+## Starting a new project: `kp new`
+
+Everything in the next section — the `extern` bindings, plus a `vendor/kopular/` copy of
+this package's browser files and an import map pointing at it (a browser can't resolve a
+bare specifier like `"kopular/component"` the way Node's own module resolution does) — is
+boilerplate every Kopular project needs verbatim. Generate it instead of reconstructing it
+by hand (or from memory, if you're an AI agent):
+
+```bash
+npx kp new my-app
+cd my-app
+npm install
+npm start   # builds, vendors kopular's browser files, and serves at :8080
+```
+
+This scaffolds a real, working `Component` (`src/counter.ks` — the same Counter shown
+above), the ambient DOM/Kopular `extern` bindings it needs (`src/kopular_bindings.ks`),
+and a `README.md` that points an AI agent at this package's own `LLM.md` before it starts
+generating code. `kp` ships from this package (not from `kopscript`'s own `ks` CLI) since
+scaffolding a *Kopular* app is a framework concern, not a language one — `ks` stays a
+pure-language tool with no framework knowledge baked in.
+
 ## Using Kopular from another KopScript project
 
 KopScript's own `using "./path";` only resolves relative paths within a project — it has
 no package-import mechanism yet. Cross-package consumption goes through `extern`
-instead, the same way KopScript already describes any other JS/npm dependency:
+instead, the same way KopScript already describes any other JS/npm dependency
+(`kp new` above generates exactly this, if you'd rather not hand-write it):
 
 ```ks
 extern class Component {

package/bin/kp.mjs

@@ -0,0 +1,316 @@
+#!/usr/bin/env node
+// Kopular's own scaffolding CLI — separate from kopscript's `ks` (build/run/
+// watch/check), which stays a pure-language tool with no knowledge of any
+// framework built on top of it. `kp new` generates a *Kopular* app skeleton
+// (a Component, the ambient extern bindings its Render()/Mount() calls
+// need, and the vendor/serve scripts a Kopular app needs to run in a real
+// browser), so it lives here instead — in the package that actually knows
+// what a Kopular app looks like.
+//
+// Hand-written plain JS, not compiled from a .ks source, the same as
+// src/http_runtime.js: filesystem scaffolding isn't a Kopular Component, and
+// KopScript has no object-literal syntax to build the file-content map this
+// needs anyway.
+import { writeFileSync, mkdirSync, existsSync, readdirSync, readFileSync } from "node:fs";
+import { basename, dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
+const kopularPkg = JSON.parse(readFileSync(join(packageRoot, "package.json"), "utf-8"));
+// Read the ranges to generate from Kopular's own package.json rather than
+// hardcoding them a second time here — this file only has to change when the
+// *shape* of a scaffolded project changes, not on every kopular/kopscript release.
+const KOPULAR_RANGE = `^${kopularPkg.version}`;
+const KOPSCRIPT_RANGE = kopularPkg.devDependencies.kopscript;
+
+function packageJsonTemplate(name) {
+  return `{
+  "name": "${name}",
+  "version": "0.1.0",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "ks build src/app.ks && npm run vendor",
+    "vendor": "node scripts/vendor-kopular.mjs",
+    "serve": "node scripts/serve.mjs . 8080",
+    "start": "npm run build && npm run serve"
+  },
+  "dependencies": {
+    "kopular": "${KOPULAR_RANGE}"
+  },
+  "devDependencies": {
+    "kopscript": "${KOPSCRIPT_RANGE}"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}
+`;
+}
+
+const INDEX_HTML_TEMPLATE = `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>Kopular app</title>
+  </head>
+  <body>
+    <!--
+      Compiled output imports Kopular's classes as bare specifiers
+      ("kopular/component", "kopular/router") — real Node module resolution
+      understands that natively via node_modules, but a browser needs an
+      explicit import map, since "kopular/component" isn't a URL on its own.
+      This points at vendor/kopular/ (see scripts/vendor-kopular.mjs), not
+      node_modules/kopular/src/ directly, so the browser never has to be
+      served the whole node_modules tree just to reach two files inside it.
+    -->
+    <script type="importmap">
+      {
+        "imports": {
+          "kopular/component": "/vendor/kopular/component.js",
+          "kopular/router": "/vendor/kopular/router.js"
+        }
+      }
+    </script>
+    <script type="module" src="/src/app.js"></script>
+  </body>
+</html>
+`;
+
+const GITIGNORE_TEMPLATE = `node_modules/
+*.js
+/vendor/
+.DS_Store
+`;
+
+function readmeTemplate(name) {
+  return `# ${name}
+
+A [KopScript](https://www.npmjs.com/package/kopscript) + [Kopular](https://www.npmjs.com/package/kopular) app, scaffolded with \`kp new\`.
+
+## Commands
+
+- \`npm install\`
+- \`npm run build\` — compiles \`src/*.ks\` to JS and vendors Kopular's browser files into \`vendor/\`
+- \`npm run serve\` — serves the app at http://localhost:8080/
+- \`npm start\` — both of the above
+
+## Where to go next
+
+- \`src/counter.ks\` is a real, working Kopular \`Component\` — start there.
+- \`src/kopular_bindings.ks\` declares the ambient DOM and Kopular types this project builds on (see the comments inside it for why these have to be redeclared per-project rather than imported).
+- For routing, dependency injection ("Pure DI" / a composition root), structural directives, or the \`Http\` client, see Kopular's own README and \`node_modules/kopular/LLM.md\`.
+- For the full language reference, see \`node_modules/kopscript/LLM.md\`.
+
+**Working with an AI agent on this project?** Point it at \`node_modules/kopscript/LLM.md\` and \`node_modules/kopular/LLM.md\` first — they're dense, example-verified references written specifically to be loaded as context, not narrative docs.
+`;
+}
+
+const SERVE_MJS_TEMPLATE = `#!/usr/bin/env node
+// Minimal static file server for previewing the compiled app in a real
+// browser. Kept dependency-free on purpose — browsers won't load ES module
+// imports over file://, so anything with \`using\`/\`extern\`-based imports
+// needs to be served over http to actually run.
+import { createServer } from "node:http";
+import { readFile } from "node:fs/promises";
+import { extname, join, resolve } from "node:path";
+
+const root = resolve(process.argv[2] ?? ".");
+const port = Number(process.argv[3] ?? 8080);
+
+const MIME_TYPES = {
+  ".html": "text/html; charset=utf-8",
+  ".js": "text/javascript; charset=utf-8",
+  ".mjs": "text/javascript; charset=utf-8",
+  ".css": "text/css; charset=utf-8",
+  ".json": "application/json; charset=utf-8",
+};
+
+const server = createServer(async (req, res) => {
+  try {
+    let pathname = decodeURIComponent(new URL(req.url, "http://localhost").pathname);
+    if (pathname === "/") pathname = "/index.html";
+    let filePath = join(root, pathname);
+    if (!filePath.startsWith(root)) {
+      res.writeHead(403).end("Forbidden");
+      return;
+    }
+
+    let data;
+    try {
+      data = await readFile(filePath);
+    } catch (err) {
+      // SPA fallback: a path with no file extension is a client-side route
+      // Router would handle once the page loads, not a missing asset — serve
+      // the app shell instead of 404ing. A path that *does* have an
+      // extension (a genuinely missing .js/.css/...) still 404s normally.
+      if (extname(pathname)) throw err;
+      filePath = join(root, "index.html");
+      data = await readFile(filePath);
+    }
+
+    res.writeHead(200, { "Content-Type": MIME_TYPES[extname(filePath)] ?? "application/octet-stream" });
+    res.end(data);
+  } catch {
+    res.writeHead(404).end("Not found");
+  }
+});
+
+server.listen(port, () => {
+  console.log(\`Serving \${root} at http://localhost:\${port}/\`);
+});
+`;
+
+const VENDOR_KOPULAR_MJS_TEMPLATE = `#!/usr/bin/env node
+// Copies the Kopular files the browser actually needs out of node_modules
+// into a small local vendor/ directory — the import map in index.html points
+// here instead of into node_modules directly, since shipping (or even
+// locally serving) the whole node_modules tree just to get a few files out
+// of it is unnecessary.
+//
+// dom.js isn't in the import map itself, but component.js and router.js each
+// import it internally via a relative "./dom.js" — Kopular's own compiled
+// files reference each other as siblings, so all three have to land in the
+// same vendor/kopular/ directory together, not just the two the import map
+// names explicitly.
+import { copyFileSync, mkdirSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const root = join(dirname(fileURLToPath(import.meta.url)), "..");
+const outDir = join(root, "vendor", "kopular");
+mkdirSync(outDir, { recursive: true });
+
+for (const file of ["dom.js", "component.js", "router.js"]) {
+  copyFileSync(join(root, "node_modules", "kopular", "src", file), join(outDir, file));
+}
+
+console.log(\`Vendored kopular/{dom,component,router}.js into \${outDir}\`);
+`;
+
+// Ambient DOM bindings, plus Kopular's own classes redeclared as `extern` —
+// copied verbatim from a real project's working copy. `using` only resolves
+// relative paths within a project (KopScript has no package-import mechanism
+// yet), so it can't reach across the node_modules boundary into Kopular's
+// own .ks sources — every consuming project redeclares this ambient surface
+// once, here.
+const KOPULAR_BINDINGS_KS_TEMPLATE = `// Ambient DOM bindings — describing standing browser globals, not anything
+// Kopular itself exports, so this is just describing the platform.
+extern class Event {
+  Element target { get; }
+  void preventDefault();
+};
+
+extern class Element {
+  string textContent { get; set; }
+  string innerHTML { get; set; }
+  string id { get; set; }
+  string className { get; set; }
+  string href { get; set; }
+  string src { get; set; }
+  string alt { get; set; }
+  void appendChild(Element child);
+  void replaceChild(Element newChild, Element oldChild);
+  void addEventListener(string eventType, (Event) => void handler);
+  void removeEventListener(string eventType, (Event) => void handler);
+  Element querySelector(string selector);
+};
+
+extern class Document {
+  Element createElement(string tagName);
+  Element getElementById(string id);
+  Element body { get; }
+};
+
+extern Document document;
+
+// Kopular's real classes, consumed from the real published "kopular" npm
+// package. \`virtual\` on Render() is what lets a class here \`override\` it.
+extern class Component {
+  constructor();
+  virtual Element Render();
+  void Mount(Element parent);
+  void Update();
+} from "kopular/component";
+
+extern class Router {
+  constructor(Component notFoundPage);
+  void AddRoute(string path, Component page);
+  void Navigate(string path);
+  void Mount(Element parent);
+} from "kopular/router";
+`;
+
+// The same Counter shown in Kopular's own README/LLM.md — real, verified
+// example code, not a placeholder.
+const COUNTER_KS_TEMPLATE = `using "./kopular_bindings";
+
+class Counter : Component {
+  private state<number> Count;
+
+  constructor() : base() {
+    this.Count = state(0);
+    this.Count.Subscribe((number v) => this.Update());
+  }
+
+  public override Element Render() {
+    Element button = document.createElement("button");
+    button.textContent = "Count: " + this.Count.Value;
+    button.addEventListener("click", (Event e) => {
+      this.Count.Value = this.Count.Value + 1;
+    });
+    return button;
+  }
+}
+`;
+
+const APP_KS_TEMPLATE = `using "./kopular_bindings";
+using "./counter";
+
+// The app's root: mounts straight to document.body since there's nothing
+// else in the shell yet. Add a Router and a composition root (see Kopular's
+// README on "Pure DI") once there's more than one page.
+Counter app = new Counter();
+app.Mount(document.body);
+`;
+
+function scaffoldProject(dirPath) {
+  const name = basename(dirPath);
+  if (existsSync(dirPath) && readdirSync(dirPath).length > 0) {
+    console.error(`kp: '${dirPath}' already exists and is not empty`);
+    process.exitCode = 1;
+    return;
+  }
+
+  mkdirSync(join(dirPath, "src"), { recursive: true });
+  mkdirSync(join(dirPath, "scripts"), { recursive: true });
+
+  writeFileSync(join(dirPath, "package.json"), packageJsonTemplate(name), "utf-8");
+  writeFileSync(join(dirPath, "index.html"), INDEX_HTML_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, ".gitignore"), GITIGNORE_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, "README.md"), readmeTemplate(name), "utf-8");
+  writeFileSync(join(dirPath, "scripts", "serve.mjs"), SERVE_MJS_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, "scripts", "vendor-kopular.mjs"), VENDOR_KOPULAR_MJS_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, "src", "kopular_bindings.ks"), KOPULAR_BINDINGS_KS_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, "src", "counter.ks"), COUNTER_KS_TEMPLATE, "utf-8");
+  writeFileSync(join(dirPath, "src", "app.ks"), APP_KS_TEMPLATE, "utf-8");
+
+  console.log(`Created ${name} in ${dirPath}`);
+  console.log("");
+  console.log("Next steps:");
+  console.log(`  cd ${name}`);
+  console.log("  npm install");
+  console.log("  npm start");
+}
+
+function main() {
+  const [command, dir] = process.argv.slice(2);
+  if (command !== "new" || !dir) {
+    console.error("Usage: kp new <project-directory>");
+    process.exitCode = 1;
+    return;
+  }
+  scaffoldProject(resolve(dir));
+}
+
+main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kopular",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Kopular: a small component framework for KopScript — components, reactive state, constructor-injected services, routing, structural directives, and HTTP, with no template DSL and no DI container",
   "type": "module",
   "license": "MIT",
@@ -16,6 +16,9 @@
     "ui"
   ],
   "main": "./src/component.js",
+  "bin": {
+    "kp": "./bin/kp.mjs"
+  },
   "exports": {
     ".": "./src/component.js",
     "./component": "./src/component.js",
@@ -26,6 +29,7 @@
   },
   "files": [
     "src",
+    "bin",
     "assets",
     "LLM.md"
   ],
@@ -36,7 +40,7 @@
     "test:watch": "vitest"
   },
   "devDependencies": {
-    "kopscript": "^0.3.0",
+    "kopscript": "^0.4.0",
     "@types/jsdom": "^30.0.0",
     "@types/node": "^20.14.0",
     "jsdom": "^25.0.1",