Project Types can tinker with output files

This allows manuscript projects to provide a more nuanced output file for its notebooks.

Author: dragonstyle

src/project/project-index.ts

@@ -4,12 +4,12 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { dirname, isAbsolute, join, relative } from "path/mod.ts";
+import { basename, dirname, isAbsolute, join, relative } from "path/mod.ts";
 import { existsSync } from "fs/mod.ts";
 
 import * as ld from "../core/lodash.ts";
 
-import { ProjectContext } from "./types.ts";
+import { kProjectType, ProjectContext } from "./types.ts";
 import { Metadata } from "../config/types.ts";
 import { Format } from "../config/types.ts";
 import { PartitionedMarkdown } from "../core/pandoc/types.ts";
@@ -34,6 +34,7 @@ import {
 } from "./types/website/website-config.ts";
 import { kDefaultProjectFileContents } from "./types/project-default.ts";
 import { formatOutputFile } from "../core/render.ts";
+import { projectType } from "./types/project-types.ts";
 
 export interface InputTargetIndex extends Metadata {
   title?: string;
@@ -247,8 +248,16 @@ export async function resolveInputTarget(
   if (index) {
     const formats = formatsPreferHtml(index.formats) as Record<string, Format>;
     const format = Object.values(formats)[0];
+
+    // lookup the project type
+    const projType = projectType(project.config?.project?.[kProjectType]);
+    const projOutputFile = projType.outputFile
+      ? projType.outputFile(href, format, project)
+      : undefined;
+
     const [hrefDir, hrefStem] = dirAndStem(href);
-    const outputFile = formatOutputFile(format) || `${hrefStem}.html`;
+    const outputFile = projOutputFile || formatOutputFile(format) ||
+      `${hrefStem}.html`;
     const outputHref = pathWithForwardSlashes(
       (absolute ? "/" : "") + join(hrefDir, outputFile),
     );

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

@@ -164,8 +164,8 @@ export const manuscriptRenderer = (
     onFilterContexts: (
       file: string,
       contexts: Record<string, RenderContext>,
-      files: RenderFile[],
-      options: RenderOptions,
+      _files: RenderFile[],
+      _options: RenderOptions,
     ) => {
       const isValidNotebookOutput = (to: string) => {
         return [isJatsOutput, (format: string) => {
@@ -175,19 +175,6 @@ export const manuscriptRenderer = (
         });
       };
 
-      // if the render file list doesn't contain any article, and there is a custom too
-      // (so this is an attemp to render only manuscript notebooks), throw error
-      if (
-        options.flags?.to && !isValidNotebookOutput(options.flags.to) &&
-        !files.find((renderFile) => {
-          return isArticle(renderFile.path, context, manuscriptConfig);
-        })
-      ) {
-        throw new Error(
-          "Notebooks within manuscript projects can only be rendered as a part of rendering the article or as an HTML or JATS preview.",
-        );
-      }
-
       // Articles can be any format, notebooks can only be HTML or JATS
       if (isNotebook(file)) {
         const outContexts: Record<string, RenderContext> = {};

src/project/types/manuscript/manuscript.ts

@@ -78,6 +78,7 @@ import { logProgress } from "../../../core/log.ts";
 import { formatLanguage } from "../../../core/language.ts";
 import { manuscriptRenderer } from "./manuscript-render.ts";
 import { isRStudioPreview } from "../../../core/platform.ts";
+import { outputFile } from "../../../render/notebook/notebook-contributor-html.ts";
 
 const kMecaIcon = "archive";
 const kOutputDir = "_manuscript";
@@ -258,6 +259,20 @@ export const manuscriptProjectType: ProjectType = {
   },
   pandocRenderer: manuscriptRenderer,
   outputDir: kOutputDir,
+  outputFile: (input: string, format: Format, project: ProjectContext) => {
+    const manuscriptConfig = project.config
+      ?.[kManuscriptType] as ResolvedManuscriptConfig;
+
+    // Enable this stuff only if this is not the notebook view of an article
+    if (
+      !isArticleManuscript(input, format, project, manuscriptConfig) &&
+      isHtmlOutput(format.pandoc)
+    ) {
+      return outputFile(input);
+    } else {
+      return undefined;
+    }
+  },
   cleanOutputDir: true,
   incrementalFormatPreviewing: true,
   filterParams: async (options: PandocOptions) => {
@@ -452,7 +467,7 @@ export const manuscriptProjectType: ProjectType = {
 
     return Promise.resolve(extras);
   },
-  previewSkipUnmodified: false,
+  previewSkipUnmodified: true,
   renderResultFinalOutput: (
     renderResults: RenderResult,
   ) => {

src/project/types/types.ts

@@ -31,6 +31,11 @@ export interface ProjectType {
   ) => Promise<ProjectConfig>;
   libDir?: string;
   outputDir?: string;
+  outputFile?: (
+    input: string,
+    format: Format,
+    project: ProjectContext,
+  ) => string | undefined;
   filterOutputFile?: (file: string) => string;
   cleanOutputDir?: boolean;
   formatLibDirs?: () => string[];

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

@@ -49,7 +49,7 @@ export const htmlNotebookContributor: NotebookContributor = {
   outputFile,
 };
 
-function outputFile(
+export function outputFile(
   nbAbsPath: string,
 ): string {
   return `${basename(nbAbsPath)}.html`;