@automerge/create-repo-node-app 2.6.0-subduction.8 → 2.7.0-authors.0

package/README.md

@@ -1,19 +1,17 @@
 # Scaffolding for a node `automerge-repo` app
 
-This generates a simple javascript project with the necessary dependencies for a repo which synchronises over websockets and stores data in the filesystem.
+This generates a simple TypeScript project with the dependencies for a repo that
+synchronises over WebSockets and stores data on the filesystem.
 
 ## How to use
 
-### NPM
-
 ```
 npm create @automerge/repo-node-app <your project name>
 ```
 
-### Yarn
-
-```
-yarn create @automerge/repo-node-app <your project name>
-```
+(or `pnpm create`, `yarn create`, `bun create` — the scaffold detects your
+package manager.)
 
-Now change into the directory and start editing `index.js`
+The project runs with Node's built-in TypeScript support, so there is no build
+step. Change into the directory, install dependencies, and start editing
+`index.ts`.

package/dist/index.js

@@ -1,47 +1,78 @@
 #!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import child_process from "child_process";
-const execSync = child_process.execSync;
-function createPackageJson(projectName) {
-    const packageJson = {
-        name: projectName,
-        version: "1.0.0",
-        description: "",
-        main: "index.js",
-        type: "module",
-        scripts: {
-            start: "node index.js",
-        },
-        dependencies: {
-            "@automerge/automerge-repo": "^1.0",
-            "@automerge/automerge-repo-network-websocket": "^1.0",
-            "@automerge/automerge-repo-storage-nodefs": "^1.0",
-        },
-    };
-    fs.writeFileSync(path.join(projectName, "package.json"), JSON.stringify(packageJson, null, 2) + "\n");
-}
-function createIndexJs(projectName) {
-    const indexJsContent = `import { Repo } from "@automerge/automerge-repo"
-import { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket"
-import { NodeFSStorageAdapter } from "@automerge/automerge-repo-storage-nodefs"
-
-const repo = new Repo({
-  storage: new NodeFSStorageAdapter("./db"),
-  network: [new WebSocketClientAdapter("wss://sync.automerge.org")]
-})
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+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);
+    }
+    else {
+        fs.copyFileSync(src, dest);
+    }
+};
+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 = `node_modules
+automerge-data
+*.log
 `;
-    fs.writeFileSync(path.join(projectName, "index.js"), indexJsContent);
-}
-function main() {
-    const projectName = process.argv[2];
+const main = async () => {
+    intro("create-repo-node-app · Automerge for Node");
+    let projectName = process.argv[2];
     if (!projectName) {
-        console.error("Please provide a project name");
+        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();
+    }
+    const root = path.join(process.cwd(), projectName);
+    if (fs.existsSync(root)) {
+        cancel(`Directory "${projectName}" already exists.`);
         process.exit(1);
     }
-    fs.mkdirSync(projectName);
-    createPackageJson(projectName);
-    createIndexJs(projectName);
-    execSync(`cd ${projectName} && npm install`, { stdio: "inherit" });
-}
-main();
+    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} start`,
+    ].join("\n"));
+};
+main().catch(error => {
+    console.error(error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,18 +1,36 @@
 {
   "name": "@automerge/create-repo-node-app",
-  "version": "2.6.0-subduction.8",
+  "version": "2.7.0-authors.0",
   "description": "Create an automerge-repo app for node",
-  "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/create-repo-node-app",
+  "repository": "https://github.com/automerge/automerge-repo/tree/main/packages/create-repo-node-app",
   "author": "Alex Good <alex@memoryandthought.me>",
   "license": "MIT",
   "type": "module",
-  "bin": "dist/index.js",
+  "files": [
+    "dist/index.js",
+    "template"
+  ],
   "publishConfig": {
     "access": "public",
     "tag": "subduction"
   },
+  "dependencies": {
+    "@clack/prompts": "^1.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.19",
+    "execa": "^9.6.1",
+    "typescript": "^6.0.3"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
   "scripts": {
     "build": "tsc",
-    "postbuild": "node postbuild.js"
+    "postbuild": "node postbuild.js",
+    "test": "node test.js"
+  },
+  "bin": {
+    "create-repo-node-app": "dist/index.js"
   }
 }

package/template/.oxlintrc.json

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

package/template/README.md

@@ -0,0 +1,28 @@
+# Automerge node app
+
+A starter [Automerge](https://automerge.org) app for Node. It keeps a repo of
+documents on the local filesystem and syncs them with a WebSocket sync server.
+
+## Run
+
+```sh
+pnpm install
+pnpm start
+```
+
+`pnpm start` runs `index.ts` directly using Node's built-in TypeScript support
+(Node 22.18+), so there is no build step. Edit `index.ts` to build your app.
+
+## Type-check
+
+```sh
+pnpm typecheck
+```
+
+## Lint
+
+```sh
+pnpm lint
+```
+
+Linting uses [oxlint](https://oxc.rs).

package/template/index.ts

@@ -0,0 +1,20 @@
+import { Repo } from "@automerge/automerge-repo"
+import { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket"
+import { NodeFSStorageAdapter } from "@automerge/automerge-repo-storage-nodefs"
+
+// A repo that persists documents to the local filesystem and syncs them with a
+// WebSocket sync server. Point the adapter at your own server for production.
+const repo = new Repo({
+  storage: new NodeFSStorageAdapter("./automerge-data"),
+  network: [new WebSocketClientAdapter("wss://sync.automerge.org")],
+})
+
+// Create a document and make a change. Share `handle.url` with another peer
+// (or load it elsewhere) to sync the same document.
+const handle = repo.create<{ count: number }>({ count: 0 })
+handle.change(doc => {
+  doc.count += 1
+})
+
+console.log(`Created document: ${handle.url}`)
+console.log("Syncing… press Ctrl+C to stop.")

package/template/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "projectName",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "engines": {
+    "node": ">=22.18"
+  },
+  "scripts": {
+    "start": "node index.ts",
+    "typecheck": "tsc",
+    "lint": "oxlint"
+  },
+  "dependencies": {
+    "@automerge/automerge-repo": "^2.5.6",
+    "@automerge/automerge-repo-network-websocket": "^2.5.6",
+    "@automerge/automerge-repo-storage-nodefs": "^2.5.6"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.0",
+    "oxlint": "^1.67.0",
+    "typescript": "^6.0.3"
+  }
+}

package/template/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "types": ["node"]
+  },
+  "include": ["*.ts"]
+}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/postbuild.js

@@ -1,3 +0,0 @@
-import fs from "fs"
-
-fs.chmodSync("dist/index.js", "755")

package/src/index.ts

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-
-import fs from "fs"
-import path from "path"
-import child_process from "child_process"
-
-const execSync = child_process.execSync
-
-function createPackageJson(projectName: string) {
-  const packageJson = {
-    name: projectName,
-    version: "1.0.0",
-    description: "",
-    main: "index.js",
-    type: "module",
-    scripts: {
-      start: "node index.js",
-    },
-    dependencies: {
-      "@automerge/automerge-repo": "^1.0",
-      "@automerge/automerge-repo-network-websocket": "^1.0",
-      "@automerge/automerge-repo-storage-nodefs": "^1.0",
-    },
-  }
-  fs.writeFileSync(
-    path.join(projectName, "package.json"),
-    JSON.stringify(packageJson, null, 2) + "\n"
-  )
-}
-
-function createIndexJs(projectName: string) {
-  const indexJsContent = `import { Repo } from "@automerge/automerge-repo"
-import { WebSocketClientAdapter } from "@automerge/automerge-repo-network-websocket"
-import { NodeFSStorageAdapter } from "@automerge/automerge-repo-storage-nodefs"
-
-const repo = new Repo({
-  storage: new NodeFSStorageAdapter("./db"),
-  network: [new WebSocketClientAdapter("wss://sync.automerge.org")]
-})
-`
-  fs.writeFileSync(path.join(projectName, "index.js"), indexJsContent)
-}
-
-function main() {
-  const projectName = process.argv[2]
-  if (!projectName) {
-    console.error("Please provide a project name")
-    process.exit(1)
-  }
-
-  fs.mkdirSync(projectName)
-  createPackageJson(projectName)
-  createIndexJs(projectName)
-  execSync(`cd ${projectName} && npm install`, { stdio: "inherit" })
-}
-
-main()

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "jsx": "react",
-    "module": "NodeNext",
-    "moduleResolution": "Node16",
-    "declaration": true,
-    "declarationMap": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["dist"]
-}

package/vitest.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig, mergeConfig } from "vitest/config"
-import rootConfig from "../../vitest.config"
-
-export default mergeConfig(
-  rootConfig,
-  defineConfig({
-    test: {
-      environment: "node",
-    },
-  })
-)