render jupyter percent scripts (#6700)

Author: jjallaire

src/core/jupyter/jupyter-fixups.ts

@@ -8,7 +8,7 @@ import { stringify } from "yaml/mod.ts";
 import { warning } from "log/mod.ts";
 
 import { kTitle } from "../../config/constants.ts";
-import { Metadata } from "../../publish/netlify/api/index.ts";
+import { Metadata } from "../../config/types.ts";
 import { lines } from "../lib/text.ts";
 import { markdownWithExtractedHeading } from "../pandoc/pandoc-partition.ts";
 import { partitionYamlFrontMatter, readYamlFromMarkdown } from "../yaml.ts";
@@ -135,17 +135,17 @@ export function fixupBokehCells(nb: JupyterNotebook): JupyterNotebook {
   return nb;
 }
 
-export function fixupFrontMatter(nb: JupyterNotebook): JupyterNotebook {
-  // helper to generate yaml
-  const asYamlText = (yaml: Metadata) => {
-    return stringify(yaml, {
-      indent: 2,
-      lineWidth: -1,
-      sortKeys: false,
-      skipInvalid: true,
-    });
-  };
+// helper to generate yaml
+export function asYamlText(yaml: Metadata) {
+  return stringify(yaml, {
+    indent: 2,
+    lineWidth: -1,
+    sortKeys: false,
+    skipInvalid: true,
+  });
+}
 
+export function fixupFrontMatter(nb: JupyterNotebook): JupyterNotebook {
   // helper to create nb lines (w/ newline after)
   const nbLines = (lns: string[]) => {
     return lns.map((line) => line.endsWith("\n") ? line : `${line}\n`);

src/core/jupyter/jupyter.ts

@@ -141,7 +141,7 @@ import {
   JupyterToMarkdownResult,
 } from "./types.ts";
 import { figuresDir, inputFilesDir } from "../render.ts";
-import { lines } from "../text.ts";
+import { lines, trimEmptyLines } from "../lib/text.ts";
 import { partitionYamlFrontMatter, readYamlFromMarkdown } from "../yaml.ts";
 import { languagesInMarkdown } from "../../execute/engine-shared.ts";
 import {
@@ -347,7 +347,7 @@ export async function quartoMdToJupyter(
           delete yaml.jupyter;
           // write the cell only if there is metadata to write
           if (Object.keys(yaml).length > 0) {
-            const yamlFrontMatter = mdTrimEmptyLines(lines(stringify(yaml, {
+            const yamlFrontMatter = trimEmptyLines(lines(stringify(yaml, {
               indent: 2,
               lineWidth: -1,
               sortKeys: false,
@@ -405,7 +405,7 @@ export async function quartoMdToJupyter(
       }
 
       // if the source is empty then don't add it
-      cell.source = mdTrimEmptyLines(cell.source);
+      cell.source = trimEmptyLines(cell.source);
       if (cell.source.length > 0) {
         nb.cells.push(cell);
       }
@@ -898,7 +898,7 @@ export function jupyterCellOptionsAsComment(
       ...stringifyOptions,
     });
     const commentChars = langCommentChars(language);
-    const yamlOutput = mdTrimEmptyLines(lines(cellYaml)).map((line) => {
+    const yamlOutput = trimEmptyLines(lines(cellYaml)).map((line) => {
       line = optionCommentPrefix(commentChars[0]) + line +
         optionCommentSuffix(commentChars[1]);
       return line + "\n";
@@ -965,6 +965,26 @@ export function mdFromContentCell(
   return contentCellEnvelope(cell.id, mdEnsureTrailingNewline(source));
 }
 
+export function mdFormatOutput(format: string, source: string[]) {
+  const ticks = ticksForCode(source);
+  return mdEnclosedOutput(ticks + "{=" + format + "}", source, ticks);
+}
+
+export function mdRawOutput(mimeType: string, source: string[]) {
+  switch (mimeType) {
+    case kTextHtml:
+      return mdHtmlOutput(source);
+    case kTextLatex:
+      return mdLatexOutput(source);
+    case kRestructuredText:
+      return mdFormatOutput("rst", source);
+    case kApplicationRtf:
+      return mdFormatOutput("rtf", source);
+    case kApplicationJavascript:
+      return mdScriptOutput(mimeType, source);
+  }
+}
+
 export function mdFromRawCell(
   cell: JupyterCellWithOptions,
   options?: JupyterToMarkdownOptions,
@@ -973,17 +993,9 @@ export function mdFromRawCell(
 
   const mimeType = cell.metadata?.[kCellRawMimeType];
   if (mimeType) {
-    switch (mimeType) {
-      case kTextHtml:
-        return rawCellEnvelope(cell.id, mdHtmlOutput(cell.source));
-      case kTextLatex:
-        return rawCellEnvelope(cell.id, mdLatexOutput(cell.source));
-      case kRestructuredText:
-        return rawCellEnvelope(cell.id, mdFormatOutput("rst", cell.source));
-      case kApplicationRtf:
-        return rawCellEnvelope(cell.id, mdFormatOutput("rtf", cell.source));
-      case kApplicationJavascript:
-        return rawCellEnvelope(cell.id, mdScriptOutput(mimeType, cell.source));
+    const rawOutput = mdRawOutput(mimeType, cell.source);
+    if (rawOutput) {
+      return rawCellEnvelope(cell.id, rawOutput);
     }
   }
 
@@ -1386,15 +1398,15 @@ async function mdFromCodeCell(
         line.search(/echo:\s+fenced/) === -1
       );
       if (optionsSource.length > 0) {
-        source = mdTrimEmptyLines(source, "trailing");
+        source = trimEmptyLines(source, "trailing");
       } else {
-        source = mdTrimEmptyLines(source, "all");
+        source = trimEmptyLines(source, "all");
       }
       source.unshift(...optionsSource);
       source.unshift("```{{" + options.language + "}}\n");
       source.push("\n```\n");
     } else if (cell.optionsSource.length > 0) {
-      source = mdTrimEmptyLines(source, "leading");
+      source = trimEmptyLines(source, "leading");
     }
     if (options.preserveCodeCellYaml) {
       md.push(...cell.optionsSource);
@@ -1868,11 +1880,6 @@ function mdMarkdownOutput(md: string[]) {
   return md.join("") + "\n";
 }
 
-function mdFormatOutput(format: string, source: string[]) {
-  const ticks = ticksForCode(source);
-  return mdEnclosedOutput(ticks + "{=" + format + "}", source, ticks);
-}
-
 function mdLatexOutput(latex: string[]) {
   return mdFormatOutput("tex", latex);
 }
@@ -1902,36 +1909,6 @@ function mdScriptOutput(mimeType: string, script: string[]) {
   return mdHtmlOutput(scriptTag);
 }
 
-function mdTrimEmptyLines(
-  lines: string[],
-  trim: "leading" | "trailing" | "all" = "all",
-) {
-  // trim leading lines
-  if (trim === "all" || trim === "leading") {
-    const firstNonEmpty = lines.findIndex((line) => line.trim().length > 0);
-    if (firstNonEmpty === -1) {
-      return [];
-    }
-    lines = lines.slice(firstNonEmpty);
-  }
-
-  // trim trailing lines
-  if (trim === "all" || trim === "trailing") {
-    let lastNonEmpty = -1;
-    for (let i = lines.length - 1; i >= 0; i--) {
-      if (lines[i].trim().length > 0) {
-        lastNonEmpty = i;
-        break;
-      }
-    }
-    if (lastNonEmpty > -1) {
-      lines = lines.slice(0, lastNonEmpty + 1);
-    }
-  }
-
-  return lines;
-}
-
 function mdCodeOutput(code: string[], clz?: string) {
   const ticks = ticksForCode(code);
   const open = ticks + (clz ? `{.${clz}}` : "");

src/core/lib/text.ts

@@ -16,6 +16,36 @@ export function normalizeNewlines(text: string) {
   return lines(text).join("\n");
 }
 
+export function trimEmptyLines(
+  lines: string[],
+  trim: "leading" | "trailing" | "all" = "all",
+) {
+  // trim leading lines
+  if (trim === "all" || trim === "leading") {
+    const firstNonEmpty = lines.findIndex((line) => line.trim().length > 0);
+    if (firstNonEmpty === -1) {
+      return [];
+    }
+    lines = lines.slice(firstNonEmpty);
+  }
+
+  // trim trailing lines
+  if (trim === "all" || trim === "trailing") {
+    let lastNonEmpty = -1;
+    for (let i = lines.length - 1; i >= 0; i--) {
+      if (lines[i].trim().length > 0) {
+        lastNonEmpty = i;
+        break;
+      }
+    }
+    if (lastNonEmpty > -1) {
+      lines = lines.slice(0, lastNonEmpty + 1);
+    }
+  }
+
+  return lines;
+}
+
 // NB we can't use JS matchAll or replaceAll here because we need to support old
 // Chromium in the IDE
 //

src/execute/engine.ts

@@ -1,9 +1,8 @@
 /*
-* engine.ts
-*
-* Copyright (C) 2020-2022 Posit Software, PBC
-*
-*/
+ * engine.ts
+ *
+ * Copyright (C) 2020-2022 Posit Software, PBC
+ */
 
 import { extname, join } from "path/mod.ts";
 
@@ -20,8 +19,8 @@ import { kEngine } from "../config/constants.ts";
 
 import { knitrEngine } from "./rmd.ts";
 import { jupyterEngine } from "./jupyter/jupyter.ts";
-import { markdownEngine } from "./markdown.ts";
-import { ExecutionEngine } from "./types.ts";
+import { kMdExtensions, markdownEngine } from "./markdown.ts";
+import { ExecutionEngine, kQmdExtensions } from "./types.ts";
 import { languagesInMarkdown } from "./engine-shared.ts";
 import { languages as handlerLanguages } from "../core/handlers/base.ts";
 import { MappedString } from "../core/lib/text-types.ts";
@@ -82,10 +81,7 @@ export function engineValidExtensions(): string[] {
   return ld.uniq(kEngines.flatMap((engine) => engine.validExtensions()));
 }
 
-export function markdownExecutionEngine(
-  markdown: string,
-  flags?: RenderFlags,
-) {
+export function markdownExecutionEngine(markdown: string, flags?: RenderFlags) {
   // read yaml and see if the engine is declared in yaml
   // (note that if the file were a non text-file like ipynb
   //  it would have already been claimed via extension)
@@ -100,9 +96,7 @@ export function markdownExecutionEngine(
           return engine;
         }
         const format = metadataAsFormat(yaml);
-        if (
-          format.execute?.[kEngine] === engine.name
-        ) {
+        if (format.execute?.[kEngine] === engine.name) {
           return engine;
         }
       }
@@ -142,9 +136,7 @@ export function markdownExecutionEngine(
  * @param file filename
  * @returns the reason
  */
-export function fileEngineClaimReason(
-  file: string,
-) {
+export function fileEngineClaimReason(file: string) {
   // get the extension and validate that it can be handled by at least one of our engines
   const ext = extname(file).toLowerCase();
   if (!kEngines.some((engine) => engine.validExtensions().includes(ext))) {
@@ -153,7 +145,7 @@ export function fileEngineClaimReason(
 
   // try to find an engine that claims this extension outright
   for (const engine of kEngines) {
-    if (engine.claimsExtension(ext)) {
+    if (engine.claimsFile(file, ext)) {
       return "extension";
     }
   }
@@ -174,17 +166,21 @@ export function fileExecutionEngine(
 
   // try to find an engine that claims this extension outright
   for (const engine of kEngines) {
-    if (engine.claimsExtension(ext)) {
+    if (engine.claimsFile(file, ext)) {
       return engine;
     }
   }
 
   // if we were passed a transformed markdown, use that for the text instead
   // of the contents of the file.
-  return markdownExecutionEngine(
-    markdown ? markdown.value : Deno.readTextFileSync(file),
-    flags,
-  );
+  if (kMdExtensions.includes(ext) || kQmdExtensions.includes(ext)) {
+    return markdownExecutionEngine(
+      markdown ? markdown.value : Deno.readTextFileSync(file),
+      flags,
+    );
+  } else {
+    return undefined;
+  }
 }
 
 export async function fileExecutionEngineAndTarget(