@majordigital/create-acorn 1.1.1 → 1.1.3

package/README.md

@@ -1,6 +1,8 @@
 # @majordigital/create-acorn
 
-Interactive CLI to scaffold a Next.js 15 project with a headless CMS and Acorn components.
+**Create Acorn** is Major Digital's production-ready scaffolding 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.
 
 ## Quick Start
 
@@ -8,50 +10,78 @@ Interactive CLI to scaffold a Next.js 15 project with a headless CMS and Acorn c
 npx @majordigital/create-acorn@latest
 ```
 
-The CLI will walk you through selecting a CMS (Prismic, Storyblok, or Dato) and scaffold a Next.js 15 project with TypeScript, Tailwind, and Biome.
+The CLI walks you through selecting a headless CMS and scaffolds a complete, opinionated project in seconds.
+
+## What's Inside
 
-## What You Get
+Every Acorn project ships with a carefully curated stack:
 
-The CLI scaffolds a complete project with:
+- **Next.js 15** — App Router, TypeScript, Tailwind CSS, and Turbopack
+- **Acorn Component Library** — A battle-tested set of UI primitives, layout systems, and page sections built for Major Digital's design language
+- **Headless CMS Integration** — First-class support for Prismic, Storyblok, and DatoCMS with pre-configured SDKs and environment templates
+- **Biome** — Fast, unified linting and formatting with custom rules for React, Next.js, and Tailwind class sorting
+- **Lefthook + Commitlint** — Pre-commit quality gates and conventional commit enforcement out of the box
+- **SVG-as-components** — Inline SVG imports via `@svgr/webpack` for both Webpack and Turbopack
+- **Bundle Analysis** — `@next/bundle-analyzer` ready to go with `ANALYZE=true`
 
-- **Next.js 15** with App Router, TypeScript, and Tailwind
-- **Acorn component library** — UI elements, layout components, sections, forms, typography, and navigation
-- **Biome** for linting and formatting
-- **Your chosen CMS** pre-configured
+## Acorn Component Architecture
 
-### Included Acorn Boilerplate
+The Acorn library follows a layered component hierarchy designed for consistency and reuse across projects:
 
 ```
 src/
-├── app/          # Next.js app routes (layout, page, not-found, robots, sitemap)
-├── icons/        # SVG icons
-├── lib/          # Utilities, fonts, config, metadata helpers
-├── styles/       # Global CSS
-├── types/        # TypeScript type definitions
+├── app/              # Next.js App Router (layout, pages, not-found, robots, sitemap)
+├── icons/            # SVG assets imported as React components
+├── lib/              # Utilities, fonts, config, metadata helpers, caching
+├── styles/           # Global CSS and Tailwind directives
+├── types/            # TypeScript definitions and SVG module declarations
 └── ui/
-    ├── components/   # Nav, Card, Accordion, CTA, Quote, Form, etc.
-    ├── elements/     # Button, Chip, Tooltip, typography, form inputs
-    ├── layout/       # Container, PageSection
-    └── sections/     # Header, Footer
+    ├── elements/     # Atomic building blocks (Button, Chip, Tooltip, form inputs, typography)
+    ├── components/   # Composed features (Nav, Card, Accordion, CTA, Quote, ContactForm)
+    ├── layout/       # Structural wrappers (Container, PageSection)
+    └── sections/     # Full-width page regions (Header, Footer)
 ```
 
+## Supported CMS Platforms
+
+| 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 |
+
 ## Non-Interactive Usage
 
+For CI pipelines or scripted setups:
+
 ```bash
 npx @majordigital/create-acorn@latest --cms prismic --repo my-repo
 npx @majordigital/create-acorn@latest --cms storyblok
 npx @majordigital/create-acorn@latest --cms dato
 ```
 
-## Prismic Setup
+## Generated Project Files
+
+Beyond the component library, every scaffold includes:
+
+| File | Purpose |
+|------|---------|
+| `biome.jsonc` | Linting, formatting, and import organisation rules |
+| `lefthook.yml` | Pre-commit checks and commit message validation |
+| `commitlint.config.ts` | Conventional commit enforcement |
+| `next.config.ts` | SVG loader, bundle analyser, image remote patterns |
+| `postcss.config.js` | Tailwind CSS and Autoprefixer |
+| `tsconfig.json` | TypeScript with `@/*` path aliases |
+| `.env.example` | CMS-specific environment variable template |
+| `.npmrc` | Legacy peer deps for React 19 compatibility |
+| `README.md` | Project-specific documentation based on CMS choice |
+
+## npm
 
-If you select Prismic, the CLI runs Slice Machine init and connects to your new or existing repository.
+[![npm version](https://img.shields.io/npm/v/@majordigital/create-acorn)](https://www.npmjs.com/package/@majordigital/create-acorn)
 
-Repository name rules: lowercase letters, numbers, and hyphens only.
+Published at [@majordigital/create-acorn](https://www.npmjs.com/package/@majordigital/create-acorn)
 
-After setup:
+## Changelog
 
-1. Start Slice Machine: `npm run slicemachine`
-2. Create your custom types at http://localhost:9999
-3. Push your custom types to Prismic
-4. Start your dev server: `npm run dev`
+See [CHANGELOG.md](CHANGELOG.md) for a full release history.

package/bin/create-acorn.mjs

@@ -70,7 +70,7 @@ function parseFlag(name) {
 
 function runCommand(cmd, args, options = {}) {
   return new Promise((resolve, reject) => {
-    const child = spawn(cmd, args, { stdio: 'inherit', shell: false, ...options });
+    const child = spawn(cmd, args, { stdio: 'inherit', shell: true, ...options });
     child.on('close', (code) => {
       if (code === 0) resolve();
       else reject(new Error(`${cmd} ${args.join(' ')} exited with code ${code}`));
@@ -91,7 +91,9 @@ async function scaffoldNextApp() {
     '--app',
     '--src-dir',
     '--import-alias', '@/*',
-    '--use-npm'
+    '--use-npm',
+    '--turbopack',
+    '--yes'
   ]);
   console.log('');
   console.log('Next.js project scaffolded successfully.');
@@ -122,7 +124,8 @@ async function scaffoldNextApp() {
     'react-accessible-accordion', 'react-hook-form', 'zod'
   ]);
   await runCommand('npm', ['install', '--save-dev', '--legacy-peer-deps',
-    '@svgr/webpack', '@types/lodash.get'
+    '@svgr/webpack', '@types/lodash.get',
+    'tailwindcss@^3.4.10', 'autoprefixer', 'postcss'
   ]);
   console.log('Acorn dependencies installed.');
   console.log('');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@majordigital/create-acorn",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Interactive scaffold for Acorn with Storyblok/Prismic/DatoCMS, TypeScript, and Tailwind.",
   "bin": {
     "create-acorn": "bin/create-acorn.mjs",
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/MajorDigital/majordigital-acorn.git"
+    "url": "git+https://github.com/MajorDigital/create-acorn.git"
   },
   "files": [
     "bin",