getfilepress 0.0.0 → 0.1.0

package/packages/import/src/write-site.ts

@@ -0,0 +1,371 @@
+import {
+	copyFileSync,
+	existsSync,
+	mkdirSync,
+	readdirSync,
+	writeFileSync,
+	rmSync
+} from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { spawnSync } from 'node:child_process';
+import type { DesignBrief, ImportOptions, SiteIR } from './ir.ts';
+import { fetchBuffer } from './fetch.ts';
+import { fetchChosenImages } from './images.ts';
+import { themeCssFromBrief } from './theme.ts';
+
+function writeAttribution(metaDir: string, ir: SiteIR) {
+	const stockLines = ir.notes.filter(
+		(n) =>
+			n.includes('Openverse') ||
+			n.startsWith('- **') ||
+			n.startsWith('Stock attribution')
+	);
+	if (!stockLines.length) return;
+	writeFileSync(
+		join(metaDir, 'IMAGE_ATTRIBUTION.md'),
+		`# Image attribution
+
+Chrome covers were fetched via [Openverse](https://openverse.org/) (Creative Commons).
+Keep this file with the site if you redistribute.
+
+${stockLines.join('\n')}
+`
+	);
+}
+
+const DEFAULT_FAVICON = resolve(
+	dirname(fileURLToPath(import.meta.url)),
+	'../../core/src/lib/assets/favicon.svg'
+);
+
+function ensureScaffold(out: string, opts: ImportOptions, title: string, url: string) {
+	const configPath = join(out, 'filepress.config.ts');
+	const needsScaffold = !existsSync(configPath) || !existsSync(join(out, 'package.json'));
+	if (!needsScaffold) {
+		mkdirSync(join(out, 'posts'), { recursive: true });
+		mkdirSync(join(out, 'pages'), { recursive: true });
+		mkdirSync(join(out, 'static'), { recursive: true });
+		return;
+	}
+
+	const createScript = join(opts.engineRoot, 'scripts', 'create-site.mjs');
+	const result = spawnSync(
+		process.execPath,
+		[
+			createScript,
+			opts.siteName,
+			'--external',
+			out,
+			'--title',
+			title,
+			'--url',
+			url,
+			...(opts.force ? ['--force'] : [])
+		],
+		{ encoding: 'utf8' }
+	);
+	if (result.status !== 0) {
+		throw new Error(`create-site failed:\n${result.stdout}\n${result.stderr}`);
+	}
+}
+
+function yamlQuote(s: string): string {
+	return JSON.stringify(s);
+}
+
+function postFilename(date: string, slug: string): string {
+	return `${date}-${slug}.md`;
+}
+
+function rewriteImageUrls(markdown: string, mapping: Map<string, string>): string {
+	let out = markdown;
+	for (const [from, to] of mapping) {
+		out = out.split(from).join(to);
+		// also without origin if relative forms appeared
+	}
+	return out;
+}
+
+async function downloadImages(
+	urls: string[],
+	staticDir: string
+): Promise<Map<string, string>> {
+	const map = new Map<string, string>();
+	const imgDir = join(staticDir, 'images');
+	mkdirSync(imgDir, { recursive: true });
+	let i = 0;
+	for (const url of urls) {
+		try {
+			const buf = await fetchBuffer(url);
+			const ext = guessExt(url, buf);
+			const base = url.split('/').pop()?.split('?')[0] || `img-${++i}`;
+			const safe = base.replace(/[^\w.-]+/g, '-').slice(0, 80) || `img-${++i}`;
+			const name = safe.includes('.') ? safe : `${safe}${ext}`;
+			const dest = join(imgDir, name);
+			writeFileSync(dest, buf);
+			map.set(url, `/images/${name}`);
+		} catch (e) {
+			console.warn(`import: image skip ${url}: ${e instanceof Error ? e.message : e}`);
+		}
+	}
+	return map;
+}
+
+/** Copy favicons / touch icons to static/ root (preserve basename). */
+async function downloadRootAssets(urls: string[], staticDir: string): Promise<void> {
+	mkdirSync(staticDir, { recursive: true });
+	for (const url of urls) {
+		try {
+			const buf = await fetchBuffer(url);
+			const name = new URL(url).pathname.split('/').filter(Boolean).pop();
+			if (!name || name.includes('..')) continue;
+			writeFileSync(join(staticDir, name), buf);
+		} catch {
+			/* optional asset */
+		}
+	}
+}
+
+function guessExt(url: string, buf: Uint8Array): string {
+	const path = new URL(url).pathname.toLowerCase();
+	if (path.endsWith('.png')) return '.png';
+	if (path.endsWith('.jpg') || path.endsWith('.jpeg')) return '.jpg';
+	if (path.endsWith('.webp')) return '.webp';
+	if (path.endsWith('.gif')) return '.gif';
+	if (path.endsWith('.svg')) return '.svg';
+	if (buf[0] === 0x89 && buf[1] === 0x50) return '.png';
+	if (buf[0] === 0xff && buf[1] === 0xd8) return '.jpg';
+	return '.bin';
+}
+
+function buildReport(ir: SiteIR, opts: ImportOptions, brief: DesignBrief | null): string {
+	const imgs = brief?.images;
+	const imageSection = imgs
+		? `## Chrome images
+
+${imgs.hero ? `- Hero cover: \`${imgs.hero}\`` : '- Hero cover: (none — typographic lede)'}
+${imgs.header ? `- Header cover: \`${imgs.header}\`` : '- Header cover: (none)'}
+${imgs.background ? `- Page background: \`${imgs.background}\`` : '- Page background: (none)'}
+${imgs.logo ? `- Logo (config): \`${imgs.logo}\`` : '- Logo: (none — text title)'}
+${imgs.portrait ? `- Portrait file (not a CSS cover): \`${imgs.portrait}\`` : '- Portrait: (none)'}
+
+Replace files under \`static/images/\` anytime; theme.css references cover paths only (not portrait).
+`
+		: `## Chrome images
+
+Not fetched. Re-run with \`--fetch-images\` to download suggested hero/header/background/logo into \`static/images/\`, or drop your own files there and set paths in \`theme.css\` / \`logo\` in config.
+`;
+
+	return `# filepress import report
+
+Source: ${ir.source.url}
+Generator guess: ${ir.source.generator ?? 'unknown'}
+Output: ${opts.out}
+Generated: ${new Date().toISOString()}
+
+## Identity
+
+- Title: ${ir.identity.title}
+- Author: ${ir.identity.author}
+- Canonical URL (config): ${opts.canonicalUrl || ir.identity.canonicalUrl}
+
+## Imported
+
+- Posts: ${ir.posts.length}
+- Pages: ${ir.pages.length}
+- Topics: ${ir.topics.map((t) => t.tag).join(', ') || '(none)'}
+
+## URL remaps
+
+Posts move to \`/posts/<slug>\` (filepress default). If you need old paths (e.g. \`/writing/…\`), add Cloudflare Pages redirects.
+
+${ir.posts.map((p) => `- \`${p.sourceUrl}\` → \`/posts/${p.slug}\``).join('\n')}
+
+${ir.pages.map((p) => `- \`${p.sourceUrl}\` → \`/${p.slug}\``).join('\n')}
+
+## Notes
+
+${ir.notes.map((n) => `- ${n}`).join('\n')}
+
+## Design
+
+${brief ? `Mood: ${brief.mood}\nDensity: ${brief.density}\nDo: ${brief.do.join('; ')}\nDon't: ${brief.dont.join('; ')}` : 'No LLM brief (token theme from defaults / source CSS).'}
+
+${imageSection}
+## Next
+
+\`\`\`bash
+cd ${opts.out}
+pnpm install
+pnpm filepress dev
+\`\`\`
+`;
+}
+
+export async function writeSite(
+	ir: SiteIR,
+	opts: ImportOptions,
+	brief: DesignBrief | null
+): Promise<{ reportPath: string }> {
+	const out = resolve(opts.out);
+	if (existsSync(out)) {
+		const entries = readdirSync(out).filter((e) => e !== '.git' && e !== 'artifacts');
+		if (entries.length && !opts.force) {
+			throw new Error(
+				`Refusing non-empty directory ${out} (pass --force to overwrite generated files carefully)`
+			);
+		}
+		if (opts.force && existsSync(join(out, 'filepress.config.ts'))) {
+			// wipe content dirs we own; keep .git
+			for (const d of ['posts', 'pages', 'static', '.filepress-import']) {
+				rmSync(join(out, d), { recursive: true, force: true });
+			}
+		}
+	}
+
+	const title = opts.title || ir.identity.title;
+	const url = opts.canonicalUrl || ir.identity.canonicalUrl;
+	const author = opts.author || ir.identity.author;
+
+	mkdirSync(out, { recursive: true });
+	ensureScaffold(out, opts, title, url);
+
+	// Remove scaffold sample content; we'll write imported files
+	rmSync(join(out, 'posts', 'hello-world.md'), { force: true });
+	rmSync(join(out, 'pages', 'about.md'), { force: true });
+	// Clear prior import posts/pages when re-running with --force
+	if (opts.force) {
+		for (const dir of ['posts', 'pages']) {
+			const abs = join(out, dir);
+			if (!existsSync(abs)) continue;
+			for (const f of readdirSync(abs)) {
+				if (f.endsWith('.md')) rmSync(join(abs, f), { force: true });
+			}
+		}
+	}
+
+	const staticDir = join(out, 'static');
+	mkdirSync(staticDir, { recursive: true });
+
+	let activeBrief = brief;
+	if (opts.fetchImages && brief?.images) {
+		console.log('import: fetching chrome images …');
+		const local = await fetchChosenImages(brief.images, staticDir);
+		activeBrief = { ...brief, images: local };
+	}
+
+	const allImages = [
+		...new Set([...ir.posts.flatMap((p) => p.imageUrls), ...ir.pages.flatMap((p) => p.imageUrls)])
+	];
+	const imageMap = await downloadImages(allImages, staticDir);
+	await downloadRootAssets(ir.assets ?? [], staticDir);
+	// Layout always links /favicon.svg — guarantee one exists for prerender.
+	const faviconDest = join(staticDir, 'favicon.svg');
+	if (!existsSync(faviconDest) && existsSync(DEFAULT_FAVICON)) {
+		copyFileSync(DEFAULT_FAVICON, faviconDest);
+	}
+
+	for (const post of ir.posts) {
+		const body = rewriteImageUrls(post.markdown, imageMap);
+		const tags =
+			post.tags.length > 0 ? `\ntags: [${post.tags.map((t) => yamlQuote(t)).join(', ')}]` : '';
+		const desc = post.description ? `\ndescription: ${yamlQuote(post.description)}` : '';
+		const md = `---
+title: ${yamlQuote(post.title)}
+date: ${post.date}
+slug: ${yamlQuote(post.slug)}${desc}${tags}
+---
+
+${body}
+`;
+		writeFileSync(join(out, 'posts', postFilename(post.date, post.slug)), md);
+	}
+
+	for (const page of ir.pages) {
+		const body = rewriteImageUrls(page.markdown, imageMap);
+		const desc = page.description ? `\ndescription: ${yamlQuote(page.description)}` : '';
+		const md = `---
+title: ${yamlQuote(page.title)}${desc}
+order: ${page.order}
+---
+
+${body}
+`;
+		writeFileSync(join(out, 'pages', `${page.slug}.md`), md);
+	}
+
+	const topicsLit = ir.topics
+		.map((t) => `\t\t{ label: ${yamlQuote(t.label)}, tag: ${yamlQuote(t.tag)} }`)
+		.join(',\n');
+	const navLit = ir.nav
+		.map((n) => `\t\t{ label: ${yamlQuote(n.label)}, href: ${yamlQuote(n.href)} }`)
+		.join(',\n');
+	const ledeLine = ir.lede ? `\n\tlede: ${yamlQuote(ir.lede)},` : '';
+	const logo = activeBrief?.images?.logo;
+	const logoLine = logo ? `\n\tlogo: ${yamlQuote(logo)},` : '';
+
+	writeFileSync(
+		join(out, 'filepress.config.ts'),
+		`import { defineFilepressConfig } from 'getfilepress';
+
+export default defineFilepressConfig({
+	title: ${yamlQuote(title)},
+	description: ${yamlQuote(ir.identity.description)},
+	url: ${yamlQuote(url)},
+	author: ${yamlQuote(author)},${ledeLine}${logoLine}
+	nav: [
+${navLit}
+	],
+	topics: [
+${topicsLit}
+	]
+});
+`
+	);
+
+	writeFileSync(join(out, 'theme.css'), themeCssFromBrief(activeBrief ?? undefined));
+
+	const metaDir = join(out, '.filepress-import');
+	mkdirSync(metaDir, { recursive: true });
+	writeFileSync(join(metaDir, 'site-ir.json'), JSON.stringify(ir, null, 2));
+	if (activeBrief)
+		writeFileSync(join(metaDir, 'design-brief.json'), JSON.stringify(activeBrief, null, 2));
+	writeAttribution(metaDir, ir);
+	const reportPath = join(metaDir, 'import-report.md');
+	writeFileSync(reportPath, buildReport(ir, opts, activeBrief));
+
+	// gitignore import cache
+	const gi = join(out, '.gitignore');
+	writeFileSync(
+		gi,
+		`/build
+/node_modules
+.DS_Store
+Thumbs.db
+.filepress/
+.filepress-genie/
+.filepress-import/crawl-cache/
+`
+	);
+
+	return { reportPath };
+}
+
+export function defaultEngineRoot(): string {
+	// packages/import/src → repo root
+	return resolve(dirname(fileURLToPath(import.meta.url)), '../../..');
+}
+
+export function defaultOutPath(engineRoot: string, siteName: string): string {
+	return resolve(engineRoot, '..', siteName);
+}
+
+export function siteNameFromUrl(source: string): string {
+	try {
+		const host = new URL(source).hostname.replace(/^www\./, '');
+		return host.split('.')[0].toLowerCase().replace(/[^a-z0-9-]+/g, '-') || 'imported-site';
+	} catch {
+		return 'imported-site';
+	}
+}

package/packages/import/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"module": "esnext",
+		"moduleResolution": "bundler",
+		"target": "esnext",
+		"strict": true,
+		"skipLibCheck": true,
+		"noEmit": true,
+		"lib": ["ESNext", "DOM"],
+		"types": ["node"]
+	},
+	"include": ["src/**/*.ts"]
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - 'packages/*'

package/scripts/create-site.mjs

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+// Scaffold a content-only filepress site.
+//
+// Monorepo (default):
+//   node scripts/create-site.mjs my-site --title "My Site" --url https://my.site
+//   → sites/my-site/
+//
+// External sibling repo:
+//   node scripts/create-site.mjs example-site --external ../example-site \
+//     --title "…" --url https://…
+//   → writes package.json with "getfilepress": "link:<rel-to-engine>"
+//
+// Refuses a non-empty target (edge case 18), unless --force is passed (still
+// refuses to overwrite filepress.config.ts / package.json if present).
+
+import { copyFileSync, existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';
+import { dirname, join, relative, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const scriptDir = dirname(fileURLToPath(import.meta.url));
+const repoRoot = resolve(scriptDir, '..');
+
+function fail(msg) {
+	console.error(`create-site: ${msg}`);
+	process.exit(1);
+}
+
+function parseArgs(argv) {
+	const args = { _: [], force: false };
+	for (let i = 0; i < argv.length; i++) {
+		const a = argv[i];
+		if (a === '--title' || a === '--url' || a === '--external') args[a.slice(2)] = argv[++i];
+		else if (a === '--force') args.force = true;
+		else args._.push(a);
+	}
+	return args;
+}
+
+const args = parseArgs(process.argv.slice(2));
+const name = args._[0];
+
+if (!name) {
+	fail(
+		'missing site name.\n' +
+			'  Usage: node scripts/create-site.mjs <name> [--title ..] [--url ..] [--external <path>]'
+	);
+}
+if (!/^[a-z0-9][a-z0-9-]*$/.test(name)) {
+	fail(`invalid site name "${name}". Use lowercase letters, numbers, and hyphens.`);
+}
+
+const external = Boolean(args.external);
+const target = external ? resolve(repoRoot, args.external) : join(repoRoot, 'sites', name);
+
+if (existsSync(target)) {
+	const entries = readdirSync(target).filter((e) => e !== '.git' && e !== 'artifacts');
+	if (entries.length > 0 && !args.force) {
+		fail(`refusing to overwrite non-empty directory: ${target} (pass --force to merge carefully)`);
+	}
+	if (existsSync(join(target, 'filepress.config.ts'))) {
+		fail(`filepress.config.ts already exists in ${target}`);
+	}
+	if (external && existsSync(join(target, 'package.json'))) {
+		fail(`package.json already exists in ${target}`);
+	}
+}
+
+const title = args.title || name;
+const url = args.url || `https://${name}.example.com`;
+
+mkdirSync(join(target, 'posts'), { recursive: true });
+mkdirSync(join(target, 'pages'), { recursive: true });
+mkdirSync(join(target, 'static'), { recursive: true });
+
+const defaultFavicon = join(repoRoot, 'packages', 'core', 'src', 'lib', 'assets', 'favicon.svg');
+if (existsSync(defaultFavicon)) {
+	copyFileSync(defaultFavicon, join(target, 'static', 'favicon.svg'));
+}
+
+const configImport = external
+	? `import { defineFilepressConfig } from 'getfilepress';`
+	: `import { defineFilepressConfig } from 'getfilepress';`;
+
+writeFileSync(
+	join(target, 'filepress.config.ts'),
+	`${configImport}
+
+export default defineFilepressConfig({
+	title: ${JSON.stringify(title)},
+	description: 'A filepress site.',
+	url: ${JSON.stringify(url)},
+	author: ${JSON.stringify(title)},
+	topics: []
+});
+`
+);
+
+writeFileSync(
+	join(target, '.gitignore'),
+	`/build
+/node_modules
+.DS_Store
+Thumbs.db
+.filepress/
+.filepress-genie/
+.filepress-import/crawl-cache/
+`
+);
+
+const today = new Date().toISOString().slice(0, 10);
+writeFileSync(
+	join(target, 'posts', 'hello-world.md'),
+	`---
+title: "Hello, world"
+date: ${today}
+description: The first post on ${title}.
+tags: [meta]
+---
+
+This is your first post. Edit or replace \`posts/hello-world.md\`, then push.
+`
+);
+
+writeFileSync(
+	join(target, 'pages', 'about.md'),
+	`---
+title: About
+description: About ${title}.
+order: 1
+---
+
+Tell visitors who you are. This page lives at \`/about\` — edit \`pages/about.md\`.
+`
+);
+
+if (external) {
+	const relToEngine = relative(target, repoRoot).replace(/\\/g, '/') || '..';
+	writeFileSync(
+		join(target, 'package.json'),
+		JSON.stringify(
+			{
+				name,
+				private: true,
+				version: '0.0.1',
+				type: 'module',
+				scripts: {
+					dev: 'filepress dev',
+					build: 'filepress build',
+					preview: 'filepress preview',
+					check: 'filepress check'
+				},
+				devDependencies: {
+					// link: uses the live engine tree (with its workspace node_modules).
+					// Alternatives after publish / push:
+					// "getfilepress": "^0.1.0"
+					// "getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.0"
+					getfilepress: `link:${relToEngine}`
+				}
+			},
+			null,
+			'\t'
+		) + '\n'
+	);
+
+	writeFileSync(
+		join(target, 'tsconfig.json'),
+		`{
+	"compilerOptions": {
+		"module": "esnext",
+		"moduleResolution": "bundler",
+		"target": "esnext",
+		"strict": true,
+		"skipLibCheck": true,
+		"noEmit": true,
+		"allowImportingTsExtensions": true
+	},
+	"include": ["filepress.config.ts"]
+}
+`
+	);
+
+	writeFileSync(
+		join(target, 'README.md'),
+		`# ${title}
+
+Content-only filepress site. Local engine via \`link:${relToEngine}\`.
+
+\`\`\`bash
+# once in the engine repo
+cd ${relToEngine} && pnpm install
+
+# in this site
+pnpm install
+pnpm dev
+pnpm build    # → build/
+\`\`\`
+
+Optional: add \`theme.css\` next to \`filepress.config.ts\` to
+override the default Essay theme.
+
+## Deploy (Cloudflare Pages)
+
+\`link:\` only works on your machine. For CI/hosting, switch to npm or a git pin:
+
+\`\`\`json
+"getfilepress": "^0.1.0"
+\`\`\`
+
+or:
+
+\`\`\`json
+"getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.0"
+\`\`\`
+
+| Setting | Value |
+| --- | --- |
+| Build command | \`pnpm install && pnpm build\` |
+| Output directory | \`build\` |
+`
+	);
+
+	console.log(`Created external site at ${target}`);
+	console.log(`Next:`);
+	console.log(`  cd ${relToEngine} && pnpm install   # if not already`);
+	console.log(`  cd ${target} && pnpm install && pnpm dev`);
+} else {
+	writeFileSync(
+		join(target, 'tsconfig.json'),
+		`{
+	"compilerOptions": {
+		"module": "esnext",
+		"moduleResolution": "bundler",
+		"target": "esnext",
+		"strict": true,
+		"skipLibCheck": true,
+		"noEmit": true,
+		"allowImportingTsExtensions": true
+	},
+	"include": ["filepress.config.ts"]
+}
+`
+	);
+
+	writeFileSync(
+		join(target, 'README.md'),
+		`# ${title}
+
+Content-only filepress site (monorepo). Edit [\`filepress.config.ts\`](filepress.config.ts)
+and [\`posts/\`](posts/). Optional [\`theme.css\`](theme.css) overrides the Essay theme.
+
+\`\`\`bash
+pnpm filepress dev --site ${name}
+pnpm filepress build --site ${name}   # → build/
+\`\`\`
+`
+	);
+
+	console.log(`Created sites/${name} (content-only)`);
+	console.log(`Next: pnpm filepress dev --site ${name}`);
+}