@janga/norna 0.7.13 → 0.7.15

package/scripts/lib/typography.mjs

@@ -1,7 +1,7 @@
-export const typographyPresetNames = [
-	'quiet-gallery',
-	'compact-gallery',
-	'text-forward',
+export const typographyProfileNames = [
+	'restrained',
+	'dense',
+	'reading',
 	'statement',
 ];
 
@@ -11,8 +11,8 @@ export const typographyRhythmNames = [
 	'airy',
 ];
 
-export const typographyPresets = {
-	'quiet-gallery': {
+export const typographyProfiles = {
+	restrained: {
 		headings: {
 			h1: {
 				align: { desktop: 'left', mobile: 'left' },
@@ -51,7 +51,7 @@ export const typographyPresets = {
 			lineHeight: 1.35,
 		},
 	},
-	'compact-gallery': {
+	dense: {
 		headings: {
 			h1: {
 				align: { desktop: 'left', mobile: 'left' },
@@ -90,7 +90,7 @@ export const typographyPresets = {
 			lineHeight: 1.25,
 		},
 	},
-	'text-forward': {
+	reading: {
 		headings: {
 			h1: {
 				align: { desktop: 'left', mobile: 'left' },
@@ -216,7 +216,7 @@ export const typographyRhythms = {
 };
 
 export const defaultTypography = {
-	preset: 'quiet-gallery',
+	profile: 'restrained',
 	rhythm: 'normal',
 };
 
@@ -243,13 +243,13 @@ export const mergeDeep = (base, override) => {
 };
 
 export const resolveTypographyConfig = (typography = defaultTypography) => {
-	const presetName = typography?.preset ?? defaultTypography.preset;
+	const profileName = typography?.profile ?? defaultTypography.profile;
 	const rhythmName = typography?.rhythm ?? defaultTypography.rhythm;
-	const preset = typographyPresets[presetName];
+	const profile = typographyProfiles[profileName];
 	const rhythm = typographyRhythms[rhythmName];
 
-	if (!preset) {
-		throw new Error(`Unknown typography preset: ${presetName}`);
+	if (!profile) {
+		throw new Error(`Unknown typography profile: ${profileName}`);
 	}
 
 	if (!rhythm) {
@@ -257,9 +257,9 @@ export const resolveTypographyConfig = (typography = defaultTypography) => {
 	}
 
 	return {
-		preset: presetName,
+		profile: profileName,
 		rhythm: rhythmName,
-		values: mergeDeep(mergeDeep(preset, rhythm), typography?.overrides),
+		values: mergeDeep(mergeDeep(profile, rhythm), typography?.overrides),
 	};
 };
 

package/scripts/lib/yaml-config.mjs

@@ -0,0 +1,50 @@
+import { load } from 'js-yaml';
+import {
+	validateFrontmatterIndentation,
+} from './site-content.mjs';
+
+const formatSchemaIssues = (issues) => issues.map((issue) => {
+	const location = issue.path.join('.') || '(root)';
+	return `- ${location}: ${issue.message}`;
+});
+
+export const parseYamlConfig = (source, label, {
+	schema,
+	validateStructure,
+} = {}) => {
+	const issues = [];
+
+	validateFrontmatterIndentation(source, (issue) => issues.push(issue));
+	validateStructure?.(source, (issue) => issues.push(issue));
+
+	if (issues.length > 0) {
+		throw new Error([
+			`${label} has invalid YAML structure.`,
+			...issues.map((issue) => `- ${issue.message}`),
+		].join('\n'));
+	}
+
+	let data;
+	try {
+		data = load(source) ?? {};
+	} catch (error) {
+		const detail = error instanceof Error ? error.message : String(error);
+		throw new Error(`${label} contains invalid YAML.\n${detail}`);
+	}
+
+	if (!data || typeof data !== 'object' || Array.isArray(data)) {
+		throw new Error(`${label} must contain a YAML mapping at the top level.`);
+	}
+
+	if (!schema) return data;
+
+	const parsed = schema.safeParse(data);
+	if (!parsed.success) {
+		throw new Error([
+			`${label} has invalid values.`,
+			...formatSchemaIssues(parsed.error.issues),
+		].join('\n'));
+	}
+
+	return parsed.data;
+};

package/scripts/list-theme-presets.mjs

@@ -0,0 +1,15 @@
+import {
+	getThemePresetMetadata,
+	themePresetNames,
+} from './lib/theme-presets.mjs';
+
+const args = process.argv.slice(2);
+if (args.length > 0) {
+	throw new Error('Usage: norna theme:presets');
+}
+
+console.log('Theme presets\n');
+for (const name of themePresetNames) {
+	const preset = getThemePresetMetadata(name);
+	console.log(`${name}\n  ${preset.description}`);
+}

package/scripts/release.mjs

@@ -3,6 +3,7 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { promisify } from 'node:util';
 import { execFile } from 'node:child_process';
+import { getShortGitStatusPath, parseShortGitStatus } from './lib/git-status.mjs';
 import { runInherit } from './lib/run-command.mjs';
 
 const execFileAsync = promisify(execFile);
@@ -17,7 +18,7 @@ const showHelp = releaseArguments.includes('--help') || releaseArguments.include
 
 const printUsage = () => {
 	console.log('Usage: node scripts/release.mjs <patch|minor|major>');
-	console.log('Checks npm authentication, runs npm test, creates the version commit and tag, publishes to npm, then pushes the commit and tag.');
+	console.log('Checks npm authentication, prepares the version and schemas, runs npm test, creates the release commit and tag, publishes to npm, then pushes.');
 };
 
 const run = (command, args) => runInherit(command, args, { cwd: repoRoot });
@@ -27,6 +28,48 @@ const readPackageVersion = async () => {
 	return packageJson.version;
 };
 
+const releasePaths = ['package.json', 'package-lock.json', 'schemas'];
+
+const getWorktreeChanges = async () => {
+	const { stdout } = await execFileAsync('git', ['status', '--short'], { cwd: repoRoot });
+	return parseShortGitStatus(stdout);
+};
+
+const isReleasePath = (filePath) => (
+	filePath === 'package.json'
+	|| filePath === 'package-lock.json'
+	|| filePath === 'schemas'
+	|| filePath.startsWith('schemas/')
+);
+
+const assertOnlyReleaseChanges = async () => {
+	const changes = await getWorktreeChanges();
+	const unexpected = changes.filter((line) => !isReleasePath(getShortGitStatusPath(line)));
+	if (unexpected.length > 0) {
+		throw new Error(`Release checks changed unexpected files:\n${unexpected.join('\n')}`);
+	}
+	for (const requiredPath of ['package.json', 'package-lock.json']) {
+		if (!changes.some((line) => getShortGitStatusPath(line) === requiredPath)) {
+			throw new Error(`Release preparation did not update ${requiredPath}.`);
+		}
+	}
+};
+
+const assertTagDoesNotExist = async (tag) => {
+	try {
+		await execFileAsync('git', ['rev-parse', '--quiet', '--verify', `refs/tags/${tag}`], { cwd: repoRoot });
+	} catch (error) {
+		if (error?.code === 1) return;
+		throw error;
+	}
+	throw new Error(`Git tag ${tag} already exists.`);
+};
+
+const rollbackPreparedRelease = async () => {
+	await execFileAsync('git', ['restore', '--staged', '--worktree', '--', ...releasePaths], { cwd: repoRoot });
+	console.log('Release preparation failed before commit. Restored package version and generated schemas.');
+};
+
 const assertCleanWorktree = async (stage) => {
 	const { stdout } = await execFileAsync('git', ['status', '--short'], { cwd: repoRoot });
 
@@ -61,17 +104,50 @@ if (showHelp || !releaseType) {
 	throw new Error(`Unsupported release type: ${releaseType}`);
 } else {
 	const previousVersion = await readPackageVersion();
+	let preparationStarted = false;
+	let releaseCommitCreated = false;
+	let releaseTagCreated = false;
+	let publishedVersion = null;
 
 	await assertCleanWorktree('before the release checks');
 	await assertNpmAuthenticated();
 	console.log(`Preparing a ${releaseType} release from ${previousVersion}.`);
-	await run(npmBin, ['test']);
-	await assertCleanWorktree('after the release checks');
-	await run(npmBin, ['version', releaseType, '--message', 'Release %s']);
 
-	const publishedVersion = await readPackageVersion();
-	await run(npmBin, ['run', 'release:publish']);
-	await run('git', ['push', '--follow-tags']);
+	try {
+		preparationStarted = true;
+		await run(npmBin, ['version', releaseType, '--no-git-tag-version']);
+		publishedVersion = await readPackageVersion();
+		const releaseTag = `v${publishedVersion}`;
+		if (publishedVersion === previousVersion) {
+			throw new Error(`Version did not change from ${previousVersion}.`);
+		}
+
+		await assertTagDoesNotExist(releaseTag);
+		await run(npmBin, ['run', 'schemas:generate']);
+		await run(npmBin, ['test']);
+		await assertOnlyReleaseChanges();
+		await run('git', ['add', ...releasePaths]);
+		await run('git', ['commit', '-m', `Release ${releaseTag}`]);
+		releaseCommitCreated = true;
+		await run('git', ['tag', releaseTag]);
+		releaseTagCreated = true;
+		await run(npmBin, ['run', 'release:publish']);
+		await run('git', ['push', '--follow-tags']);
 
-	console.log(`Released @janga/norna@${publishedVersion}.`);
+		console.log(`Released @janga/norna@${publishedVersion}.`);
+	} catch (error) {
+		if (preparationStarted && !releaseCommitCreated) {
+			try {
+				await rollbackPreparedRelease();
+			} catch (rollbackError) {
+				throw new AggregateError([error, rollbackError], 'Release failed and automatic rollback also failed.');
+			}
+		} else if (releaseCommitCreated) {
+			const state = releaseTagCreated
+				? `Release commit and tag v${publishedVersion} remain locally.`
+				: `Release commit for v${publishedVersion} remains locally, but its tag was not created.`;
+			console.error(state);
+		}
+		throw error;
+	}
 }

package/scripts/show-typography.mjs

@@ -1,22 +1,19 @@
 import { readFile } from 'node:fs/promises';
 import path from 'node:path';
-import { parseYamlMapping } from './lib/frontmatter-yaml.mjs';
 import {
 	defaultTypography,
 	resolveTypographyConfig,
 	toYamlLines,
-	typographyPresets,
+	typographyProfiles,
 	typographyRhythms,
 } from './lib/typography.mjs';
 import {
 	getBodySections,
 	getContentFiles,
 	readSiteFile,
-	splitSiteFile,
 	validateContentFrontmatterStructure,
 	validateFrontmatterIndentation,
-	validateRouteThemeFrontmatterStructure,
-	validateThemeFrontmatterStructure,
+	validateRouteThemeYamlStructure,
 } from './lib/site-content.mjs';
 import {
 	siteContentLabel,
@@ -25,7 +22,9 @@ import {
 	siteThemeLabel,
 	siteThemePath,
 } from './lib/site-paths.mjs';
+import { readThemeConfig } from './lib/theme-config.mjs';
 import { resolveThemeConfig } from './lib/theme-presets.mjs';
+import { parseYamlConfig } from './lib/yaml-config.mjs';
 
 const mode = process.argv[2] ?? 'show';
 
@@ -130,7 +129,7 @@ const annotateResolvedValues = (resolved, sources) => {
 	return annotated;
 };
 
-const defaultSources = (presetName, rhythmName) => {
+const defaultSources = (profileName, rhythmName) => {
 	const sources = {};
 
 	for (const path of typographyValuePaths) {
@@ -138,7 +137,7 @@ const defaultSources = (presetName, rhythmName) => {
 		setPath(sources, path, {
 			source: rhythmValuePaths.has(pathKey)
 				? `rhythm:${rhythmName}`
-				: `preset:${presetName}`,
+				: `profile:${profileName}`,
 			inherited: false,
 		});
 	}
@@ -165,16 +164,16 @@ const applyOverrideSources = (sources, typographyConfig, sourceLabel) => {
 const resolveAnnotatedTypographyConfig = (typographyConfig, sourceLabel) => {
 	const resolved = resolveTypographyConfig(typographyConfig ?? defaultTypography);
 	const sources = applyOverrideSources(
-		defaultSources(resolved.preset, resolved.rhythm),
+		defaultSources(resolved.profile, resolved.rhythm),
 		typographyConfig,
 		sourceLabel,
 	);
 
 	return {
-		preset: {
-			value: resolved.preset,
-			source: typographyConfig?.preset ? sourceLabel : 'engine default',
-			...(typographyConfig?.preset ? {} : { inherited: true }),
+		profile: {
+			value: resolved.profile,
+			source: typographyConfig?.profile ? sourceLabel : 'engine default',
+			...(typographyConfig?.profile ? {} : { inherited: true }),
 		},
 		rhythm: {
 			value: resolved.rhythm,
@@ -187,25 +186,13 @@ const resolveAnnotatedTypographyConfig = (typographyConfig, sourceLabel) => {
 };
 
 const formatAnnotatedTypography = (annotated) => ({
-	preset: annotated.preset,
+	profile: annotated.profile,
 	rhythm: annotated.rhythm,
 	resolved: annotateResolvedValues(annotated.resolved, annotated.sources),
 });
 
 const readThemeTypography = async () => {
-	const themeFile = await readFile(siteThemePath, 'utf8');
-	const { frontmatter: themeFrontmatter, frontmatterBody: themeFrontmatterBody } = splitSiteFile(themeFile, siteThemeLabel);
-	const indentationIssues = [];
-	validateFrontmatterIndentation(themeFrontmatter, (issue) => indentationIssues.push(issue));
-	validateThemeFrontmatterStructure(themeFrontmatter, (issue) => indentationIssues.push(issue));
-	if (indentationIssues.length > 0) {
-		throw new Error([
-			`Cannot inspect typography because ${siteThemeLabel} has invalid frontmatter.`,
-			...indentationIssues.map((issue) => `- ${issue.message}`),
-		].join('\n'));
-	}
-
-	const themeConfig = resolveThemeConfig(parseYamlMapping(themeFrontmatterBody), siteThemeLabel);
+	const themeConfig = resolveThemeConfig(await readThemeConfig(), siteThemeLabel);
 	const themeTypographyConfig = themeConfig.typography;
 	return resolveAnnotatedTypographyConfig(themeTypographyConfig ?? defaultTypography, siteThemeLabel);
 };
@@ -213,26 +200,17 @@ const readThemeTypography = async () => {
 const readRouteThemeTypography = async (contentFile, themeTypography) => {
 	if (contentFile.isHome) return themeTypography;
 
-	const routeThemePath = path.join(siteRoutesDir, contentFile.routeDirectory, 'theme.md');
-	const routeThemeLabel = `${contentFile.contentLabel.replace(/\/route-content\.md$/, '')}/theme.md`;
+	const routeThemePath = path.join(siteRoutesDir, contentFile.routeDirectory, 'theme.yaml');
 	const routeThemeFile = await readFile(routeThemePath, 'utf8').catch((error) => {
 		if (error?.code === 'ENOENT') return null;
 		throw error;
 	});
 	if (!routeThemeFile) return themeTypography;
+	const routeThemeLabel = `${contentFile.contentLabel.replace(/\/content\.md$/, '')}/theme.yaml`;
 
-	const { frontmatter, frontmatterBody } = splitSiteFile(routeThemeFile, routeThemeLabel);
-	const indentationIssues = [];
-	validateFrontmatterIndentation(frontmatter, (issue) => indentationIssues.push(issue));
-	validateRouteThemeFrontmatterStructure(frontmatter, (issue) => indentationIssues.push(issue));
-	if (indentationIssues.length > 0) {
-		throw new Error([
-			`Cannot inspect typography because ${routeThemeLabel} has invalid frontmatter.`,
-			...indentationIssues.map((issue) => `- ${issue.message}`),
-		].join('\n'));
-	}
-
-	const routeThemeConfig = resolveThemeConfig(parseYamlMapping(frontmatterBody), routeThemeLabel);
+	const routeThemeConfig = resolveThemeConfig(parseYamlConfig(routeThemeFile, routeThemeLabel, {
+		validateStructure: validateRouteThemeYamlStructure,
+	}), routeThemeLabel);
 	const typographyConfig = routeThemeConfig.typography;
 	return resolveAnnotatedTypographyConfig(typographyConfig ?? defaultTypography, routeThemeLabel);
 };
@@ -267,9 +245,9 @@ const readPageTypography = async (contentFile, siteThemeTypography) => {
 	};
 };
 
-if (mode === 'presets') {
+if (mode === 'profiles') {
 	console.log(toYamlLines({
-		presets: typographyPresets,
+		profiles: typographyProfiles,
 		rhythms: typographyRhythms,
 	}).join('\n'));
 } else if (mode === 'show') {
@@ -278,9 +256,7 @@ if (mode === 'presets') {
 	const output = {
 		theme: {
 			source: siteThemeLabel,
-			presentation: {
-				typography: formatAnnotatedTypography(themeTypography),
-			},
+			typography: formatAnnotatedTypography(themeTypography),
 		},
 		pages: Object.fromEntries(pages.map((page) => [
 			page.route,
@@ -299,5 +275,5 @@ if (mode === 'presets') {
 
 	console.log(toYamlLines(output).join('\n'));
 } else {
-	throw new Error('Usage: norna typography presets|show');
+	throw new Error('Usage: norna typography profiles|show');
 }

package/scripts/sync-content-sections.mjs

@@ -21,7 +21,7 @@ import {
 	toPosixPath,
 	validateContentFrontmatterStructure,
 	validateFrontmatterIndentation,
-	validateThemeFrontmatterStructure,
+	validateThemeYamlStructure,
 } from './lib/site-content.mjs';
 import { readImageDimensions } from './lib/image-dimensions.mjs';
 import {
@@ -393,7 +393,7 @@ let themeFrontmatter = null;
 try {
 	themeFrontmatter = (await readThemeFile(siteThemePath)).frontmatter;
 	validateFrontmatterIndentation(themeFrontmatter, addIssue);
-	validateThemeFrontmatterStructure(themeFrontmatter, addIssue);
+	validateThemeYamlStructure(themeFrontmatter, addIssue);
 } catch (error) {
 	if (error?.code !== 'ENOENT') {
 		throw error;

package/scripts/test-client-javascript.mjs

@@ -11,7 +11,7 @@ await mkdir(tempParent, { recursive: true });
 const tempRoot = await mkdtemp(path.join(tempParent, 'norna-client-javascript-'));
 const siteDir = path.join(tempRoot, 'site');
 const routeDir = path.join(siteDir, 'routes', '010-details');
-const configPath = path.join(siteDir, 'config.md');
+const configPath = path.join(siteDir, 'config.yaml');
 
 const runBuild = () => {
 	const result = spawnSync(process.execPath, [nornaBin, 'build'], {
@@ -44,10 +44,8 @@ const assertScrollBehavior = (html, behavior, label) => {
 		`${label} should render scroll-behavior: ${behavior}.`,
 	);
 };
-const writeConfig = (scrollBehavior) => writeFile(configPath, `---
-url: https://example.com/
-${scrollBehavior ? `scrollBehavior: ${scrollBehavior}\n` : ''}---
-`);
+const writeConfig = (scrollBehavior) => writeFile(configPath, `url: https://example.com/
+${scrollBehavior ? `scrollBehavior: ${scrollBehavior}\n` : ''}`);
 const writeSvg = (filePath, color) => writeFile(filePath, [
 	'<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 160 90">',
 	`  <rect width="160" height="90" fill="${color}"/>`,
@@ -58,46 +56,50 @@ const writeSvg = (filePath, color) => writeFile(filePath, [
 try {
 	await mkdir(path.join(siteDir, 'public'), { recursive: true });
 	await writeConfig();
-	await writeFile(path.join(siteDir, 'theme.md'), `---
-typography:
-  preset: text-forward
-presentation:
-  palette: paper
----
+	await writeFile(path.join(siteDir, 'theme.yaml'), `typography:
+  profile: reading
+palette: paper
 `);
-	await writeFile(path.join(siteDir, 'sitewide-content.md'), `---
-navigation:
-  brand: Test site
----
+	await writeFile(path.join(siteDir, 'sitewide-content.yaml'), `navigation:
+  label: Test site
 `);
 	await writeFile(path.join(siteDir, 'content.md'), `---
-title: Static single page
-description: A single page without interactive features.
+title: Section navigation
+description: A single page with sticky section navigation.
 sections:
   intro: {}
   more: {}
 ---
 ## Intro {#intro}
 
-Ordinary Markdown needs no client-side JavaScript.
+The section heading is a native anchor target.
 
 ## More {#more}
 
-Additional sections do not make the page interactive.
+The navigation enhancement keeps native anchors clear of the sticky header.
 `);
 
 	runBuild();
 	const instantHtml = await readPage();
-	assertNoClientJavaScript(instantHtml, 'The default instant scroll mode');
+	assert.equal(
+		getScripts(instantHtml).length,
+		1,
+		'Sticky section navigation should load only its anchor-offset enhancement.',
+	);
+	assert.match(getScripts(instantHtml)[0], /site-top-anchor-offset/);
 	assertScrollBehavior(instantHtml, 'auto', 'The default instant scroll mode');
 	assert.match(instantHtml, /<nav class="page-nav"/);
 	assert.match(instantHtml, /href="#intro"/);
 	assert.match(instantHtml, /href="#more"/);
 
-	await writeConfig('browser-smooth');
+	await writeConfig('smooth');
 	runBuild();
 	const browserSmoothHtml = await readPage();
-	assertNoClientJavaScript(browserSmoothHtml, 'The browser smooth scroll mode');
+	assert.equal(
+		getScripts(browserSmoothHtml).length,
+		1,
+		'Browser smooth scrolling should use the same anchor-offset enhancement.',
+	);
 	assertScrollBehavior(browserSmoothHtml, 'smooth', 'The browser smooth scroll mode');
 
 	await writeConfig();
@@ -115,7 +117,7 @@ sections:
 
 Ordinary Markdown needs no client-side JavaScript.
 `);
-	await writeFile(path.join(routeDir, 'route-content.md'), `---
+	await writeFile(path.join(routeDir, 'content.md'), `---
 title: Details
 description: Static managed images.
 sections:
@@ -157,7 +159,7 @@ This sentence has additional context.{note-ref}
 
 {note: The note remains readable without JavaScript, while alignment is enhanced when JavaScript runs.}
 `);
-	await writeFile(path.join(routeDir, 'route-content.md'), `---
+	await writeFile(path.join(routeDir, 'content.md'), `---
 title: Carousel
 description: An interactive image carousel.
 sections:
@@ -192,7 +194,7 @@ sections:
 
 The only interactive feature is the banner.
 `);
-	await writeFile(path.join(routeDir, 'route-content.md'), `---
+	await writeFile(path.join(routeDir, 'content.md'), `---
 title: Details
 description: A second plain page.
 sections:
@@ -202,12 +204,10 @@ sections:
 
 Plain route content.
 `);
-	await writeFile(path.join(siteDir, 'sitewide-content.md'), `---
-banners:
+	await writeFile(path.join(siteDir, 'sitewide-content.yaml'), `banners:
   - id: test-banner
     title: Test banner
     text: This banner can be dismissed.
----
 `);
 
 	runBuild();