create-dokio 0.1.7 → 0.1.9

package/dist/index.js

@@ -1,7 +1,13 @@
 #!/usr/bin/env node
 
 // src/index.ts
-import kleur3 from "kleur";
+import prompts3 from "prompts";
+import kleur6 from "kleur";
+
+// src/template.ts
+import { join as join3 } from "path";
+import fse3 from "fs-extra";
+import kleur4 from "kleur";
 
 // src/prompts.ts
 import prompts from "prompts";
@@ -21,6 +27,46 @@ function buildPages(pageCount) {
   return Array.from({ length: pageCount }, (_, i) => getPageName(i, pageCount));
 }
 
+// src/hubs.ts
+var HUBS = [
+  { id: "meridianenergy", title: "Meridian Energy Hub" },
+  { id: "aexp", title: "Amex Global" },
+  { id: "ipa", title: "IPA LAM Hub" },
+  { id: "bupa-sam", title: "Bupa Sales And Marketing Hub" },
+  { id: "gwm", title: "GWM Advertising Studio" },
+  { id: "knowledgebase", title: "KB Hub" },
+  { id: "vidacorp", title: "VidaDesign Hub" },
+  { id: "mi", title: "Measurable Impact" },
+  { id: "bupa-hs", title: "Bupa Health Services" },
+  { id: "originloopvpp-partnerships-hub", title: "Origin Loop VPP Partnerships Hub" },
+  { id: "amazon-devices", title: "Amazon Devices" },
+  { id: "belmond", title: "Belmond" },
+  { id: "origin", title: "Origin" },
+  { id: "shell-au", title: "Shell Australia Brand Templates" },
+  { id: "nissan", title: "Nissan" },
+  { id: "bupa-agedcare", title: "Bupa Aged Care" },
+  { id: "australian-unity", title: "Australian Unity" },
+  { id: "poolwerx", title: "Poolwerx Loop" },
+  { id: "scimmer", title: "Scimmer" },
+  { id: "sandbox", title: "Sandbox" },
+  { id: "bupa-healthy-cities", title: "Bupa Healthy Cities" },
+  { id: "eabrandhub", title: "EnergyAustralia's Brand Hub" },
+  { id: "origin-fugu", title: "Origin Fugu" },
+  { id: "fridas", title: "Frida's Luxe Sip n' Paint" },
+  { id: "headspace", title: "Headspace" },
+  { id: "iris-samsung", title: "Iris | Samsung" },
+  { id: "bupa-marketing", title: "Bupa Marketing" },
+  { id: "bupa-retail", title: "Bupa Retail" },
+  { id: "designsystem", title: "Design System" },
+  { id: "hellofresh", title: "HelloFresh" }
+];
+function hubRepoUrl(hubId) {
+  return `https://github.com/dokioco/${hubId}-templates`;
+}
+function hubRepoDirName(hubId) {
+  return `${hubId}-templates`;
+}
+
 // src/prompts.ts
 var onCancel = () => {
   console.log(kleur.yellow("\n  Cancelled.\n"));
@@ -29,12 +75,18 @@ var onCancel = () => {
 async function runPrompts(nameArg) {
   const base = await prompts(
     [
+      {
+        type: "text",
+        name: "templateId",
+        message: "Template ID  (e.g. HW485)",
+        validate: (v) => /^[A-Za-z0-9]+$/.test(v.trim()) || "Alphanumeric only"
+      },
       {
         type: nameArg ? null : "text",
         name: "name",
-        message: 'Template name (kebab-case, no "dokio-" prefix)',
-        initial: "my-template",
-        validate: (v) => /^[a-z0-9-]+$/.test(v) || "Lowercase letters, numbers, hyphens only"
+        message: "Template name  (e.g. My Cool Template)",
+        initial: "My Template",
+        validate: (v) => v.trim().length > 0 || "Required"
       },
       {
         type: "select",
@@ -48,17 +100,19 @@ async function runPrompts(nameArg) {
         ]
       },
       {
-        type: "text",
-        name: "subdomain",
-        message: "Subdomain",
-        initial: "test"
+        type: "select",
+        name: "hubId",
+        message: "Hub",
+        choices: HUBS.map((h) => ({ title: h.title, value: h.id }))
       }
     ],
     { onCancel }
   );
-  const name = nameArg ? toKebab(nameArg) : base.name;
-  const fullName = `dokio-${name}`;
-  const subdomain = base.subdomain;
+  const templateId = base.templateId.trim();
+  const name = nameArg ? nameArg.trim() : base.name.trim();
+  const fullName = `${templateId}-${toKebab(name)}`;
+  const hubId = base.hubId;
+  const subdomain = hubId;
   if (base.mode === "pdf") {
     const pdf = await prompts(
       [
@@ -103,9 +157,11 @@ async function runPrompts(nameArg) {
     );
     return {
       mode: "pdf",
+      templateId,
       name,
       fullName,
       subdomain,
+      hubId,
       width: pdf.width,
       height: pdf.height,
       pageCount: pdf.pageCount,
@@ -142,9 +198,11 @@ async function runPrompts(nameArg) {
     );
     return {
       mode: "general",
+      templateId,
       name,
       fullName,
       subdomain,
+      hubId,
       width: gen.width,
       height: gen.height,
       pageCount: gen.pageCount,
@@ -152,16 +210,11 @@ async function runPrompts(nameArg) {
     };
   }
   if (base.mode === "video") {
-    return { mode: "video", name, fullName, subdomain };
+    return { mode: "video", templateId, name, fullName, subdomain, hubId };
   }
-  return { mode: "email", name, fullName, subdomain };
+  return { mode: "email", templateId, name, fullName, subdomain, hubId };
 }
 
-// src/scaffold.ts
-import { join } from "path";
-import fse from "fs-extra";
-import kleur2 from "kleur";
-
 // src/templates/shared.ts
 function changelog(fullName) {
   return `# Changelog
@@ -216,6 +269,29 @@ function fontsScssEmpty() {
 // }
 `;
 }
+function commitMsgHook() {
+  return `#!/usr/bin/env sh
+
+commit_msg=$(cat "$1")
+first_line=$(printf '%s' "$commit_msg" | head -n 1)
+pattern='^(feat|fix|chore|docs|style|refactor|test|perf|ci|build|revert)(\\(.+\\))?: .+'
+
+if ! printf '%s' "$first_line" | grep -qE "$pattern"; then
+  printf '\\n  \u2717 Invalid commit message.\\n\\n'
+  printf '  Must follow Conventional Commits:\\n\\n'
+  printf '    feat: add new feature\\n'
+  printf '    fix: resolve a bug\\n'
+  printf '    chore: maintenance task\\n'
+  printf '    docs: update documentation\\n'
+  printf '    style: formatting only\\n'
+  printf '    refactor: code change, no feature/fix\\n'
+  printf '    test: add or update tests\\n'
+  printf '    perf: performance improvement\\n\\n'
+  printf '  Your message: "%s"\\n\\n' "$first_line"
+  exit 1
+fi
+`;
+}
 function mixinsScss() {
   return `@mixin absolute($top: auto, $right: auto, $bottom: auto, $left: auto) {
   position: absolute;
@@ -250,7 +326,7 @@ function mixinsScss() {
 // src/templates/pdf.ts
 function pdfFiles(config, pages) {
   return {
-    "CHANGELOG.md": changelog(config.fullName),
+    "CHANGELOG.md": changelog(`${config.templateId} - ${config.name}`),
     "data.yaml": pdfYaml(config),
     "index.html": pdfHtml(pages),
     "assets/.gitkeep": gitkeep(),
@@ -263,9 +339,9 @@ function pdfFiles(config, pages) {
   };
 }
 function pdfYaml(config) {
-  const { fullName, subdomain, width, height, pageCount, princeVersion, resizable, proofable, orderable } = config;
+  const { templateId, name, subdomain, width, height, pageCount, princeVersion, resizable, proofable, orderable } = config;
   const lines = [
-    `name: TEMPLATEID - ${fullName}`,
+    `name: ${templateId} - ${name}`,
     `mode: pdf`,
     `prince_version: ${princeVersion}`,
     `status: 0`,
@@ -443,7 +519,7 @@ function pdfPageScss(pages) {
 // src/templates/general.ts
 function generalFiles(config, pages) {
   return {
-    "CHANGELOG.md": changelog(config.fullName),
+    "CHANGELOG.md": changelog(`${config.templateId} - ${config.name}`),
     "data.yaml": generalYaml(config),
     "index.html": generalHtml(pages),
     "assets/.gitkeep": gitkeep(),
@@ -456,9 +532,9 @@ function generalFiles(config, pages) {
   };
 }
 function generalYaml(config) {
-  const { fullName, subdomain, width, height, pageCount, exportFormats } = config;
+  const { templateId, name, subdomain, width, height, pageCount, exportFormats } = config;
   const lines = [
-    `name: TEMPLATEID - ${fullName}`,
+    `name: ${templateId} - ${name}`,
     `mode: general`,
     `subdomain: ${subdomain}`,
     `dimension_mode: px`,
@@ -589,7 +665,7 @@ function generalPageScss(pages) {
 // src/templates/video.ts
 function videoFiles(config) {
   return {
-    "CHANGELOG.md": changelog(config.fullName),
+    "CHANGELOG.md": changelog(`${config.templateId} - ${config.name}`),
     "data.yaml": videoYaml(config),
     "index.html": videoHtml(),
     "assets/.gitkeep": gitkeep(),
@@ -605,7 +681,7 @@ function videoFiles(config) {
 }
 function videoYaml(config) {
   return `# TODO: Video template support is WIP
-name: TEMPLATEID - ${config.fullName}
+name: ${config.templateId} - ${config.name}
 mode: video
 subdomain: ${config.subdomain}
 duration: '30'
@@ -674,7 +750,7 @@ $color-accent: #0079C8;
 // src/templates/email.ts
 function emailFiles(config) {
   return {
-    "CHANGELOG.md": changelog(config.fullName),
+    "CHANGELOG.md": changelog(`${config.templateId} - ${config.name}`),
     "data.yaml": emailYaml(config),
     "index.html": emailHtml(),
     "assets/.gitkeep": gitkeep(),
@@ -689,7 +765,7 @@ function emailFiles(config) {
   };
 }
 function emailYaml(config) {
-  return `name: TEMPLATEID - ${config.fullName}
+  return `name: ${config.templateId} - ${config.name}
 mode: email
 status: 0
 subdomain: ${config.subdomain}
@@ -792,55 +868,207 @@ $color-accent: #0079C8;
 `;
 }
 
+// src/files.ts
+function buildFiles(config) {
+  if (config.mode === "pdf") return pdfFiles(config, buildPages(config.pageCount));
+  if (config.mode === "general") return generalFiles(config, buildPages(config.pageCount));
+  if (config.mode === "video") return videoFiles(config);
+  return emailFiles(config);
+}
+
+// src/git.ts
+import { join, basename } from "path";
+import { execSync } from "child_process";
+import fse from "fs-extra";
+import kleur2 from "kleur";
+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)) {
+    console.log(kleur2.dim(`
+  \u21BB Pulling latest ${dirName}...`));
+    execSync("git pull", { cwd: hubDir, stdio: "ignore" });
+  } else {
+    console.log(kleur2.dim(`
+  \u2193 Cloning ${hubRepoUrl(hubId)}...`));
+    execSync(`git clone ${hubRepoUrl(hubId)}`, { stdio: "inherit" });
+  }
+  return hubDir;
+}
+async function setupHooks(hubDir) {
+  const hookPath = join(hubDir, ".githooks", "commit-msg");
+  if (!await fse.pathExists(hookPath)) {
+    await fse.ensureDir(join(hookPath, ".."));
+    await fse.writeFile(hookPath, commitMsgHook(), "utf8");
+    await fse.chmod(hookPath, 493);
+    console.log(kleur2.dim(`  + .githooks/commit-msg`));
+  }
+  execSync("git config core.hooksPath .githooks", { cwd: hubDir, stdio: "ignore" });
+}
+
 // src/scaffold.ts
-async function scaffold(config) {
-  const outDir = join(process.cwd(), config.fullName);
-  if (await fse.pathExists(outDir)) {
-    console.error(kleur2.red(`
-  Error: directory "${config.fullName}" already exists.
+import { join as join2 } from "path";
+import fse2 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");
+    console.log(kleur3.dim(`  + ${fullName}/${rel}`));
+  }
+}
+
+// src/template.ts
+async function runTemplate(nameArg) {
+  console.log(kleur4.bold().cyan("\n  \u25C6 dokio create template\n"));
+  const config = await runPrompts(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)) {
+    console.error(kleur4.red(`
+  Error: "${config.fullName}" already exists in ${hubDirName}/templates/.
 `));
     process.exit(1);
   }
-  let files;
-  if (config.mode === "pdf") {
-    files = pdfFiles(config, buildPages(config.pageCount));
-  } else if (config.mode === "general") {
-    files = generalFiles(config, buildPages(config.pageCount));
-  } else if (config.mode === "video") {
-    files = videoFiles(config);
-  } else {
-    files = emailFiles(config);
+  console.log("");
+  await writeFiles(outDir, files, config.fullName);
+  await setupHooks(hubDir);
+  const templatePath = `${hubDirName}/templates/${config.fullName}`;
+  console.log(kleur4.green(`
+  \u2713 Created ${kleur4.bold(templatePath)}
+`));
+  if (config.mode === "video") {
+    console.log(kleur4.yellow(`  \u26A0  video support is WIP \u2014 check data.yaml for TODOs
+`));
   }
+  console.log(kleur4.dim(`  Next steps:`));
+  console.log(kleur4.dim(`    cd ${templatePath}`));
+  console.log(kleur4.dim(`    Edit data.yaml \u2014 set your template ID`));
+  console.log(kleur4.dim(`    Add assets to assets/`));
+  console.log("");
+  console.log(kleur4.dim(`  When ready to commit:`));
+  console.log(kleur4.dim(`    cd ../../  (back to ${hubDirName}/)`));
+  console.log(kleur4.dim(`    git add templates/${config.fullName}/`));
+  console.log(kleur4.dim(`    git commit -m "feat: add ${config.name} template"`));
+  console.log(kleur4.dim(`    git push`));
+  console.log("");
+}
+
+// src/hub.ts
+import { join as join4 } from "path";
+import { execSync as execSync2 } from "child_process";
+import fse4 from "fs-extra";
+import kleur5 from "kleur";
+import prompts2 from "prompts";
+var onCancel2 = () => {
+  console.log(kleur5.yellow("\n  Cancelled.\n"));
+  process.exit(0);
+};
+async function runHub() {
+  console.log(kleur5.bold().cyan("\n  \u25C6 dokio create hub\n"));
+  const answers = await prompts2(
+    [
+      {
+        type: "text",
+        name: "hubId",
+        message: "Hub ID  (kebab-case, e.g. bupa-sam)",
+        validate: (v) => /^[a-z0-9-]+$/.test(v.trim()) || "Lowercase letters, numbers, hyphens only"
+      },
+      {
+        type: "text",
+        name: "hubName",
+        message: "Hub display name  (e.g. Bupa Sales And Marketing Hub)",
+        validate: (v) => v.trim().length > 0 || "Required"
+      }
+    ],
+    { onCancel: onCancel2 }
+  );
+  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)) {
+    console.error(kleur5.red(`
+  Error: "${dirName}" already exists.
+`));
+    process.exit(1);
+  }
+  const files = {
+    ".githooks/commit-msg": commitMsgHook(),
+    ".vscode/settings.json": JSON.stringify({ "scss.validate": false, "css.validate": false }, null, 2) + "\n",
+    "templates/.gitkeep": "",
+    "tools/.gitkeep": "",
+    ".gitignore": `.DS_Store
+node_modules/
+*.log
+`,
+    "README.md": `# ${hubName}
+
+Templates for ${hubName} on Dokio.
+
+## Creating a new template
+
+Run \`create-dokio template\` from inside this repo.
+`
+  };
   console.log("");
   for (const [rel, content] of Object.entries(files)) {
-    const fullPath = join(outDir, rel);
-    await fse.ensureDir(join(fullPath, ".."));
-    await fse.writeFile(fullPath, content, "utf8");
-    console.log(kleur2.dim(`  + ${rel}`));
+    const fullPath = join4(outDir, rel);
+    await fse4.ensureDir(join4(fullPath, ".."));
+    await fse4.writeFile(fullPath, content, "utf8");
+    if (rel === ".githooks/commit-msg") await fse4.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" });
+  console.log(kleur5.green(`
+  \u2713 Created ${kleur5.bold(dirName)}
+`));
+  console.log(kleur5.dim(`  Next steps:`));
+  console.log(kleur5.dim(`    cd ${dirName}`));
+  console.log(kleur5.dim(`    Create a GitHub repo: github.com/dokioco/${dirName}`));
+  console.log(kleur5.dim(`    git remote add origin https://github.com/dokioco/${dirName}`));
+  console.log(kleur5.dim(`    git push -u origin main`));
+  console.log("");
 }
 
 // src/index.ts
-async function run(nameArg) {
-  console.log(kleur3.bold().cyan("\n  \u25C6 dokio create\n"));
-  const config = await runPrompts(nameArg);
-  await scaffold(config);
-  const isWip = config.mode === "video";
-  console.log(kleur3.green(`
-  \u2713 Created ${kleur3.bold(config.fullName)}
-`));
-  if (isWip) {
-    console.log(
-      kleur3.yellow(`  \u26A0  ${config.mode} support is WIP \u2014 check data.yaml for TODOs
-`)
-    );
+async function main(argv) {
+  const subcommand = argv[0];
+  if (subcommand === "template") {
+    return runTemplate(argv[1]);
   }
-  console.log(kleur3.dim(`  Next steps:`));
-  console.log(kleur3.dim(`    cd ${config.fullName}`));
-  console.log(kleur3.dim(`    Edit data.yaml \u2014 set your template ID and subdomain`));
-  console.log(kleur3.dim(`    Add assets to assets/`));
-  console.log("");
+  if (subcommand === "hub") {
+    return runHub();
+  }
+  console.log(kleur6.bold().cyan("\n  \u25C6 dokio create\n"));
+  const { action } = await prompts3(
+    {
+      type: "select",
+      name: "action",
+      message: "What are you creating?",
+      choices: [
+        { title: "Template", value: "template", description: "Scaffold a new template inside a hub repo" },
+        { title: "Hub", value: "hub", description: "Create a new hub repository" }
+      ]
+    },
+    {
+      onCancel: () => {
+        console.log(kleur6.yellow("\n  Cancelled.\n"));
+        process.exit(0);
+      }
+    }
+  );
+  if (action === "hub") return runHub();
+  return runTemplate();
 }
 
 // bin/index.ts
-run(process.argv[2]);
+main(process.argv.slice(2));

package/package.json

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