Remove explicitly controlled output file

notebook-context is in charge of providing the output file

Author: dragonstyle

src/format/html/format-html-notebook-preview.ts

@@ -73,15 +73,13 @@ export const notebookPreviewer = (
     input: string,
     nbAbsPath: string,
     title?: string,
-    nbPreviewFile?: string,
     callback?: (nbPreview: NotebookPreview) => void,
   ) => {
     // Try to provide a title
     previewQueue.push({
       input,
       nbPath: nbAbsPath,
       title: title,
-      nbPreviewFile,
       callback,
     });
   };
@@ -107,7 +105,7 @@ export const notebookPreviewer = (
     let renderCount = 0;
     for (let i = 0; i < total; i++) {
       const work = previewQueue[i];
-      const { nbPath, input, title, nbPreviewFile } = work;
+      const { nbPath, input, title } = work;
       if (
         toRenderPaths.includes(nbPath) && !haveRenderedPaths.includes(nbPath) &&
         !quiet
@@ -149,7 +147,6 @@ export const notebookPreviewer = (
                 title: resolvedTitle,
                 filename: basename(nbAbsPath),
               },
-              undefined,
               project,
             );
             if (renderedIpynb && renderedIpynb.output && !project) {
@@ -180,7 +177,6 @@ export const notebookPreviewer = (
                 downloadHref,
                 downloadFile: basename(nbAbsPath),
               },
-              nbPreviewFile,
               project,
             );
             if (htmlPreview.output && !project) {

src/format/html/format-html-notebook.ts

@@ -147,7 +147,6 @@ export async function emplaceNotebookPreviews(
           input,
           input,
           undefined, // title
-          undefined, // preview file name
           (nbPreview) => {
             // If this is a cell _in_ a source notebook, it will not be parented
             // by an embed cell
@@ -198,17 +197,11 @@ export async function emplaceNotebookPreviews(
       const title = nbDivEl.getAttribute("data-notebook-title");
       nbDivEl.removeAttribute("data-notebook-title");
 
-      const notebookPreviewFile = nbDivEl.getAttribute(
-        "data-notebook-preview-file",
-      );
-      nbDivEl.removeAttribute("data-notebook-preview-file");
-
       if (notebookPath) {
         previewer.enQueuePreview(
           input,
           nbAbsPath(input, notebookPath),
           title === null ? undefined : title,
-          notebookPreviewFile === null ? undefined : notebookPreviewFile,
           (nbPreview) => {
             // Add a decoration to this div node
             if (inline) {

src/format/jats/format-jats-postprocess.ts

@@ -56,7 +56,6 @@ export const renderSubarticlePostProcessor = (
         kJatsSubarticle,
         services,
         undefined,
-        undefined,
         project,
       );
     }

src/render/notebook/notebook-context.ts

@@ -4,11 +4,7 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import {
-  ExecutedFile,
-  RenderedFile,
-  RenderServices,
-} from "../../command/render/types.ts";
+import { ExecutedFile, RenderServices } from "../../command/render/types.ts";
 import { InternalError } from "../../core/lib/error.ts";
 import { kJatsSubarticle } from "../../format/jats/format-jats-types.ts";
 import { ProjectContext } from "../../project/types.ts";
@@ -19,6 +15,7 @@ import {
   NotebookContext,
   NotebookContributor,
   NotebookMetadata,
+  NotebookRenderResult,
   RenderType,
 } from "./notebook-types.ts";
 
@@ -56,7 +53,7 @@ export function notebookContext(): NotebookContext {
   const addRendering = (
     nbAbsPath: string,
     renderType: RenderType,
-    result: RenderedFile,
+    result: NotebookRenderResult,
   ) => {
     const absPath = join(dirname(nbAbsPath), basename(result.file));
     const output = {
@@ -151,7 +148,6 @@ export function notebookContext(): NotebookContext {
       renderType: RenderType,
       services: RenderServices,
       notebookMetadata?: NotebookMetadata,
-      outputFile?: string,
       project?: ProjectContext,
     ) => {
       addMetadata(nbAbsPath, renderType, notebookMetadata);
@@ -161,7 +157,6 @@ export function notebookContext(): NotebookContext {
         token(),
         services,
         notebookMetadata,
-        outputFile,
         project,
       );
 

src/render/notebook/notebook-contributor-html.ts

@@ -103,7 +103,6 @@ async function renderHtmlNotebook(
   _subArticleToken: string,
   services: RenderServices,
   notebookMetadata?: NotebookMetadata,
-  outputFile?: string,
   project?: ProjectContext,
 ): Promise<RenderedFile> {
   // Use the special `embed` template for this render
@@ -121,7 +120,7 @@ async function renderHtmlNotebook(
         metadata: {
           [kTo]: "html",
           [kTheme]: format.metadata[kTheme],
-          [kOutputFile]: outputFile || `${basename(nbPath)}`,
+          [kOutputFile]: `${basename(nbPath)}.html`,
           [kTemplate]: template,
           [kNotebookViewStyle]: kNotebookViewStyleNotebook,
           [kAppendixStyle]: "none",

src/render/notebook/notebook-contributor-ipynb.ts

@@ -71,7 +71,6 @@ async function renderOutputNotebook(
   _subArticleToken: string,
   services: RenderServices,
   _notebookMetadata?: NotebookMetadata,
-  outputFile?: string,
   project?: ProjectContext,
 ): Promise<RenderedFile> {
   const rendered = await renderFiles(
@@ -81,7 +80,7 @@ async function renderOutputNotebook(
       flags: {
         metadata: {
           [kTo]: "ipynb",
-          [kOutputFile]: outputFile || ipynbOutputFile(nbPath),
+          [kOutputFile]: ipynbOutputFile(nbPath),
         },
         quiet: false,
       },

src/render/notebook/notebook-contributor-jats.ts

@@ -77,7 +77,6 @@ async function renderJats(
   subArticleToken: string,
   services: RenderServices,
   _notebookMetadata?: NotebookMetadata,
-  outputFile?: string,
   project?: ProjectContext,
 ): Promise<RenderedFile> {
   const rendered = await renderFiles(
@@ -90,7 +89,7 @@ async function renderJats(
           [kLintXml]: false,
           [kJatsSubarticle]: true,
           [kJatsSubarticleId]: subArticleToken,
-          [kOutputFile]: outputFile || jatsOutputFile(nbPath),
+          [kOutputFile]: jatsOutputFile(nbPath),
           [kTemplate]: subarticleTemplatePath,
           [kNotebookPreserveCells]: true,
           [kNotebookPreserveCells]: true,

src/render/notebook/notebook-types.ts

@@ -44,6 +44,12 @@ export interface NotebookOutput {
   resourceFiles: RenderResourceFiles;
 }
 
+export interface NotebookRenderResult {
+  file: string;
+  supporting?: string[];
+  resourceFiles: RenderResourceFiles;
+}
+
 // Metadata that can be passed when rendering/resolving a notebook
 export interface NotebookMetadata {
   title: string;
@@ -61,7 +67,7 @@ export interface NotebookTemplateMetadata extends NotebookMetadata {
 
 export interface NotebookContext {
   // Retrieves the notebook from the context.
-  get: (nbPath: string) => Notebook | undefined;
+  get: (nbPath: string, outputFile?: string) => Notebook | undefined;
   // Resolves the data on an executedFile into data that will
   // create a `renderType` output when rendered.
   resolve: (
@@ -89,7 +95,6 @@ export interface NotebookContext {
     renderType: RenderType,
     renderServices: RenderServices,
     notebookMetadata?: NotebookMetadata,
-    outputFile?: string,
     project?: ProjectContext,
   ) => Promise<NotebookPreview>;
   // Previews are cleaned up when the notebook context is disposed, but
@@ -113,7 +118,6 @@ export interface NotebookContributor {
     token: string,
     services: RenderServices,
     notebookMetadata?: NotebookMetadata,
-    outputFile?: string,
     project?: ProjectContext,
-  ): Promise<RenderedFile>;
+  ): Promise<NotebookRenderResult>;
 }

src/resources/filters/layout/manuscript.lua

@@ -69,14 +69,18 @@ function manuscript()
 
           -- Provide preview path for the preview generator - this
           -- will specify a preview file name to use when generating this preview
-          -- TODO Should we really just handle this by convention?
+          -- 
+          -- NOTE: This is a point of coordinate where the name of the notebooks is important
+          -- and this is relying upon that name being present in order to form these links
+          --
+          -- TODO: Make the filter params include notebook-context information that
+          -- can be used to resolve links (if they are present)
           local nbFileName = pandoc.path.filename(nbPath)
           local nbDir = pandoc.path.directory(nbPath)
           if nbDir == "." then
             nbDir = ""
           end
           local previewFile = nbFileName .. ".html"
-          divEl.attributes['notebook-preview-file'] = previewFile;
           local previewPath = pandoc.path.join({nbDir, previewFile})
 
           -- The title for the notebook