inspect - provide information about output files from input files

src/inspect/inspect-types.ts

@@ -4,7 +4,7 @@
  * Copyright (C) 2020-2022 Posit Software, PBC
  */
 
-import { Format } from "../config/types.ts";
+import { Format, FormatIdentifier } from "../config/types.ts";
 import { Extension } from "../extension/types.ts";
 import {
   FileInclusion,
@@ -25,6 +25,7 @@ export interface InspectedFile {
   includeMap: FileInclusion[];
   codeCells: InspectedMdCell[];
   metadata: Record<string, unknown>;
+  outputFiles: Record<string, FormatIdentifier>;
 }
 
 export interface InspectedConfig {

src/inspect/inspect.ts

@@ -49,6 +49,7 @@ import {
 import { validateDocumentFromSource } from "../core/schema/validate-document.ts";
 import { error } from "../deno_ral/log.ts";
 import { ProjectContext } from "../project/types.ts";
+import { resolveOutputFileNames } from "../project/project-index.ts";
 
 export function isProjectConfig(
   config: InspectedConfig,
@@ -90,6 +91,7 @@ const inspectProjectConfig = async (context: ProjectContext) => {
     return undefined;
   }
   const fileInformation: Record<string, InspectedFile> = {};
+  await resolveOutputFileNames(context);
   for (const file of context.files.input) {
     await populateFileInformation(context, fileInformation, file);
   }
@@ -144,6 +146,7 @@ const populateFileInformation = async (
       [],
     codeCells: context.fileInformationCache.get(file)?.codeCells ?? [],
     metadata: context.fileInformationCache.get(file)?.metadata ?? {},
+    outputFiles: context.fileInformationCache.get(file)?.outputFiles ?? {},
   };
 };
 
@@ -213,9 +216,11 @@ const inspectDocumentConfig = async (path: string) => {
       );
     }
 
+    path = normalizePath(path);
     await context.resolveFullMarkdownForFile(engine, path);
     await projectResolveCodeCellsForFile(context, engine, path);
     await projectFileMetadata(context, path);
+    await resolveOutputFileNames(context);
     const fileInformation = context.fileInformationCache.get(path);
 
     // data to write
@@ -231,6 +236,7 @@ const inspectDocumentConfig = async (path: string) => {
           includeMap: fileInformation?.includeMap ?? [],
           codeCells: fileInformation?.codeCells ?? [],
           metadata: fileInformation?.metadata ?? {},
+          outputFiles: fileInformation?.outputFiles ?? {},
         },
       },
     };

src/project/project-index.ts

@@ -27,7 +27,11 @@ import {
 import { kTitle } from "../config/constants.ts";
 import { fileExecutionEngine } from "../execute/engine.ts";
 
-import { projectConfigFile, projectOutputDir } from "./project-shared.ts";
+import {
+  ensureFileInformationCache,
+  projectConfigFile,
+  projectOutputDir,
+} from "./project-shared.ts";
 import { projectScratchPath } from "./project-scratch.ts";
 import { parsePandocTitle } from "../core/pandoc/pandoc-partition.ts";
 import { readYamlFromString } from "../core/yaml.ts";
@@ -297,20 +301,13 @@ export async function resolveInputTarget(
   }
 }
 
-export async function inputFileForOutputFile(
+// populates the outputNameIndex field in the project context
+export async function resolveOutputFileNames(
   project: ProjectContext,
-  output: string,
-): Promise<{ file: string; format: Format } | undefined> {
-  // compute output dir
+): Promise<void> {
+  if (project.outputNameIndex) return;
   const outputDir = projectOutputDir(project);
 
-  // full path to output (it's relative to output dir)
-  output = isAbsolute(output) ? output : join(outputDir, output);
-
-  if (project.outputNameIndex !== undefined) {
-    return project.outputNameIndex.get(output);
-  }
-
   project.outputNameIndex = new Map();
   for (const file of project.files.input) {
     const inputRelative = relative(project.dir, file);
@@ -319,6 +316,8 @@ export async function inputFileForOutputFile(
       relative(project.dir, file),
     );
     if (index) {
+      const cache = ensureFileInformationCache(project, file);
+      cache.outputFiles = cache.outputFiles || {};
       Object.keys(index.formats).forEach((key) => {
         const format = index.formats[key];
         const outputFile = formatOutputFile(format);
@@ -329,11 +328,25 @@ export async function inputFileForOutputFile(
             outputFile,
           );
           project.outputNameIndex!.set(formatOutputPath, { file, format });
+          cache.outputFiles![formatOutputPath] = format.identifier;
         }
       });
     }
   }
-  return project.outputNameIndex.get(output);
+}
+
+export async function inputFileForOutputFile(
+  project: ProjectContext,
+  output: string,
+): Promise<{ file: string; format: Format } | undefined> {
+  // compute output dir
+  const outputDir = projectOutputDir(project);
+
+  // full path to output (it's relative to output dir)
+  output = isAbsolute(output) ? output : join(outputDir, output);
+
+  await resolveOutputFileNames(project);
+  return project.outputNameIndex?.get(output);
 }
 
 export async function inputTargetIndexForOutputFile(

src/project/types.ts

@@ -5,7 +5,7 @@
  */
 
 import { RenderServices } from "../command/render/types.ts";
-import { Metadata, PandocFlags } from "../config/types.ts";
+import { FormatIdentifier, Metadata, PandocFlags } from "../config/types.ts";
 import { Format, FormatExtras } from "../config/types.ts";
 import { Brand, LightDarkBrand } from "../core/brand/brand.ts";
 import { MappedString } from "../core/mapped-text.ts";
@@ -57,6 +57,7 @@ export type FileInformation = {
   target?: ExecutionTarget;
   metadata?: Metadata;
   brand?: LightDarkBrand;
+  outputFiles?: Record<string, FormatIdentifier>;
 };
 
 export interface ProjectContext extends Cloneable<ProjectContext> {

src/project/types/single-file/single-file.ts

@@ -46,7 +46,7 @@ export async function singleFileProjectContext(
     dir: normalizePath(dirname(source)),
     engines: [],
     files: {
-      input: [],
+      input: [normalizePath(source)],
     },
     notebookContext,
     environment: () => environmentMemoizer(result),

tests/smoke/inspect/inspect-cleanup.test.ts

@@ -5,6 +5,7 @@
 *
 */
 
+import { normalizePath } from "../../../src/core/path.ts";
 import { existsSync } from "../../../src/deno_ral/fs.ts";
 import {  } from "../../../src/project/types.ts";
 import {
@@ -25,7 +26,7 @@ import { assert } from "testing/asserts";
         verify: async (outputs: ExecuteOutput[]) => {
           assert(existsSync(output));
           const json = JSON.parse(Deno.readTextFileSync(output));
-          assert(json.fileInformation["docs/inspect/cleanup-issue-12336/cleanup-bug.qmd"].metadata.engine === "jupyter");
+          assert(json.fileInformation[normalizePath("docs/inspect/cleanup-issue-12336/cleanup-bug.qmd")].metadata.engine === "jupyter");
           assert(!existsSync("docs/inspect/cleanup-issue-12336/cleanup-bug.quarto_ipynb"));
         }
       }

tests/smoke/inspect/inspect-code-cells.test.ts

@@ -13,6 +13,7 @@ import {
   testQuartoCmd,
 } from "../../test.ts";
 import { assert } from "testing/asserts";
+import { normalizePath } from "../../../src/core/path.ts";
 
 (() => {
   const input = "docs/project/book/_include.qmd";
@@ -26,7 +27,7 @@ import { assert } from "testing/asserts";
         verify: async (outputs: ExecuteOutput[]) => {
           assert(existsSync(output));
           const json = JSON.parse(Deno.readTextFileSync(output));
-          const info = json.fileInformation["docs/project/book/_include.qmd"];
+          const info = json.fileInformation[normalizePath("docs/project/book/_include.qmd")];
           const codeCells = info.codeCells;
           assertObjectMatch(info.codeCells[0], { 
             start: 0,
@@ -65,12 +66,12 @@ import { assert } from "testing/asserts";
         verify: async (outputs: ExecuteOutput[]) => {
           assert(existsSync(output));
           const json = JSON.parse(Deno.readTextFileSync(output));
-          const info = json.fileInformation["docs/inspect/10039.qmd"];
+          const info = json.fileInformation[normalizePath("docs/inspect/10039.qmd")];
           const codeCells = info.codeCells;
           assertObjectMatch(info.codeCells[1], {
             "start": 14,
             "end": 18,
-            "file": "docs/inspect/10039.qmd",
+            "file": normalizePath("docs/inspect/10039.qmd"),
             "source": "p[[1]]\n",
             "language": "r",
             "metadata": {

tests/smoke/inspect/inspect-include.test.ts

@@ -11,6 +11,7 @@ import {
   testQuartoCmd,
 } from "../../test.ts";
 import { assert } from "testing/asserts";
+import { normalizePath } from "../../../src/core/path.ts";
 
 (() => {
   const input = "docs/inspect/foo.qmd";
@@ -22,20 +23,21 @@ import { assert } from "testing/asserts";
       {
         name: "inspect-include",
         verify: async (outputs: ExecuteOutput[]) => {
-          assert(existsSync("docs/inspect/foo.json"));
-          const json = JSON.parse(Deno.readTextFileSync("docs/inspect/foo.json"));
-          assertObjectMatch(json.fileInformation["docs/inspect/foo.qmd"].includeMap[0],
+          assert(existsSync(output));
+          const normalizedPath = normalizePath(input);
+          const json = JSON.parse(Deno.readTextFileSync(output));
+          assertObjectMatch(json.fileInformation[normalizedPath].includeMap[0],
           {
-            source: input,
+            source: normalizedPath,
             target: "_bar.qmd"
           });
         }
       }
     ],
     {
       teardown: async () => {
-        if (existsSync("docs/inspect/foo.json")) {
-          Deno.removeSync("docs/inspect/foo.json");
+        if (existsSync(output)) {
+          Deno.removeSync(output);
         }
       }
     },

tests/smoke/inspect/inspect-recursive-include.test.ts

@@ -12,6 +12,7 @@ import {
   testQuartoCmd,
 } from "../../test.ts";
 import { assert, assertEquals } from "testing/asserts";
+import { normalizePath } from "../../../src/core/path.ts";
 
 (() => {
   const input = "docs/websites/issue-9253/index.qmd";
@@ -25,7 +26,7 @@ import { assert, assertEquals } from "testing/asserts";
         verify: async (outputs: ExecuteOutput[]) => {
           assert(existsSync(output));
           const json = JSON.parse(Deno.readTextFileSync(output));
-          const info = json.fileInformation["docs/websites/issue-9253/index.qmd"];
+          const info = json.fileInformation[normalizePath("docs/websites/issue-9253/index.qmd")];
           const includeMap: FileInclusion[] = info.includeMap;
           assertObjectMatch(info.includeMap[0], { target: "_include.qmd" });
           assertObjectMatch(info.includeMap[1], { source: "_include.qmd", target: "_include2.qmd" });