@astrojs/markdoc 0.9.4 → 0.10.0

package/dist/content-entry-type.js

@@ -1,6 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
-import { fileURLToPath } from "node:url";
+import { fileURLToPath, pathToFileURL } from "node:url";
 import Markdoc from "@markdoc/markdoc";
 import { emitESMImage } from "astro/assets/utils";
 import matter from "gray-matter";
@@ -25,9 +25,40 @@ async function getContentEntryType({
         tokens = htmlTokenTransform(tokenizer, tokens);
       }
       const ast = Markdoc.parse(tokens);
-      const usedTags = getUsedTags(ast);
       const userMarkdocConfig = markdocConfigResult?.config ?? {};
       const markdocConfigUrl = markdocConfigResult?.fileUrl;
+      const pluginContext = this;
+      const markdocConfig = await setupConfig(userMarkdocConfig, options);
+      const filePath = fileURLToPath(fileUrl);
+      raiseValidationErrors({
+        ast,
+        /* Raised generics issue with Markdoc core https://github.com/markdoc/markdoc/discussions/400 */
+        markdocConfig,
+        entry,
+        viteId,
+        astroConfig,
+        filePath
+      });
+      await resolvePartials({
+        ast,
+        markdocConfig,
+        fileUrl,
+        allowHTML: options?.allowHTML,
+        tokenizer,
+        pluginContext,
+        root: astroConfig.root,
+        raisePartialValidationErrors: (partialAst, partialPath) => {
+          raiseValidationErrors({
+            ast: partialAst,
+            markdocConfig,
+            entry,
+            viteId,
+            astroConfig,
+            filePath: partialPath
+          });
+        }
+      });
+      const usedTags = getUsedTags(ast);
       let componentConfigByTagMap = {};
       for (const tag of usedTags) {
         const render = userMarkdocConfig.tags?.[tag]?.render;
@@ -42,37 +73,6 @@ async function getContentEntryType({
           componentConfigByNodeMap[nodeType] = render;
         }
       }
-      const pluginContext = this;
-      const markdocConfig = await setupConfig(userMarkdocConfig, options);
-      const filePath = fileURLToPath(fileUrl);
-      const validationErrors = Markdoc.validate(
-        ast,
-        /* Raised generics issue with Markdoc core https://github.com/markdoc/markdoc/discussions/400 */
-        markdocConfig
-      ).filter((e) => {
-        return (
-          // Ignore `variable-undefined` errors.
-          // Variables can be configured at runtime,
-          // so we cannot validate them at build time.
-          e.error.id !== "variable-undefined" && (e.error.level === "error" || e.error.level === "critical")
-        );
-      });
-      if (validationErrors.length) {
-        const frontmatterBlockOffset = entry.rawData.split("\n").length + 2;
-        const rootRelativePath = path.relative(fileURLToPath(astroConfig.root), filePath);
-        throw new MarkdocError({
-          message: [
-            `**${String(rootRelativePath)}** contains invalid content:`,
-            ...validationErrors.map((e) => `- ${e.error.message}`)
-          ].join("\n"),
-          location: {
-            // Error overlay does not support multi-line or ranges.
-            // Just point to the first line.
-            line: frontmatterBlockOffset + validationErrors[0].lines[0],
-            file: viteId
-          }
-        });
-      }
       await emitOptimizedImages(ast.children, {
         astroConfig,
         pluginContext,
@@ -115,6 +115,107 @@ export const Content = createContentComponent(
     )
   };
 }
+async function resolvePartials({
+  ast,
+  fileUrl,
+  root,
+  tokenizer,
+  allowHTML,
+  markdocConfig,
+  pluginContext,
+  raisePartialValidationErrors
+}) {
+  const relativePartialPath = path.relative(fileURLToPath(root), fileURLToPath(fileUrl));
+  for (const node of ast.walk()) {
+    if (node.type === "tag" && node.tag === "partial") {
+      const { file } = node.attributes;
+      if (!file) {
+        throw new MarkdocError({
+          // Should be caught by Markdoc validation step.
+          message: `(Uncaught error) Partial tag requires a 'file' attribute`
+        });
+      }
+      if (markdocConfig.partials?.[file])
+        continue;
+      let partialPath;
+      let partialContents;
+      try {
+        const resolved = await pluginContext.resolve(file, fileURLToPath(fileUrl));
+        let partialId = resolved?.id;
+        if (!partialId) {
+          const attemptResolveAsRelative = await pluginContext.resolve(
+            "./" + file,
+            fileURLToPath(fileUrl)
+          );
+          if (!attemptResolveAsRelative?.id)
+            throw new Error();
+          partialId = attemptResolveAsRelative.id;
+        }
+        partialPath = fileURLToPath(new URL(prependForwardSlash(partialId), "file://"));
+        partialContents = await fs.promises.readFile(partialPath, "utf-8");
+      } catch {
+        throw new MarkdocError({
+          message: [
+            `**${String(relativePartialPath)}** contains invalid content:`,
+            `Could not read partial file \`${file}\`. Does the file exist?`
+          ].join("\n")
+        });
+      }
+      if (pluginContext.meta.watchMode)
+        pluginContext.addWatchFile(partialPath);
+      let partialTokens = tokenizer.tokenize(partialContents);
+      if (allowHTML) {
+        partialTokens = htmlTokenTransform(tokenizer, partialTokens);
+      }
+      const partialAst = Markdoc.parse(partialTokens);
+      raisePartialValidationErrors(partialAst, partialPath);
+      await resolvePartials({
+        ast: partialAst,
+        root,
+        fileUrl: pathToFileURL(partialPath),
+        tokenizer,
+        allowHTML,
+        markdocConfig,
+        pluginContext,
+        raisePartialValidationErrors
+      });
+      Object.assign(node, partialAst);
+    }
+  }
+}
+function raiseValidationErrors({
+  ast,
+  markdocConfig,
+  entry,
+  viteId,
+  astroConfig,
+  filePath
+}) {
+  const validationErrors = Markdoc.validate(ast, markdocConfig).filter((e) => {
+    return (e.error.level === "error" || e.error.level === "critical") && // Ignore `variable-undefined` errors.
+    // Variables can be configured at runtime,
+    // so we cannot validate them at build time.
+    e.error.id !== "variable-undefined" && // Ignore missing partial errors.
+    // We will resolve these in `resolvePartials`.
+    !(e.error.id === "attribute-value-invalid" && e.error.message.match(/^Partial .+ not found/));
+  });
+  if (validationErrors.length) {
+    const frontmatterBlockOffset = entry.rawData.split("\n").length + 2;
+    const rootRelativePath = path.relative(fileURLToPath(astroConfig.root), filePath);
+    throw new MarkdocError({
+      message: [
+        `**${String(rootRelativePath)}** contains invalid content:`,
+        ...validationErrors.map((e) => `- ${e.error.message}`)
+      ].join("\n"),
+      location: {
+        // Error overlay does not support multi-line or ranges.
+        // Just point to the first line.
+        line: frontmatterBlockOffset + validationErrors[0].lines[0],
+        file: viteId
+      }
+    });
+  }
+}
 function getUsedTags(markdocAst) {
   const tags = /* @__PURE__ */ new Set();
   const validationErrors = Markdoc.validate(markdocAst);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
   "description": "Add support for Markdoc in your Astro site",
-  "version": "0.9.4",
+  "version": "0.10.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -64,8 +64,8 @@
     "kleur": "^4.1.5",
     "zod": "^3.22.4",
     "@astrojs/internal-helpers": "0.4.0",
-    "@astrojs/markdown-remark": "5.0.0",
-    "@astrojs/prism": "3.0.0"
+    "@astrojs/markdown-remark": "5.1.0",
+    "@astrojs/prism": "3.1.0"
   },
   "peerDependencies": {
     "astro": "^3.0.0 || ^4.0.0"
@@ -76,11 +76,11 @@
     "devalue": "^4.3.2",
     "linkedom": "^0.16.4",
     "vite": "^5.1.4",
-    "astro": "4.5.13",
+    "astro": "4.6.0",
     "astro-scripts": "0.0.14"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": "^18.17.1 || ^20.3.0 || >=21.0.0"
   },
   "publishConfig": {
     "provenance": true
@@ -89,6 +89,6 @@
     "build": "astro-scripts build \"src/**/*.ts\" && tsc",
     "build:ci": "astro-scripts build \"src/**/*.ts\"",
     "dev": "astro-scripts dev \"src/**/*.ts\"",
-    "test": "astro-scripts test --timeout 40000 \"test/**/*.test.js\""
+    "test": "astro-scripts test --timeout 60000 \"test/**/*.test.js\""
   }
 }