Ensure that all contributors to dependencies append

HTML dependencies were overwriting format-resources which were contributed earlier in the pipeline.

This change ensures we’re always appending and adds type safety + exposes typed ability for typescript to contribute all types of supported resources.

Fixes #1538

Author: dragonstyle

news/changelog-1.1.md

@@ -73,6 +73,10 @@
 
 - support `echo: true` and other per-document settings (#1485)
 
+## Extensions
+
+- Properly copy `format-resources` for HTML based formats
+
 ## Publishing
 
 - Detect authentication error for quarto.pub and re-establish credentials

src/command/render/pandoc-dependencies-html.ts

@@ -25,25 +25,25 @@ import { lines } from "../../core/lib/text.ts";
 import { copyResourceFile } from "../../project/project-resources.ts";
 import { copyFileIfNewer } from "../../core/copy.ts";
 import { ProjectContext } from "../../project/types.ts";
+import {
+  appendDependencies,
+  HtmlFormatDependency,
+} from "./pandoc-dependencies.ts";
 
 export function writeDependencies(
   dependenciesFile: string,
   extras: FormatExtras,
 ) {
   if (extras.html?.[kDependencies]) {
-    const dependencyLines: string[] = [];
-    for (const dependency of extras.html?.[kDependencies]!) {
-      dependencyLines.push(
-        JSON.stringify({ type: "html", content: dependency }),
-      );
-    }
+    const dependencies: HtmlFormatDependency[] = extras.html[kDependencies]!
+      .map((dep) => {
+        return {
+          type: "html",
+          content: dep,
+        };
+      });
 
-    if (dependencyLines.length > 0) {
-      Deno.writeTextFileSync(
-        dependenciesFile,
-        `${dependencyLines.join("\n")}\n`,
-      );
-    }
+    appendDependencies(dependenciesFile, dependencies);
   }
 }
 

src/command/render/pandoc-dependencies-resources.ts

@@ -10,6 +10,10 @@ import { copyTo } from "../../core/copy.ts";
 import { lines } from "../../core/text.ts";
 
 import { basename, join } from "path/mod.ts";
+import {
+  appendDependencies,
+  FormatResourceDependency,
+} from "./pandoc-dependencies.ts";
 
 export interface FormatResource {
   file: string;
@@ -27,20 +31,13 @@ export function writeFormatResources(
       ? formatResources
       : [formatResources];
 
-    const dependencyLines: string[] = [];
-    for (const file of files) {
-      const path = join(inputDir, file);
-      // Ensure this is input relative
-      dependencyLines.push(
-        JSON.stringify({ type: kFormatResources, content: { file: path } }),
-      );
-    }
-    if (dependencyLines.length > 0) {
-      Deno.writeTextFileSync(
-        dependenciesFile,
-        `${dependencyLines.join("\n")}\n`,
-      );
-    }
+    const dependencies: FormatResourceDependency[] = files.map((file) => {
+      return {
+        type: kFormatResources,
+        content: { file: join(inputDir, file) },
+      };
+    });
+    appendDependencies(dependenciesFile, dependencies);
   }
 }
 

src/command/render/pandoc-dependencies.ts

@@ -0,0 +1,68 @@
+/*
+* pandoc-dependencies.ts
+*
+* Copyright (C) 2020 by RStudio, PBC
+*
+*/
+
+import { FormatDependency } from "../../config/types.ts";
+import { appendTextFile } from "../../core/file.ts";
+
+export interface HtmlFormatDependency {
+  type: "html";
+  content: FormatDependency;
+}
+
+export interface FormatResourceDependency {
+  type: "format-resources";
+  content: {
+    file: string;
+  };
+}
+
+export interface TextDependency {
+  type: "text";
+  content: {
+    text: string;
+    location: "before-body" | "after-body" | "in-header";
+  };
+}
+
+export interface FileDependency {
+  type: "file";
+  content: {
+    path: string;
+  };
+}
+
+export interface UsePackageDependency {
+  type: "usepackage";
+  content: {
+    package: string;
+    options: string;
+  };
+}
+
+export function appendDependencies(
+  dependenciesFile: string,
+  dependencies: Array<
+    | HtmlFormatDependency
+    | FormatResourceDependency
+    | TextDependency
+    | FileDependency
+    | UsePackageDependency
+  >,
+) {
+  const dependencyLines: string[] = [];
+  for (const dependency of dependencies) {
+    dependencyLines.push(
+      JSON.stringify(dependency),
+    );
+  }
+  if (dependencyLines.length > 0) {
+    appendTextFile(
+      dependenciesFile,
+      `${dependencyLines.join("\n")}\n`,
+    );
+  }
+}

src/core/file.ts

@@ -37,6 +37,19 @@ export async function visitLines(
   }
 }
 
+export async function appendTextFile(
+  path: string,
+  text: string,
+) {
+  const file = await Deno.open(path, { append: true });
+  try {
+    const encoder = new TextEncoder();
+    file.writeSync(encoder.encode(text));
+  } finally {
+    file.close();
+  }
+}
+
 export async function touch(path: string) {
   if (Deno.build.os === "windows") {
     // Touch the file be rewriting it