Add url field to PageInfo for canonical URL access in layouts

[bcomnes]

Closes #238

What changed

Adds a url field to the PageInfo object, computed once at page identification time from path and outputName. Layouts can now use page.url directly instead of manually reconstructing the URL from page.path.

// Before: fragile, wrong for loose markdown pages
export default function rootLayout ({ children, vars, page }) {
  const pageUrl = page.path ? '/' + page.path + '/' : '/'
  const canonicalUrl = `${vars.siteUrl}${pageUrl}`
}

// After
export default function rootLayout ({ children, vars, page }) {
  const canonicalUrl = `${vars.siteUrl}${page.url}`
}

URL derivation rules

• Index pages (outputName === 'index.html'): trailing-slash URL — /blog/my-post/, or / for the root
• Non-index pages (loose markdown): URL includes the filename — /blog/loose-page.html

Path separators are normalized via fsPathToUrlPath for Windows safety.

Why page.url instead of vars.pageUrl

url is a fact about the page derived from its filesystem location, not a user-configurable variable. It belongs on PageInfo alongside path and outputName, not injected into the user variable cascade. Layouts already receive page directly.

Also in this PR

• @types/pretty installed, removing the // @ts-expect-error on the pretty import
• Resolved pre-existing // @ts-ignore in PageData.vars with a targeted /** @type {T} */ cast
• Fixed pretty() call-site type error (Awaited<V> → cast to string)
• README updated to document page.url and replace manual path construction in examples

[coveralls]

Coverage Report for CI Build 26374300398

Coverage increased (+0.5%) to 92.658%

Details

• Coverage increased (+0.5%) from the base build.
• Patch coverage: 33 of 33 lines across 3 files are fully covered (100%).
• No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.

---

Coverage Stats

Relevant Lines:	4131
Covered Lines:	3911
Line Coverage:	94.67%
Relevant Branches:	595
Covered Branches:	468
Branch Coverage:	78.66%
Branches in Coverage %:	Yes
Coverage Strength:	73.92 hits per line

---

💛 - Coveralls

[Copilot]

Pull request overview

This PR aims to make canonical URL construction easier in layouts by automatically injecting a pageUrl value into PageData.vars, derived from pageInfo.

Changes:

• Inject pageUrl into the base of the vars merge inside PageData.vars, allowing user-defined pageUrl to override it via later spreads.

Comments suppressed due to low confidence (1)

lib/build-pages/page-data.js:149

• New public-ish behavior (vars.pageUrl) isn’t covered by tests. The repo already has node:test coverage for build behavior (eg test-cases/general-features/index.test.js). Please add a regression test that asserts vars.pageUrl (or an HTML marker rendered from it) for both an index page (/some-dir/) and a loose markdown page (/some-dir/file.html), and ideally cover Windows path normalization as well.

      pageUrl: this.pageInfo.path ? `/${this.pageInfo.path}/` : '/',
      ...globalVars,
      ...globalDataVars,
      ...pageVars,
      ...builderVars,
    }

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

This PR makes vars.pageUrl available to every rendered page by computing it from pageInfo inside PageData.vars, allowing layouts to build canonical/OG URLs without duplicating the project’s URL-construction convention.

Changes:

• Injects a computed pageUrl into PageData.vars at the base of the vars merge (so user overrides still win).
• Computes pageUrl with special handling for index.html (trailing-slash URLs) vs non-index outputs (include filename).
• Normalizes URL paths via fsPathToUrlPath() for cross-platform (Windows) safety.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Adds automatic vars.pageUrl injection to every page so layouts can build canonical URLs without manually reconstructing URL path conventions.

Changes:

• Inject pageUrl into PageData.vars at the lowest precedence so user-defined vars can override it.
• Compute pageUrl based on pageInfo.path + outputName, mapping index.html to trailing-slash URLs and including filenames for non-index outputs.
• Normalize path separators via fsPathToUrlPath() for cross-platform URL consistency.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[bcomnes]

This looks ready to go. It just needs readme docs and the above questions resolved.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	esbuild-plugin-polyfill-node@​0.3.0
	@​types/​pretty@​2.0.3
	@​types/​react-dom@​19.2.3
	@​voxpelli/​tsconfig@​15.1.2
	markdown-it-admonition@​1.0.4
	@​types/​react@​19.2.15
	markdown-it-container@​4.0.0
	react@​19.2.6
	typescript@​5.8.3
	typescript@​5.9.3
	react-dom@​19.2.6

View full report