Move post processing post pandoc rendering of all formats

Author: dragonstyle

src/command/render/render-files.ts

@@ -42,7 +42,7 @@ import { ojsExecuteResult } from "../../execute/ojs/compile.ts";
 import { ExecuteResult, MappedExecuteResult } from "../../execute/types.ts";
 import { kProjectLibDir, ProjectContext } from "../../project/types.ts";
 import { outputRecipe } from "./output.ts";
-import { renderPandoc } from "./render.ts";
+import { PandocRenderCompletion, renderPandoc } from "./render.ts";
 import { renderContexts } from "./render-contexts.ts";
 import { renderProgress } from "./render-info.ts";
 import {
@@ -530,7 +530,7 @@ function defaultPandocRenderer(
   _options: RenderOptions,
   _project?: ProjectContext,
 ): PandocRenderer {
-  const renderedFiles: RenderedFile[] = [];
+  const renderCompletions: PandocRenderCompletion[] = [];
 
   return {
     onBeforeExecute: (_format: Format) => ({}),
@@ -540,9 +540,13 @@ function defaultPandocRenderer(
       executedFile: ExecutedFile,
       quiet: boolean,
     ) => {
-      renderedFiles.push(await renderPandoc(executedFile, quiet));
+      renderCompletions.push(await renderPandoc(executedFile, quiet));
     },
     onComplete: async () => {
+      const renderedFiles = [];
+      for (const renderCompletion of renderCompletions) {
+        renderedFiles.push(await renderCompletion.complete());
+      }
       return {
         files: await Promise.resolve(renderedFiles),
       };

src/command/render/render.ts

@@ -53,10 +53,14 @@ import { filesDirMediabagDir } from "./render-paths.ts";
 import { replaceNotebookPlaceholders } from "../../core/jupyter/jupyter-embed.ts";
 import { kIncludeAfterBody, kIncludeInHeader } from "../../config/constants.ts";
 
+export interface PandocRenderCompletion {
+  complete: () => Promise<RenderedFile>;
+}
+
 export async function renderPandoc(
   file: ExecutedFile,
   quiet: boolean,
-): Promise<RenderedFile> {
+): Promise<PandocRenderCompletion> {
   // alias options
   const { context, recipe, executeResult, resourceFiles } = file;
 
@@ -159,161 +163,168 @@ export async function renderPandoc(
     return Promise.reject();
   }
 
-  pushTiming("render-postprocessor");
-  // run optional post-processor (e.g. to restore html-preserve regions)
-  if (executeResult.postProcess) {
-    await withTimingAsync("engine-postprocess", async () => {
-      return await context.engine.postprocess({
-        engine: context.engine,
-        target: context.target,
-        format,
-        output: recipe.output,
-        tempDir: context.options.services.temp.createDir(),
-        projectDir: context.project?.dir,
-        preserve: executeResult.preserve,
-        quiet: context.options.flags?.quiet,
-      });
-    });
-  }
+  return {
+    complete: async () => {
+      pushTiming("render-postprocessor");
+      // run optional post-processor (e.g. to restore html-preserve regions)
+      if (executeResult.postProcess) {
+        await withTimingAsync("engine-postprocess", async () => {
+          return await context.engine.postprocess({
+            engine: context.engine,
+            target: context.target,
+            format,
+            output: recipe.output,
+            tempDir: context.options.services.temp.createDir(),
+            projectDir: context.project?.dir,
+            preserve: executeResult.preserve,
+            quiet: context.options.flags?.quiet,
+          });
+        });
+      }
 
-  // run html postprocessors if we have them
-  const canHtmlPostProcess = isHtmlFileOutput(format.pandoc);
-  if (!canHtmlPostProcess && pandocResult.htmlPostprocessors.length > 0) {
-    const postProcessorNames = pandocResult.htmlPostprocessors.map((p) =>
-      p.name
-    ).join(", ");
-    const msg =
-      `Attempt to HTML post process non HTML output using: ${postProcessorNames}`;
-    throw new Error(msg);
-  }
-  const htmlPostProcessors = canHtmlPostProcess
-    ? pandocResult.htmlPostprocessors
-    : [];
-  const htmlFinalizers = canHtmlPostProcess
-    ? pandocResult.htmlFinalizers || []
-    : [];
-
-  const htmlPostProcessResult = await runHtmlPostprocessors(
-    pandocResult.inputMetadata,
-    pandocResult.inputTraits,
-    pandocOptions,
-    htmlPostProcessors,
-    htmlFinalizers,
-  );
+      // run html postprocessors if we have them
+      const canHtmlPostProcess = isHtmlFileOutput(format.pandoc);
+      if (!canHtmlPostProcess && pandocResult.htmlPostprocessors.length > 0) {
+        const postProcessorNames = pandocResult.htmlPostprocessors.map((p) =>
+          p.name
+        ).join(", ");
+        const msg =
+          `Attempt to HTML post process non HTML output using: ${postProcessorNames}`;
+        throw new Error(msg);
+      }
+      const htmlPostProcessors = canHtmlPostProcess
+        ? pandocResult.htmlPostprocessors
+        : [];
+      const htmlFinalizers = canHtmlPostProcess
+        ? pandocResult.htmlFinalizers || []
+        : [];
+
+      const htmlPostProcessResult = await runHtmlPostprocessors(
+        pandocResult.inputMetadata,
+        pandocResult.inputTraits,
+        pandocOptions,
+        htmlPostProcessors,
+        htmlFinalizers,
+      );
 
-  // Compute the path to the output file
-  const outputFile = isAbsolute(pandocOptions.output)
-    ? pandocOptions.output
-    : join(dirname(pandocOptions.source), pandocOptions.output);
+      // Compute the path to the output file
+      const outputFile = isAbsolute(pandocOptions.output)
+        ? pandocOptions.output
+        : join(dirname(pandocOptions.source), pandocOptions.output);
 
-  // run generic postprocessors
-  if (pandocResult.postprocessors) {
-    for (const postprocessor of pandocResult.postprocessors) {
-      await postprocessor(outputFile);
-    }
-  }
+      // run generic postprocessors
+      if (pandocResult.postprocessors) {
+        for (const postprocessor of pandocResult.postprocessors) {
+          await postprocessor(outputFile);
+        }
+      }
 
-  let finalOutput: string;
-  let selfContained: boolean;
+      let finalOutput: string;
+      let selfContained: boolean;
 
-  await withTimingAsync("postprocess-selfcontained", async () => {
-    // ensure flags
-    const flags = context.options.flags || {};
+      await withTimingAsync("postprocess-selfcontained", async () => {
+        // ensure flags
+        const flags = context.options.flags || {};
 
-    // call complete handler (might e.g. run latexmk to complete the render)
-    finalOutput = await recipe.complete(pandocOptions) || recipe.output;
+        // call complete handler (might e.g. run latexmk to complete the render)
+        finalOutput = await recipe.complete(pandocOptions) || recipe.output;
 
-    // determine whether this is self-contained output
-    selfContained = isSelfContainedOutput(
-      flags,
-      format,
-      finalOutput,
-    );
+        // determine whether this is self-contained output
+        selfContained = isSelfContainedOutput(
+          flags,
+          format,
+          finalOutput,
+        );
 
-    // 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);
-    }
-  });
+        // 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);
+        }
+      });
 
-  // compute the relative path to the files dir
-  let filesDir: string | undefined = inputFilesDir(context.target.source);
-  // undefine it if it doesn't exist
-  filesDir = existsSync(join(dirname(context.target.source), filesDir))
-    ? filesDir
-    : undefined;
-
-  // add any injected libs to supporting
-  let supporting = filesDir ? executeResult.supporting : undefined;
-  if (filesDir && isHtmlFileOutput(format.pandoc)) {
-    const filesDirAbsolute = join(dirname(context.target.source), filesDir);
-    if (
-      existsSync(filesDirAbsolute) &&
-      (!supporting || !supporting.includes(filesDirAbsolute))
-    ) {
-      const filesLibs = join(dirname(context.target.source), context.libDir);
+      // compute the relative path to the files dir
+      let filesDir: string | undefined = inputFilesDir(context.target.source);
+      // undefine it if it doesn't exist
+      filesDir = existsSync(join(dirname(context.target.source), filesDir))
+        ? filesDir
+        : undefined;
+
+      // add any injected libs to supporting
+      let supporting = filesDir ? executeResult.supporting : undefined;
+      if (filesDir && isHtmlFileOutput(format.pandoc)) {
+        const filesDirAbsolute = join(dirname(context.target.source), filesDir);
+        if (
+          existsSync(filesDirAbsolute) &&
+          (!supporting || !supporting.includes(filesDirAbsolute))
+        ) {
+          const filesLibs = join(
+            dirname(context.target.source),
+            context.libDir,
+          );
+          if (
+            existsSync(filesLibs) &&
+            (!supporting || !supporting.includes(filesLibs))
+          ) {
+            supporting = supporting || [];
+            supporting.push(filesLibs);
+          }
+        }
+      }
       if (
-        existsSync(filesLibs) &&
-        (!supporting || !supporting.includes(filesLibs))
+        htmlPostProcessResult.supporting &&
+        htmlPostProcessResult.supporting.length > 0
       ) {
         supporting = supporting || [];
-        supporting.push(filesLibs);
-      }
-    }
-  }
-  if (
-    htmlPostProcessResult.supporting &&
-    htmlPostProcessResult.supporting.length > 0
-  ) {
-    supporting = supporting || [];
-    supporting.push(...htmlPostProcessResult.supporting);
-  }
-
-  withTiming("render-cleanup", () =>
-    renderCleanup(
-      context.target.input,
-      finalOutput!,
-      format,
-      selfContained! ? supporting : undefined,
-      executionEngineKeepMd(context.target.input),
-    ));
-
-  // if there is a project context then return paths relative to the project
-  const projectPath = (path: string) => {
-    if (context.project) {
-      if (isAbsolute(path)) {
-        return relative(
-          Deno.realPathSync(context.project.dir),
-          Deno.realPathSync(path),
-        );
-      } else {
-        return relative(
-          Deno.realPathSync(context.project.dir),
-          Deno.realPathSync(join(dirname(context.target.source), path)),
-        );
+        supporting.push(...htmlPostProcessResult.supporting);
       }
-    } else {
-      return path;
-    }
-  };
-  popTiming();
 
-  return {
-    input: projectPath(context.target.source),
-    markdown: executeResult.markdown,
-    format,
-    supporting: supporting
-      ? supporting.filter(existsSync).map((file: string) =>
-        context.project ? relative(context.project.dir, file) : file
-      )
-      : undefined,
-    file: projectPath(finalOutput!),
-    resourceFiles: {
-      globs: pandocResult.resources,
-      files: resourceFiles.concat(htmlPostProcessResult.resources),
+      withTiming("render-cleanup", () =>
+        renderCleanup(
+          context.target.input,
+          finalOutput!,
+          format,
+          selfContained! ? supporting : undefined,
+          executionEngineKeepMd(context.target.input),
+        ));
+
+      // if there is a project context then return paths relative to the project
+      const projectPath = (path: string) => {
+        if (context.project) {
+          if (isAbsolute(path)) {
+            return relative(
+              Deno.realPathSync(context.project.dir),
+              Deno.realPathSync(path),
+            );
+          } else {
+            return relative(
+              Deno.realPathSync(context.project.dir),
+              Deno.realPathSync(join(dirname(context.target.source), path)),
+            );
+          }
+        } else {
+          return path;
+        }
+      };
+      popTiming();
+
+      return {
+        input: projectPath(context.target.source),
+        markdown: executeResult.markdown,
+        format,
+        supporting: supporting
+          ? supporting.filter(existsSync).map((file: string) =>
+            context.project ? relative(context.project.dir, file) : file
+          )
+          : undefined,
+        file: projectPath(finalOutput!),
+        resourceFiles: {
+          globs: pandocResult.resources,
+          files: resourceFiles.concat(htmlPostProcessResult.resources),
+        },
+        selfContained: selfContained!,
+      };
     },
-    selfContained: selfContained!,
   };
 }
 

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

@@ -211,7 +211,8 @@ export function bookPandocRenderer(
         }
 
         // perform the render
-        renderedFiles.push(await renderPandoc(file, quiet));
+        const renderCompletion = await renderPandoc(file, quiet);
+        renderedFiles.push(await renderCompletion.complete());
 
         // accumulate executed files for single file formats
       } else {
@@ -300,7 +301,8 @@ async function renderSingleFileBook(
   );
 
   // do pandoc render
-  const renderedFile = await renderPandoc(executedFile, quiet);
+  const renderCompletion = await renderPandoc(executedFile, quiet);
+  const renderedFile = await renderCompletion.complete();
 
   // cleanup step for each executed file
   files.forEach((file) => {