create-goodfellow 0.1.0 → 0.3.0

package/templates/starter/vercel.ts

@@ -0,0 +1,65 @@
+// Vercel's settings for this site, which Vercel reads when it builds the site.
+//
+// Vercel also sends the redirects from Site Settings → Redirects (content/redirects.json) itself,
+// so visitors go straight to the new address. Like the pages the build writes at old addresses
+// for other hosts, a redirect from an address a page has is left out: pages always win.
+// This file uses only Node's own modules, since Vercel may read it before installing packages.
+import { existsSync, readdirSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+
+export const config = {
+  framework: null,
+  installCommand: "npm ci",
+  buildCommand: "npx goodfellow build",
+  outputDirectory: "dist",
+  redirects: redirects(),
+};
+
+interface Redirect {
+  from: string;
+  to: string;
+}
+
+function readJson(file: string): Record<string, unknown> | undefined {
+  return existsSync(file) ? JSON.parse(readFileSync(file, "utf8")) : undefined;
+}
+
+/** Every file in a folder and its folders, as paths inside it. */
+function filesIn(dir: string): string[] {
+  if (!existsSync(dir)) return [];
+  return readdirSync(dir, { recursive: true, encoding: "utf8" }).map((file) => file.split("\\").join("/"));
+}
+
+/** The addresses that have pages: `content/pages/about.json` is /about, and each collection item has its own. */
+function pageAddresses(): Set<string> {
+  const addresses = new Set<string>();
+  for (const file of filesIn("content/pages")) {
+    if (file.endsWith(".json")) addresses.add(`/${file.slice(0, -".json".length)}`.replace(/\/?index$/, "") || "/");
+  }
+  for (const id of filesIn("content/collections").filter((file) => file.endsWith("/_collection.json"))) {
+    const folder = id.slice(0, -"/_collection.json".length);
+    const pattern = readJson(join("content/collections", id))?.path;
+    if (typeof pattern !== "string") continue;
+    for (const file of readdirSync(join("content/collections", folder))) {
+      const slug = /^(.+)\.(json|md)$/.exec(file)?.[1];
+      if (slug && file !== "_collection.json") addresses.add(pattern.replace("{slug}", slug).replace(/\/+$/, ""));
+    }
+  }
+  return addresses;
+}
+
+/** An address as Vercel matches it, with the characters its patterns use escaped. */
+function source(path: string): string {
+  return encodeURI(path).replace(/[()[\]{}+*?:!]/g, "\\$&");
+}
+
+function redirects() {
+  const list = (readJson("content/redirects.json")?.redirects ?? []) as Redirect[];
+  const pages = pageAddresses();
+  return list.flatMap(({ from, to }) => {
+    const path = from.replace(/\/+$/, "");
+    if (pages.has(path)) return [];
+    // With and without a trailing slash, as the other hosts serve the page there.
+    return [path, `${path}/`].map((address) => ({ source: source(address), destination: to, permanent: true }));
+  });
+}

package/templates/versions.json

@@ -1,13 +1,14 @@
 {
-  "@goodfellow-cms/admin": "0.1.0",
-  "@goodfellow-cms/ai": "0.1.0",
-  "@goodfellow-cms/blocks": "0.1.0",
-  "goodfellow": "0.1.0",
-  "@goodfellow-cms/core": "0.1.0",
-  "create-goodfellow": "0.1.0",
-  "@goodfellow-cms/github": "0.1.0",
-  "@goodfellow-cms/gitlab": "0.1.0",
-  "@goodfellow-cms/next": "0.1.0",
-  "@goodfellow-cms/react": "0.1.0",
-  "@goodfellow-cms/registry": "0.1.0"
+  "@goodfellow-cms/admin": "0.3.0",
+  "@goodfellow-cms/ai": "0.3.0",
+  "@goodfellow-cms/blocks": "0.3.0",
+  "goodfellow": "0.3.0",
+  "@goodfellow-cms/core": "0.3.0",
+  "create-goodfellow": "0.3.0",
+  "@goodfellow-cms/github": "0.3.0",
+  "@goodfellow-cms/gitlab": "0.3.0",
+  "@goodfellow-cms/mcp": "0.3.0",
+  "@goodfellow-cms/next": "0.3.0",
+  "@goodfellow-cms/react": "0.3.0",
+  "@goodfellow-cms/registry": "0.3.0"
 }

package/dist/scaffold-4nOF_fOJ.js

@@ -1,207 +0,0 @@
-import { cp, mkdir, readFile, readdir, rename, rm, rmdir, writeFile } from "node:fs/promises";
-import { basename, dirname, join, relative, resolve, sep } from "node:path";
-import { EMPTY_RECORD, GOODFELLOW_REGISTRY, availableBlocks, planInstall } from "@goodfellow-cms/core";
-//#region src/scaffold.ts
-/** The sites a new site can start from. The keys are what `--template` takes. */
-const TEMPLATES = {
-	starter: {
-		label: "Starter",
-		description: "A simple site with a few pages and a news section"
-	},
-	parish: {
-		label: "Parish example",
-		description: "A made-up parish with Mass times, events, news, bulletins and staff, and blocks of its own"
-	},
-	next: {
-		label: "Starter for Next.js",
-		description: "The starter as a Next.js site, for developers who want their own Next.js pages beside it"
-	}
-};
-/** Where the built site is served from. Each has its own setup file in the template. */
-const HOSTS = {
-	"github-pages": {
-		label: "GitHub Pages",
-		files: [".github/workflows/deploy.yml"],
-		note: "Free for public repositories. Not allowed for online businesses or shops."
-	},
-	"gitlab-pages": {
-		label: "GitLab Pages",
-		files: [".gitlab-ci.yml"],
-		note: "Free, including for private projects. No rule against business sites that we know of."
-	},
-	vercel: {
-		label: "Vercel",
-		files: ["vercel.json"],
-		note: "Works with GitHub and GitLab. The free plan is for non-commercial sites only."
-	}
-};
-/** The hosts that can serve a site stored with `backend`: GitHub Pages only builds GitHub repositories, and so on. */
-function hostsFor(backend) {
-	if (backend === "github") return ["github-pages", "vercel"];
-	if (backend === "gitlab") return ["gitlab-pages", "vercel"];
-	return [
-		"github-pages",
-		"gitlab-pages",
-		"vercel"
-	];
-}
-/** A problem the person creating the site can fix, described in plain words. */
-var ScaffoldError = class extends Error {
-	name = "ScaffoldError";
-};
-/** Never copied, wherever they are: installed packages and build caches. */
-const SKIPPED = /* @__PURE__ */ new Set(["node_modules", ".turbo"]);
-/** Never copied from the template's own folder: build output, and files only the Goodfellow repository uses. */
-const SKIPPED_AT_ROOT = /* @__PURE__ */ new Set([
-	"dist",
-	"out",
-	".next",
-	"next-env.d.ts",
-	"turbo.json"
-]);
-/**
-* npm leaves `.gitignore` files out of published packages, so templates are
-* bundled with `_gitignore` instead, and it's renamed back in the new site.
-*/
-const BUNDLED_GITIGNORE = "_gitignore";
-/**
-* Copies a template's files, leaving out installed packages and build output.
-* `bundling` renames `.gitignore` files for publishing; otherwise they're renamed back.
-*/
-async function copyTemplate(from, to, { bundling = false } = {}) {
-	await cp(from, to, {
-		recursive: true,
-		filter: (source) => {
-			const path = relative(from, source).split(sep);
-			return !path.some((part) => SKIPPED.has(part)) && !SKIPPED_AT_ROOT.has(path[0] ?? "");
-		}
-	});
-	const [find, replace] = bundling ? [".gitignore", BUNDLED_GITIGNORE] : [BUNDLED_GITIGNORE, ".gitignore"];
-	for (const file of await readdir(to, { recursive: true })) if (basename(file) === find) await rename(join(to, file), join(to, file.slice(0, -find.length) + replace));
-}
-/** A valid npm package name from a folder name, such as `My Parish` → `my-parish`. */
-function packageName(folder) {
-	return basename(resolve(folder)).toLowerCase().replace(/[^a-z0-9._-]+/g, "-").replace(/^[._-]+|[-]+$/g, "").slice(0, 214) || "my-site";
-}
-/**
-* Reads a repository from what someone typed: `owner/name`, or its address on
-* GitHub or GitLab. Returns `undefined` if it isn't one.
-*/
-function parseRepo(host, input) {
-	let path = input.trim().replace(/\.git$/, "").replace(/\/+$/, "");
-	const prefix = host === "github" ? /^(?:https?:\/\/)?(?:www\.)?github\.com\//i : /^(?:https?:\/\/)?gitlab\.com\//i;
-	path = path.replace(prefix, "");
-	return (host === "github" ? /^[A-Za-z0-9-]+\/[A-Za-z0-9._-]+$/ : /^[A-Za-z0-9][A-Za-z0-9._-]*(?:\/[A-Za-z0-9._-]+)+$/).test(path) ? path : void 0;
-}
-/** The template's `package.json`, named for the new site and with workspace links replaced by published versions. */
-function sitePackageJson(source, name, versions) {
-	const pkg = JSON.parse(source);
-	const result = {
-		...pkg,
-		name
-	};
-	for (const key of ["dependencies", "devDependencies"]) {
-		const deps = pkg[key];
-		if (!deps) continue;
-		result[key] = Object.fromEntries(Object.entries(deps).map(([dep, range]) => {
-			if (!range.startsWith("workspace:")) return [dep, range];
-			const version = versions[dep];
-			if (!version) throw new Error(`No version of ${dep} to use in the new site.`);
-			return [dep, `^${version}`];
-		}));
-	}
-	return `${JSON.stringify(result, null, 2)}\n`;
-}
-/** Turns on one of the commented-out `backend` lines in a template's `goodfellow.config.tsx`. */
-function configureBackend(config, backend) {
-	const importLine = `// import { ${backend.host} } from "@goodfellow-cms/${backend.host}";`;
-	const backendLine = new RegExp(`^([ \\t]*)// backend: ${backend.host}\\(.*$`, "m");
-	if (!config.includes(importLine) || !backendLine.test(config)) throw new Error(`The template's goodfellow.config.tsx has no ${backend.host} line to turn on.`);
-	const call = backend.host === "github" ? `github({ repo: ${JSON.stringify(backend.repo)} })` : `gitlab({ project: ${JSON.stringify(backend.repo)} })`;
-	return config.replace(importLine, importLine.slice(3)).replace(backendLine, `$1backend: ${call},`);
-}
-/** Notes in a site's README for people reading it in the Goodfellow repository, which new sites don't need. */
-const REPOSITORY_NOTE = /<!-- goodfellow-repository -->[\s\S]*?<!-- \/goodfellow-repository -->\n*/g;
-/** A site's README without the notes for people reading it in the Goodfellow repository. */
-function withoutRepositoryNotes(readme) {
-	return readme.replace(REPOSITORY_NOTE, "");
-}
-/** Which blocks a new site starts with, besides the built-in ones. */
-const BLOCK_CHOICES = {
-	recommended: {
-		label: "Recommended",
-		description: "Adds the recommended blocks, such as Hero, Cards and FAQ. Others can be added in the admin panel."
-	},
-	"built-in": {
-		label: "Built-in blocks only",
-		description: "Starts with Goodfellow's own blocks. More can be added in the admin panel."
-	}
-};
-/** Reads a built registry from disk, as the admin panel would read it from its address. */
-function localRegistry(dir) {
-	const base = "https://registry.invalid/r/";
-	return {
-		registries: { [GOODFELLOW_REGISTRY]: `${base}{name}.json` },
-		fetchJson: async (url) => JSON.parse(await readFile(join(dir, url.slice(27)), "utf8"))
-	};
-}
-/**
-* Installs the registry's recommended blocks into a new site, as the admin
-* panel's Blocks screen would, so the site can add and remove them there later.
-*/
-async function installRecommendedBlocks(target, registryDir) {
-	const { registries, fetchJson } = localRegistry(registryDir);
-	const recommended = (await availableBlocks(registries, fetchJson)).filter((block) => block.recommended);
-	const readSiteFile = (path) => readFile(join(target, path), "utf8").catch(() => void 0);
-	let record = EMPTY_RECORD;
-	for (const block of recommended) {
-		const plan = await planInstall({
-			ref: block.ref,
-			registries,
-			fetchJson,
-			readFile: readSiteFile,
-			record,
-			blocks: []
-		});
-		for (const change of plan.changes) {
-			if (!("content" in change)) continue;
-			await mkdir(dirname(join(target, change.path)), { recursive: true });
-			await writeFile(join(target, change.path), change.content);
-		}
-		record = plan.record;
-	}
-	return recommended.map((block) => block.title);
-}
-async function isEmptyFolder(path) {
-	try {
-		return (await readdir(path)).length === 0;
-	} catch (error) {
-		if (error.code === "ENOENT") return true;
-		throw error;
-	}
-}
-/** Creates a new site in `target` from a template. */
-async function scaffold({ template, target, versions, backend, host, registryDir }) {
-	if (!await isEmptyFolder(target)) throw new ScaffoldError(`The folder ${target} already has files in it. Choose a new folder for the site.`);
-	await mkdir(target, { recursive: true });
-	await copyTemplate(template, target);
-	const pkgPath = join(target, "package.json");
-	await writeFile(pkgPath, sitePackageJson(await readFile(pkgPath, "utf8"), packageName(target), versions));
-	const readmePath = join(target, "README.md");
-	const readme = await readFile(readmePath, "utf8").catch(() => void 0);
-	if (readme !== void 0) await writeFile(readmePath, withoutRepositoryNotes(readme));
-	if (registryDir) await installRecommendedBlocks(target, registryDir);
-	if (backend) {
-		const configPath = join(target, "goodfellow.config.tsx");
-		await writeFile(configPath, configureBackend(await readFile(configPath, "utf8"), backend));
-	}
-	if (host) {
-		for (const [name, { files }] of Object.entries(HOSTS)) {
-			if (name === host) continue;
-			for (const file of files) await rm(join(target, file), { force: true });
-		}
-		for (const dir of [".github/workflows", ".github"]) if (await isEmptyFolder(join(target, dir))) await rmdir(join(target, dir)).catch(() => void 0);
-	}
-}
-//#endregion
-export { TEMPLATES as a, hostsFor as c, parseRepo as d, scaffold as f, ScaffoldError as i, installRecommendedBlocks as l, withoutRepositoryNotes as m, BUNDLED_GITIGNORE as n, configureBackend as o, sitePackageJson as p, HOSTS as r, copyTemplate as s, BLOCK_CHOICES as t, packageName as u };