Merge pull request #5086 from quarto-dev/fix/resource-path

`resource-path` should be taken into account for resource embeding

Author: dragonstyle

src/command/render/render.ts

@@ -52,6 +52,7 @@ import {
   kIncludeBeforeBody,
   kIncludeInHeader,
   kInlineIncludes,
+  kResourcePath,
 } from "../../config/constants.ts";
 import { pandocIngestSelfContainedContent } from "../../core/pandoc/self-contained.ts";
 
@@ -273,7 +274,10 @@ export async function renderPandoc(
         // If this is self-contained, run pandoc to 'suck in' the dependencies
         // which may have been added in the post processor
         if (selfContained && isHtmlFileOutput(format.pandoc)) {
-          await pandocIngestSelfContainedContent(outputFile);
+          await pandocIngestSelfContainedContent(
+            outputFile,
+            format.pandoc[kResourcePath],
+          );
         }
       });
 

src/config/constants.ts

@@ -418,6 +418,7 @@ export const kEmbedResources = "embed-resources";
 export const kIncludeBeforeBody = "include-before-body";
 export const kIncludeAfterBody = "include-after-body";
 export const kIncludeInHeader = "include-in-header";
+export const kResourcePath = "resource-path";
 export const kCiteproc = "citeproc";
 export const kCiteMethod = "cite-method";
 export const kFilters = "filters";
@@ -562,7 +563,7 @@ export const kPandocDefaultsKeys = [
   kIncludeBeforeBody,
   kIncludeAfterBody,
   kIncludeInHeader,
-  "resource-path",
+  kResourcePath,
   kCiteproc,
   kCiteMethod,
   "citation-abbreviations",

src/config/types.ts

@@ -153,6 +153,7 @@ import {
   kRepoActionLinksEdit,
   kRepoActionLinksIssue,
   kRepoActionLinksSource,
+  kResourcePath,
   kSearch,
   kSearchClearButtonTitle,
   kSearchCopyLinkTitle,
@@ -467,6 +468,7 @@ export interface FormatPandoc {
   [kIncludeBeforeBody]?: string[];
   [kIncludeAfterBody]?: string[];
   [kIncludeInHeader]?: string[];
+  [kResourcePath]?: string[];
   [kReferenceLocation]?: string;
   [kCiteproc]?: boolean;
   [kCiteMethod]?: string;

src/core/pandoc/self-contained.ts

@@ -8,7 +8,10 @@ import { basename, dirname } from "path/mod.ts";
 import { formatResourcePath, pandocBinaryPath } from "../../core/resources.ts";
 import { execProcess } from "../../core/process.ts";
 
-export const pandocIngestSelfContainedContent = async (file: string) => {
+export const pandocIngestSelfContainedContent = async (
+  file: string,
+  resourcePath?: string[],
+) => {
   const filename = basename(file);
   const workingDir = dirname(file);
 
@@ -33,6 +36,9 @@ export const pandocIngestSelfContainedContent = async (file: string) => {
   cmd.push("--output", filename);
   cmd.push("--metadata", "title=placeholder");
   cmd.push("--embed-resources");
+  if (resourcePath && resourcePath.length) {
+    cmd.push("--resource-path", resourcePath.join(":"));
+  }
   const result = await execProcess({
     cmd,
     stdout: "piped",

src/format/reveal/format-reveal-multiplex.ts

@@ -7,6 +7,7 @@
 import { existsSync } from "fs/mod.ts";
 import { join } from "path/mod.ts";
 import { isSelfContainedOutput } from "../../command/render/render-info.ts";
+import { kResourcePath } from "../../config/constants.ts";
 
 import { Format, FormatExtras, PandocFlags } from "../../config/types.ts";
 import { pandocIngestSelfContainedContent } from "../../core/pandoc/self-contained.ts";
@@ -80,7 +81,10 @@ export function revealMultiplexExtras(
 
         // If this is self contained, we should ingest dependencies
         if (selfContained) {
-          await pandocIngestSelfContainedContent(speakerOutput);
+          await pandocIngestSelfContainedContent(
+            speakerOutput,
+            format.pandoc[kResourcePath],
+          );
         }
       }],
     };

tests/docs/smoke-all/2023/04/04/dummy/temp.png

@@ -0,0 +1,16 @@
+---
+format:
+  html:
+    embed-resources: true
+resource-path: ["dummy"]
+_quarto:
+  tests:
+    html:
+      ensureHtmlElements:
+        - ['img[src^="data:image/png;base64"]']
+        - ['img[src^="temp.png"]']
+---
+
+# show the plot
+
+![alt text](temp.png "tooltip")

tests/docs/smoke-all/2023/04/04/issue-5084.qmd

@@ -0,0 +1,65 @@
+smokeAllFolder=./docs/smoke-all
+
+cwd=$(dirname $0)
+
+cd $smokeAllFolder
+
+year=$(date +"%Y")
+month=$(date +"%m")
+day=$(date +"%d")
+
+CheckCreateAndEnter() {
+  [[ ! -d "$1" ]] && mkdir -p $1
+  cd $1
+}
+
+CheckCreateAndEnter $year
+CheckCreateAndEnter $month
+CheckCreateAndEnter $day
+
+file=$1
+
+YAML=$(cat << EOF
+---
+format: html
+_quarto:
+  tests:
+    html:
+      ensureHtmlElements:
+        - []
+        - []
+      ensureFileRegexMatches:
+        - [] 
+        - []
+    latex:
+      ensureFileRegexMatches:
+        - []
+        - []
+    pdf:
+      noErrors: default
+      fileExists: 
+        supportPath: mediabag/lter_penguins.png
+    docx:
+      ensureDocxRegexMatches:
+        - []
+        - []
+    pptx:
+      ensurePptxRegexMatches:
+        - []
+        - []
+    asciidoc: default
+---
+EOF
+)
+
+if [ ! -f "$file" ]; then
+  echo "$YAML" > $file
+fi
+
+if [[ -z $(command -v code) ]]; then
+  vscode=true
+fi
+
+$vscode && code $file
+
+cd $cwd