@majordigital/create-acorn 1.0.0

package/README.md

@@ -0,0 +1,100 @@
+# Acorn
+
+## Introduction 📖
+
+This is MAJOR's starter boilerplate for NextJs projects. You can either use it without a headless CMS, connect it to a headless CMS of your choice, or use the blueprints we have for our current evolving selection of headless CMS's which includes:
+
+- Primsic
+- Storyblok
+
+## Running This Project 🚀
+
+This website is built using the [NextJS](https://nextjs.org/) framework, utilising [TypeScript](https://www.typescriptlang.org/) to strongly check types/props and provide helpful intelisense, and the utility-first CSS framework [Tailwind](https://tailwindcss.com/) as the styling library.
+
+To run this project, following the following instructions:
+
+1.  **Install dependencies**
+    Navigate to the root directory.
+
+    ```bash
+    npm i
+    ```
+
+2.  **Run the website**
+    In the root directory.
+
+    ```bash
+    npm run dev
+    ```
+
+## Create Acorn CLI 🧰
+
+First iteration of an interactive CLI to scaffold a Headless CMS skeleton with Next.js 15 and Acorn components.
+
+- Default framework: Next.js 15
+- UI base: Acorn components (this repo)
+- CMS options: Prismic, Storyblok, Dato
+
+Recommended usage (once published to npm):
+
+- Use npm init-style:
+
+```bash
+npm create acorn@latest
+```
+
+- Or via npx with the alias:
+
+```bash
+npx major-acorn@latest
+```
+
+Local (from this repo):
+
+```bash
+npm run create
+# or
+npm run acorn
+```
+
+### Prismic setup
+
+If you select Prismic, the CLI follows the official Next.js guide and runs Slice Machine init for you:
+
+```bash
+npx @slicemachine/init@latest --repository <your-repository-name>
+```
+
+You can also pass the repository name non-interactively:
+
+```bash
+npm run acorn -- --cms prismic --repo my-repo
+# or
+npx major-acorn@latest --cms prismic --repo my-repo
+```
+
+Repository name rules: lowercase letters, numbers, and hyphens only.
+
+Or pass a non-interactive flag:
+
+```bash
+node bin/create-acorn.mjs --cms prismic
+node bin/create-acorn.mjs --cms storyblok
+node bin/create-acorn.mjs --cms dato
+```
+
+Notes:
+- This first iteration collects your CMS choice only and prints the selection. In the next iteration, the CLI will scaffold the appropriate folder structure and config for your chosen CMS.
+- To expose this CLI as global commands (`create-acorn` and `major-acorn`) via `npm create`/`npx`, remove `"private": true` and publish to npm.
+- While it’s technically possible to trigger prompts on `npm install major-acorn` via a `postinstall` script, it’s discouraged as it surprises installs and breaks CI. The recommended flow is `npm create acorn` or `npx major-acorn` to start a new project.
+
+## Contacts 🧑‍💻
+
+The primary contact for this project is [Davs Howard](mailto:davs@majordigital.com).
+
+### Roadmap
+
+- [Commitizen](https://github.com/commitizen/cz-cli)
+- Integration and E2E testing
+- Storybook
+- GitHub workflows

package/bin/create-acorn.mjs

@@ -0,0 +1,146 @@
+#!/usr/bin/env node
+/** biome-ignore-all assist/source/organizeImports: necessary for setup */
+import readline from 'node:readline';
+import { argv, exit } from 'node:process';
+import { spawn } from 'node:child_process';
+import { basename } from 'node:path';
+
+const CMS_CHOICES = [
+  { key: 'prismic', label: 'Prismic' },
+  { key: 'storyblok', label: 'Storyblok' },
+  { key: 'dato', label: 'Dato' }
+];
+
+function printHeader() {
+  console.log('');
+  console.log('Create Acorn — Next.js 15 + Acorn Components');
+  console.log('');
+}
+
+function printChoices() {
+  console.log('Which headless CMS would you like to use?');
+  CMS_CHOICES.forEach((c, i) => {
+    console.log(`  ${i + 1}) ${c.label}`);
+  });
+  console.log('');
+}
+
+function parseNonInteractiveArg() {
+  // Support: --cms prismic|storyblok|dato
+  const idx = argv.indexOf('--cms');
+  if (idx !== -1 && argv[idx + 1]) {
+    const val = String(argv[idx + 1]).toLowerCase();
+    const choice = CMS_CHOICES.find((c) => c.key === val);
+    if (choice) return choice;
+  }
+  return null;
+}
+
+async function promptInteractive() {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    printChoices();
+    rl.question('Enter a number (1-3): ', (answer) => {
+      const num = Number(answer);
+      const idx = Number.isFinite(num) ? num - 1 : -1;
+      rl.close();
+      resolve(CMS_CHOICES[idx]);
+    });
+  });
+}
+
+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);
+    });
+  });
+}
+
+function parseFlag(name) {
+  const idx = argv.findIndex((a) => a === `--${name}`);
+  if (idx !== -1 && argv[idx + 1]) return String(argv[idx + 1]);
+  return undefined;
+}
+
+function runCommand(cmd, args, options = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(cmd, args, { stdio: 'inherit', shell: false, ...options });
+    child.on('close', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${cmd} ${args.join(' ')} exited with code ${code}`));
+    });
+    child.on('error', reject);
+  });
+}
+
+async function setupPrismic() {
+  const nonInteractiveRepo = parseFlag('repo');
+  const cwdName = basename(process.cwd())
+    .toLowerCase()
+    .replace(/[^a-z0-9-]/g, '-')
+    .replace(/-{2,}/g, '-')
+    .replace(/^-+|-+$/g, '');
+  const defaultBase = cwdName && cwdName !== 'acorn' ? cwdName : 'acorn';
+  const prefixed = defaultBase.startsWith('majordigital-') ? defaultBase : `majordigital-${defaultBase}`;
+  const suggested = nonInteractiveRepo || prefixed;
+
+  let repo = nonInteractiveRepo;
+  if (!repo) {
+    repo = await ask('Enter your Prismic repository name', suggested);
+  }
+
+  if (!/^[a-z0-9-]+$/.test(repo)) {
+    console.error('Repository name must be lowercase letters, numbers, and hyphens only.');
+    exit(1);
+  }
+
+  console.log('');
+  console.log(`Initializing Prismic Slice Machine for repo: ${repo}`);
+  console.log('');
+
+  await runCommand('npx', ['@slicemachine/init@latest', '--repository', repo]);
+
+  console.log('');
+  console.log('Prismic Slice Machine initialization complete.');
+  console.log('Review newly added files and follow any prompts from Prismic.');
+  console.log('');
+}
+
+async function main() {
+  printHeader();
+  let selection = parseNonInteractiveArg();
+  if (!selection) {
+    selection = await promptInteractive();
+  }
+
+  if (!selection) {
+    console.error('Invalid choice. Please run again and choose 1-3, or pass --cms prismic|storyblok|dato');
+    exit(1);
+  }
+
+  console.log('');
+  console.log(`You selected: ${selection.label}`);
+  console.log('');
+
+  // Default stack context
+  console.log('- Default framework: Next.js 15');
+  console.log('- UI base: Acorn components from this repo');
+  console.log('');
+
+  if (selection.key === 'prismic') {
+    await setupPrismic();
+  } else {
+    console.log(`CMS preset ${selection.label} scaffolding is coming next.`);
+    console.log('This run only confirms selection for non-Prismic options.');
+    console.log('');
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  exit(1);
+});

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@majordigital/create-acorn",
+  "version": "1.0.0",
+  "description": "Interactive scaffold for Acorn with Storyblok/Prismic/DatoCMS, TypeScript, and Tailwind.",
+  "bin": {
+    "create-acorn": "bin/create-acorn.mjs",
+    "major-acorn": "bin/create-acorn.mjs"
+  },
+  "type": "module",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MajorDigital/majordigital-acorn.git"
+  },
+  "files": [
+    "bin",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "create": "node bin/create-acorn.mjs",
+    "acorn": "node bin/create-acorn.mjs",
+    "dev": "next dev --turbo",
+    "build": "next build",
+    "start": "next start",
+    "preview": "next build && next start",
+    "slicemachine": "start-slicemachine"
+  },
+  "dependencies": {
+    "@headlessui/react": "^2.2.3",
+    "@headlessui/tailwindcss": "^0.2.2",
+    "@heroicons/react": "^2.2.0",
+    "@hookform/error-message": "^2.0.1",
+    "@hookform/resolvers": "^5.0.1",
+    "@next/bundle-analyzer": "^15.3.2",
+    "clsx": "^2.1.1",
+    "next": "15.5.9",
+    "next-seo": "^6.6.0",
+    "react": "19.2.3",
+    "react-accessible-accordion": "^5.0.1",
+    "react-dom": "19.2.3",
+    "react-hook-form": "^7.70.0",
+    "tailwindcss": "^3.4.17",
+    "zod": "^3.24.4"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@slicemachine/adapter-next": "^0.3.93",
+    "@svgr/webpack": "^8.1.0",
+    "@types/lodash.get": "^4.4.9",
+    "@types/node": "22.15.18",
+    "@types/react": "19.1.4",
+    "@types/react-dom": "19.1.5",
+    "autoprefixer": "^10.4.21",
+    "cross-env": "^7.0.3",
+    "postcss": "^8.5.3",
+    "slice-machine-ui": "^2.20.5",
+    "typescript": "^5.8.3"
+  }
+}