@janga/norna 0.7.18 → 0.7.22

package/scripts/test-page-model.mjs

@@ -1,108 +0,0 @@
-import assert from 'node:assert/strict';
-import {
-	decodePageDirectoryPath,
-	encodePageDirectoryPath,
-	getPageDirectoryAncestors,
-	parsePageDirectory,
-	parsePageDirectoryPath,
-} from './lib/page-model.mjs';
-
-assert.deepEqual(parsePageDirectory('010-getting-started'), {
-	pageDirectory: '010-getting-started',
-	pageOrder: 10,
-	pageId: 'getting-started',
-});
-
-assert.deepEqual(parsePageDirectory('120-api-reference'), {
-	pageDirectory: '120-api-reference',
-	pageOrder: 120,
-	pageId: 'api-reference',
-});
-
-assert.deepEqual(parsePageDirectory('000-home'), {
-	pageDirectory: '000-home',
-	pageOrder: 0,
-	pageId: 'home',
-});
-
-assert.deepEqual(parsePageDirectoryPath('000-home'), {
-	pageDirectory: '000-home',
-	pageDirectories: ['000-home'],
-	pageId: 'home',
-	pageIds: [],
-	pageOrder: 0,
-	pageOrders: [],
-	pagePath: '',
-	parentPagePath: null,
-	depth: 1,
-});
-
-assert.throws(
-	() => parsePageDirectoryPath('000-home/pages/010-about'),
-	/000-home is the homepage and cannot contain child pages.*beside it under site\/pages\/.*below another non-home page/,
-);
-
-assert.deepEqual(parsePageDirectoryPath('010-guides/pages/020-installation'), {
-	pageDirectory: '010-guides/pages/020-installation',
-	pageDirectories: ['010-guides', '020-installation'],
-	pageId: 'installation',
-	pageIds: ['guides', 'installation'],
-	pageOrder: 20,
-	pageOrders: [10, 20],
-	pagePath: 'guides/installation',
-	parentPagePath: 'guides',
-	depth: 2,
-});
-
-assert.equal(
-	encodePageDirectoryPath('010-guides/pages/020-installation'),
-	'010-guides--020-installation',
-);
-assert.equal(
-	decodePageDirectoryPath('010-guides--020-installation'),
-	'010-guides/pages/020-installation',
-);
-assert.deepEqual(
-	getPageDirectoryAncestors('010-guides/pages/020-installation/pages/030-macos'),
-	[
-		'010-guides',
-		'010-guides/pages/020-installation',
-		'010-guides/pages/020-installation/pages/030-macos',
-	],
-);
-
-for (const pageDirectoryPath of [
-	'010-guides/020-installation',
-	'010-guides/children/020-installation',
-	'pages/010-guides',
-	'010-guides/pages',
-]) {
-	assert.throws(
-		() => parsePageDirectoryPath(pageDirectoryPath),
-		/(Nested pages must use|Use a pages directory)/,
-		`${pageDirectoryPath} should be rejected`,
-	);
-}
-
-for (const pageDirectory of [
-	'000-about',
-	'10-about',
-	'010_About',
-	'010-About',
-	'010-about-',
-	'010-about--team',
-	'010-om-oss!',
-]) {
-	assert.throws(
-		() => parsePageDirectory(pageDirectory),
-		/(Page directories must use the form NNN-page-id|000 prefix is reserved)/,
-		`${pageDirectory} should be rejected`,
-	);
-}
-
-assert.throws(
-	() => parsePageDirectoryPath('010-guides/pages/000-home'),
-	/000-home is allowed only as a top-level page/,
-);
-
-console.log('Page model test passed.');

package/scripts/test-project-config.mjs

@@ -1,139 +0,0 @@
-import assert from 'node:assert/strict';
-import { spawnSync } from 'node:child_process';
-import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import path from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { getBasePathRedirectLocation } from './lib/base-path-redirect.mjs';
-
-const repoRoot = path.resolve(import.meta.dirname, '..');
-const projectConfigUrl = pathToFileURL(path.join(repoRoot, 'scripts', 'lib', 'project-config.mjs')).href;
-const tempRoot = await mkdtemp(path.join(tmpdir(), 'norna-project-config-'));
-const importScript = `
-	const { projectConfig } = await import(${JSON.stringify(projectConfigUrl)});
-	console.log(JSON.stringify({
-		basePath: projectConfig.site.basePath,
-		language: projectConfig.locale.lang,
-		labels: projectConfig.locale.labels,
-		navigationMode: projectConfig.navigation.mode,
-		scrollBehavior: projectConfig.navigation.scrollBehavior,
-		url: projectConfig.site.url,
-	}));
-`;
-
-const createSite = async (name, config) => {
-	const projectRoot = path.join(tempRoot, name);
-	const siteDir = path.join(projectRoot, 'site');
-	await mkdir(path.join(siteDir, 'pages', '000-home'), { recursive: true });
-	await writeFile(path.join(siteDir, 'config.yaml'), config);
-	await writeFile(path.join(siteDir, 'pages', '000-home', 'content.md'), '# Config test\n\n## Intro {#intro}\n\nText.\n');
-	await writeFile(path.join(siteDir, 'theme.yaml'), 'preset: documentation\n');
-	return { projectRoot, siteDir };
-};
-
-const loadConfig = ({ projectRoot, siteDir }, env = {}) => spawnSync(
-	process.execPath,
-	['--input-type=module', '--eval', importScript],
-	{
-		cwd: projectRoot,
-		encoding: 'utf8',
-		env: {
-			...process.env,
-			NORNA_INVOCATION_ROOT: projectRoot,
-			NORNA_SITE_DIR: siteDir,
-			...env,
-		},
-	},
-);
-
-const assertFailure = (result, expectedPattern) => {
-	assert.notEqual(result.status, 0, result.stdout);
-	assert.match(`${result.stdout}\n${result.stderr}`, expectedPattern);
-};
-
-try {
-	assert.equal(getBasePathRedirectLocation('/norna/', '/norna'), '/norna/');
-	assert.equal(getBasePathRedirectLocation('/norna/', '/norna?source=test'), '/norna/?source=test');
-	assert.equal(getBasePathRedirectLocation('/norna/', '/norna/'), undefined);
-	assert.equal(getBasePathRedirectLocation('/norna/', '/norna/concepts/'), undefined);
-	assert.equal(getBasePathRedirectLocation('/', '/'), undefined);
-
-	const minimalSite = await createSite('minimal', 'url: https://example.com/docs\n');
-	const minimalResult = loadConfig(minimalSite);
-	assert.equal(minimalResult.status, 0, minimalResult.stderr);
-	assert.deepEqual(JSON.parse(minimalResult.stdout), {
-		basePath: '/docs/',
-		language: 'en',
-		labels: {
-			breadcrumb: 'Breadcrumb',
-			dismissBanner: 'Dismiss notice',
-			built: 'Built',
-			images: 'Images',
-			navigationChildren: 'Child pages',
-			navigationMenu: 'Menu',
-			note: 'Note',
-			pageNavigation: 'Page contents',
-			siteBanners: 'Site notices',
-			siteNavigation: 'Pages',
-			skipToContent: 'Skip to content',
-		},
-		navigationMode: 'automatic',
-		scrollBehavior: 'instant',
-		url: 'https://example.com/docs/',
-	});
-
-	const localizedSite = await createSite('localized', 'url: https://example.com/\nlanguage: sv-SE\nscrollBehavior: smooth\n');
-	const localizedResult = loadConfig(localizedSite);
-	assert.equal(localizedResult.status, 0, localizedResult.stderr);
-	const localizedConfig = JSON.parse(localizedResult.stdout);
-	assert.equal(localizedConfig.language, 'sv-SE');
-	assert.equal(localizedConfig.labels.built, 'Byggd');
-	assert.equal(localizedConfig.labels.skipToContent, 'Hoppa till innehållet');
-	assert.equal(localizedConfig.scrollBehavior, 'smooth');
-
-	const treeNavigationSite = await createSite('tree-navigation', 'url: https://example.com/\nnavigation:\n  mode: tree\n');
-	const treeNavigationResult = loadConfig(treeNavigationSite);
-	assert.equal(treeNavigationResult.status, 0, treeNavigationResult.stderr);
-	assert.equal(JSON.parse(treeNavigationResult.stdout).navigationMode, 'tree');
-
-	const overrideResult = loadConfig(minimalSite, {
-		NORNA_SITE_URL: 'http://127.0.0.1:4567/preview',
-	});
-	assert.equal(overrideResult.status, 0, overrideResult.stderr);
-	assert.deepEqual(
-		JSON.parse(overrideResult.stdout),
-		{
-			...JSON.parse(minimalResult.stdout),
-			basePath: '/preview/',
-			url: 'http://127.0.0.1:4567/preview/',
-		},
-	);
-
-	assertFailure(
-		loadConfig(await createSite('unknown-field', 'url: https://example.com/\nbasePath: /docs/\n')),
-		/not a valid top-level config field/,
-	);
-	assertFailure(
-		loadConfig(await createSite('invalid-yaml', 'url: https://example.com/\nConfiguration prose.\n')),
-		/contains invalid YAML/,
-	);
-	assertFailure(
-		loadConfig(await createSite('unsupported-language', 'url: https://example.com/\nlanguage: de\n')),
-		/has no built-in Norna UI text/,
-	);
-	assertFailure(
-		loadConfig(await createSite('invalid-url', 'url: example.com\n')),
-		/url must be an absolute URL/,
-	);
-	assertFailure(
-		loadConfig(await createSite('invalid-scroll-behavior', 'url: https://example.com/\nscrollBehavior: slow\n')),
-		/scrollBehavior must be one of instant, smooth/,
-	);
-	assertFailure(
-		loadConfig(await createSite('obsolete-smooth-scroll', 'url: https://example.com/\nsmoothScroll: true\n')),
-		/not a valid top-level config field/,
-	);
-	console.log('Project config test passed.');
-} finally {
-	await rm(tempRoot, { force: true, recursive: true });
-}

package/scripts/test-schemas.mjs

@@ -1,169 +0,0 @@
-import assert from 'node:assert/strict';
-import { existsSync } from 'node:fs';
-import { readFile } from 'node:fs/promises';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
-const packageJson = JSON.parse(await readFile(path.join(root, 'package.json'), 'utf8'));
-const expectedDocumentationRef = `v${packageJson.version}`;
-const filenames = [
-	'config.schema.json',
-	'theme.schema.json',
-	'page-theme.schema.json',
-	'sitewide-content.schema.json',
-	'content-frontmatter.schema.json',
-];
-const requiredRichHelp = {
-	'config.schema.json': ['url', 'language', 'navigation', 'scrollBehavior'],
-	'theme.schema.json': ['preset', 'shape', 'layout', 'images', 'typography', 'palette', 'sections'],
-	'page-theme.schema.json': ['layout', 'images', 'sections'],
-	'sitewide-content.schema.json': ['logo', 'banners', 'footer'],
-	'content-frontmatter.schema.json': ['page', 'navigation'],
-};
-const manifest = JSON.parse(await readFile(path.join(root, 'schemas', 'manifest.json'), 'utf8'));
-assert.equal(manifest.editorApiVersion, 1);
-assert.equal(manifest.schemaVersion, 2);
-assert.equal(manifest.files.pageTheme, 'page-theme.schema.json');
-
-const githubHeadingAnchor = (heading) => heading
-	.toLowerCase()
-	.replace(/<[^>]+>/g, '')
-	.replace(/[`*_~]/g, '')
-	.replace(/[^\p{L}\p{N}\s-]/gu, '')
-	.trim()
-	.replace(/\s+/g, '-');
-
-const assertDocumentationLinks = async (markdownDescription, location) => {
-	const links = [...markdownDescription.matchAll(
-		/https:\/\/github\.com\/janga\/norna\/blob\/([^/\s]+)\/docs\/([^\s)#]+)(?:#([^\s)]+))?/g,
-	)];
-	assert.ok(links.length > 0, `${location} has no documentation link.`);
-
-	for (const [, reference, filename, anchor] of links) {
-		assert.equal(reference, expectedDocumentationRef, `${location} uses documentation ref ${reference}.`);
-		const documentationPath = path.join(root, 'docs', decodeURIComponent(filename));
-		assert.ok(existsSync(documentationPath), `${location} links to missing docs/${filename}.`);
-		if (!anchor) continue;
-
-		const source = await readFile(documentationPath, 'utf8');
-		const anchors = source
-			.split('\n')
-			.filter((line) => /^#{1,6}\s/.test(line))
-			.map((line) => githubHeadingAnchor(line.replace(/^#{1,6}\s+/, '')));
-		assert.ok(anchors.includes(anchor), `${location} links to missing anchor docs/${filename}#${anchor}.`);
-	}
-};
-
-const visitSchema = (schema, location, richProperties) => {
-	assert.equal(schema.enum, undefined, `${location} uses an undescribed enum.`);
-	if (schema.properties) {
-		for (const [name, property] of Object.entries(schema.properties)) {
-			assert.ok(property.description, `${location}.${name} has no description.`);
-			richProperties.push([property, `${location}.${name}`]);
-			visitSchema(property, `${location}.${name}`, richProperties);
-		}
-	}
-	if (schema.items) visitSchema(schema.items, `${location}[]`, richProperties);
-	if (schema.additionalProperties && typeof schema.additionalProperties === 'object') {
-		visitSchema(schema.additionalProperties, `${location}.*`, richProperties);
-	}
-	for (const keyword of ['allOf', 'anyOf', 'oneOf']) {
-		for (const [index, candidate] of (schema[keyword] ?? []).entries()) {
-			if (Object.hasOwn(candidate, 'const')) {
-				assert.ok(candidate.title, `${location}.${keyword}[${index}] has no title.`);
-				assert.ok(candidate.description, `${location}.${keyword}[${index}] has no description.`);
-			}
-			visitSchema(candidate, `${location}.${keyword}[${index}]`, richProperties);
-		}
-	}
-};
-
-for (const filename of filenames) {
-	const schema = JSON.parse(await readFile(path.join(root, 'schemas', filename), 'utf8'));
-	assert.ok(schema.description, `${filename} has no root description.`);
-	assert.match(schema.markdownDescription, /^```yaml\n/, `${filename} rich help must start with YAML syntax.`);
-	await assertDocumentationLinks(schema.markdownDescription, filename);
-	for (const propertyName of requiredRichHelp[filename]) {
-		const property = schema.properties[propertyName];
-		assert.match(
-			property.markdownDescription,
-			/^```yaml\n/,
-			`${filename}.${propertyName} rich help must start with YAML syntax.`,
-		);
-		await assertDocumentationLinks(property.markdownDescription, `${filename}.${propertyName}`);
-	}
-	const richProperties = [];
-	visitSchema(schema, filename, richProperties);
-	for (const [property, location] of richProperties) {
-		assert.match(
-			property.markdownDescription,
-			/^```yaml\n/,
-			`${location} rich help must start with YAML syntax.`,
-		);
-		await assertDocumentationLinks(property.markdownDescription, location);
-	}
-}
-
-const config = JSON.parse(await readFile(path.join(root, 'schemas', 'config.schema.json'), 'utf8'));
-assert.equal(config.properties.language.default, 'en');
-assert.deepEqual(config.properties.language.examples, ['en', 'sv', 'en-GB', 'sv-SE']);
-assert.equal(config.properties.scrollBehavior.default, 'instant');
-
-const sitewide = JSON.parse(await readFile(path.join(root, 'schemas', 'sitewide-content.schema.json'), 'utf8'));
-assert.deepEqual(Object.keys(sitewide.properties.logo.properties), ['height']);
-assert.match(sitewide.properties.logo.markdownDescription, /```yaml\nlogo:\n  height: 2rem\n```/);
-assert.match(sitewide.properties.logo.markdownDescription, /does not enable or select the file/);
-assert.match(sitewide.properties.logo.markdownDescription, /homepage Markdown H1/);
-assert.match(sitewide.properties.logo.markdownDescription, /docs\/public-files\.md#navigation-logo/);
-assert.equal(sitewide.properties.logo.description.length < 100, true);
-const bannerItem = sitewide.properties.banners.items;
-assert.equal(bannerItem.title, 'Warning banner');
-assert.match(bannerItem.description, /important temporary information/);
-assert.match(bannerItem.markdownDescription, /A `warning` is a dismissible site-wide notice/);
-await assertDocumentationLinks(bannerItem.markdownDescription, 'sitewide-content.schema.json.banners[]');
-assert.equal(bannerItem.defaultSnippets[0].label, 'Warning banner');
-assert.deepEqual(bannerItem.defaultSnippets[0].body, {
-	id: '${1:project-status}',
-	tone: 'warning',
-	title: '${2:Important notice}',
-	text: '${3:Brief explanation.}',
-});
-await assertDocumentationLinks(
-	bannerItem.defaultSnippets[0].markdownDescription,
-	'sitewide-content.schema.json.banners[].defaultSnippets[0]',
-);
-const buildInfo = sitewide.properties.footer.properties.buildInfo;
-assert.equal(buildInfo.type, 'boolean');
-assert.equal(buildInfo.default, false);
-assert.match(buildInfo.markdownDescription, /footer:\n  buildInfo: true/);
-
-const theme = JSON.parse(await readFile(path.join(root, 'schemas', 'theme.schema.json'), 'utf8'));
-assert.equal(theme.properties.layout.properties.gutter.defaultSnippets[0].label, 'Responsive page gutter');
-assert.equal(theme.properties.layout.properties.spacing.defaultSnippets[0].label, 'Layout spacing overrides');
-assert.equal(theme.properties.typography.properties.overrides.defaultSnippets[0].label, 'Typography overrides');
-assert.equal(
-	theme.properties.images.properties.maxAvailableWidthPercent.defaultSnippets[0].label,
-	'Responsive image limit',
-);
-assert.equal(theme.properties.navigation, undefined);
-assert.equal(theme.properties.layout.properties.density, undefined);
-assert.ok(theme.properties.layout.properties.contentSpacing);
-assert.ok(theme.properties.layout.properties.textWidth);
-assert.ok(theme.properties.sections.properties.backgroundPattern);
-
-const pageTheme = JSON.parse(await readFile(path.join(root, 'schemas', 'page-theme.schema.json'), 'utf8'));
-assert.deepEqual(Object.keys(pageTheme.properties), ['layout', 'images', 'sections']);
-assert.deepEqual(Object.keys(pageTheme.properties.layout.properties), ['contentSpacing', 'textWidth']);
-assert.equal(pageTheme.properties.preset, undefined);
-assert.equal(pageTheme.properties.palette, undefined);
-assert.equal(pageTheme.properties.typography, undefined);
-
-const content = JSON.parse(await readFile(path.join(root, 'schemas', 'content-frontmatter.schema.json'), 'utf8'));
-assert.deepEqual(Object.keys(content.properties), ['page', 'navigation']);
-assert.deepEqual(Object.keys(content.properties.page.properties), ['description']);
-assert.equal(content.properties.page.required, undefined);
-assert.equal(content.required, undefined);
-assert.deepEqual(Object.keys(content.properties.navigation.properties), ['listed']);
-
-console.log('Schema metadata tests passed.');

package/scripts/test-site-public.mjs

@@ -1,85 +0,0 @@
-import assert from 'node:assert/strict';
-import { access, mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
-import { spawnSync } from 'node:child_process';
-import { tmpdir } from 'node:os';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
-const syncScript = path.join(repoRoot, 'scripts', 'sync-site-public.mjs');
-const tests = [];
-
-const test = (name, run) => {
-	tests.push({ name, run });
-};
-
-const fileExists = async (filePath) => access(filePath).then(() => true, () => false);
-
-const runSyncScript = (root, env = {}) => spawnSync(process.execPath, [syncScript], {
-	cwd: root,
-	encoding: 'utf8',
-	env: {
-		...process.env,
-		...env,
-	},
-});
-
-const getOutput = (result) => `${result.stdout}${result.stderr}`;
-
-const writeFixtureFile = async (root, relativePath, contents) => {
-	const filePath = path.join(root, relativePath);
-	await mkdir(path.dirname(filePath), { recursive: true });
-	await writeFile(filePath, contents);
-};
-
-const readFixtureFile = (root, relativePath) => readFile(path.join(root, relativePath), 'utf8');
-
-const withTempProject = async (run) => {
-	const root = await mkdtemp(path.join(tmpdir(), 'walde-site-public-'));
-
-	try {
-		await run(root);
-	} finally {
-		await rm(root, { force: true, recursive: true });
-	}
-};
-
-test('site:public copies configured public files, removes stale generated public files, and keeps images output', async () => {
-	await withTempProject(async (root) => {
-		await writeFixtureFile(root, 'custom-site/public/CNAME', 'example.com\n');
-		await writeFixtureFile(root, 'custom-site/public/robots.txt', 'User-agent: *\nAllow: /\n');
-		await writeFixtureFile(root, 'custom-site/public/nested/source.txt', 'source file\n');
-		await writeFixtureFile(root, 'custom-site/.norna/public/stale.txt', 'stale generated file\n');
-		await writeFixtureFile(root, 'custom-site/.norna/public/nested/old.txt', 'stale nested file\n');
-		await writeFixtureFile(root, 'custom-site/.norna/public/images/generated/keep.webp', 'generated image\n');
-
-		const result = runSyncScript(root, { NORNA_SITE_DIR: 'custom-site' });
-		const output = getOutput(result);
-
-		assert.equal(result.status, 0, output);
-		assert.match(output, /Synced custom-site\/public\/ to custom-site\/\.norna\/public\/\./);
-		assert.equal(await readFixtureFile(root, 'custom-site/.norna/public/CNAME'), 'example.com\n');
-		assert.equal(await readFixtureFile(root, 'custom-site/.norna/public/robots.txt'), 'User-agent: *\nAllow: /\n');
-		assert.equal(await readFixtureFile(root, 'custom-site/.norna/public/nested/source.txt'), 'source file\n');
-		assert.equal(await fileExists(path.join(root, 'custom-site/.norna/public/stale.txt')), false);
-		assert.equal(await fileExists(path.join(root, 'custom-site/.norna/public/nested/old.txt')), false);
-		assert.equal(await readFixtureFile(root, 'custom-site/.norna/public/images/generated/keep.webp'), 'generated image\n');
-	});
-});
-
-let failed = 0;
-
-for (const { name, run } of tests) {
-	try {
-		await run();
-		console.log(`ok - ${name}`);
-	} catch (error) {
-		failed += 1;
-		console.error(`not ok - ${name}`);
-		console.error(error);
-	}
-}
-
-if (failed > 0) {
-	process.exit(1);
-}