create-reactwright-doc 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reactwright contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# create-reactwright-doc
+
+Scaffolds a new Reactwright document with the template of your choice.
+
+## Quick start
+
+```sh
+npm create reactwright-doc@latest my-doc -- --template=essay
+cd my-doc
+npm install
+npm run build
+```
+
+## Templates
+
+| Flag | Package | Description |
+|------|---------|-------------|
+| `--template=essay` (default) | `@reactwright/template-essay` | MLA-style academic essay, Times 12pt double-spaced, Works Cited bibliography |
+| `--template=ieee` | `@reactwright/template-ieee` | IEEE conference paper, two-column, numbered sections, numeric citations |
+| `--template=report` | `@reactwright/template-report` | Technical/business report, single-spaced, decimal section numbering |
+
+## What you get
+
+```
+my-doc/
+├── package.json     # deps: reactwright + chosen template + react
+├── my-doc.tsx       # starter document using <Template />
+└── README.md        # build + edit instructions
+```
+
+The starter is intentionally minimal — replace the bodies, add sections,
+ship.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "create-reactwright-doc",
+  "version": "0.1.0",
+  "description": "Scaffolder for new Reactwright documents.",
+  "license": "MIT",
+  "author": "Reactwright contributors",
+  "homepage": "https://github.com/PurpleReverie/reactwright/tree/main/packages/create-reactwright-doc#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PurpleReverie/reactwright.git",
+    "directory": "packages/create-reactwright-doc"
+  },
+  "bugs": {
+    "url": "https://github.com/PurpleReverie/reactwright/issues"
+  },
+  "keywords": ["reactwright", "scaffolder", "create-app"],
+  "type": "module",
+  "bin": {
+    "create-reactwright-doc": "./src/index.js"
+  },
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "check": "node --check src/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.js

@@ -0,0 +1,306 @@
+#!/usr/bin/env node
+// Scaffolder for new Reactwright documents.
+//
+// Usage:
+//   npm create reactwright-doc my-doc -- --template=essay
+//   npx create-reactwright-doc my-doc --template=ieee
+//
+// Creates <my-doc>/ with:
+//   - package.json declaring deps on reactwright + the chosen template
+//   - <my-doc>.tsx using <Template /> from the template package
+//   - README.md with build instructions
+
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+
+const TEMPLATES = {
+  essay: {
+    pkg: "@reactwright/template-essay",
+    description: "MLA-style academic essay (Times 12pt double-spaced, Works Cited)"
+  },
+  ieee: {
+    pkg: "@reactwright/template-ieee",
+    description: "IEEE conference paper (two-column, numbered sections, numeric citations)"
+  },
+  "ieee-report": {
+    pkg: "@reactwright/template-ieee-report",
+    description: "IEEE technical report (single-column long-form, Roman section numbering)"
+  },
+  report: {
+    pkg: "@reactwright/template-report",
+    description: "Technical/business report (single-spaced, decimal section numbering)"
+  },
+  book: {
+    pkg: "@reactwright/template-book",
+    description: "Long-form chaptered book (5.5×8.5 trade paperback, Georgia serif)"
+  },
+  letter: {
+    pkg: "@reactwright/template-letter",
+    description: "Formal business letter (one-page, named regions: letterhead, addressee, …)"
+  }
+};
+
+const REACTWRIGHT_VERSION = "^0.2.0";
+const TEMPLATE_VERSION = "^0.1.0";
+
+function parseArgs(argv) {
+  let name = null;
+  let template = "essay";
+  for (const arg of argv) {
+    if (arg.startsWith("--template=")) {
+      template = arg.slice("--template=".length);
+    } else if (arg === "--help" || arg === "-h") {
+      return { help: true };
+    } else if (!arg.startsWith("--") && name == null) {
+      name = arg;
+    }
+  }
+  return { name, template };
+}
+
+function printHelp() {
+  console.log(`create-reactwright-doc — scaffold a new Reactwright document
+
+Usage:
+  npm create reactwright-doc <name> -- --template=<template>
+  npx create-reactwright-doc <name> --template=<template>
+
+Templates:
+${Object.entries(TEMPLATES).map(([k, v]) => `  ${k.padEnd(12)}  ${v.description}`).join("\n")}
+
+Defaults: --template=essay
+
+After scaffolding:
+  cd <name>
+  npm install
+  npm run build
+`);
+}
+
+function fail(message) {
+  console.error(`Error: ${message}`);
+  process.exit(1);
+}
+
+function main() {
+  const args = parseArgs(process.argv.slice(2));
+  if (args.help) {
+    printHelp();
+    return;
+  }
+  if (!args.name) {
+    fail("Missing project name.\nUsage: npm create reactwright-doc my-doc -- --template=essay");
+  }
+  const template = TEMPLATES[args.template];
+  if (!template) {
+    fail(`Unknown template '${args.template}'. Available: ${Object.keys(TEMPLATES).join(", ")}.`);
+  }
+
+  const targetDir = path.resolve(process.cwd(), args.name);
+  if (fs.existsSync(targetDir)) {
+    fail(`Directory already exists: ${targetDir}`);
+  }
+  fs.mkdirSync(targetDir, { recursive: true });
+
+  const entryFile = `${args.name}.tsx`;
+  const pkg = {
+    name: args.name,
+    version: "0.1.0",
+    private: true,
+    type: "module",
+    scripts: {
+      build: `reactwright ${entryFile} --format html,pdf --out .`
+    },
+    dependencies: {
+      [template.pkg]: TEMPLATE_VERSION,
+      react: "^19.0.0",
+      reactwright: REACTWRIGHT_VERSION
+    }
+  };
+
+  fs.writeFileSync(
+    path.join(targetDir, "package.json"),
+    JSON.stringify(pkg, null, 2) + "\n"
+  );
+
+  fs.writeFileSync(
+    path.join(targetDir, entryFile),
+    starterTsx(args.template, args.name)
+  );
+
+  fs.writeFileSync(
+    path.join(targetDir, "README.md"),
+    starterReadme(args.name, args.template, entryFile)
+  );
+
+  console.log(`✓ Created ${args.name}/
+
+  ${args.name}/
+  ├── package.json
+  ├── ${entryFile}
+  └── README.md
+
+Next steps:
+  cd ${args.name}
+  npm install
+  npm run build
+
+The build outputs ${args.name.replace(/\W/g, "_")}.html and ${args.name.replace(/\W/g, "_")}.pdf alongside the source.
+`);
+}
+
+function starterTsx(templateKey, name) {
+  const template = TEMPLATES[templateKey];
+  if (templateKey === "letter") {
+    return `import "reactwright/jsx";
+import { Template } from "${template.pkg}";
+
+export { Template };
+
+export default function Document() {
+  return (
+    <document title="${name}" author="Sender Name">
+      <section role="letterhead" title="Sender Name">
+        <p>123 Example Street</p>
+        <p>City, ST 00000</p>
+        <p>sender@example.com</p>
+      </section>
+
+      <section role="date" title="">
+        <p>1 January 2026</p>
+      </section>
+
+      <section role="addressee" title="">
+        <p>Recipient Name</p>
+        <p>Recipient Title</p>
+        <p>Organization</p>
+        <p>Recipient Address</p>
+      </section>
+
+      <section role="salutation" title="">
+        <p>Dear Recipient,</p>
+      </section>
+
+      <p>
+        Write your opening paragraph here. Replace this starter prose
+        with the substance of your letter.
+      </p>
+
+      <section role="closing" title="">
+        <p>Sincerely,</p>
+      </section>
+
+      <section role="signature" title="">
+        <p>Sender Name</p>
+        <p>Sender Title</p>
+      </section>
+    </document>
+  );
+}
+`;
+  }
+  if (templateKey === "book") {
+    return `import "reactwright/jsx";
+import { Template } from "${template.pkg}";
+
+export { Template };
+
+export default function Document() {
+  return (
+    <document title="${name}" author="A. Author">
+      <section role="title-page" title="${name}">
+        <p>A. Author</p>
+      </section>
+
+      <section role="front-matter" title="Copyright">
+        <p>Copyright © 2026 A. Author. All rights reserved.</p>
+      </section>
+
+      <section role="chapter" title="The First Chapter">
+        <set running="chapter-title" value="The First Chapter" />
+        <p>
+          Welcome to your new book. Replace this opening paragraph with
+          your prose. Each <code>{"<section role=\\"chapter\\">"}</code> becomes
+          a chapter that starts on a fresh page.
+        </p>
+      </section>
+
+      <section role="back-matter" title="Acknowledgments">
+        <p>Thanks to everyone who made this possible.</p>
+      </section>
+    </document>
+  );
+}
+`;
+  }
+  return `import "reactwright/jsx";
+import { Template } from "${template.pkg}";
+
+export { Template };
+
+export default function Document() {
+  return (
+    <document title="${name}" author="Anonymous">
+      <section title="Introduction">
+        <p>
+          Welcome to your new Reactwright document. Edit this file to
+          replace the starter content. Anything you can express in JSX
+          flows through the engine to paginated HTML and PDF.
+        </p>
+        <p>
+          See <a href="https://github.com/PurpleReverie/reactwright">the
+          documentation</a> for the full primitive vocabulary.
+        </p>
+      </section>
+
+      <section title="Next steps">
+        <p>
+          Try editing this section. Add more sections. Drop in figures,
+          tables, citations. Run <code>npm run build</code> to regenerate
+          the PDF.
+        </p>
+      </section>
+
+      <refs>
+        <ref-entry refKey="example">
+          Example, A. (2026). <em>A Placeholder Reference</em>. Publisher.
+        </ref-entry>
+      </refs>
+    </document>
+  );
+}
+`;
+}
+
+function starterReadme(name, templateKey, entryFile) {
+  return `# ${name}
+
+A Reactwright document scaffolded with \`create-reactwright-doc --template=${templateKey}\`.
+
+## Build
+
+\`\`\`sh
+npm install
+npm run build
+\`\`\`
+
+This produces \`${entryFile.replace(/\.tsx$/, ".html")}\` and \`${entryFile.replace(/\.tsx$/, ".pdf")}\`.
+
+## Edit
+
+Edit \`${entryFile}\` to write your document. Reactwright primitives like
+\`<section>\`, \`<p>\`, \`<figure>\`, \`<table>\`, and \`<cite>\` are
+declared in JSX; the engine compiles them to paginated HTML + PDF.
+
+Replace the bibliography stub with your real references in the
+\`<refs>\` block, then cite them via \`<cite cite="key" />\`.
+
+## Learn more
+
+- Reactwright docs: https://github.com/PurpleReverie/reactwright
+- Template (${templateKey}): https://github.com/PurpleReverie/reactwright/tree/main/packages/template-${templateKey}
+`;
+}
+
+main();