Provide outputs to post processors when they are run

Author: dragonstyle

src/command/render/latexmk/latexmk.ts

@@ -24,6 +24,8 @@ import { OutputRecipe } from "../types.ts";
 import { generatePdf } from "./pdf.ts";
 import { LatexmkOptions } from "./types.ts";
 import { texToPdfOutputRecipe } from "../output-tex.ts";
+import { join } from "path/mod.ts";
+import { dirAndStem } from "../../../core/path.ts";
 
 export function useQuartoLatexmk(
   format: Format,
@@ -57,7 +59,7 @@ export function quartoLatexmkOutputRecipe(
   // output dir
   const outputDir = format.render[kLatexOutputDir];
 
-  const pdfGenerator = (
+  const generate = (
     input: string,
     format: Format,
     pandocOptions: PandocOptions,
@@ -87,13 +89,24 @@ export function quartoLatexmkOutputRecipe(
     return generatePdf(mkOptions);
   };
 
+  const computePath = (input: string, format: Format) => {
+    const [cwd, stem] = dirAndStem(input);
+    const mkOutputdir = format.render[kLatexOutputDir];
+    return mkOutputdir
+      ? join(mkOutputdir, stem + ".pdf")
+      : join(cwd, stem + ".pdf");
+  };
+
   return texToPdfOutputRecipe(
     input,
     finalOutput,
     options,
     format,
     "latex",
-    pdfGenerator,
+    {
+      generate,
+      computePath,
+    },
     outputDir,
   );
 }

src/command/render/output-tex.ts

@@ -21,11 +21,14 @@ import { OutputRecipe } from "./types.ts";
 import { pdfEngine } from "../../config/pdf.ts";
 import { execProcess } from "../../core/process.ts";
 
-export type PdfGenerator = (
-  input: string,
-  format: Format,
-  pandocOptions: PandocOptions,
-) => Promise<string>;
+export interface PdfGenerator {
+  generate: (
+    input: string,
+    format: Format,
+    pandocOptions: PandocOptions,
+  ) => Promise<string>;
+  computePath: (input: string, format: Format) => string;
+}
 
 export function texToPdfOutputRecipe(
   input: string,
@@ -58,25 +61,14 @@ export function texToPdfOutputRecipe(
   // ouptut to the user's requested destination
   const complete = async (pandocOptions: PandocOptions) => {
     const input = join(inputDir, output);
-    const pdfOutput = await pdfGenerator(input, format, pandocOptions);
+    const pdfOutput = await pdfGenerator.generate(input, format, pandocOptions);
 
     // keep tex if requested
     const compileTex = join(inputDir, output);
     if (!format.render[kKeepTex]) {
       Deno.removeSync(compileTex);
     }
 
-    const normalizePath = (input: string, output: string) => {
-      if (isAbsolute(output)) {
-        return output;
-      } else {
-        return relative(
-          Deno.realPathSync(dirname(input)),
-          Deno.realPathSync(output),
-        );
-      }
-    };
-
     // copy (or write for stdout) compiled pdf to final output location
     if (finalOutput) {
       if (finalOutput === kStdOut) {
@@ -111,6 +103,10 @@ export function texToPdfOutputRecipe(
     }
   };
 
+  const pdfOutput = finalOutput
+    ? finalOutput === kStdOut ? undefined : normalizePath(input, finalOutput)
+    : normalizePath(input, pdfGenerator.computePath(input, format));
+
   // tweak writer if it's pdf
   const to = format.pandoc.to === "pdf" ? pdfIntermediateTo : format.pandoc.to;
 
@@ -127,6 +123,7 @@ export function texToPdfOutputRecipe(
       },
     },
     complete,
+    finalOutput: pdfOutput,
   };
 }
 
@@ -151,7 +148,12 @@ export function contextPdfOutputRecipe(
   options: RenderOptions,
   format: Format,
 ): OutputRecipe {
-  const pdfGenerator = async (
+  const computePath = (input: string, _format: Format) => {
+    const [dir, stem] = dirAndStem(input);
+    return join(dir, stem + ".pdf");
+  };
+
+  const generate = async (
     input: string,
     format: Format,
     pandocOptions: PandocOptions,
@@ -177,8 +179,7 @@ export function contextPdfOutputRecipe(
     // run context
     const result = await execProcess({ cmd });
     if (result.success) {
-      const [dir, stem] = dirAndStem(input);
-      return join(dir, stem + ".pdf");
+      return computePath(input, format);
     } else {
       throw new Error();
     }
@@ -190,6 +191,20 @@ export function contextPdfOutputRecipe(
     options,
     format,
     "context",
-    pdfGenerator,
+    {
+      generate,
+      computePath,
+    },
   );
 }
+
+const normalizePath = (input: string, output: string) => {
+  if (isAbsolute(output)) {
+    return output;
+  } else {
+    return relative(
+      dirname(input),
+      output,
+    );
+  }
+};

src/command/render/render-files.ts

@@ -50,6 +50,7 @@ import {
   PandocRenderer,
   RenderContext,
   RenderedFile,
+  RenderedFormat,
   RenderExecuteOptions,
   RenderFile,
   RenderFilesResult,
@@ -88,6 +89,7 @@ import {
 } from "../../core/timing.ts";
 import { satisfies } from "semver/mod.ts";
 import { quartoConfig } from "../../core/quarto.ts";
+import { registerProjectType } from "../../project/types/project-types.ts";
 
 export async function renderExecute(
   context: RenderContext,
@@ -351,6 +353,12 @@ export async function renderFiles(
         }
         executeResult.supporting.push(...results.supporting);
       };
+
+      const outputs: Array<{
+        path: string;
+        format: Format;
+      }> = [];
+
       for (const format of Object.keys(contexts)) {
         pushTiming("render-context");
         const context = ld.cloneDeep(contexts[format]) as RenderContext; // since we're going to mutate it...
@@ -388,6 +396,10 @@ export async function renderFiles(
 
           // get output recipe
           const recipe = await outputRecipe(context);
+          outputs.push({
+            path: recipe.finalOutput || recipe.output,
+            format: context.format,
+          });
 
           // determine execute options
           const executeOptions = mergeConfigs(
@@ -502,6 +514,7 @@ export async function renderFiles(
           popTiming();
         }
       }
+      await pandocRenderer.onPostProcess(outputs);
     }
 
     if (progress) {
@@ -531,22 +544,25 @@ function defaultPandocRenderer(
   _project?: ProjectContext,
 ): PandocRenderer {
   const renderCompletions: PandocRenderCompletion[] = [];
+  const renderedFiles: RenderedFile[] = [];
 
   return {
     onBeforeExecute: (_format: Format) => ({}),
-
     onRender: async (
       _format: string,
       executedFile: ExecutedFile,
       quiet: boolean,
     ) => {
       renderCompletions.push(await renderPandoc(executedFile, quiet));
     },
-    onComplete: async () => {
-      const renderedFiles = [];
-      for (const renderCompletion of renderCompletions) {
-        renderedFiles.push(await renderCompletion.complete());
+    onPostProcess: async (renderedFormats: RenderedFormat[]) => {
+      let completion = renderCompletions.pop();
+      while (completion) {
+        renderedFiles.push(await completion.complete(renderedFormats));
+        completion = renderCompletions.pop();
       }
+    },
+    onComplete: async () => {
       return {
         files: await Promise.resolve(renderedFiles),
       };

src/command/render/render.ts

@@ -20,7 +20,7 @@ import {
 import { inputFilesDir } from "../../core/render.ts";
 import { pathWithForwardSlashes } from "../../core/path.ts";
 
-import { FormatPandoc } from "../../config/types.ts";
+import { Format, FormatPandoc } from "../../config/types.ts";
 import {
   executionEngine,
   executionEngineKeepMd,
@@ -31,6 +31,7 @@ import {
   HtmlPostProcessResult,
   PandocInputTraits,
   PandocOptions,
+  RenderedFormat,
 } from "./types.ts";
 import { runPandoc } from "./pandoc.ts";
 import { renderCleanup } from "./cleanup.ts";
@@ -54,7 +55,9 @@ import { replaceNotebookPlaceholders } from "../../core/jupyter/jupyter-embed.ts
 import { kIncludeAfterBody, kIncludeInHeader } from "../../config/constants.ts";
 
 export interface PandocRenderCompletion {
-  complete: () => Promise<RenderedFile>;
+  complete: (
+    outputs: RenderedFormat[],
+  ) => Promise<RenderedFile>;
 }
 
 export async function renderPandoc(
@@ -164,7 +167,7 @@ export async function renderPandoc(
   }
 
   return {
-    complete: async () => {
+    complete: async (renderedFormats: RenderedFormat[]) => {
       pushTiming("render-postprocessor");
       // run optional post-processor (e.g. to restore html-preserve regions)
       if (executeResult.postProcess) {

src/command/render/types.ts

@@ -125,9 +125,17 @@ export interface PandocRenderer {
     file: ExecutedFile,
     quiet: boolean,
   ) => Promise<void>;
+  onPostProcess: (
+    renderedFormats: RenderedFormat[],
+  ) => Promise<void>;
   onComplete: (error?: boolean, quiet?: boolean) => Promise<RenderFilesResult>;
 }
 
+export interface RenderedFormat {
+  path: string;
+  format: Format;
+}
+
 export interface RenderFile {
   path: string;
   formats?: string[];
@@ -222,4 +230,7 @@ export interface OutputRecipe {
   // can optionally return an alternate output path. passed the actual
   // options used to run pandoc (for deducing e.g. pdf engine options)
   complete: (options: PandocOptions) => Promise<string | void>;
+
+  // The final output for the recipe (if different than the output itself)
+  finalOutput?: string;
 }

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

@@ -33,14 +33,18 @@ import {
 import { Format, Metadata } from "../../../config/types.ts";
 import { isHtmlOutput } from "../../../config/format.ts";
 
-import { renderPandoc } from "../../../command/render/render.ts";
+import {
+  PandocRenderCompletion,
+  renderPandoc,
+} from "../../../command/render/render.ts";
 
 import { renderContexts } from "../../../command/render/render-contexts.ts";
 
 import {
   ExecutedFile,
   RenderContext,
   RenderedFile,
+  RenderedFormat,
   RenderOptions,
 } from "../../../command/render/types.ts";
 import { outputRecipe } from "../../../command/render/output.ts";
@@ -96,6 +100,7 @@ export function bookPandocRenderer(
   // rendered files to return. some formats need to end up returning all of the individual
   // renderedFiles (e.g. html or asciidoc) and some formats will consolidate all of their
   // files into a single one (e.g. pdf or epub)
+  const renderCompletions: PandocRenderCompletion[] = [];
   const renderedFiles: RenderedFile[] = [];
 
   // accumulate executed files for formats that need deferred rendering
@@ -212,14 +217,22 @@ export function bookPandocRenderer(
 
         // perform the render
         const renderCompletion = await renderPandoc(file, quiet);
-        renderedFiles.push(await renderCompletion.complete());
-
+        renderCompletions.push(renderCompletion);
         // accumulate executed files for single file formats
       } else {
         executedFiles[format] = executedFiles[format] || [];
         executedFiles[format].push(file);
       }
     },
+    onPostProcess: async (
+      renderedFormats: RenderedFormat[],
+    ) => {
+      let completion = renderCompletions.pop();
+      while (completion) {
+        renderedFiles.push(await completion.complete(renderedFormats));
+        completion = renderCompletions.pop();
+      }
+    },
     onComplete: async (error?: boolean, quiet?: boolean) => {
       // if there was an error during execution then cleanup any
       // executed files we've accumulated and return no rendered files
@@ -302,7 +315,8 @@ async function renderSingleFileBook(
 
   // do pandoc render
   const renderCompletion = await renderPandoc(executedFile, quiet);
-  const renderedFile = await renderCompletion.complete();
+  const renderedFormats: RenderedFormat[] = [];
+  const renderedFile = await renderCompletion.complete(renderedFormats);
 
   // cleanup step for each executed file
   files.forEach((file) => {