create-dokio 0.1.17 → 0.1.18

package/README.md

@@ -113,6 +113,26 @@ cp tools/changelog/.env.example tools/changelog/.env
 
 ---
 
+### `create-dokio repair`
+
+**Run this once after cloning a hub repo.** Hooks live in `.githooks/`, but Git activates them via `core.hooksPath` — a setting stored in `.git/config`, which is **never committed or cloned**. So a fresh clone has the hook files but they don't run: the commit-message check is skipped and changelogs stop auto-updating. Git cannot enable repo hooks automatically on clone (security), so every machine must opt in once.
+
+```bash
+# from inside a cloned hub repo (e.g. bupa-sam-templates/)
+npx --yes create-dokio@latest repair
+```
+
+**What it does:**
+- Sets `git config core.hooksPath .githooks` for this clone (the actual fix)
+- Re-writes the managed tooling to the latest version (`.githooks/commit-msg`, `.githooks/post-commit`, `tools/changelog/update_changelog.py`)
+- Ensures `.vscode/settings.json`, `tools/changelog/.env.example`, and `.gitignore` entries exist
+
+Safe to re-run any time — it never touches your template content or `tools/changelog/.env`.
+
+> **Teammates:** if your commit messages aren't being checked, or template `CHANGELOG.md` files aren't updating on commit, you haven't run `repair` on your clone yet.
+
+---
+
 ## Template types
 
 ### PDF

package/dist/index.js

@@ -2,12 +2,12 @@
 
 // src/index.ts
 import prompts3 from "prompts";
-import kleur6 from "kleur";
+import kleur7 from "kleur";
 import { createRequire } from "module";
 
 // src/template.ts
-import { join as join3 } from "path";
-import fse3 from "fs-extra";
+import { join as join4 } from "path";
+import fse4 from "fs-extra";
 import kleur4 from "kleur";
 
 // src/prompts.ts
@@ -878,10 +878,15 @@ function buildFiles(config) {
 }
 
 // src/git.ts
-import { join, basename } from "path";
+import { join as join2, basename } from "path";
+import { execSync as execSync2 } from "child_process";
+import fse2 from "fs-extra";
+import kleur2 from "kleur";
+
+// src/hubSetup.ts
+import { join } from "path";
 import { execSync } from "child_process";
 import fse from "fs-extra";
-import kleur2 from "kleur";
 
 // src/templates/changelog.ts
 function changelogScript() {
@@ -1092,91 +1097,112 @@ function changelogEnvExample() {
 `;
 }
 
+// src/hubSetup.ts
+function vscodeSettings() {
+  return JSON.stringify({ "scss.validate": false, "css.validate": false }, null, 2) + "\n";
+}
+var REQUIRED_IGNORES = [".DS_Store", "node_modules/", "*.log", "tools/changelog/.env"];
+var MANAGED = [
+  { rel: ".githooks/commit-msg", content: commitMsgHook, exec: true },
+  { rel: ".githooks/post-commit", content: changelogHook, exec: true },
+  { rel: "tools/changelog/update_changelog.py", content: changelogScript, exec: true }
+];
+var ENSURE = [
+  { rel: "tools/changelog/.env.example", content: changelogEnvExample },
+  { rel: ".vscode/settings.json", content: vscodeSettings }
+];
+async function writeFile(hubDir, file) {
+  const fullPath = join(hubDir, file.rel);
+  await fse.ensureDir(join(fullPath, ".."));
+  await fse.writeFile(fullPath, file.content(), "utf8");
+  if (file.exec) await fse.chmod(fullPath, 493);
+}
+async function syncHubFiles(hubDir, opts) {
+  const written = [];
+  for (const file of MANAGED) {
+    const exists = await fse.pathExists(join(hubDir, file.rel));
+    if (exists && !opts.force) continue;
+    await writeFile(hubDir, file);
+    written.push(`${exists ? "~" : "+"} ${file.rel}`);
+  }
+  for (const file of ENSURE) {
+    if (await fse.pathExists(join(hubDir, file.rel))) continue;
+    await writeFile(hubDir, file);
+    written.push(`+ ${file.rel}`);
+  }
+  const gitignorePath = join(hubDir, ".gitignore");
+  if (!await fse.pathExists(gitignorePath)) {
+    await fse.writeFile(gitignorePath, REQUIRED_IGNORES.join("\n") + "\n", "utf8");
+    written.push("+ .gitignore");
+  } else {
+    const existing = await fse.readFile(gitignorePath, "utf8");
+    const missing = REQUIRED_IGNORES.filter((e) => !existing.includes(e));
+    if (missing.length) {
+      await fse.appendFile(gitignorePath, missing.join("\n") + "\n");
+      written.push(`~ .gitignore (added: ${missing.join(", ")})`);
+    }
+  }
+  return { written };
+}
+function setHooksPath(hubDir) {
+  execSync("git config core.hooksPath .githooks", { cwd: hubDir, stdio: "ignore" });
+}
+
 // src/git.ts
 async function ensureHubRepo(hubId) {
   const cwd = process.cwd();
   const dirName = hubRepoDirName(hubId);
   const alreadyInside = basename(cwd) === dirName;
-  const hubDir = alreadyInside ? cwd : join(cwd, dirName);
-  if (alreadyInside || await fse.pathExists(hubDir)) {
+  const hubDir = alreadyInside ? cwd : join2(cwd, dirName);
+  if (alreadyInside || await fse2.pathExists(hubDir)) {
     console.log(kleur2.dim(`
   \u21BB Pulling latest ${dirName}...`));
-    execSync("git pull", { cwd: hubDir, stdio: "ignore" });
+    execSync2("git pull", { cwd: hubDir, stdio: "ignore" });
   } else {
     console.log(kleur2.dim(`
   \u2193 Cloning ${hubRepoUrl(hubId)}...`));
-    execSync(`git clone ${hubRepoUrl(hubId)}`, { stdio: "inherit" });
+    execSync2(`git clone ${hubRepoUrl(hubId)}`, { stdio: "inherit" });
   }
   return hubDir;
 }
 async function setupHooks(hubDir) {
-  const commitMsgPath = join(hubDir, ".githooks", "commit-msg");
-  if (!await fse.pathExists(commitMsgPath)) {
-    await fse.ensureDir(join(commitMsgPath, ".."));
-    await fse.writeFile(commitMsgPath, commitMsgHook(), "utf8");
-    await fse.chmod(commitMsgPath, 493);
-    console.log(kleur2.dim(`  + .githooks/commit-msg`));
-  }
-  const postCommitPath = join(hubDir, ".githooks", "post-commit");
-  const changelogScriptPath = join(hubDir, "tools", "changelog", "update_changelog.py");
-  if (!await fse.pathExists(changelogScriptPath)) {
-    await fse.ensureDir(join(changelogScriptPath, ".."));
-    await fse.writeFile(changelogScriptPath, changelogScript(), "utf8");
-    await fse.chmod(changelogScriptPath, 493);
-    console.log(kleur2.dim(`  + tools/changelog/update_changelog.py`));
-    const envExamplePath = join(hubDir, "tools", "changelog", ".env.example");
-    await fse.writeFile(envExamplePath, changelogEnvExample(), "utf8");
-    console.log(kleur2.dim(`  + tools/changelog/.env.example`));
-    if (!await fse.pathExists(postCommitPath)) {
-      await fse.writeFile(postCommitPath, changelogHook(), "utf8");
-      await fse.chmod(postCommitPath, 493);
-      console.log(kleur2.dim(`  + .githooks/post-commit`));
-    }
-  }
-  const vscodePath = join(hubDir, ".vscode", "settings.json");
-  if (!await fse.pathExists(vscodePath)) {
-    await fse.ensureDir(join(vscodePath, ".."));
-    await fse.writeFile(vscodePath, JSON.stringify({ "scss.validate": false, "css.validate": false }, null, 2) + "\n", "utf8");
-    console.log(kleur2.dim(`  + .vscode/settings.json`));
-  }
-  const gitignorePath = join(hubDir, ".gitignore");
-  const requiredIgnores = [".DS_Store", "node_modules/", "*.log", "tools/changelog/.env"];
-  if (!await fse.pathExists(gitignorePath)) {
-    await fse.writeFile(gitignorePath, requiredIgnores.join("\n") + "\n", "utf8");
-    console.log(kleur2.dim(`  + .gitignore`));
-  } else {
-    const existing = await fse.readFile(gitignorePath, "utf8");
-    const missing = requiredIgnores.filter((e) => !existing.includes(e));
-    if (missing.length) {
-      await fse.appendFile(gitignorePath, missing.join("\n") + "\n");
-      console.log(kleur2.dim(`  ~ .gitignore (added: ${missing.join(", ")})`));
-    }
-  }
-  const readmePath = join(hubDir, "README.md");
-  if (!await fse.pathExists(readmePath)) {
+  const { written } = await syncHubFiles(hubDir, { force: false });
+  for (const line of written) console.log(kleur2.dim(`  ${line}`));
+  const readmePath = join2(hubDir, "README.md");
+  if (!await fse2.pathExists(readmePath)) {
     const hubName = basename(hubDir);
-    await fse.writeFile(readmePath, `# ${hubName}
+    await fse2.writeFile(readmePath, `# ${hubName}
 
 Templates for ${hubName} on Dokio.
 
+## After cloning (required, once per clone)
+
+Git hooks (commit-message check + auto-changelog) are not active until you run:
+
+\`\`\`
+npx create-dokio repair
+\`\`\`
+
+Git cannot enable repo hooks automatically on clone, so every teammate must run this once.
+
 ## Creating a new template
 
 Run \`create-dokio template\` from inside this repo.
 `, "utf8");
     console.log(kleur2.dim(`  + README.md`));
   }
-  execSync("git config core.hooksPath .githooks", { cwd: hubDir, stdio: "ignore" });
+  setHooksPath(hubDir);
 }
 
 // src/scaffold.ts
-import { join as join2 } from "path";
-import fse2 from "fs-extra";
+import { join as join3 } from "path";
+import fse3 from "fs-extra";
 import kleur3 from "kleur";
 async function writeFiles(outDir, files, fullName) {
   for (const [rel, content] of Object.entries(files)) {
-    const fullPath = join2(outDir, rel);
-    await fse2.ensureDir(join2(fullPath, ".."));
-    await fse2.writeFile(fullPath, content, "utf8");
+    const fullPath = join3(outDir, rel);
+    await fse3.ensureDir(join3(fullPath, ".."));
+    await fse3.writeFile(fullPath, content, "utf8");
     console.log(kleur3.dim(`  + ${fullName}/${rel}`));
   }
 }
@@ -1188,8 +1214,8 @@ async function runTemplate(nameArg) {
   const files = buildFiles(config);
   const hubDir = await ensureHubRepo(config.hubId);
   const hubDirName = hubRepoDirName(config.hubId);
-  const outDir = join3(hubDir, "templates", config.fullName);
-  if (await fse3.pathExists(outDir)) {
+  const outDir = join4(hubDir, "templates", config.fullName);
+  if (await fse4.pathExists(outDir)) {
     console.error(kleur4.red(`
   Error: "${config.fullName}" already exists in ${hubDirName}/templates/.
 `));
@@ -1220,9 +1246,9 @@ async function runTemplate(nameArg) {
 }
 
 // src/hub.ts
-import { join as join4 } from "path";
-import { execSync as execSync2 } from "child_process";
-import fse4 from "fs-extra";
+import { join as join5 } from "path";
+import { execSync as execSync3 } from "child_process";
+import fse5 from "fs-extra";
 import kleur5 from "kleur";
 import prompts2 from "prompts";
 var onCancel2 = () => {
@@ -1251,8 +1277,8 @@ async function runHub() {
   const hubId = answers.hubId.trim();
   const hubName = answers.hubName.trim();
   const dirName = `${hubId}-templates`;
-  const outDir = join4(process.cwd(), dirName);
-  if (await fse4.pathExists(outDir)) {
+  const outDir = join5(process.cwd(), dirName);
+  if (await fse5.pathExists(outDir)) {
     console.error(kleur5.red(`
   Error: "${dirName}" already exists.
 `));
@@ -1274,6 +1300,16 @@ tools/changelog/.env
 
 Templates for ${hubName} on Dokio.
 
+## After cloning (required, once per clone)
+
+Git hooks (commit-message check + auto-changelog) are not active until you run:
+
+\`\`\`
+npx create-dokio repair
+\`\`\`
+
+Git cannot enable repo hooks automatically on clone, so every teammate must run this once.
+
 ## Creating a new template
 
 Run \`create-dokio template\` from inside this repo.
@@ -1281,16 +1317,16 @@ Run \`create-dokio template\` from inside this repo.
   };
   console.log("");
   for (const [rel, content] of Object.entries(files)) {
-    const fullPath = join4(outDir, rel);
-    await fse4.ensureDir(join4(fullPath, ".."));
-    await fse4.writeFile(fullPath, content, "utf8");
-    if (rel === ".githooks/commit-msg" || rel === ".githooks/post-commit" || rel === "tools/changelog/update_changelog.py") await fse4.chmod(fullPath, 493);
+    const fullPath = join5(outDir, rel);
+    await fse5.ensureDir(join5(fullPath, ".."));
+    await fse5.writeFile(fullPath, content, "utf8");
+    if (rel === ".githooks/commit-msg" || rel === ".githooks/post-commit" || rel === "tools/changelog/update_changelog.py") await fse5.chmod(fullPath, 493);
     console.log(kleur5.dim(`  + ${rel}`));
   }
-  execSync2("git init", { cwd: outDir, stdio: "ignore" });
-  execSync2("git config core.hooksPath .githooks", { cwd: outDir, stdio: "ignore" });
-  execSync2("git add .", { cwd: outDir, stdio: "ignore" });
-  execSync2('git commit -m "chore: init Dokio Hub"', { cwd: outDir, stdio: "ignore" });
+  execSync3("git init", { cwd: outDir, stdio: "ignore" });
+  execSync3("git config core.hooksPath .githooks", { cwd: outDir, stdio: "ignore" });
+  execSync3("git add .", { cwd: outDir, stdio: "ignore" });
+  execSync3('git commit -m "chore: init Dokio Hub"', { cwd: outDir, stdio: "ignore" });
   console.log(kleur5.green(`
   \u2713 Created ${kleur5.bold(dirName)}
 `));
@@ -1300,12 +1336,53 @@ Run \`create-dokio template\` from inside this repo.
   console.log(kleur5.dim(`    git remote add origin https://github.com/dokioco/${dirName}`));
   console.log(kleur5.dim(`    git push -u origin main`));
   console.log("");
+  console.log(kleur5.dim(`  Teammates \u2014 after cloning, enable git hooks once:`));
+  console.log(kleur5.dim(`    npx create-dokio repair`));
+  console.log("");
   console.log(kleur5.dim(`  Changelog (optional \u2014 for AI descriptions):`));
   console.log(kleur5.dim(`    cp tools/changelog/.env.example tools/changelog/.env`));
   console.log(kleur5.dim(`    # Add your ANTHROPIC_API_KEY to tools/changelog/.env`));
   console.log("");
 }
 
+// src/repair.ts
+import { execSync as execSync4 } from "child_process";
+import { basename as basename2 } from "path";
+import kleur6 from "kleur";
+function repoRoot() {
+  try {
+    return execSync4("git rev-parse --show-toplevel", {
+      stdio: ["ignore", "pipe", "ignore"]
+    }).toString().trim();
+  } catch {
+    return null;
+  }
+}
+async function runRepair() {
+  console.log(kleur6.bold().cyan("\n  \u25C6 dokio repair\n"));
+  const hubDir = repoRoot();
+  if (!hubDir) {
+    console.error(kleur6.red("  Not a git repository.\n"));
+    console.error(kleur6.dim("  Run this from inside a cloned hub repo (e.g. bupa-sam-templates/).\n"));
+    process.exit(1);
+  }
+  const { written } = await syncHubFiles(hubDir, { force: true });
+  setHooksPath(hubDir);
+  for (const line of written) console.log(kleur6.dim(`  ${line}`));
+  console.log(kleur6.dim("  \u2713 git config core.hooksPath .githooks"));
+  console.log(kleur6.green(`
+  \u2713 Repaired ${kleur6.bold(basename2(hubDir))}
+`));
+  console.log(kleur6.dim("  Git hooks are now active for this clone:"));
+  console.log(kleur6.dim("    \u2022 commit-msg  \u2192 enforces Conventional Commits"));
+  console.log(kleur6.dim("    \u2022 post-commit \u2192 auto-updates template CHANGELOG.md"));
+  console.log("");
+  console.log(kleur6.dim("  For AI changelog descriptions (optional):"));
+  console.log(kleur6.dim("    cp tools/changelog/.env.example tools/changelog/.env"));
+  console.log(kleur6.dim("    # add ANTHROPIC_API_KEY to tools/changelog/.env"));
+  console.log("");
+}
+
 // src/index.ts
 var require2 = createRequire(import.meta.url);
 async function main(argv) {
@@ -1321,7 +1398,10 @@ async function main(argv) {
   if (subcommand === "hub") {
     return runHub();
   }
-  console.log(kleur6.bold().cyan("\n  \u25C6 dokio create\n"));
+  if (subcommand === "repair") {
+    return runRepair();
+  }
+  console.log(kleur7.bold().cyan("\n  \u25C6 dokio create\n"));
   const { action } = await prompts3(
     {
       type: "select",
@@ -1334,7 +1414,7 @@ async function main(argv) {
     },
     {
       onCancel: () => {
-        console.log(kleur6.yellow("\n  Cancelled.\n"));
+        console.log(kleur7.yellow("\n  Cancelled.\n"));
         process.exit(0);
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-dokio",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "CLI scaffold for Dokio templates",
   "type": "module",
   "bin": {