Merge pull request #9997 from quarto-dev/fix/extensions/format-resour…

…ces-globs

news/changelog-1.5.md

@@ -128,6 +128,7 @@ All changes included in 1.5:
 
 - ([#8385](https://github.com/quarto-dev/quarto-cli/issues/8385)): Properly copy project resources when extensions are installed at project level.
 - ([#8547](https://github.com/quarto-dev/quarto-cli/issues/8547)): Support installing extensions from github branch with forward slash in the name.
+- ([#9918](https://github.com/quarto-dev/quarto-cli/issues/9918)): `format-resources` can use explicit [Quarto glob syntax](https://quarto.org/docs/reference/globs.html), e.g. `format-resources: dir/**/*` to copy all files in `dir` and its subdirectories to input root, but use `format-resources: dir` to copy `dir` and its contents to input root.
 - ([#9948](https://github.com/quarto-dev/quarto-cli/issues/9948)): New extension type: `metadata`. Example use case: support `pre-render` and `post-render` script lists in `project` metadata.
 
 ## Shortcodes

src/extension/extension.ts

@@ -730,6 +730,7 @@ async function readExtension(
         extensionDir,
         formatMeta[kFormatResources] as string[],
         [],
+        { mode: "strict" },
       );
       if (resolved.include.length > 0) {
         formatMeta[kFormatResources] = resolved.include.map((include) => {

tests/docs/extensions/format-resources/9918/_extensions/test/_extension.yml

@@ -0,0 +1,13 @@
+title: Test
+author: Christophe Dervieux
+version: 1.0.0
+quarto-required: ">=1.3"
+contributes:
+  formats:
+    html:
+      format-resources:
+        - folder-to-root
+        - files-to-root/**/*
+        - dummy-4.txt
+    gfm:
+      format-resources: folder-to-root

tests/docs/extensions/format-resources/9918/_extensions/test/dummy-4.txt

@@ -0,0 +1 @@
+This file should be copied to root project for rendering as it is included as a format-resources

tests/docs/extensions/format-resources/9918/_extensions/test/files-to-root/dummy-2.txt

@@ -0,0 +1 @@
+This file should be copied to root project for rendering as it is included as a format-resources

tests/docs/extensions/format-resources/9918/_extensions/test/files-to-root/dummy-3.txt

@@ -0,0 +1 @@
+This file should be copied to root project for rendering as it is included as a format-resources

tests/docs/extensions/format-resources/9918/_extensions/test/folder-to-root/dummy.txt

@@ -0,0 +1 @@
+This file should be copied to root project for rendering as it is included as a format-resources

tests/docs/extensions/format-resources/9918/index.qmd

@@ -0,0 +1,9 @@
+---
+title: Untitled
+format:
+  test-html: default
+  test-gfm: default
+---
+
+This document uses a test extension that should include nested resources
+

tests/smoke/extensions/extension-render-format-resources.test.ts

@@ -0,0 +1,33 @@
+/*
+* extension-render-doc.test.ts
+*
+* Copyright (C) 2020-2022 Posit Software, PBC
+*
+*/
+
+import { safeRemoveSync } from "../../../src/core/path.ts";
+import { dirname, join } from "../../../src/deno_ral/path.ts";
+import { fileLoader } from "../../utils.ts";
+import { fileExists, folderExists, pathDoNotExists } from "../../verify.ts";
+import { testRender } from "../render/render.ts";
+
+// This file uses custom formats 'test-html' provided by test extension
+const input = fileLoader("extensions/format-resources/9918")("index.qmd", "test-html");
+const rootDir = dirname(input.input)
+const resourcesFile = [
+  join('folder-to-root', 'dummy.txt'),
+  'dummy-2.txt', 'dummy-3.txt', 'dummy-4.txt',
+].map((x) => join(rootDir, x))
+testRender(input.input, "test-html", false, 
+  [
+    folderExists(join(rootDir, "folder-to-root")),
+    ...resourcesFile.map(fileExists),
+    pathDoNotExists(join(rootDir, "dummy.txt")),
+  ],
+  {
+    teardown: () => {
+      resourcesFile.forEach((x) => safeRemoveSync(x));
+      return Promise.resolve();
+    },
+  }
+);

tests/smoke/render/render.ts

@@ -17,6 +17,7 @@ import {
 } from "../../verify.ts";
 import { safeRemoveSync } from "../../../src/core/path.ts";
 import { safeExistsSync } from "../../../src/core/path.ts";
+import { assert } from "../../../src/vendor/deno.land/[email protected]/assert/assert.ts";
 
 export function testSimpleIsolatedRender(
   file: string,
@@ -66,6 +67,12 @@ export function testRender(
     verify,
     {
       ...context,
+      setup: async () => {
+        if (context?.setup) {
+          await context?.setup();
+        }
+        assert(safeExistsSync(input), `Input file ${input} does not exist. Test could not be ran.`);
+      },
       teardown: async () => {
         if (context?.teardown) {
           await context?.teardown();

tests/verify.ts

@@ -180,6 +180,16 @@ export const fileExists = (file: string): Verify => {
   };
 };
 
+export const pathDoNotExists = (path: string): Verify => {
+  return {
+    name: `path ${path} exists`,
+    verify: (_output: ExecuteOutput[]) => {
+      verifyNoPath(path);
+      return Promise.resolve();
+    },
+  };
+};
+
 export const directoryContainsOnlyAllowedPaths = (dir: string, paths: string[]): Verify => {
   return {
     name: `Ensure only has ${paths.length} paths in folder`,