From f0a9ebd2e812e8b0f3a50f35d39ed9a8b2026f7c Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 Jun 2026 17:44:49 -0400 Subject: [PATCH 1/5] Update Docsy theme module to main (post-#2647) --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index c4fc3bcf21..3a2188871e 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/google/docsy-example go 1.12 -require github.com/google/docsy/theme v0.0.0-20260530181410-94f94145fe15 // indirect +require github.com/google/docsy/theme v0.0.0-20260611213000-5c5733de6062 // indirect diff --git a/go.sum b/go.sum index 4e10ac0b75..69bc01e796 100644 --- a/go.sum +++ b/go.sum @@ -1,6 +1,6 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w= github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy/theme v0.0.0-20260530181410-94f94145fe15 h1:ZvwTrXGvb54wT1ajJnnFcepHZnW9R3sypzhAIlGfFps= -github.com/google/docsy/theme v0.0.0-20260530181410-94f94145fe15/go.mod h1:CGCFFJjc3PAYexPDsQqTbB3/lWnncwlwKLnSQkDaaF0= +github.com/google/docsy/theme v0.0.0-20260611213000-5c5733de6062 h1:Wm1KR34lrCA0DLlTfVaVaSNl9IoCFd8Dw7vKiH+5Zqc= +github.com/google/docsy/theme v0.0.0-20260611213000-5c5733de6062/go.mod h1:CGCFFJjc3PAYexPDsQqTbB3/lWnncwlwKLnSQkDaaF0= github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o= github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= From 563765513619f0cb7ccacb7724331b2d50c69e90 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 Jun 2026 17:45:30 -0400 Subject: [PATCH 2/5] Migrate off deprecated language config keys and .Sites - hugo.yaml: languageName -> label, languageDirection -> direction - layouts/home.redirects: .Sites -> hugo.Sites (deprecated in 0.156.0) Build now logs zero deprecation notices at --logLevel info. --- layouts/home.redirects | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/layouts/home.redirects b/layouts/home.redirects index 336493edf5..691b6f430d 100644 --- a/layouts/home.redirects +++ b/layouts/home.redirects @@ -5,7 +5,7 @@ Adapted from https://gohugo.io/methods/page/aliases/#template-implementation cSpell:ignore hugo */ -}} -{{ range .Sites -}} +{{ range hugo.Sites -}} {{ range $p := .Pages -}} {{ range .Aliases -}} {{ if findRE `\s` . -}} From d06cc5707f354ef6bb6468d1c6c259ac433f9bba Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 Jun 2026 17:49:20 -0400 Subject: [PATCH 3/5] Add site tests: language selector and RTL rendering - tests/site.test.mjs validates the generated site: disabled menu entries for untranslated languages, links to existing translations, and dir=rtl/lang=fa on Persian pages - Wire test:site into the test-only chain --- package.json | 3 ++- tests/site.test.mjs | 57 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 tests/site.test.mjs diff --git a/package.json b/package.json index 11f780b085..463ce8a98b 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ", "serve": "npm run _serve", "test-and-fix": "npm run fix && npm run test-only", - "test-only": "npm run check:links", + "test-only": "npm run check:links && npm run test:site", + "test:site": "node --test 'tests/**/*.test.mjs'", "test": "npm run test-and-fix", "update:docsy:main": "hugo mod get -u github.com/google/docsy/theme@main && hugo mod tidy", "update:docsy:mod": "hugo mod get -u github.com/google/docsy/theme && hugo mod tidy", diff --git a/tests/site.test.mjs b/tests/site.test.mjs new file mode 100644 index 0000000000..6f054a1b39 --- /dev/null +++ b/tests/site.test.mjs @@ -0,0 +1,57 @@ +import test from 'node:test'; +import assert from 'node:assert/strict'; +import { readFileSync } from 'node:fs'; +import { join } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +// Validates the navbar language selector and RTL rendering in the generated +// site (public/). Assumes the site has been built (`npm run build`); in the +// `test-only` chain, the check:links prebuild takes care of that. + +const publicDir = fileURLToPath(new URL('../public', import.meta.url)); + +function page(relPath) { + return readFileSync(join(publicDir, relPath, 'index.html'), 'utf8'); +} + +// Extract the language-menu markup from a page. +function langMenu(html) { + const m = html.match( + /
[\s\S]*?<\/ul>\s*<\/div>/, + ); + assert.ok(m, 'page has a td-lang-menu language selector'); + return m[0]; +} + +test('language selector marks untranslated languages as disabled', (t) => { + // /docs/tasks/ exists only in English: the menu should show an active + // entry (English) and disabled, link-less entries for no and fa. + const menu = langMenu(page('docs/tasks')); + const active = menu.match(/class="dropdown-item active"/g) ?? []; + const disabled = menu.match(/class="dropdown-item disabled"/g) ?? []; + assert.equal(active.length, 1, 'one active language entry'); + assert.equal(disabled.length, 2, 'two disabled (untranslated) entries'); + assert.ok( + !/]*class="dropdown-item (active|disabled)"/.test(menu), + 'active/disabled entries are not links', + ); + t.diagnostic(`active: ${active.length}, disabled: ${disabled.length}`); +}); + +test('language selector links to existing translations', (t) => { + // /docs/overview/ has a Persian translation: the menu should link to it. + const menu = langMenu(page('docs/overview')); + assert.match( + menu, + / { + const html = page('fa'); + assert.match(html, /]*\bdir="rtl"/, 'html element has dir="rtl"'); + assert.match(html, /]*\blang="fa"/, 'html element has lang="fa"'); + t.diagnostic('fa home page has dir="rtl" and lang="fa"'); +}); From 10db99dd773ece9758fbb129aa36c80a235af768 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 Jun 2026 18:00:19 -0400 Subject: [PATCH 4/5] Add no-deprecations build test Fails if the site build logs any Hugo deprecation notices; includes a seeded-deprecation sanity case. Builds to tmp/ to avoid racing with tests that read public/. --- .gitignore | 1 + tests/no-deprecations.test.mjs | 72 ++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 tests/no-deprecations.test.mjs diff --git a/.gitignore b/.gitignore index 40b67f41a7..a016b92fea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ /public +/tmp resources/ node_modules/ package-lock.json diff --git a/tests/no-deprecations.test.mjs b/tests/no-deprecations.test.mjs new file mode 100644 index 0000000000..5503b35ef0 --- /dev/null +++ b/tests/no-deprecations.test.mjs @@ -0,0 +1,72 @@ +import test from 'node:test'; +import assert from 'node:assert/strict'; +import { spawnSync } from 'node:child_process'; +import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs'; +import { dirname, join } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +const siteDir = fileURLToPath(new URL('../', import.meta.url)); + +// Build to a scratch dir so this test never races with tests that read +// public/ (node --test runs test files concurrently). Kept after the run +// for inspection; cleared at start. +const outDir = join(siteDir, 'tmp', 'test-no-deprecations'); + +function buildSite() { + const res = spawnSync(`npm run build -- -d ${outDir}`, { + cwd: siteDir, + shell: true, + encoding: 'utf8', + }); + const output = `${res.stdout ?? ''}${res.stderr ?? ''}`; + const deprecations = output + .split('\n') + .filter((line) => /deprecated/i.test(line)); + return { res, output, deprecations }; +} + +test('site build logs no Hugo deprecation notices', (t) => { + // The `_hugo-dev` script builds with `--logLevel info`, the level at which + // Hugo first reports deprecated API usage. + rmSync(outDir, { recursive: true, force: true }); + const { res, output, deprecations } = buildSite(); + assert.equal(res.status, 0, `Build failed:\n${output}`); + assert.deepEqual(deprecations, [], 'Hugo build logged deprecation notice(s)'); + t.diagnostic(`Scanned ${output.split('\n').length} build-log lines`); +}); + +// Sanity check that the test above can actually detect deprecation notices: +// seed a deprecated API call via the theme's head-end hook and ensure that +// Hugo reports it. Guards against, e.g., Hugo demoting deprecation notices +// below the info log level. +test('build with seeded deprecated API call logs a deprecation notice', (t) => { + const hookPath = join( + siteDir, + 'layouts', + '_partials', + 'hooks', + 'head-end.html', + ); + assert.ok( + !existsSync(hookPath), + `${hookPath} already exists; this test needs to create it`, + ); + mkdirSync(dirname(hookPath), { recursive: true }); + writeFileSync( + hookPath, + '{{/* Temporary file seeded by no-deprecations.test.mjs. */}}\n' + + '{{ .Language.LanguageName }}\n', + ); + try { + const { res, output, deprecations } = buildSite(); + assert.equal(res.status, 0, `Seeded build failed:\n${output}`); + assert.ok( + deprecations.length > 0, + 'Seeded deprecated API call was not reported by the Hugo build', + ); + t.diagnostic(`Seeded deprecation reported as: ${deprecations[0].trim()}`); + } finally { + rmSync(hookPath); + rmSync(dirname(hookPath), { recursive: true, force: true }); + } +}); From f6343b9ec1159a7f48a80e88b4d568769caa0795 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 11 Jun 2026 18:09:22 -0400 Subject: [PATCH 5/5] Address review feedback - hugo.yaml: raise module.hugoVersion.min to 0.158.0, matching the new theme floor - no-deprecations test: prune test-created dirs only when empty, so future hook files can't be deleted by test cleanup --- hugo.yaml | 2 +- tests/no-deprecations.test.mjs | 20 +++++++++++++++++--- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/hugo.yaml b/hugo.yaml index ffa69fec82..44fcc5786e 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -247,7 +247,7 @@ module: # workspace: docsy.work hugoVersion: extended: true - min: 0.157.0 + min: 0.158.0 imports: - path: github.com/google/docsy/theme disable: false diff --git a/tests/no-deprecations.test.mjs b/tests/no-deprecations.test.mjs index 5503b35ef0..a41d8ea903 100644 --- a/tests/no-deprecations.test.mjs +++ b/tests/no-deprecations.test.mjs @@ -1,7 +1,13 @@ import test from 'node:test'; import assert from 'node:assert/strict'; import { spawnSync } from 'node:child_process'; -import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs'; +import { + existsSync, + mkdirSync, + rmSync, + rmdirSync, + writeFileSync, +} from 'node:fs'; import { dirname, join } from 'node:path'; import { fileURLToPath } from 'node:url'; @@ -66,7 +72,15 @@ test('build with seeded deprecated API call logs a deprecation notice', (t) => { ); t.diagnostic(`Seeded deprecation reported as: ${deprecations[0].trim()}`); } finally { - rmSync(hookPath); - rmSync(dirname(hookPath), { recursive: true, force: true }); + rmSync(hookPath, { force: true }); + // Prune test-created dirs only if empty (rmdirSync refuses to delete + // non-empty directories), in case other hooks/partials are added later. + for (const dir of [dirname(hookPath), dirname(dirname(hookPath))]) { + try { + rmdirSync(dir); + } catch { + break; // Directory not empty; leave it (and its parents) in place. + } + } } });