pager config (#247)

observablehq · Nov 28, 2023 · ac92804 · ac92804
1 parent 6300bb8
commit ac92804
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 23 deletions.
diff --git a/docs/.observablehq/config.ts b/docs/.observablehq/config.ts
@@ -29,8 +29,5 @@ export default {
       ]
     },
     {name: "Contributing", path: "/contributing"}
-  ],
-  toc: {
-    show: true
-  }
+  ]
 };
diff --git a/src/config.ts b/src/config.ts
@@ -22,6 +22,7 @@ export interface TableOfContents {
 export interface Config {
   title?: string;
   pages: (Page | Section)[]; // TODO rename to sidebar?
+  pager: boolean; // defaults to true
   toc: TableOfContents;
 }
 
@@ -56,11 +57,12 @@ async function readPages(root: string): Promise<Page[]> {
 }
 
 export async function normalizeConfig(spec: any, root: string): Promise<Config> {
-  let {title, pages = await readPages(root), toc = true} = spec;
+  let {title, pages = await readPages(root), pager = true, toc = true} = spec;
   if (title !== undefined) title = String(title);
   pages = Array.from(pages, normalizePageOrSection);
+  pager = Boolean(pager);
   toc = normalizeToc(toc);
-  return {title, pages, toc};
+  return {title, pages, pager, toc};
 }
 
 function normalizePageOrSection(spec: any): Page | Section {

diff --git a/src/pager.ts b/src/pager.ts
@@ -6,11 +6,11 @@ export type PageLink =
   | {prev: Page; next: undefined}; // last page
 
 // Pager links in the footer are computed once for a given navigation.
-const pagers = new WeakMap<Config["pages"], Map<string, PageLink>>();
+const linkCache = new WeakMap<Config["pages"], Map<string, PageLink>>();
 
-export function pager(path: string, options: Pick<Config, "pages" | "title"> = {pages: []}): PageLink | undefined {
+export function findLink(path: string, options: Pick<Config, "pages" | "title"> = {pages: []}): PageLink | undefined {
   const {pages, title} = options;
-  let links = pagers.get(pages);
+  let links = linkCache.get(pages);
   if (!links) {
     links = new Map<string, PageLink>();
     let prev: Page | undefined;
@@ -24,7 +24,7 @@ export function pager(path: string, options: Pick<Config, "pages" | "title"> = {
       prev = page;
     }
     if (links.size === 1) links.clear(); // no links if only one page
-    pagers.set(pages, links);
+    linkCache.set(pages, links);
   }
   return links.get(path);
 }

diff --git a/src/render.ts b/src/render.ts
@@ -4,7 +4,7 @@ import {type Html, html} from "./html.js";
 import {type ImportResolver, createImportResolver} from "./javascript/imports.js";
 import {type FileReference, type ImportReference} from "./javascript.js";
 import {type CellPiece, type ParseResult, parseMarkdown} from "./markdown.js";
-import {type PageLink, pager} from "./pager.js";
+import {type PageLink, findLink} from "./pager.js";
 import {relativeUrl} from "./url.js";
 
 export interface Render {
@@ -49,11 +49,9 @@ type RenderInternalOptions =
   | {preview?: false} // serverless
   | {preview: true}; // preview
 
-function render(
-  parseResult: ParseResult,
-  {root, path, pages, title, toc, preview, resolver}: RenderOptions & RenderInternalOptions
-): string {
-  toc = mergeToc(parseResult.data?.toc, toc);
+function render(parseResult: ParseResult, options: RenderOptions & RenderInternalOptions): string {
+  const {root, path, pages, title, preview, resolver} = options;
+  const toc = mergeToc(parseResult.data?.toc, options.toc);
   const headers = toc.show ? findHeaders(parseResult) : [];
   return String(html`<!DOCTYPE html>
 <meta charset="utf-8">${path === "/404" ? html`\n<base href="/">` : ""}
@@ -83,7 +81,7 @@ ${pages.length > 0 ? renderSidebar(title, pages, path) : ""}
 ${headers.length > 0 ? renderToc(headers, toc.label) : ""}<div id="observablehq-center">
 <main id="observablehq-main" class="observablehq">
 ${html.unsafe(parseResult.html)}</main>
-${renderFooter(path, {pages, title})}
+${renderFooter(path, options)}
 </div>
 `);
 }
@@ -174,8 +172,8 @@ function renderImportPreloads(parseResult: ParseResult, path: string, resolver:
   return html`${Array.from(preloads, (href) => html`\n<link rel="modulepreload" href="${href}">`)}`;
 }
 
-function renderFooter(path: string, options?: Pick<Config, "pages" | "title">): Html {
-  const link = pager(path, options);
+function renderFooter(path: string, options: Pick<Config, "pages" | "pager" | "title">): Html {
+  const link = options.pager ? findLink(path, options) : null;
   return html`<footer id="observablehq-footer">${link ? renderPager(path, link) : ""}
 <div>© ${new Date().getUTCFullYear()} Observable, Inc.</div>
 </footer>`;

diff --git a/test/config-test.ts b/test/config-test.ts
@@ -12,14 +12,16 @@ describe("readConfig(root)", () => {
         {path: "/sub/two", name: "Two"}
       ],
       title: undefined,
-      toc: {label: "On this page", show: true}
+      toc: {label: "On this page", show: true},
+      pager: true
     });
   });
   it("returns the default config if no config file is found", async () => {
     assert.deepStrictEqual(await readConfig("test/input/build/simple"), {
       pages: [{name: "Build test case", path: "/simple"}],
       title: undefined,
-      toc: {label: "Contents", show: true}
+      toc: {label: "Contents", show: true},
+      pager: true
     });
   });
 });
@@ -72,6 +74,15 @@ describe("normalizeConfig(spec, root)", () => {
     assert.deepStrictEqual((await config({pages: [], toc: true}, root)).toc, {label: "Contents", show: true});
     assert.deepStrictEqual((await config({pages: [], toc: false}, root)).toc, {label: "Contents", show: false});
   });
+  it("coerces pager", async () => {
+    assert.strictEqual((await config({pages: [], pager: 0}, root)).pager, false);
+    assert.strictEqual((await config({pages: [], pager: 1}, root)).pager, true);
+    assert.strictEqual((await config({pages: [], pager: ""}, root)).pager, false);
+    assert.strictEqual((await config({pages: [], pager: "0"}, root)).pager, true);
+  });
+  it("populates default pager", async () => {
+    assert.strictEqual((await config({pages: []}, root)).pager, true);
+  });
 });
 
 describe("mergeToc(spec, toc)", () => {

diff --git a/test/pager-test.ts b/test/pager-test.ts
@@ -1,7 +1,7 @@
 import assert from "node:assert";
-import {pager} from "../src/pager.js";
+import {findLink as pager} from "../src/pager.js";
 
-describe("pager(path, options)", () => {
+describe("findLink(path, options)", () => {
   it("returns the previous and next links for three pages", () => {
     const config = {
       pages: [
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,8 +29,5 @@ export default { @@
           ]
         },
         {name: "Contributing", path: "/contributing"}
-      ],
-      toc: {
-        show: true
-      }
+      ]
     };