* Information-architecture contracts: docs-map registration, sitemap and
* hreflang preservation, navigation parity across breakpoints and locales,
* and the accessibility hooks (skip link, labelled nav, aria-current).
*
* These are deterministic source/unit contracts in the same style as
* public-copy.test.ts: they read the real sources and assert structure, so a
* future IA change fails here first instead of drifting silently.
*/
import { existsSync, readFileSync } from "node:fs";
import { describe, expect, it } from "vitest";
import buildSitemap from "../app/sitemap";
import { DOC_TOPICS, docTopicHref, getTopic } from "./docs-map";
import { docsTopicIsCurrent } from "./docs-navigation";
import { locales } from "./i18n/config";
import { contentLocalesForPath } from "./i18n/content-locales";
import { getChrome, getHome } from "./i18n/dictionaries";
import {
currentNavHref,
footerLegalLinks,
footerProductLinks,
footerProjectLinks,
navLinks as buildNavLinks,
secondaryNavLinks as buildSecondaryNavLinks,
} from "./i18n/links";
import { SITE_URL } from "./page-meta";
const webRoot = new URL("../", import.meta.url);
const repoRoot = new URL("../../", import.meta.url);
function webText(path: string): string {
return readFileSync(new URL(path, webRoot), "utf8");
}
const sitemapEntries = buildSitemap();
const nav = webText("components/nav.tsx");
const navLinks = webText("components/nav-links.tsx");
const mobileMenu = webText("components/mobile-menu.tsx");
const footer = webText("components/footer.tsx");
const localeLayout = webText("app/[locale]/layout.tsx");
const css = webText("app/globals.css");
describe("docs-map registration", () => {
it("registers the guide and vocabulary topics as first-party pages", () => {
const guide = getTopic("guide");
const vocabulary = getTopic("vocabulary");
expect(guide?.hasPage).toBe(true);
expect(vocabulary?.hasPage).toBe(true);
expect(vocabulary?.category).toBe("core-concepts");
expect(docTopicHref(guide!, "en")).toBe("/en/docs/guide");
expect(docTopicHref(vocabulary!, "zh")).toBe("/zh/docs/vocabulary");
expect(docsTopicIsCurrent(vocabulary!, "en", "/en/docs/vocabulary")).toBe(true);
});
it("keeps every docs topic repo source on disk", () => {
for (const topic of DOC_TOPICS) {
const sources = Array.isArray(topic.repoSource) ? topic.repoSource : [topic.repoSource];
for (const source of sources) {
expect(existsSync(new URL(source, repoRoot)), `${topic.id}: ${source}`).toBe(true);
}
}
});
it("keeps topic labels and descriptions bilingual", () => {
for (const topic of DOC_TOPICS) {
for (const pair of [topic.label, topic.description]) {
expect(pair.en.trim().length, `${topic.id} en`).toBeGreaterThan(0);
expect(pair.zh.trim().length, `${topic.id} zh`).toBeGreaterThan(0);
}
}
});
});
describe("sitemap and hreflang preservation", () => {
it("indexes every first-party docs page", () => {
for (const topic of DOC_TOPICS) {
if (!topic.hasPage) continue;
const path = topic.sitePath ? `/${topic.sitePath}` : `/docs/${topic.slug}`;
expect(
sitemapEntries.some((entry) => entry.url === `${SITE_URL}/en${path}`),
path,
).toBe(true);
}
expect(
sitemapEntries.some((entry) => entry.url === `${SITE_URL}/en/docs/guide`),
).toBe(true);
expect(
sitemapEntries.some((entry) => entry.url === `${SITE_URL}/en/docs/vocabulary`),
).toBe(true);
});
it("keeps sitemap and hreflang output aligned with real translation coverage", () => {
expect(sitemapEntries).toHaveLength(98);
for (const path of ["/product", "/pricing", "/signin", "/signup", "/legal/terms", "/legal/privacy"]) {
expect(
sitemapEntries.some((entry) => entry.url === `${SITE_URL}/en${path}`),
path,
).toBe(true);
}
for (const [path, expectedLocales] of [
["/", locales],
["/docs/guide", contentLocalesForPath("/docs/guide")],
["/docs", ["en", "zh"]],
] as const) {
const suffix = path === "/" ? "" : path;
const entry = sitemapEntries.find(
(candidate) => candidate.url === `${SITE_URL}/en${suffix}`,
);
expect(entry, path).toBeDefined();
expect(Object.keys(entry?.alternates?.languages ?? {}), path).toEqual([
...expectedLocales,
]);
}
expect(sitemapEntries.every((entry) => !("lastModified" in entry))).toBe(true);
});
it("keeps the new docs pages on the shared metadata helper", () => {
for (const route of ["guide", "vocabulary"]) {
const page = webText(`app/[locale]/docs/${route}/page.tsx`);
expect(page, route).toContain('import { buildPageMetadata } from "@/lib/page-meta"');
expect(page, route).toContain(`path: "/docs/${route}"`);
}
});
it("indexes public sign-in and create-account routes", () => {
for (const path of ["/signin", "/signup"]) {
expect(
sitemapEntries.some((entry) => entry.url === `${SITE_URL}/en${path}`),
path,
).toBe(true);
expect(existsSync(new URL(`app/[locale]${path}/page.tsx`, webRoot)), path).toBe(true);
}
const entry = webText("components/public-account-entry.tsx");
expect(entry).toContain("CANONICAL_MARK_SRC");
expect(entry).toContain("installLocally");
expect(webText("app/[locale]/signin/page.tsx")).toContain('kind="sign-in"');
expect(webText("app/[locale]/signup/page.tsx")).toContain('kind="sign-up"');
expect(nav).toContain("APP_LOGIN_URL");
expect(nav).toContain("APP_SIGNUP_URL");
});
});
describe("navigation parity and accessibility", () => {
it("keeps desktop and mobile navigation on one shared link set", () => {
expect(nav).toContain("<NavLinks links={links} primaryAria={chrome.navPrimaryAria} />");
expect(nav).toContain("links={links}");
expect(mobileMenu).toContain("[...links, ...moreLinks].map");
expect(navLinks).toContain("links.map");
expect(nav).toContain("navLinks(locale, chrome)");
expect(nav).not.toMatch(/const (EN|ZH)_LINKS/);
expect(navLinks).toContain(
'className="hidden xl:flex min-w-0 shrink items-center gap-x-5 gap-y-1 flex-wrap"',
);
expect(navLinks).not.toContain("nav-link-secondary");
expect(mobileMenu).toContain("l.secondary");
expect(mobileMenu).toContain("xl:hidden inline-flex");
expect(nav).toContain("paper-install-cta hidden xl:inline-flex");
expect(mobileMenu).toContain('import { createPortal } from "react-dom"');
expect(mobileMenu).toContain("createPortal(<div");
expect(mobileMenu).toContain("document.body");
expect(mobileMenu).toContain("element.inert = true");
expect(mobileMenu).toContain('if (e.key !== "Tab") return');
expect(mobileMenu).toContain('window.matchMedia("(min-width: 1280px)")');
expect(mobileMenu).toContain("if (event.matches) closeImmediately()");
expect(webText("components/locale-switcher.tsx")).toContain("replacePathLocale(pathname, code)");
expect(webText("components/theme-toggle.tsx")).toContain("isDocsPath(pathname)");
expect(webText("middleware.ts")).toContain("pathLocale(pathname)");
});
it("keeps nav link paths in exact locale-swap parity for every routed locale", () => {
const reference = buildNavLinks("en", getChrome("en")).map((l) =>
l.href.replace(/^\/en\//, ""),
);
expect(reference).toEqual(["product", "models", "pricing", "docs"]);
const moreReference = buildSecondaryNavLinks("en", getChrome("en")).map((l) =>
l.href.replace(/^\/en\//, ""),
);
expect(moreReference).toEqual(["docs/guide", "install", "faq", "community", "contribute"]);
for (const locale of locales) {
const links = buildNavLinks(locale, getChrome(locale));
expect(
links.map((l) => l.href.replace(new RegExp(`^/${locale}/`), "")),
`${locale} nav routes`,
).toEqual(reference);
const more = buildSecondaryNavLinks(locale, getChrome(locale));
expect(
more.map((l) => l.href.replace(new RegExp(`^/${locale}/`), "")),
`${locale} secondary nav routes`,
).toEqual(moreReference);
for (const link of [...links, ...more]) {
expect(link.href.startsWith(`/${locale}/`), `${locale} ${link.href}`).toBe(true);
expect(link.label.trim().length, `${locale} empty nav label`).toBeGreaterThan(0);
}
}
});
it("keeps footer link paths in exact locale-swap parity for every routed locale", () => {
const reference = footerProductLinks("en", getChrome("en")).map((l) =>
l.href.replace(/^\/en\//, ""),
);
expect(reference).toContain("product");
expect(reference).toContain("docs/guide");
expect(reference).toContain("faq");
for (const locale of locales) {
const product = footerProductLinks(locale, getChrome(locale));
expect(
product.map((l) => l.href.replace(new RegExp(`^/${locale}/`), "")),
`${locale} footer product routes`,
).toEqual(reference);
const project = footerProjectLinks(locale, getChrome(locale));
expect(project.map((l) => l.href), `${locale} footer project routes`).toEqual([
"https://github.com/Hmbown/CodeWhale",
"https://github.com/Hmbown/CodeWhale/issues",
"https://discord.gg/37gfS3ksug",
`/${locale}/contribute`,
"https://github.com/Hmbown/CodeWhale/blob/main/LICENSE",
]);
const legal = footerLegalLinks(locale, getChrome(locale));
expect(legal.map((l) => l.href), `${locale} footer legal`).toEqual([
`/${locale}/pricing`,
`/${locale}/legal/terms`,
`/${locale}/legal/privacy`,
]);
expect(legal.map((l) => l.label), `${locale} footer legal labels`).toEqual([
getChrome(locale).footerPricing,
getChrome(locale).footerTerms,
getChrome(locale).footerPrivacy,
]);
}
});
it("labels the primary nav and marks the current page accessibly", () => {
expect(navLinks).toContain("aria-label={primaryAria}");
expect(getChrome("en").navPrimaryAria).toBe("Primary");
expect(getChrome("zh").navPrimaryAria).toBe("主导航");
expect(navLinks).toContain('aria-current={isActive ? "page" : undefined}');
expect(mobileMenu).toContain('aria-current={isActive ? "page" : undefined}');
expect(mobileMenu).toContain('aria-expanded={open}');
expect(mobileMenu).toContain('aria-controls="mobile-menu"');
expect(mobileMenu).toContain('role="dialog"');
});
it("marks exactly one nav link as the current page on a nested route", () => {
for (const locale of locales) {
const links = [
...buildNavLinks(locale, getChrome(locale)),
...buildSecondaryNavLinks(locale, getChrome(locale)),
];
const guide = `/${locale}/docs/guide`;
const naive = links.filter(
(l) => guide === l.href || guide.startsWith(`${l.href}/`),
);
expect(naive.length, `${locale} ancestor+page collision`).toBeGreaterThan(1);
expect(currentNavHref(links, guide), `${locale} current nav link`).toBe(guide);
expect(
currentNavHref(links, `/${locale}/docs/configuration`),
`${locale} section fallback`,
).toBe(`/${locale}/docs`);
expect(currentNavHref(links, `/${locale}`), `${locale} home`).toBeNull();
}
expect(navLinks).toContain("currentNavHref(links, pathname)");
expect(mobileMenu).toContain("currentNavHref([...links, ...moreLinks], pathname)");
expect(navLinks).not.toContain("pathname.startsWith(");
expect(mobileMenu).not.toContain("pathname.startsWith(");
});
it("ships a keyboard-reachable skip link to the main landmark", () => {
expect(localeLayout).toContain('href="#main-content"');
expect(localeLayout).toContain('className="skip-link"');
expect(localeLayout).toContain('<main id="main-content">');
expect(css).toContain(".skip-link:focus-visible");
});
it("keeps the docs trail on the docs-map registry", () => {
const docsLayout = webText("app/[locale]/docs/layout.tsx");
const docsMap = webText("lib/docs-map.ts");
expect(docsMap).toContain("sidebar, breadcrumbs, and drift/parity checks");
expect(docsMap).toContain("export const DOC_CATEGORY_LABELS");
expect(docsLayout).toContain("<DocsBreadcrumb locale={locale} />");
expect(css).toContain(".docs-breadcrumb");
});
it("keeps responsive breakpoints for the getting-started steps", () => {
expect(css).toMatch(/\.gs-steps\s*\{[^}]*repeat\(4, minmax\(0, 1fr\)\)/);
expect(css).toMatch(
/@media \(max-width: 760px\)[\s\S]*?\.gs-steps\s*\{[^}]*repeat\(2, minmax\(0, 1fr\)\)/,
);
expect(css).toMatch(
/@media \(max-width: 520px\)[\s\S]*?\.gs-steps\s*\{\s*grid-template-columns: 1fr/,
);
});
it("keeps the footer discovery links alongside the pinned legal links", () => {
for (const locale of ["en", "zh"]) {
const product = footerProductLinks(locale, getChrome(locale)).map((l) => l.href);
expect(product, `${locale} footer product`).toContain(`/${locale}/docs/guide`);
expect(product, `${locale} footer product`).toContain(`/${locale}/faq`);
}
const license = footerProjectLinks("en", getChrome("en")).at(-1);
expect(license).toEqual({
label: "MIT license",
href: "https://github.com/Hmbown/CodeWhale/blob/main/LICENSE",
});
expect(footerLegalLinks("zh", getChrome("zh")).map((l) => l.label)).toEqual([
"价格",
"服务条款",
"隐私政策",
]);
expect(footer).toContain("footerProductLinks(locale, chrome)");
expect(footer).toContain("footerProjectLinks(locale, chrome)");
expect(footer).toContain("footerLegalLinks(locale, chrome)");
});
});
describe("homepage integration", () => {
const homepage = webText("app/[locale]/page.tsx");
it("renders the shared getting-started path on the homepage", () => {
expect(homepage).toContain('import { GettingStartedSteps } from "@/components/getting-started-steps"');
expect(homepage).toContain("<GettingStartedSteps locale={locale} />");
expect(homepage).toContain("product-start");
expect(homepage).toContain("/docs/guide");
expect(homepage).toContain("/docs/vocabulary");
});
it("keeps the previously pinned homepage facts intact", () => {
expect(homepage).toContain("facts.latestPublishedRelease");
expect(homepage).toContain("d.sourceCandidate");
expect(getHome("en").sourceCandidate).toBe("Unreleased");
expect(homepage).toContain('src="/codewhale-tui.png"');
for (const label of ["Plan", "Work", "Operate", "Ask", "Auto-Review", "Full Access"]) {
expect(homepage).toContain(label);
}
});
});