Merge pull request #1302 from quarto-dev/bugfix/ext

Extension `Formats` Name Tweak

Author: jjallaire

src/command/list/cmd.ts

@@ -77,20 +77,20 @@ async function outputExtensions(
         extension.contributes.filters &&
         extension.contributes.filters?.length > 0
       ) {
-        contribs.push("filter");
+        contribs.push("filters");
       }
 
       if (
         extension.contributes.shortcodes &&
         extension.contributes.shortcodes?.length > 0
       ) {
-        contribs.push("shortcode");
+        contribs.push("shortcodes");
       }
 
       if (
-        extension.contributes.format
+        extension.contributes.formats
       ) {
-        contribs.push("format");
+        contribs.push("formats");
       }
       return contribs.join(", ");
     };

src/command/render/render-contexts.ts

@@ -44,7 +44,6 @@ import {
   kIncludeBeforeBody,
   kIncludeInHeader,
   kIpynbFilters,
-  kLatexInputPaths,
   kMetadataFormat,
   kOutputExt,
   kOutputFile,
@@ -573,7 +572,7 @@ const readExtensionFormat = async (
     );
 
     // Read the yaml file and resolve / bucketize
-    const extensionFormat = extension?.contributes.format;
+    const extensionFormat = extension?.contributes.formats;
     if (extensionFormat) {
       const extensionMetadata =
         (extensionFormat[formatDesc.baseFormat] || {}) as Metadata;

src/extension/extension-shared.ts

@@ -25,7 +25,7 @@ export interface Extension extends Record<string, unknown> {
   contributes: {
     shortcodes?: string[];
     filters?: QuartoFilter[];
-    format?: Record<string, unknown>;
+    formats?: Record<string, unknown>;
   };
 }
 
@@ -42,7 +42,7 @@ export interface ExtensionContext {
   find(
     name: string,
     input: string,
-    contributes?: "shortcodes" | "filters" | "format",
+    contributes?: "shortcodes" | "filters" | "formats",
     project?: ProjectContext,
   ): Extension[];
 }

src/extension/extension.ts

@@ -63,7 +63,7 @@ export function createExtensionContext(): ExtensionContext {
   const find = (
     name: string,
     input: string,
-    contributes?: "shortcodes" | "filters" | "format",
+    contributes?: "shortcodes" | "filters" | "formats",
     project?: ProjectContext,
   ): Extension[] => {
     const extId = toExtensionId(name);
@@ -145,15 +145,15 @@ const loadExtension = (
 function findExtensions(
   extensions: Extension[],
   extensionId: ExtensionId,
-  contributes?: "shortcodes" | "filters" | "format",
+  contributes?: "shortcodes" | "filters" | "formats",
 ) {
   // Filter the extension based upon what they contribute
   const exts = extensions.filter((ext) => {
     if (contributes === "shortcodes" && ext.contributes.shortcodes) {
       return true;
     } else if (contributes === "filters" && ext.contributes.filters) {
       return true;
-    } else if (contributes === "format" && ext.contributes.format) {
+    } else if (contributes === "formats" && ext.contributes.formats) {
       return true;
     } else {
       return contributes === undefined;
@@ -239,6 +239,7 @@ export function readExtensions(
       }
     }
   }
+
   return extensions;
 }
 
@@ -352,7 +353,7 @@ function validateExtension(extension: Extension) {
   const contribs = [
     extension.contributes.filters,
     extension.contributes.shortcodes,
-    extension.contributes.format,
+    extension.contributes.formats,
   ];
   contribs.forEach((contrib) => {
     if (contrib) {
@@ -391,37 +392,45 @@ function readExtension(
   // Paths used should be considered relative to this dir
   const extensionDir = dirname(extensionFile);
 
+  // The formats that are being contributed
+  const formats = contributes?.formats as Metadata ||
+    contributes?.format as Metadata || {};
+
   // Read any embedded extension
   const embeddedExtensions = existsSync(join(extensionDir, kExtensionDir))
     ? readExtensions(join(extensionDir, kExtensionDir))
     : [];
 
-  // The items that can be contributed
-  // Resolve shortcodes and filters (these might come from embedded extension)
-  // Note that resolving will throw if the extension cannot be resolved
-  const shortcodes = (contributes?.shortcodes as string[] || []).flatMap((
-    shortcode,
-  ) => {
-    return resolveShortcode(embeddedExtensions, extensionDir, shortcode);
-  });
-  const filters = (contributes?.filters as QuartoFilter[] || []).flatMap(
-    (filter) => {
-      return resolveFilter(embeddedExtensions, extensionDir, filter);
-    },
-  );
-  const format = contributes?.format as Metadata || {};
-
   // Process the special 'common' key by merging it
   // into any key that isn't 'common' and then removing it
-  Object.keys(format).filter((key) => {
+  Object.keys(formats).filter((key) => {
     return key !== kCommon;
   }).forEach((key) => {
-    format[key] = mergeConfigs(
-      format[kCommon] || {},
-      format[key],
+    formats[key] = mergeConfigs(
+      formats[kCommon] || {},
+      formats[key],
+    );
+
+    const formatMeta = formats[key] as Metadata;
+
+    // Resolve shortcodes and filters (these might come from embedded extension)
+    // Note that resolving will throw if the extension cannot be resolved
+    formatMeta.shortcodes = (formatMeta.shortcodes as string[] || []).flatMap((
+      shortcode,
+    ) => {
+      return resolveShortcode(embeddedExtensions, extensionDir, shortcode);
+    });
+    formatMeta.filters = (formatMeta.filters as QuartoFilter[] || []).flatMap(
+      (filter) => {
+        return resolveFilter(embeddedExtensions, extensionDir, filter);
+      },
     );
   });
-  delete format[kCommon];
+  delete formats[kCommon];
+
+  // Alias the contributions
+  const shortcodes = (contributes?.shortcodes || []) as string[];
+  const filters = (contributes?.filters || {}) as QuartoFilter[];
 
   // Create the extension data structure
   return {
@@ -433,7 +442,7 @@ function readExtension(
     contributes: {
       shortcodes: shortcodes.map((code) => join(extensionDir, code)),
       filters,
-      format,
+      formats,
     },
   };
 }

src/extension/install.ts

@@ -115,7 +115,7 @@ async function determineInstallDir(
     // use its path as the target for installation
     const extension = context.extension(extensionName, dir);
     if (extension) {
-      if (Object.keys(extension?.contributes.format || {}).length > 0) {
+      if (Object.keys(extension?.contributes.formats || {}).length > 0) {
         return extension?.path;
       } else {
         throw new Error(
@@ -324,10 +324,10 @@ async function confirmInstallation(
     const contributes = to.contributes;
     const extTypes: string[] = [];
     if (
-      contributes.format &&
-      Object.keys(contributes.format).length > 0
+      contributes.formats &&
+      Object.keys(contributes.formats).length > 0
     ) {
-      Object.keys(contributes.format).length === 1
+      Object.keys(contributes.formats).length === 1
         ? extTypes.push("format")
         : extTypes.push("formats");
     }

tests/docs/extensions/format/academic/_extensions/quarto-journals/elsevier/_extension.yml

@@ -1,6 +1,6 @@
 name: Elsevier Journal Format
 contributes:
-  format:
+  formats:
     common:
       date-format: full
     pdf:

tests/run-tests.sh

@@ -33,7 +33,7 @@ source bin/activate
 python3 -m pip install -r requirements.txt -q
 
 # Ensure that tinytex is installed
-quarto tools install tinytex
+quarto install tool tinytex --no-prompt
 
 "${DENO_DIR}/tools/deno" test ${QUARTO_DENO_OPTIONS} ${QUARTO_DENO_EXTRA_OPTIONS} "${QUARTO_IMPORT_ARGMAP}" $@