enable use of custom HTML formats for websites

Author: jjallaire

news/changelog-1.2.md

@@ -29,6 +29,7 @@
 
 - Properly allow `twitter-card` and `open-graph` to override the page description.
 - Don't discover resources within a site or book output directory
+- Enable use of custom HTML formats for websites
 
 ## Publishing
 

src/project/project-context.ts

@@ -105,7 +105,6 @@ export async function projectContext(
   path: string,
   flags?: RenderFlags,
   force = false,
-  forceHtml = false,
 ): Promise<ProjectContext | undefined> {
   let dir = Deno.realPathSync(
     Deno.statSync(path).isDirectory ? path : dirname(path),
@@ -225,7 +224,6 @@ export async function projectContext(
           projectConfig = await type.config(
             dir,
             projectConfig,
-            forceHtml,
             flags,
           );
         }

src/project/project-index.ts

@@ -31,7 +31,7 @@ import { readYamlFromString } from "../core/yaml.ts";
 import { formatKeys } from "../config/metadata.ts";
 import {
   formatsPreferHtml,
-  normalizeWebsiteFormat,
+  websiteFormatPreferHtml,
 } from "./types/website/website-config.ts";
 import { kDefaultProjectFileContents } from "./types/project-default.ts";
 import { formatOutputFile } from "../core/render.ts";
@@ -113,7 +113,9 @@ export function readInputTargetIndex(
   if (index) {
     // normalize html to first if its included in the formats
     if (Object.keys(index.formats).includes("html")) {
-      index.formats = normalizeWebsiteFormat(index.formats, true) as Record<
+      // note that the cast it okay here b/c we know that index.formats
+      // includes only full format objects
+      index.formats = websiteFormatPreferHtml(index.formats) as Record<
         string,
         Format
       >;

src/project/serve/serve.ts

@@ -116,7 +116,7 @@ export async function serveProject(
     if (target === ".") {
       target = Deno.cwd();
     }
-    project = await projectContext(target, flags, false, true);
+    project = await projectContext(target, flags, false);
     if (!project || !project?.config) {
       throw new Error(`${target} is not a website or book project`);
     }

src/project/serve/watch.ts

@@ -54,7 +54,7 @@ export function watchProject(
 ): Promise<ProjectWatcher> {
   // helper to refresh project config
   const refreshProjectConfig = async () => {
-    project = (await projectContext(project.dir, flags, false, true))!;
+    project = (await projectContext(project.dir, flags, false))!;
   };
 
   // proj dir

src/project/types/book/book-config.ts

@@ -104,7 +104,6 @@ export const kBookItemPart = "part";
 export async function bookProjectConfig(
   projectDir: string,
   config: ProjectConfig,
-  forceHtml: boolean,
   flags?: RenderFlags,
 ) {
   // ensure we have a site
@@ -227,7 +226,7 @@ export async function bookProjectConfig(
   }
 
   // return config (inherit website config behavior)
-  return websiteProjectConfig(projectDir, config, forceHtml);
+  return websiteProjectConfig(projectDir, config);
 }
 
 function siteRepoUrl(site: Metadata) {

src/project/types/types.ts

@@ -26,7 +26,6 @@ export interface ProjectType {
   config?: (
     projectDir: string,
     config: ProjectConfig,
-    forceHtml: boolean,
     flags?: RenderFlags,
   ) => Promise<ProjectConfig>;
   libDir?: string;

src/project/types/website/website-config.ts

@@ -246,41 +246,35 @@ export function websiteConfigActions(
   }
 }
 
-export function normalizeWebsiteFormat(
+// normalize html to first if its included in the formats
+export function websiteFormatPreferHtml(
   format: string | Record<string, unknown> | undefined,
-  forceHtml: boolean,
-): string | Record<string, unknown> {
+): Record<string, unknown> {
   if (format !== undefined) {
     if (typeof (format) === "string") {
-      if (!isHtmlOutput(format, true) && forceHtml) {
-        return {
-          html: "default",
-          [format]: "default",
-        };
-      } else {
-        return format;
-      }
+      return {
+        [format]: "default",
+      };
     } else {
       const formats = Object.keys(format);
-      const orderedFormats = {} as Record<string, unknown>;
-      if (forceHtml) {
-        const htmlFormatPos = formats.findIndex((format) =>
-          isHtmlOutput(format, true)
-        );
-        if (htmlFormatPos !== -1) {
-          const htmlFormatName = formats.splice(htmlFormatPos, 1)[0];
-          orderedFormats[htmlFormatName] = format[htmlFormatName];
-        } else {
-          orderedFormats["html"] = "default";
-        }
+      const orderedFormats = {} as Record<string, Format>;
+
+      const htmlFormatPos = formats.findIndex((format) =>
+        isHtmlOutput(format, true)
+      );
+      if (htmlFormatPos !== -1) {
+        const htmlFormatName = formats.splice(htmlFormatPos, 1)[0];
+        orderedFormats[htmlFormatName] = format[htmlFormatName] as Format;
       }
       for (const formatName of formats) {
-        orderedFormats[formatName] = format[formatName];
+        orderedFormats[formatName] = format[formatName] as Format;
       }
       return orderedFormats;
     }
   } else {
-    return "html";
+    return {
+      html: "default",
+    };
   }
 }
 
@@ -305,15 +299,15 @@ export function formatsPreferHtml(formats: Record<string, unknown>) {
 export function websiteProjectConfig(
   _projectDir: string,
   config: ProjectConfig,
-  forceHtml: boolean,
   flags?: RenderFlags,
 ): Promise<ProjectConfig> {
   config = ld.cloneDeep(config);
   const format = config[kMetadataFormat] as
     | string
     | Record<string, unknown>
     | undefined;
-  config[kMetadataFormat] = normalizeWebsiteFormat(format, forceHtml);
+
+  config[kMetadataFormat] = websiteFormatPreferHtml(format);
 
   // Resolve elements to be sure they're arrays, they will be resolve later
   const ensureArray = (val: unknown) => {