@automerge/create-vite-app 2.6.0-subduction.29 → 2.6.0-subduction.30

package/dist/index.js

@@ -1,36 +1,29 @@
 #!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import child_process from "child_process";
+import fs from "node:fs";
+import path from "node:path";
 import { fileURLToPath } from "node:url";
-const execSync = child_process.execSync;
-function main() {
-    const projectName = process.argv[2];
-    if (!projectName) {
-        console.error("Please provide a project name");
-        process.exit(1);
+import { intro, outro, text, isCancel, cancel, log } from "@clack/prompts";
+const detectPackageManager = () => {
+    const ua = process.env.npm_config_user_agent ?? "";
+    return ua.split(" ")[0]?.split("/")[0] || "npm";
+};
+const copy = (src, dest) => {
+    if (fs.statSync(src).isDirectory()) {
+        copyDir(src, dest);
     }
-    const templateDir = path.resolve(fileURLToPath(import.meta.url), "../../template");
-    const root = path.join(process.cwd(), projectName);
-    const write = (file, content) => {
-        const targetPath = path.join(root, file);
-        if (content) {
-            fs.writeFileSync(targetPath, content);
-        }
-        else {
-            copy(path.join(templateDir, file), targetPath);
-        }
-    };
-    fs.mkdirSync(projectName);
-    const files = fs.readdirSync(templateDir);
-    for (const file of files.filter(f => f !== "package.json")) {
-        write(file);
+    else {
+        fs.copyFileSync(src, dest);
     }
-    const pkg = JSON.parse(fs.readFileSync(path.join(templateDir, `package.json`), "utf-8"));
-    pkg.name = projectName;
-    write("package.json", JSON.stringify(pkg, null, 2));
-    write(".gitignore", `
-# Logs
+};
+const copyDir = (srcDir, destDir) => {
+    fs.mkdirSync(destDir, { recursive: true });
+    for (const file of fs.readdirSync(srcDir)) {
+        copy(path.resolve(srcDir, file), path.resolve(destDir, file));
+    }
+};
+// Written here rather than shipped as a template file: npm strips files named
+// .gitignore from published packages, so the template can't carry one directly.
+const GITIGNORE = `# Logs
 logs
 *.log
 npm-debug.log*
@@ -54,25 +47,53 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
-  `);
-    execSync(`cd ${projectName} && npm install`, { stdio: "inherit" });
-}
-main();
-function copy(src, dest) {
-    const stat = fs.statSync(src);
-    if (stat.isDirectory()) {
-        copyDir(src, dest);
+`;
+const main = async () => {
+    intro("create-vite-app · Automerge + Vite + React");
+    let projectName = process.argv[2];
+    if (!projectName) {
+        const answer = await text({
+            message: "Project name?",
+            placeholder: "my-automerge-app",
+            validate: value => value && value.trim().length > 0
+                ? undefined
+                : "Please enter a project name",
+        });
+        if (isCancel(answer)) {
+            cancel("Scaffolding cancelled.");
+            process.exit(0);
+        }
+        projectName = answer.trim();
     }
-    else {
-        fs.copyFileSync(src, dest);
+    const root = path.join(process.cwd(), projectName);
+    if (fs.existsSync(root)) {
+        cancel(`Directory "${projectName}" already exists.`);
+        process.exit(1);
     }
-}
-function copyDir(srcDir, destDir) {
-    fs.mkdirSync(destDir, { recursive: true });
-    for (const file of fs.readdirSync(srcDir)) {
-        const srcFile = path.resolve(srcDir, file);
-        const destFile = path.resolve(destDir, file);
-        copy(srcFile, destFile);
+    const templateDir = path.resolve(fileURLToPath(import.meta.url), "../../template");
+    fs.mkdirSync(root, { recursive: true });
+    for (const file of fs.readdirSync(templateDir)) {
+        if (file === "package.json")
+            continue;
+        copy(path.join(templateDir, file), path.join(root, file));
     }
-}
+    // Copy package.json with the chosen project name.
+    const pkg = JSON.parse(fs.readFileSync(path.join(templateDir, "package.json"), "utf-8"));
+    pkg.name = projectName;
+    fs.writeFileSync(path.join(root, "package.json"), JSON.stringify(pkg, null, 2) + "\n");
+    fs.writeFileSync(path.join(root, ".gitignore"), GITIGNORE);
+    log.success(`Created ${projectName}`);
+    const pm = detectPackageManager();
+    const run = pm === "npm" ? "npm run" : pm;
+    outro([
+        "Next steps:",
+        `  cd ${projectName}`,
+        `  ${pm} install`,
+        `  ${run} dev`,
+    ].join("\n"));
+};
+main().catch(error => {
+    console.error(error);
+    process.exit(1);
+});
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/create-vite-app",
-  "version": "2.6.0-subduction.29",
+  "version": "2.6.0-subduction.30",
   "description": "Create an automerge-repo app which uses Vite",
   "repository": "https://github.com/automerge/automerge-repo/tree/main/packages/create-vite-app",
   "author": "Alex Good <alex@memoryandthought.me>",
@@ -15,8 +15,27 @@
     "access": "public",
     "tag": "subduction"
   },
+  "dependencies": {
+    "@clack/prompts": "^1.4.0"
+  },
   "devDependencies": {
-    "execa": "^8.0.1"
+    "@types/node": "^22.19.19",
+    "execa": "^9.6.1",
+    "typescript": "^6.0.3"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "build": "tsc",

package/template/.github/workflows/deploy.yml

@@ -29,18 +29,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 11
       - name: Set up Node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
-          node-version: 20
-          cache: "npm"
+          node-version: 22
+          cache: pnpm
       - name: Install dependencies
-        run: yarn
+        run: pnpm install
       - name: Build
-        run: yarn build
+        run: pnpm build
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

package/template/.oxlintrc.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["react", "typescript", "import"],
+  "categories": {
+    "correctness": "error"
+  },
+  "ignorePatterns": ["dist"],
+  "settings": {
+    "react": { "version": "19" }
+  }
+}

package/template/README.md

@@ -1,3 +1,37 @@
-# Vite + React + Automerge
+# Automerge + Vite + React
 
-This template provides a minimal vite app with React and Automerge
+A starter app built with [Automerge](https://automerge.org),
+[Vite](https://vite.dev), and React. State is a local-first Automerge document
+that syncs peer-to-peer over a WebSocket sync server and across browser tabs.
+
+## Develop
+
+```sh
+pnpm install
+pnpm dev
+```
+
+Open the app in two tabs (or share the URL, including its `#…` document hash)
+and watch the counter synchronize in real time.
+
+## Build
+
+```sh
+pnpm build
+```
+
+The static site is emitted to `dist/`.
+
+## Lint
+
+```sh
+pnpm lint
+```
+
+Linting uses [oxlint](https://oxc.rs).
+
+## Deploy
+
+A GitHub Pages workflow is included at `.github/workflows/deploy.yml`. If you
+deploy to a project page (`https://<user>.github.io/<repo>/`), set `base` in
+`vite.config.ts` to `"/<repo>/"`.

package/template/index.html

@@ -2,7 +2,6 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Meet Automerge</title>
   </head>

package/template/package.json

@@ -1,30 +1,29 @@
 {
   "name": "projectName",
   "private": true,
-  "version": "1.2.1",
+  "version": "0.0.0",
   "type": "module",
+  "engines": {
+    "node": ">=22.18"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "lint": "oxlint"
   },
   "dependencies": {
-    "@automerge/react": "^2.0.0-beta.5",
-    "react": "^18.3.0",
-    "react-dom": "^18.3.0"
+    "@automerge/react": "^2.5.6",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
   },
   "devDependencies": {
-    "@types/react": "^18.2.64",
-    "@types/react-dom": "^18.2.21",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
-    "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.57.0",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.5",
-    "typescript": "^5.2.2",
-    "vite": "^5.1.6",
-    "vite-plugin-wasm": "^3"
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "@vitejs/plugin-react": "^6.0.2",
+    "oxlint": "^1.67.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.14",
+    "vite-plugin-wasm": "^3.6.0"
   }
 }

package/template/src/main.tsx

@@ -24,7 +24,7 @@ const repo = new Repo({
 const rootDocUrl = `${document.location.hash.substring(1)}`
 let handle
 if (isValidAutomergeUrl(rootDocUrl)) {
-  handle = repo.find(rootDocUrl)
+  handle = await repo.find(rootDocUrl)
 } else {
   handle = repo.create<{ counter?: Counter }>()
   handle.change(d => (d.counter = new Counter()))

package/template/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ESNext",
     "useDefineForClassFields": true,
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
     "module": "ESNext",
     "skipLibCheck": true,
 
@@ -20,6 +20,5 @@
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true
   },
-  "include": ["src"],
-  "references": [{ "path": "./tsconfig.node.json" }]
+  "include": ["src"]
 }

package/template/.eslintrc.cjs

@@ -1,18 +0,0 @@
-module.exports = {
-  root: true,
-  env: { browser: true, es2020: true },
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:react-hooks/recommended",
-  ],
-  ignorePatterns: ["dist", ".eslintrc.cjs"],
-  parser: "@typescript-eslint/parser",
-  plugins: ["react-refresh"],
-  rules: {
-    "react-refresh/only-export-components": [
-      "warn",
-      { allowConstantExport: true },
-    ],
-  },
-}

package/template/tsconfig.node.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "skipLibCheck": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "allowSyntheticDefaultImports": true,
-    "strict": true
-  },
-  "include": ["vite.config.ts"]
-}