Improved jupyter assets cleanup

Author: dragonstyle

src/command/render/render.ts

@@ -20,7 +20,7 @@ import {
 import { inputFilesDir } from "../../core/render.ts";
 import { pathWithForwardSlashes } from "../../core/path.ts";
 
-import { Format, FormatPandoc } from "../../config/types.ts";
+import { FormatPandoc } from "../../config/types.ts";
 import {
   executionEngine,
   executionEngineKeepMd,
@@ -123,10 +123,10 @@ export async function renderPandoc(
 
   // Map notebook includes to pandoc includes
   const pandocIncludes: PandocIncludes = {
-    [kIncludeAfterBody]: notebookResult && notebookResult.includes?.afterBody
+    [kIncludeAfterBody]: notebookResult.includes?.afterBody
       ? [notebookResult.includes?.afterBody]
       : undefined,
-    [kIncludeInHeader]: notebookResult && notebookResult.includes?.inHeader
+    [kIncludeInHeader]: notebookResult.includes?.inHeader
       ? [notebookResult.includes?.inHeader]
       : undefined,
   };
@@ -139,7 +139,9 @@ export async function renderPandoc(
 
   // pandoc options
   const pandocOptions: PandocOptions = {
-    markdown: notebookResult ? notebookResult.markdown : executeResult.markdown,
+    markdown: notebookResult.markdown
+      ? notebookResult.markdown
+      : executeResult.markdown,
     source: context.target.source,
     output: recipe.output,
     keepYaml: recipe.keepYaml,
@@ -282,6 +284,11 @@ export async function renderPandoc(
         supporting.push(...htmlPostProcessResult.supporting);
       }
 
+      if (notebookResult.supporting) {
+        supporting = supporting || [];
+        supporting.push(...notebookResult.supporting);
+      }
+
       withTiming("render-cleanup", () =>
         renderCleanup(
           context.target.input,

src/core/jupyter/jupyter-embed.ts

@@ -9,6 +9,7 @@ import { resourcePath } from "../resources.ts";
 import { getNamedLifetime, ObjectWithLifetime } from "../lifetimes.ts";
 
 import {
+  cleanEmptyJupyterAssets,
   jupyterAssets,
   jupyterFromFile,
   jupyterToMarkdown,
@@ -44,7 +45,7 @@ import {
 import { globalTempContext } from "../temp.ts";
 import { isAbsolute } from "path/mod.ts";
 import { partitionMarkdown } from "../pandoc/pandoc-partition.ts";
-import { safeExistsSync } from "../path.ts";
+import { removeIfEmptyDir, safeExistsSync } from "../path.ts";
 import { basename } from "path/mod.ts";
 
 export interface JupyterNotebookAddress {
@@ -148,82 +149,82 @@ export async function replaceNotebookPlaceholders(
   flags: RenderFlags,
   markdown: string,
 ) {
+  // Assets
+  const assets = jupyterAssets(
+    input,
+    to,
+  );
   let match = kPlaceholderRegex.exec(markdown);
-  if (match) {
-    // Assets
-    const assets = jupyterAssets(
-      input,
-      to,
-    );
-
-    let includes;
-    while (match) {
-      // Parse the address and if this is a notebook
-      // then proceed with the replacement
-      const nbAddressStr = match[1];
-      const nbAddress = parseNotebookAddress(nbAddressStr);
-      if (nbAddress) {
-        // If a list of outputs are provided, resolve that range
-        const outputsStr = match[2];
-        const nbOutputs = outputsStr ? resolveRange(outputsStr) : undefined;
-
-        // If cell options are provided, resolve those
-        const placeholderStr = match[3];
-        const nbOptions = placeholderStr
-          ? placeholderToOptions(placeholderStr)
-          : {};
-
-        // Compute appropriate includes based upon the note
-        // dependendencies
-        const notebookIncludes = () => {
-          const nbPath = resolveNbPath(input, nbAddress.path);
-          if (safeExistsSync(nbPath)) {
-            const notebook = jupyterFromFile(nbPath);
-            const dependencies = isHtmlOutput(context.format.pandoc)
-              ? extractJupyterWidgetDependencies(notebook)
-              : undefined;
-            if (dependencies) {
-              const tempDir = globalTempContext().createDir();
-              return includesForJupyterWidgetDependencies(
-                [dependencies],
-                tempDir,
-              );
-            } else {
-              return undefined;
-            }
-          } else {
-            const notebookName = basename(nbPath);
-            throw new Error(
-              `Unable to embed content from notebook '${notebookName}'\nThe file ${nbPath} doesn't exist or cannot be read.`,
+  let includes;
+  while (match) {
+    // Parse the address and if this is a notebook
+    // then proceed with the replacement
+    const nbAddressStr = match[1];
+    const nbAddress = parseNotebookAddress(nbAddressStr);
+    if (nbAddress) {
+      // If a list of outputs are provided, resolve that range
+      const outputsStr = match[2];
+      const nbOutputs = outputsStr ? resolveRange(outputsStr) : undefined;
+
+      // If cell options are provided, resolve those
+      const placeholderStr = match[3];
+      const nbOptions = placeholderStr
+        ? placeholderToOptions(placeholderStr)
+        : {};
+
+      // Compute appropriate includes based upon the note
+      // dependendencies
+      const notebookIncludes = () => {
+        const nbPath = resolveNbPath(input, nbAddress.path);
+        if (safeExistsSync(nbPath)) {
+          const notebook = jupyterFromFile(nbPath);
+          const dependencies = isHtmlOutput(context.format.pandoc)
+            ? extractJupyterWidgetDependencies(notebook)
+            : undefined;
+          if (dependencies) {
+            const tempDir = globalTempContext().createDir();
+            return includesForJupyterWidgetDependencies(
+              [dependencies],
+              tempDir,
             );
+          } else {
+            return undefined;
           }
-        };
-        includes = notebookIncludes();
-
-        // Render the notebook markdown
-        const nbMarkdown = await notebookMarkdown(
-          nbAddress,
-          assets,
-          context,
-          flags,
-          nbOptions,
-          nbOutputs,
-        );
+        } else {
+          const notebookName = basename(nbPath);
+          throw new Error(
+            `Unable to embed content from notebook '${notebookName}'\nThe file ${nbPath} doesn't exist or cannot be read.`,
+          );
+        }
+      };
+      includes = notebookIncludes();
 
-        // Replace the placeholders with the rendered markdown
-        markdown = markdown.replaceAll(match[0], nbMarkdown);
-      }
-      match = kPlaceholderRegex.exec(markdown);
+      // Render the notebook markdown
+      const nbMarkdown = await notebookMarkdown(
+        nbAddress,
+        assets,
+        context,
+        flags,
+        nbOptions,
+        nbOutputs,
+      );
+
+      // Replace the placeholders with the rendered markdown
+      markdown = markdown.replaceAll(match[0], nbMarkdown);
     }
-    kPlaceholderRegex.lastIndex = 0;
-    return {
-      includes,
-      markdown,
-      supporting: [join(assets.base_dir, assets.supporting_dir)],
-    };
-  } else {
-    return undefined;
+    match = kPlaceholderRegex.exec(markdown);
   }
+  kPlaceholderRegex.lastIndex = 0;
+  const cleaned = cleanEmptyJupyterAssets(assets);
+  const supporting = cleaned
+    ? []
+    : [join(assets.base_dir, assets.supporting_dir)];
+
+  return {
+    includes,
+    markdown,
+    supporting: supporting,
+  };
 }
 
 function resolveNbPath(input: string, path: string) {

src/core/jupyter/jupyter.ts

@@ -145,7 +145,7 @@ import { figuresDir, inputFilesDir } from "../render.ts";
 import { lines } from "../text.ts";
 import { readYamlFromMarkdown } from "../yaml.ts";
 import { languagesInMarkdown } from "../../execute/engine-shared.ts";
-import { pathWithForwardSlashes } from "../path.ts";
+import { pathWithForwardSlashes, removeIfEmptyDir } from "../path.ts";
 import { convertToHtmlSpans, hasAnsiEscapeCodes } from "../ansi-colors.ts";
 import { ProjectContext } from "../../project/types.ts";
 import { mergeConfigs } from "../config.ts";
@@ -572,7 +572,17 @@ export function jupyterAutoIdentifier(label: string) {
   }
 }
 
-export function jupyterAssets(input: string, to?: string) {
+export interface JupyterNotebookAssetPaths {
+  base_dir: string;
+  files_dir: string;
+  figures_dir: string;
+  supporting_dir: string;
+}
+
+export function jupyterAssets(
+  input: string,
+  to?: string,
+): JupyterNotebookAssetPaths {
   // calculate and create directories
   input = Deno.realPathSync(input);
   const files_dir = join(dirname(input), inputFilesDir(input));
@@ -602,6 +612,16 @@ export function jupyterAssets(input: string, to?: string) {
   };
 }
 
+export function cleanEmptyJupyterAssets(assets: JupyterNotebookAssetPaths) {
+  const figuresRemoved = removeIfEmptyDir(
+    join(assets.base_dir, assets.figures_dir),
+  );
+  const filesRemoved = removeIfEmptyDir(
+    join(assets.base_dir, assets.files_dir),
+  );
+  return figuresRemoved && filesRemoved;
+}
+
 // Attach fully rendered notebook to render services
 // Render notebook only once per document
 // Return cells with markdown instead of complete markdown

src/core/path.ts

@@ -40,7 +40,7 @@ export function safeRemoveIfExists(file: string) {
   }
 }
 
-export function removeIfEmptyDir(dir: string) {
+export function removeIfEmptyDir(dir: string): boolean {
   if (existsSync(dir)) {
     let empty = true;
     for (const _entry of Deno.readDirSync(dir)) {
@@ -49,7 +49,11 @@ export function removeIfEmptyDir(dir: string) {
     }
     if (empty) {
       Deno.removeSync(dir, { recursive: true });
+      return true;
     }
+    return false;
+  } else {
+    return false;
   }
 }