metadata extension

Author: cscheid

src/command/render/project.ts

@@ -238,8 +238,8 @@ const getProjectRenderScripts = async (
     );
   }
   extensions.forEach((extension) => {
-    if (extension.contributes.project?.project) {
-      const project = extension.contributes.project.project as Record<
+    if (extension.contributes.metadata?.project) {
+      const project = extension.contributes.metadata.project as Record<
         string,
         unknown
       >;

src/extension/extension.ts

@@ -625,6 +625,7 @@ function validateExtension(extension: Extension) {
     extension.contributes.formats,
     extension.contributes.project,
     extension.contributes[kRevealJSPlugins],
+    extension.contributes.metadata,
   ];
   contribs.forEach((contrib) => {
     if (contrib) {
@@ -783,23 +784,30 @@ async function readExtension(
       return resolveFilterPath(extensionDir, filter);
     },
   );
-  const project = (contributes?.project || {}) as Record<string, unknown>;
-  // resolve project pre- and post-render scripts to their full path
+  const project = contributes?.project as Record<string, unknown> | undefined;
+  const metadata = contributes?.metadata as Record<string, unknown> | undefined;
+
+  // resolve metadata/project pre- and post-render scripts to their full path
   for (const key of ["pre-render", "post-render"]) {
-    if (
-      project.project &&
-      (project.project as Record<string, unknown>)[key]
-    ) {
-      const t = (project.project as Record<string, unknown>)[key];
-      const value = (Array.isArray(t) ? t : [t]) as string[];
-      const resolved = resolvePathGlobs(
-        extensionDir,
-        value as string[],
-        [],
-      );
-      if (resolved.include.length > 0) {
-        (project.project as Record<string, unknown>)[key] = resolved
-          .include;
+    for (const object of [metadata, project]) {
+      if (!object?.project || typeof object.project !== "object") {
+        continue;
+      }
+      // object.project is truthy and typeof object.project is object
+      // so we can safely cast object.project to Record<string, unknown>
+      // the TypeScript checker doesn't appear to recognize this
+      const t = (object.project as Record<string, unknown>)[key];
+      if (t) {
+        const value = (Array.isArray(t) ? t : [t]) as string[];
+        const resolved = resolvePathGlobs(
+          extensionDir,
+          value as string[],
+          [],
+        );
+        if (resolved.include.length > 0) {
+          (object.project as Record<string, unknown>)[key] = resolved
+            .include;
+        }
       }
     }
   }
@@ -818,6 +826,7 @@ async function readExtension(
     id: extensionId,
     path: extensionDir,
     contributes: {
+      metadata,
       shortcodes,
       filters,
       formats,

src/extension/types.ts

@@ -33,6 +33,7 @@ export interface Extension extends Record<string, unknown> {
   quartoVersion?: Range;
   path: string;
   contributes: {
+    metadata?: Metadata;
     project?: Record<string, unknown>;
     shortcodes?: string[];
     filters?: QuartoFilter[];

…ion/_extensions/prerender/_extension.yml …tensions/author/prerender/_extension.ymltests/docs/project/prepost/extension/_extensions/prerender/_extension.yml renamed to tests/docs/project/prepost/extension/_extensions/author/prerender/_extension.yml tests/docs/project/prepost/extension/_extensions/prerender/_extension.yml renamed to tests/docs/project/prepost/extension/_extensions/author/prerender/_extension.yml

@@ -3,7 +3,7 @@ author: cscheid
 version: 1.0.0
 quarto-required: ">=1.2.0"
 contributes:
-  project:
+  metadata:
     project:
       pre-render:
         - pre-render.ts