create-codebase-snapshot 0.0.0-stage → 2.1.1

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# create-codebase-snapshot
 
-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.
+Sets up [`@ankurhalder/codebase-snapshot`](https://www.npmjs.com/package/@ankurhalder/codebase-snapshot)
+in the current repository.
+
+```bash
+npm create codebase-snapshot
+```
+
+It detects the project type, asks a handful of questions with sensible defaults,
+and writes a `snapshot.config.mjs` that lists **every setting at its default** —
+so the config doubles as the documentation.
+
+```bash
+npm create codebase-snapshot -- --preset react-vite --yes
+```
+
+| Option | Effect |
+| :--- | :--- |
+| `--preset <name>` | Force a project preset instead of detecting one |
+| `--yes` | Accept every default without prompting |
+| `--minimal` | Write only the settings that differ from defaults |
+| `--force` | Overwrite an existing config |
+
+This package is a shim: the wizard itself lives in the main package, so
+`npx @ankurhalder/codebase-snapshot init` does exactly the same thing.

package/index.mjs

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+import { PromptCancelled, runInit } from "@ankurhalder/codebase-snapshot";
+
+/**
+ * `npm create codebase-snapshot`
+ *
+ * A thin shim over the same wizard the main package exposes, so there is exactly
+ * one prompt implementation to keep working. Everything it does is available as
+ * `npx @ankurhalder/codebase-snapshot init`; this entry point only exists because
+ * `npm create <x>` is the convention developers reach for first.
+ */
+
+const argv = process.argv.slice(2);
+
+if (argv.includes("--help") || argv.includes("-h")) {
+  process.stderr.write(
+    [
+      "create-codebase-snapshot",
+      "",
+      "  Sets up @ankurhalder/codebase-snapshot in the current directory.",
+      "",
+      "  Usage:",
+      "    npm create codebase-snapshot",
+      "",
+      "  Options:",
+      "    --preset <name>   Force a project preset instead of detecting one",
+      "    --yes             Accept every default without prompting",
+      "    --minimal         Write only the settings that differ from defaults",
+      "    --force           Overwrite an existing config",
+      "",
+    ].join("\n")
+  );
+  process.exit(0);
+}
+
+const takeValue = (flag) => {
+  const index = argv.indexOf(flag);
+  if (index === -1) return undefined;
+  const value = argv[index + 1];
+  return value && !value.startsWith("-") ? value : undefined;
+};
+
+try {
+  const result = await runInit({
+    cwd: process.cwd(),
+    preset: takeValue("--preset"),
+    yes: argv.includes("--yes"),
+    minimal: argv.includes("--minimal"),
+    force: argv.includes("--force"),
+  });
+
+  if (!result.written) {
+    process.exit(0);
+  }
+
+  process.stderr.write(`\n✅ Created ${result.configPath} (preset: ${result.preset})\n`);
+  if (result.scripts.length > 0) {
+    process.stderr.write(`   Added npm scripts: ${result.scripts.join(", ")}\n`);
+  }
+  if (result.gitignoreEntries.length > 0) {
+    process.stderr.write(`   Added to .gitignore: ${result.gitignoreEntries.join(", ")}\n`);
+  }
+  for (const note of result.notes) process.stderr.write(`   ⚠ ${note}\n`);
+  process.stderr.write("\n   Next:  npm run snapshot\n\n");
+} catch (err) {
+  if (err instanceof PromptCancelled) {
+    process.stderr.write("\n❌ Cancelled.\n");
+    process.exit(1);
+  }
+  process.stderr.write(`\n❌ ${err instanceof Error ? err.message : String(err)}\n`);
+  process.exit(1);
+}

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "create-codebase-snapshot",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.1.1",
+  "description": "Set up @ankurhalder/codebase-snapshot in a repository",
+  "license": "MIT",
+  "author": "Ankur Halder <ankur.halder12345@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ankurhalder/codebase-snapshot.git",
+    "directory": "packages/create"
+  },
+  "homepage": "https://github.com/ankurhalder/codebase-snapshot#readme",
+  "bugs": {
+    "url": "https://github.com/ankurhalder/codebase-snapshot/issues"
+  },
+  "type": "module",
+  "bin": {
+    "create-codebase-snapshot": "./index.mjs"
+  },
+  "files": [
+    "index.mjs",
+    "README.md"
+  ],
+  "dependencies": {
+    "@ankurhalder/codebase-snapshot": "^2.1.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}