tackl 2.0.0 → 2.4.0

package/README.md

@@ -9,13 +9,17 @@ mkdir my-app && cd my-app   # or clone your empty repo and cd in
 bunx tackl                  # or: bun create tackl / npm create tackl@latest
 ```
 
-You'll be asked which CMS to use — **DatoCMS**, **Sanity**, or **None** — and the scaffold is pruned to match: only the chosen adapter, its dependencies, its docs, and its `.env.example` block survive.
+You'll be asked which CMS to use — **DatoCMS**, **Sanity**, or **None** — and the scaffold is pruned to match: only the chosen adapter, its dependencies, its docs, and its `.env.example` block survive. Draft preview ships with both CMS choices (the `app/api/draft-mode/` routes resolve through the adapter seam). **None** keeps the same shape as the others — the `@cms` seam stays, rewired to a stub adapter whose `fetchContent` returns `null` — so wiring up a CMS later never touches app code; only the draft-mode routes and CMS files are removed.
+
+Choosing **Sanity** sets the whole thing up: an embedded Studio at `/studio`, example schemas, and draft-mode preview routes ship in the scaffold, and the CLI offers to run `sanity init` for you — logging in, creating/linking a project, and writing your `.env`. Scaffold → `bun run dev` → `/studio` → start editing.
+
+Design tokens live in `src/theme` and type styles in `src/css/tackl/_type.scss` — set them from your Figma file before you start building.
 
 ## What it does
 
 1. Verifies the directory is empty (an existing `.git`, `.gitignore`, `README.md` or `LICENSE` is fine — your repo's `.git` and remote are kept)
-2. Downloads the latest tagged release of the template (falls back to `main` if none)
-3. Prunes repo-only cargo (the CLI itself, `.github`) and the unused CMS adapter
+2. Downloads the latest GitHub release of the template (falls back to `main` if none can be resolved). The lookup uses `GITHUB_TOKEN` / `GH_TOKEN` when set, and otherwise falls back to github.com's non-rate-limited release redirect — so shared IPs (offices, CI) still get the release
+3. Prunes repo-only cargo (the CLI itself, `.github` templates, internal `docs/plans`) and the unused CMS adapter
 4. Sets your package name, initialises git if needed, and runs `bun install`
 
 ## Options

package/bin/tackl.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
-import { execSync } from 'child_process';
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
 import pc from 'picocolors';
 import prompts from 'prompts';
 import * as tar from 'tar';
@@ -55,18 +55,44 @@ const dirIsScaffoldable = dir => {
 // SECTION • Template ref resolution
 // NOTE • Prefer the latest GitHub release so every scaffold is a tested,
 // reproducible snapshot; fall back to main (with a warning) when no
-// release exists. --ref overrides both.
+// release can be resolved. --ref overrides both.
+// The REST API allows only 60 unauthenticated requests/hour per IP — shared
+// IPs (offices, CI) hit that — so a GITHUB_TOKEN is used when present, and
+// the github.com /releases/latest redirect (not rate-limited) is tried next.
+const RELEASE_TAG_PATTERN = /\/releases\/tag\/([^/?#]+)/;
+
+const latestReleaseFromApi = async () => {
+	const token = process.env.GITHUB_TOKEN || process.env.GH_TOKEN;
+	const res = await fetch(`https://api.github.com/repos/${OWNER}/${REPO}/releases/latest`, {
+		headers: {
+			accept: 'application/vnd.github+json',
+			'user-agent': 'tackl-cli',
+			...(token && { authorization: `Bearer ${token}` }),
+		},
+	});
+	if (!res.ok) return null;
+	const json = await res.json();
+	return json?.tag_name ?? null;
+};
+
+const latestReleaseFromRedirect = async () => {
+	const res = await fetch(`https://github.com/${OWNER}/${REPO}/releases/latest`, {
+		method: 'HEAD',
+		redirect: 'manual',
+		headers: { 'user-agent': 'tackl-cli' },
+	});
+	const match = res.headers.get('location')?.match(RELEASE_TAG_PATTERN);
+	return match ? decodeURIComponent(match[1]) : null;
+};
+
 const resolveRef = async explicitRef => {
 	if (explicitRef) return { ref: explicitRef, source: 'flag' };
-	try {
-		const res = await fetch(`https://api.github.com/repos/${OWNER}/${REPO}/releases/latest`, {
-			headers: { accept: 'application/vnd.github+json' },
-		});
-		if (res.ok) {
-			const json = await res.json();
-			if (json?.tag_name) return { ref: json.tag_name, source: 'release' };
-		}
-	} catch {}
+	for (const lookup of [latestReleaseFromApi, latestReleaseFromRedirect]) {
+		try {
+			const tag = await lookup();
+			if (tag) return { ref: tag, source: 'release' };
+		} catch {}
+	}
 	return { ref: FALLBACK_REF, source: 'fallback' };
 };
 
@@ -104,7 +130,24 @@ const stripDeps = (root, deps) => {
 		delete json.dependencies?.[d];
 		delete json.devDependencies?.[d];
 	}
-	fs.writeFileSync(p, JSON.stringify(json, null, '\t') + '\n');
+	fs.writeFileSync(p, `${JSON.stringify(json, null, '\t')}\n`);
+};
+
+// NOTE • Everything that exists solely for the embedded Sanity Studio.
+// app/api/draft-mode is NOT here — the draft routes are CMS-agnostic
+// (they resolve through @cms/draft) and only go when no CMS is chosen.
+const SANITY_STUDIO_PATHS = ['app/(studio)', 'sanity.config.ts', 'sanity'];
+const SANITY_DEPS = ['next-sanity', 'sanity', '@sanity/vision'];
+
+// NOTE • The two files the CLI rewires to the chosen adapter
+const ADAPTER_ENTRIES = ['src/cms/index.ts', 'src/cms/draft.ts'];
+const rewireAdapter = (root, adapter) => {
+	for (const rel of ADAPTER_ENTRIES) {
+		const p = path.join(root, rel);
+		if (fs.existsSync(p)) {
+			fs.writeFileSync(p, fs.readFileSync(p, 'utf8').replaceAll(`'./dato`, `'./${adapter}`));
+		}
+	}
 };
 
 const CMS = {
@@ -112,8 +155,10 @@ const CMS = {
 		title: 'DatoCMS',
 		prune: root => {
 			rmrf(root, 'src/cms/sanity');
+			rmrf(root, 'src/cms/none');
 			rmrf(root, 'docs/Sanity');
-			stripDeps(root, ['next-sanity']);
+			for (const p of SANITY_STUDIO_PATHS) rmrf(root, p);
+			stripDeps(root, SANITY_DEPS);
 			stripEnvBlock(root, '# CMS — Sanity');
 		},
 	},
@@ -121,32 +166,46 @@ const CMS = {
 		title: 'Sanity',
 		prune: root => {
 			rmrf(root, 'src/cms/dato');
+			rmrf(root, 'src/cms/none');
 			rmrf(root, 'docs/DatoCMS');
 			stripDeps(root, ['@datocms/cda-client', 'react-datocms', 'graphql', 'graphql-tag']);
 			stripEnvBlock(root, '# CMS — DatoCMS');
-			// Rewire the adapter entry to the kept adapter
-			const entry = path.join(root, 'src/cms/index.ts');
-			if (fs.existsSync(entry)) {
-				fs.writeFileSync(entry, fs.readFileSync(entry, 'utf8').replace(`'./dato'`, `'./sanity'`));
-			}
+			rewireAdapter(root, 'sanity');
 		},
 	},
 	none: {
 		title: 'No CMS',
+		// NOTE • Same shape as the other choices — the '@cms' seam survives,
+		// rewired to the stub adapter (src/cms/none), so app code and the
+		// tsconfig alias stay valid and a CMS can be wired up later. Only the
+		// CMS-specific files go: adapters, draft-mode routes, studio, docs.
 		prune: root => {
-			rmrf(root, 'src/cms');
+			rmrf(root, 'src/cms/dato');
+			rmrf(root, 'src/cms/sanity');
+			rmrf(root, 'src/cms/draft.ts');
 			rmrf(root, 'docs/Sanity');
 			rmrf(root, 'docs/DatoCMS');
-			rmrf(root, 'docs/CMS.md');
-			stripDeps(root, ['next-sanity', '@datocms/cda-client', 'react-datocms', 'graphql', 'graphql-tag']);
+			rmrf(root, 'app/api/draft-mode');
+			for (const p of SANITY_STUDIO_PATHS) rmrf(root, p);
+			stripDeps(root, [...SANITY_DEPS, '@datocms/cda-client', 'react-datocms', 'graphql', 'graphql-tag']);
 			stripEnvBlock(root, '# CMS — Sanity');
 			stripEnvBlock(root, '# CMS — DatoCMS');
+			rewireAdapter(root, 'none');
 		},
 	},
 };
 
-// NOTE • Repo-only cargo that should never land in a scaffolded project
-const REPO_CARGO = ['tackl', '.github', 'bun.lock'];
+// NOTE • Repo-only cargo that should never land in a scaffolded project.
+// .github is pruned file-by-file — the CI workflow (.github/workflows) ships
+// with every scaffold so quality gates run from the first push.
+const REPO_CARGO = [
+	'tackl',
+	'docs/plans',
+	'.github/FUNDING.yml',
+	'.github/ISSUE_TEMPLATE.md',
+	'.github/PULL_REQUEST_TEMPLATE.md',
+	'bun.lock',
+];
 
 async function main() {
 	const args = process.argv.slice(2);
@@ -182,7 +241,9 @@ ${pc.bold('Repository:')} https://github.com/${OWNER}/${REPO}
 	const targetDir = process.cwd();
 
 	if (!dirIsScaffoldable(targetDir)) {
-		log.error('This directory is not empty. Run tackl inside an empty directory (a .git folder, .gitignore, README.md and LICENSE are fine).');
+		log.error(
+			'This directory is not empty. Run tackl inside an empty directory (a .git folder, .gitignore, README.md and LICENSE are fine).'
+		);
 		process.exit(1);
 	}
 
@@ -219,10 +280,11 @@ ${pc.bold('Repository:')} https://github.com/${OWNER}/${REPO}
 
 	const cms = cmsFlag || answers.cms;
 	const rawName = flagValue('--name') || path.basename(targetDir);
-	const projectName = rawName
-		.toLowerCase()
-		.replace(/[^a-z0-9\-._]/g, '-')
-		.replace(/^[-.]+|[-.]+$/g, '') || 'tackl-app';
+	const projectName =
+		rawName
+			.toLowerCase()
+			.replace(/[^a-z0-9\-._]/g, '-')
+			.replace(/^[-.]+|[-.]+$/g, '') || 'tackl-app';
 	const doInstall = !args.includes('--no-install');
 	const doGit = !args.includes('--no-git');
 	const hadGit = fs.existsSync(path.join(targetDir, '.git'));
@@ -294,7 +356,7 @@ ${pc.bold('Repository:')} https://github.com/${OWNER}/${REPO}
 			json.version = '0.1.0';
 			delete json.repository;
 			delete json.author;
-			fs.writeFileSync(pkgPath, JSON.stringify(json, null, '\t') + '\n');
+			fs.writeFileSync(pkgPath, `${JSON.stringify(json, null, '\t')}\n`);
 			log.ok('package.json updated.');
 		} catch (e) {
 			log.warn(`Could not update package.json: ${e.message}`);
@@ -330,11 +392,39 @@ ${pc.bold('Repository:')} https://github.com/${OWNER}/${REPO}
 		log.info('Skipped dependency install.');
 	}
 
-	console.log('\n' + pc.bold(pc.green('Success!')) + ' Project scaffolded.\n');
+	// SECTION • Sanity project link
+	// NOTE • A Sanity scaffold isn't usable until a project id exists —
+	// sanity's own init logs in, creates/links a project and writes .env.
+	let sanityLinked = false;
+	if (cms === 'sanity' && process.stdout.isTTY) {
+		const { link } = await prompts({
+			type: 'confirm',
+			name: 'link',
+			message: 'Link a Sanity project now? (opens a browser login, writes .env)',
+			initial: true,
+		});
+		if (link) {
+			try {
+				execSync('bunx sanity@latest init --env .env', { cwd: targetDir, stdio: 'inherit' });
+				sanityLinked = true;
+				log.ok('Sanity project linked!');
+			} catch (e) {
+				log.warn(`sanity init did not complete: ${e.message}`);
+			}
+		}
+	}
+
+	console.log(`\n${pc.bold(pc.green('Success!'))} Project scaffolded.\n`);
 	console.log('  Next steps:');
-	console.log('  1) cp .env.example .env   # then fill in your values');
-	if (!doInstall) console.log('  2) bun install');
-	console.log(`  ${doInstall ? '2' : '3'}) bun run dev`);
+	let step = 1;
+	if (cms === 'sanity' && !sanityLinked) {
+		console.log(`  ${step++}) bunx sanity init --env .env   # create/link your Sanity project`);
+	} else if (cms !== 'sanity') {
+		console.log(`  ${step++}) cp .env.example .env   # then fill in your values`);
+	}
+	if (!doInstall) console.log(`  ${step++}) bun install`);
+	console.log(`  ${step++}) bun run dev   # then set your tokens in src/theme`);
+	if (cms === 'sanity') console.log(`  ${step}) open http://localhost:3000/studio to start editing content`);
 }
 
 main().catch(e => {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "tackl",
-	"version": "2.0.0",
-	"description": "Scaffold a Tackl project into the current directory — Next.js, styled-components, Waffl grid, DatoCMS/Sanity adapters",
+	"version": "2.4.0",
+	"description": "Scaffold a Tackl project into the current directory — Next.js, SCSS CSS Modules, Waffl grid, DatoCMS/Sanity adapters",
 	"type": "module",
 	"bin": {
 		"tackl": "bin/tackl.js"
@@ -17,7 +17,8 @@
 		"template",
 		"grid",
 		"css",
-		"styled-components",
+		"scss",
+		"css-modules",
 		"typescript"
 	],
 	"author": "joebentaylor1995",
@@ -40,6 +41,6 @@
 	"dependencies": {
 		"picocolors": "^1.1.1",
 		"prompts": "^2.4.2",
-		"tar": "^7.5.1"
+		"tar": "^7.5.22"
 	}
 }