@majordigital/create-acorn 1.5.6 → 1.5.8

package/README.md

@@ -1,6 +1,6 @@
 # @majordigital/create-acorn
 
-**Create Acorn** is Major Digital's production-ready scaffolding CLI for building headless CMS websites with Next.js 15 and the Acorn component system.
+**Create Acorn** is Major Digital's production-ready starter CLI for building headless CMS websites with Next.js 15 and the Acorn component system.
 
 It eliminates the repetitive setup that comes with every new project — framework configuration, CMS integration, linting, commit conventions, and a full UI component library — so your team can skip straight to building.
 
@@ -10,9 +10,9 @@ It eliminates the repetitive setup that comes with every new project — framewo
 npx @majordigital/create-acorn@latest
 ```
 
-> **Note:** Always use `npx` to run the CLI. Do not use `npm install` — this is a scaffolding tool, not a library dependency.
+> **Note:** Always use `npx` to run the CLI. Do not use `npm install` — this is a starter tool, not a library dependency.
 
-The CLI prompts you for a project name, creates the directory, then walks you through selecting a headless CMS — scaffolding a complete, opinionated project in seconds.
+The CLI prompts you for a project name, creates the directory, then walks you through selecting a headless CMS — generating a complete, opinionated project in seconds.
 
 ```
 ? What is the name of your project? (my-acorn-app)
@@ -59,8 +59,8 @@ src/
 | CMS | Status | Setup |
 |-----|--------|-------|
 | **Prismic** | Full integration | Slice Machine init, repository connection, slicemachine script |
-| **Storyblok** | Scaffolding ready | Environment template, component generation support |
-| **DatoCMS** | Scaffolding ready | Environment template, API token configuration |
+| **Storyblok** | Full integration | Environment template, component generation support |
+| **DatoCMS** | Full integration | Environment template, API token configuration |
 
 ## Non-Interactive Usage
 
@@ -74,7 +74,7 @@ npx @majordigital/create-acorn@latest --name my-project --cms dato
 
 ## Generated Project Files
 
-Beyond the component library, every scaffold includes:
+Beyond the component library, every project includes:
 
 | File | Purpose |
 |------|---------|

package/bin/create-acorn.mjs

@@ -79,8 +79,8 @@ function runCommand(cmd, args, options = {}) {
   });
 }
 
-async function scaffoldNextApp() {
-  console.log('Scaffolding Next.js 15 project...');
+async function setupNextApp() {
+  console.log('Setting up Next.js 15 project...');
   console.log('');
   await runCommand('npx', [
     'create-next-app@latest',
@@ -96,7 +96,7 @@ async function scaffoldNextApp() {
     '--yes'
   ]);
   console.log('');
-  console.log('Next.js project scaffolded successfully.');
+  console.log('Next.js project created successfully.');
   console.log('');
 
   // Add .npmrc with legacy-peer-deps so all npm installs (including Slice Machine) work with React 19
@@ -107,7 +107,7 @@ async function scaffoldNextApp() {
   try { rmSync(join(process.cwd(), 'next.config.ts')); } catch {}
   try { rmSync(join(process.cwd(), 'next.config.js')); } catch {}
 
-  // Copy Acorn template files (src/, public/, config files) over the Next.js scaffold
+  // Copy Acorn template files (src/, public/, config files) over the Next.js starter
   console.log('Copying Acorn boilerplate...');
   const __dirname = dirname(fileURLToPath(import.meta.url));
   const templateDir = join(__dirname, '..', 'template');
@@ -343,7 +343,7 @@ async function setupDato() {
   console.log('  https://www.datocms.com/dashboard');
   console.log('');
   console.log('Once your project is ready, provide the Full-access API token below');
-  console.log('and we will automatically scaffold all models (Page, Hero, Button, Layout, etc.).');
+  console.log('and we will automatically create all models (Page, Hero, Button, Layout, etc.).');
   console.log('');
   console.log('Token location: Settings > API Tokens > Full-access API token');
   console.log('Make sure "Access the Content Management API" is enabled and the role is Admin.');
@@ -368,11 +368,11 @@ async function setupDato() {
 
   if (apiToken) {
     console.log('');
-    console.log('Scaffolding DatoCMS models...');
+    console.log('Creating DatoCMS models...');
     console.log('');
 
     try {
-      await scaffoldDatoModels(apiToken);
+      await createDatoModels(apiToken);
       console.log('');
       console.log('DatoCMS models created successfully!');
       console.log('');
@@ -405,17 +405,16 @@ NEXT_DATOCMS_ENVIRONMENT=draft
       }
     } catch (err) {
       console.log('');
-      console.log('Warning: Could not scaffold DatoCMS models automatically.');
+      console.log('Warning: Could not create DatoCMS models automatically.');
       console.log(`  Error: ${err.message}`);
       console.log('');
-      console.log('You can create models manually in the DatoCMS dashboard.');
-      console.log('The GraphQL queries expect: Page, Hero (block), Button (block),');
-      console.log('Layout (singleton), MenuItem (block), CaseStudy, LegalPage, Post,');
-      console.log('CaseStudiesListing (singleton), PostListing (singleton).');
+      console.log('You can create models later by running:');
+      console.log('  npm run setup-dato-models');
     }
   } else {
     console.log('');
-    console.log('Skipping model scaffolding — you can set up models manually later.');
+    console.log('Skipping model creation — you can run this later inside your project:');
+    console.log('  npm run setup-dato-models');
   }
 
   // Update next.config.ts — replace Prismic image patterns with DatoCMS
@@ -474,6 +473,7 @@ NEXT_DATOCMS_ENVIRONMENT=draft
   const targetScripts = join(process.cwd(), 'scripts');
   mkdirSync(targetScripts, { recursive: true });
   cpSync(join(datoSrcDir, 'scripts', 'buildLinkIndex.ts'), join(targetScripts, 'buildLinkIndex.ts'));
+  cpSync(join(datoSrcDir, 'scripts', 'setupDatoModels.mjs'), join(targetScripts, 'setupDatoModels.mjs'));
   console.log('Copied build scripts.');
 
   // Update package.json scripts for DatoCMS
@@ -494,6 +494,7 @@ NEXT_DATOCMS_ENVIRONMENT=draft
     pkg.scripts['fix:prod'] = 'biome check . --write';
     pkg.scripts['generate-types'] = 'graphql-codegen --config graphql.config.yml';
     pkg.scripts['check-types'] = 'tsc --noEmit';
+    pkg.scripts['setup-dato-models'] = 'node scripts/setupDatoModels.mjs';
     writeFileSync(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
     console.log('Updated package.json scripts for DatoCMS.');
   } catch {
@@ -547,10 +548,10 @@ NEXT_DATOCMS_ENVIRONMENT=draft
 }
 
 /**
- * Scaffold default DatoCMS models using the Management API.
- * Creates models that match the GraphQL queries in the dato-api layer.
+ * Create default DatoCMS models using the Management API.
+ * Models match the GraphQL queries in the dato-api layer.
  */
-async function scaffoldDatoModels(apiToken) {
+async function createDatoModels(apiToken) {
   const { buildClient } = await import('@datocms/cma-client-node');
   const client = buildClient({ apiToken });
 
@@ -1089,7 +1090,7 @@ async function main() {
   console.log(`Created directory: ${projectDir}`);
   console.log('');
 
-  await scaffoldNextApp();
+  await setupNextApp();
 
   // Generate .env.example and README before CMS setup (CMS setup may block if user starts Slice Machine)
   const envExamples = {

package/dato/dato-api/scripts/setupDatoModels.mjs

@@ -0,0 +1,401 @@
+#!/usr/bin/env node
+/**
+ * Standalone script to create DatoCMS models via the Management API.
+ * Run with: npm run setup-dato-models
+ *
+ * This is useful if you:
+ * - Skipped the token during initial CLI setup
+ * - Created your DatoCMS project after running the CLI
+ * - Need to re-run model creation on a fresh DatoCMS project
+ *
+ * Requires: DATO_API_TOKEN in .env.local (Full-access token with Admin role + CMA enabled)
+ * Or pass it when prompted.
+ */
+import readline from 'node:readline';
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { buildClient } from '@datocms/cma-client-node';
+
+function ask(question, defaultValue) {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    const prompt = defaultValue ? `${question} (${defaultValue}): ` : `${question}: `;
+    rl.question(prompt, (answer) => {
+      rl.close();
+      resolve(answer && answer.trim() ? answer.trim() : defaultValue);
+    });
+  });
+}
+
+// Try to read token from .env.local
+function readTokenFromEnv() {
+  try {
+    const envPath = join(process.cwd(), '.env.local');
+    const content = readFileSync(envPath, 'utf-8');
+    const match = content.match(/^DATO_API_TOKEN=(.+)$/m);
+    return match?.[1]?.trim() || '';
+  } catch {
+    return '';
+  }
+}
+
+async function findOrCreateItemType(client, existingTypes, config) {
+  const existing = existingTypes.find(t => t.api_key === config.api_key);
+  if (existing) {
+    console.log(`  Skipping ${config.name} (already exists)...`);
+    return existing;
+  }
+  return client.itemTypes.create(config);
+}
+
+async function findOrCreateField(client, modelId, config) {
+  const existingFields = await client.fields.list(modelId);
+  const existing = existingFields.find(f => f.api_key === config.api_key);
+  if (existing) return existing;
+  return client.fields.create(modelId, config);
+}
+
+async function main() {
+  console.log('');
+  console.log('=== DatoCMS Model Setup ===');
+  console.log('');
+  console.log('This will create all required models, blocks, and fields');
+  console.log('in your DatoCMS project via the Management API.');
+  console.log('');
+  console.log('You need a Full-access API token with Admin role');
+  console.log('and "Access the Content Management API" enabled.');
+  console.log('');
+
+  const envToken = readTokenFromEnv();
+  const apiToken = await ask('Paste your Full-access API token', envToken || undefined);
+
+  if (!apiToken) {
+    console.log('No token provided. Exiting.');
+    process.exit(1);
+  }
+
+  console.log('');
+  console.log('Creating DatoCMS models...');
+  console.log('');
+
+  const client = buildClient({ apiToken });
+
+  // Fetch existing models so we can skip duplicates
+  const existingTypes = await client.itemTypes.list();
+
+  // --- Block models ---
+
+  console.log('  Creating Button block...');
+  const buttonBlock = await findOrCreateItemType(client, existingTypes, {
+    name: 'Button',
+    api_key: 'button',
+    modular_block: true,
+  });
+  await findOrCreateField(client, buttonBlock.id, {
+    label: 'Text',
+    field_type: 'string',
+    api_key: 'text',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, buttonBlock.id, {
+    label: 'Variant',
+    field_type: 'string',
+    api_key: 'variant',
+    validators: { enum: { values: ['primary', 'secondary', 'outline'] } },
+    appearance: {
+      addons: [],
+      editor: 'string_select',
+      parameters: { options: [
+        { hint: '', label: 'Primary', value: 'primary' },
+        { hint: '', label: 'Secondary', value: 'secondary' },
+        { hint: '', label: 'Outline', value: 'outline' },
+      ]},
+    },
+  });
+  await findOrCreateField(client, buttonBlock.id, {
+    label: 'Link',
+    field_type: 'json',
+    api_key: 'link',
+  });
+
+  console.log('  Creating Hero block...');
+  const heroBlock = await findOrCreateItemType(client, existingTypes, {
+    name: 'Hero',
+    api_key: 'hero',
+    modular_block: true,
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Heading',
+    field_type: 'string',
+    api_key: 'heading',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Eyebrow',
+    field_type: 'string',
+    api_key: 'eyebrow',
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Content',
+    field_type: 'text',
+    api_key: 'content',
+    appearance: {
+      addons: [],
+      editor: 'textarea',
+      parameters: {},
+    },
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Layout',
+    field_type: 'string',
+    api_key: 'layout',
+    validators: { enum: { values: ['default', 'centered', 'split'] } },
+    appearance: {
+      addons: [],
+      editor: 'string_select',
+      parameters: { options: [
+        { hint: '', label: 'Default', value: 'default' },
+        { hint: '', label: 'Centered', value: 'centered' },
+        { hint: '', label: 'Split', value: 'split' },
+      ]},
+    },
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Theme',
+    field_type: 'string',
+    api_key: 'theme',
+    validators: { enum: { values: ['light', 'dark'] } },
+    appearance: {
+      addons: [],
+      editor: 'string_select',
+      parameters: { options: [
+        { hint: '', label: 'Light', value: 'light' },
+        { hint: '', label: 'Dark', value: 'dark' },
+      ]},
+    },
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Image',
+    field_type: 'file',
+    api_key: 'image',
+  });
+  await findOrCreateField(client, heroBlock.id, {
+    label: 'Actions',
+    field_type: 'rich_text',
+    api_key: 'actions',
+    validators: {
+      rich_text_blocks: { item_types: [buttonBlock.id] },
+    },
+  });
+
+  console.log('  Creating MenuItem block...');
+  const menuItemBlock = await findOrCreateItemType(client, existingTypes, {
+    name: 'Menu Item',
+    api_key: 'menu_item',
+    modular_block: true,
+  });
+  await findOrCreateField(client, menuItemBlock.id, {
+    label: 'Heading',
+    field_type: 'string',
+    api_key: 'heading',
+    validators: { required: {} },
+  });
+
+  // --- Regular models ---
+
+  console.log('  Creating Page model...');
+  const pageModel = await findOrCreateItemType(client, existingTypes, {
+    name: 'Page',
+    api_key: 'page',
+    draft_mode_active: true,
+  });
+  const pageHeadingField = await findOrCreateField(client, pageModel.id, {
+    label: 'Heading',
+    field_type: 'string',
+    api_key: 'heading',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, pageModel.id, {
+    label: 'Description',
+    field_type: 'text',
+    api_key: 'description',
+  });
+  await findOrCreateField(client, pageModel.id, {
+    label: 'Slug',
+    field_type: 'slug',
+    api_key: 'slug',
+    validators: {
+      required: {},
+      slug_title_field: { title_field_id: pageHeadingField.id },
+    },
+  });
+  await findOrCreateField(client, pageModel.id, {
+    label: 'Parent Page',
+    field_type: 'link',
+    api_key: 'parent_page',
+    validators: {
+      item_item_type: { item_types: [pageModel.id] },
+    },
+  });
+  await findOrCreateField(client, pageModel.id, {
+    label: 'Body',
+    field_type: 'rich_text',
+    api_key: 'body',
+    validators: {
+      rich_text_blocks: { item_types: [heroBlock.id] },
+    },
+  });
+
+  // Add target link to MenuItem
+  await findOrCreateField(client, menuItemBlock.id, {
+    label: 'Target',
+    field_type: 'link',
+    api_key: 'target',
+    validators: {
+      item_item_type: { item_types: [pageModel.id] },
+    },
+  });
+
+  console.log('  Creating Case Study model...');
+  const caseStudyModel = await findOrCreateItemType(client, existingTypes, {
+    name: 'Case Study',
+    api_key: 'case_study',
+    draft_mode_active: true,
+  });
+  const caseStudyTitleField = await findOrCreateField(client, caseStudyModel.id, {
+    label: 'Title',
+    field_type: 'string',
+    api_key: 'title',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, caseStudyModel.id, {
+    label: 'Slug',
+    field_type: 'slug',
+    api_key: 'slug',
+    validators: {
+      required: {},
+      slug_title_field: { title_field_id: caseStudyTitleField.id },
+    },
+  });
+
+  console.log('  Creating Legal Page model...');
+  const legalPageModel = await findOrCreateItemType(client, existingTypes, {
+    name: 'Legal Page',
+    api_key: 'legal_page',
+    draft_mode_active: true,
+  });
+  const legalTitleField = await findOrCreateField(client, legalPageModel.id, {
+    label: 'Title',
+    field_type: 'string',
+    api_key: 'title',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, legalPageModel.id, {
+    label: 'Slug',
+    field_type: 'slug',
+    api_key: 'slug',
+    validators: {
+      required: {},
+      slug_title_field: { title_field_id: legalTitleField.id },
+    },
+  });
+  await findOrCreateField(client, legalPageModel.id, {
+    label: 'Download',
+    field_type: 'file',
+    api_key: 'download',
+  });
+
+  console.log('  Creating Post model...');
+  const postModel = await findOrCreateItemType(client, existingTypes, {
+    name: 'Post',
+    api_key: 'post',
+    draft_mode_active: true,
+  });
+  const postTitleField = await findOrCreateField(client, postModel.id, {
+    label: 'Title',
+    field_type: 'string',
+    api_key: 'title',
+    validators: { required: {} },
+  });
+  await findOrCreateField(client, postModel.id, {
+    label: 'Slug',
+    field_type: 'slug',
+    api_key: 'slug',
+    validators: {
+      required: {},
+      slug_title_field: { title_field_id: postTitleField.id },
+    },
+  });
+
+  console.log('  Creating Case Studies Listing singleton...');
+  const caseStudiesListing = await findOrCreateItemType(client, existingTypes, {
+    name: 'Case Studies Listing',
+    api_key: 'case_studies_listing',
+    singleton: true,
+  });
+  await findOrCreateField(client, caseStudiesListing.id, {
+    label: 'Slug',
+    field_type: 'string',
+    api_key: 'slug',
+    validators: { required: {} },
+  });
+
+  console.log('  Creating Post Listing singleton...');
+  const postListing = await findOrCreateItemType(client, existingTypes, {
+    name: 'Post Listing',
+    api_key: 'post_listing',
+    singleton: true,
+  });
+  await findOrCreateField(client, postListing.id, {
+    label: 'Slug',
+    field_type: 'string',
+    api_key: 'slug',
+    validators: { required: {} },
+  });
+
+  console.log('  Creating Layout singleton...');
+  const layoutModel = await findOrCreateItemType(client, existingTypes, {
+    name: 'Layout',
+    api_key: 'layout',
+    singleton: true,
+  });
+  await findOrCreateField(client, layoutModel.id, {
+    label: 'Navigation',
+    field_type: 'rich_text',
+    api_key: 'navigation',
+    validators: {
+      rich_text_blocks: { item_types: [menuItemBlock.id] },
+    },
+  });
+  await findOrCreateField(client, layoutModel.id, {
+    label: 'Footer Navigation',
+    field_type: 'rich_text',
+    api_key: 'footer_navigation',
+    validators: {
+      rich_text_blocks: { item_types: [menuItemBlock.id] },
+    },
+  });
+  await findOrCreateField(client, layoutModel.id, {
+    label: 'Copyright',
+    field_type: 'string',
+    api_key: 'copyright',
+  });
+
+  console.log('');
+  console.log('  Models created: Page, Case Study, Legal Page, Post');
+  console.log('  Singletons created: Layout, Case Studies Listing, Post Listing');
+  console.log('  Blocks created: Hero, Button, Menu Item');
+  console.log('');
+  console.log('Done! You can now run:');
+  console.log('  npm run generate-types');
+  console.log('  npm run dev');
+  console.log('');
+}
+
+main().catch((err) => {
+  console.error('');
+  console.error('Failed to create DatoCMS models.');
+  console.error(`  Error: ${err.message}`);
+  console.error('');
+  process.exit(1);
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@majordigital/create-acorn",
-  "version": "1.5.6",
-  "description": "Interactive scaffold for Acorn with Storyblok/Prismic/DatoCMS, TypeScript, and Tailwind.",
+  "version": "1.5.8",
+  "description": "Interactive starter CLI for Acorn with Storyblok/Prismic/DatoCMS, TypeScript, and Tailwind.",
   "bin": {
     "create-acorn": "bin/create-acorn.mjs",
     "major-acorn": "bin/create-acorn.mjs"