Merge branch 'main' of github.com:quarto-dev/quarto-cli into main

Author: jjallaire

news/changelog-1.2.md

@@ -41,6 +41,7 @@
 ## Lua Filters
 
 - Harden `quarto.utils.dump` so it works with pandoc's builtin global variables (#2254)
+- Add new LUA function `attachToDependency` to attach files to html dependencies. This function will copy a file into the lib dir for a named HTML dependency.
 
 ## Miscellaneous
 

src/command/render/pandoc-dependencies-html.ts

@@ -23,9 +23,9 @@ import { kIncludeAfterBody, kIncludeInHeader } from "../../config/constants.ts";
 import { TempContext } from "../../core/temp.ts";
 import { lines } from "../../core/lib/text.ts";
 import { copyFileIfNewer } from "../../core/copy.ts";
-import { ProjectContext } from "../../project/types.ts";
 import {
   appendDependencies,
+  HtmlAttachmentDependency,
   HtmlFormatDependency,
 } from "./pandoc-dependencies.ts";
 import { fixupCssReferences, isCssFile } from "../../core/css.ts";
@@ -54,32 +54,60 @@ export function readAndInjectDependencies(
   inputDir: string,
   libDir: string,
   doc: Document,
-  project?: ProjectContext,
 ) {
   const dependencyJsonStream = Deno.readTextFileSync(dependenciesFile);
   const htmlDependencies: FormatDependency[] = [];
+  const htmlAttachments: HtmlAttachmentDependency[] = [];
   lines(dependencyJsonStream).forEach((json) => {
     if (json) {
       const dependency = JSON.parse(json);
       if (dependency.type === "html") {
         htmlDependencies.push(dependency.content);
+      } else if (dependency.type === "html-attachment") {
+        htmlAttachments.push(dependency);
       }
     }
   });
 
+  const injectedDependencies = [];
   if (htmlDependencies.length > 0) {
     const injector = domDependencyInjector(doc);
-    processHtmlDependencies(
+    const injected = processHtmlDependencies(
       htmlDependencies,
       inputDir,
       libDir,
       injector,
-      project,
     );
+    injectedDependencies.push(...injected);
     // Finalize the injection
     injector.finalizeInjection();
   }
 
+  if (htmlAttachments.length > 0) {
+    for (const attachment of htmlAttachments) {
+      // Find the 'parent' dependencies for this attachment
+      const parentDependency = injectedDependencies.find((dep) => {
+        return dep.name === attachment.content.name;
+      });
+
+      if (parentDependency) {
+        // Compute the target directory
+        const directoryInfo = targetDirectoryInfo(
+          inputDir,
+          libDir,
+          parentDependency,
+        );
+
+        // copy the file
+        copyDependencyFile(
+          attachment.content.file,
+          directoryInfo.absolute,
+          !!parentDependency.external,
+        );
+      }
+    }
+  }
+
   return Promise.resolve({
     resources: [],
     supporting: [],
@@ -91,7 +119,6 @@ export function resolveDependencies(
   inputDir: string,
   libDir: string,
   temp: TempContext,
-  project: ProjectContext | undefined,
 ) {
   // deep copy to not mutate caller's object
   extras = ld.cloneDeep(extras);
@@ -106,7 +133,6 @@ export function resolveDependencies(
       inputDir,
       libDir,
       injector,
-      project,
     );
     // Finalize the injection
     injector.finalizeInjection();
@@ -170,25 +196,24 @@ function processHtmlDependencies(
   inputDir: string,
   libDir: string,
   injector: HtmlInjector,
-  project?: ProjectContext,
 ) {
-  const copiedDependencies: string[] = [];
+  const copiedDependencies: FormatDependency[] = [];
   for (const dependency of dependencies) {
     // Ensure that we copy (and render HTML for) each named dependency only once
-    if (copiedDependencies.includes(dependency.name)) {
+    if (
+      copiedDependencies.find((copiedDep) => {
+        return copiedDep.name === dependency.name;
+      })
+    ) {
       continue;
     }
 
     // provide a format libs (i.e. freezer protected) scope for injected deps
-    const targetLibDir = dependency.external
-      ? join(libDir, "quarto-contrib")
-      : libDir;
-
-    // Directory information for the dependency
-    const dir = dependency.version
-      ? `${dependency.name}-${dependency.version}`
-      : dependency.name;
-    const targetDir = join(inputDir, targetLibDir, dir);
+    const directoryInfo = targetDirectoryInfo(
+      inputDir,
+      libDir,
+      dependency,
+    );
 
     const copyFile = (
       file: DependencyFile,
@@ -198,22 +223,13 @@ function processHtmlDependencies(
         afterBody?: boolean,
       ) => void,
     ) => {
-      const targetPath = join(targetDir, file.name);
-      // If this is a user resource, treat it as a resource (resource ref discovery)
-      // if this something that we're injecting, just copy it
-      if (dependency.external) {
-        ensureDirSync(dirname(targetPath));
-        copyFileIfNewer(file.path, targetPath);
-        console.log("Copying " + file.path + " to " + targetPath);
-        if (isCssFile(file.path)) {
-          processCssFile(dirname(file.path), targetPath);
-        }
-      } else {
-        copyFileIfNewer(file.path, targetPath);
-      }
-
-      const href = join(targetLibDir, dir, file.name);
+      copyDependencyFile(
+        file,
+        directoryInfo.absolute,
+        dependency.external || false,
+      );
       if (inject) {
+        const href = join(directoryInfo.relative, file.name);
         inject(href, file.attribs, file.afterBody);
       }
     };
@@ -260,10 +276,50 @@ function processHtmlDependencies(
       dependency.resources.forEach((resource) => copyFile(resource));
     }
 
-    copiedDependencies.push(dependency.name);
+    copiedDependencies.push(dependency);
+  }
+  return copiedDependencies;
+}
+
+function copyDependencyFile(
+  file: DependencyFile,
+  targetDir: string,
+  external: boolean,
+) {
+  const targetPath = join(targetDir, file.name);
+  // If this is a user resource, treat it as a resource (resource ref discovery)
+  // if this something that we're injecting, just copy it
+  ensureDirSync(dirname(targetPath));
+  copyFileIfNewer(file.path, targetPath);
+
+  if (external && isCssFile(file.path)) {
+    processCssFile(dirname(file.path), targetPath);
   }
 }
 
+function targetDirectoryInfo(
+  inputDir: string,
+  libDir: string,
+  dependency: FormatDependency,
+) {
+  // provide a format libs (i.e. freezer protected) scope for injected deps
+  const targetLibDir = dependency.external
+    ? join(libDir, "quarto-contrib")
+    : libDir;
+
+  // Directory information for the dependency
+  const dir = dependency.version
+    ? `${dependency.name}-${dependency.version}`
+    : dependency.name;
+
+  const relativeTargetDir = join(targetLibDir, dir);
+  const absoluteTargetDir = join(inputDir, relativeTargetDir);
+  return {
+    absolute: absoluteTargetDir,
+    relative: relativeTargetDir,
+  };
+}
+
 // fixup root ('/') css references and also copy references to other
 // stylesheet or resources (e.g. images) to alongside the destFile
 function processCssFile(

src/command/render/pandoc-dependencies.ts

@@ -5,14 +5,22 @@
 *
 */
 
-import { FormatDependency } from "../../config/types.ts";
+import { DependencyFile, FormatDependency } from "../../config/types.ts";
 import { appendTextFile } from "../../core/file.ts";
 
 export interface HtmlFormatDependency {
   type: "html";
   content: FormatDependency;
 }
 
+export interface HtmlAttachmentDependency {
+  type: "html-attachment";
+  content: {
+    name: string;
+    file: DependencyFile;
+  };
+}
+
 export interface FormatResourceDependency {
   type: "format-resources";
   content: {
@@ -47,6 +55,7 @@ export function appendDependencies(
   dependenciesFile: string,
   dependencies: Array<
     | HtmlFormatDependency
+    | HtmlAttachmentDependency
     | FormatResourceDependency
     | TextDependency
     | FileDependency

src/command/render/pandoc.ts

@@ -36,7 +36,6 @@ import {
 } from "../../config/types.ts";
 import {
   isBeamerOutput,
-  isDocxOutput,
   isEpubOutput,
   isHtmlDocOutput,
   isHtmlFileOutput,
@@ -71,11 +70,7 @@ import {
   pandocDefaultsMessage,
   writeDefaultsFile,
 } from "./defaults.ts";
-import {
-  filterParamsJson,
-  quartoInitFilter,
-  removeFilterParams,
-} from "./filters.ts";
+import { filterParamsJson, removeFilterParams } from "./filters.ts";
 import {
   kAbstract,
   kAbstractTitle,
@@ -1052,7 +1047,6 @@ async function resolveExtras(
             inputDir,
             libDir,
             doc,
-            project,
           ),
       );
     };

src/command/render/render-files.ts

@@ -313,7 +313,6 @@ export async function renderFiles(
           dirname(context.target.source),
           context.libDir,
           tempContext,
-          project,
         );
         if (extras[kIncludeInHeader]) {
           executeResult.includes[kIncludeInHeader] = [

src/execute/ojs/compile.ts

@@ -797,7 +797,6 @@ export async function ojsCompile(
     dirname(options.source),
     options.libDir,
     options.temp,
-    project,
   );
 
   const ojsBundleTempFiles = [];

src/project/project-index.ts

@@ -5,7 +5,7 @@
 *
 */
 
-import { dirname, extname, join, relative } from "path/mod.ts";
+import { dirname, join, relative } from "path/mod.ts";
 import { existsSync } from "fs/mod.ts";
 
 import * as ld from "../core/lodash.ts";
@@ -20,7 +20,7 @@ import {
   pathWithForwardSlashes,
   removeIfExists,
 } from "../core/path.ts";
-import { kOutputFile, kTitle } from "../config/constants.ts";
+import { kTitle } from "../config/constants.ts";
 import { renderFormats } from "../command/render/render-contexts.ts";
 import { fileExecutionEngine } from "../execute/engine.ts";
 

src/resources/pandoc/datadir/init.lua

@@ -1322,7 +1322,11 @@ local function resolvePath(path)
 end
 
 local function resolvePathExt(path) 
-   return resolvePath(pandoc.path.join({scriptDir(), path}))
+  if isRelativeRef(path) then
+    return resolvePath(pandoc.path.join({scriptDir(), path}))
+  else
+    return path
+  end
 end
 
 -- converts the friendly Quartio location names 
@@ -1629,6 +1633,47 @@ quarto = {
          head = htmlDependency.head,
       }))
     end,
+
+    attachToDependency = function(name, pathOrFileObj)
+
+      if name == nil then
+         error("The target dependency name for an attachment cannot be nil. Please provide a valid dependency name.")
+         os.exit(1)
+      end
+
+      -- path can be a string or an obj { name, path }
+      local resolvedFile = {}
+      if type(pathOrFileObj) == "table" then
+
+         -- validate that there is at least a path
+         if pathOrFileObj.path == nil then
+            error("Error attaching to dependency '" .. name .. "'.\nYou must provide a 'path' when adding an attachment to a dependency.")
+            os.exit(1)
+         end
+
+         -- resolve a name, if one isn't provided
+         local name = pathOrFileObj.name      
+         if name == nil then
+            name = pandoc.path.filename(pathOrfileObj.path)
+         end
+
+         -- the full resolved file
+         resolvedFile = {
+            name = name,
+            path = resolvePathExt(pathOrFileObj.path)
+         }
+      else
+         resolvedFile = {
+            name = pandoc.path.filename(pathOrFileObj),
+            path = resolvePathExt(pathOrFileObj)
+         }
+      end
+
+      writeToDependencyFile(dependency("html-attachment", {
+         name = name,
+         file = resolvedFile
+      }))
+    end,
 
     useLatexPackage = function(package, options)
       writeToDependencyFile(dependency("usepackage", {package = package, options = options }))