fix(metadata): ensure YAML frontmatter is captured when preceding first heading (#735)

Author: moshams272

src/generators/metadata/utils/__tests__/parse.test.mjs

@@ -239,4 +239,28 @@ describe('parseApiDoc', () => {
       assert.strictEqual(results.length, 0);
     });
   });
+
+  describe('top-level nodes (YAML frontmatter)', () => {
+    it('captures top-level frontmatter in the first entry', () => {
+      const tree = u('root', [
+        u('yaml', 'layout: home\ncontributors: [shams]'),
+        h('First Heading'),
+        u('paragraph', [u('text', 'First content.')]),
+        h('Second Heading', 2),
+        u('paragraph', [u('text', 'Second content.')]),
+      ]);
+      const results = parseApiDoc({ path, tree }, typeMap);
+
+      assert.strictEqual(results.length, 2);
+
+      const firstContent = results[0].content.children;
+      assert.strictEqual(firstContent.length, 3);
+      assert.strictEqual(firstContent[0].type, 'yaml');
+      assert.strictEqual(firstContent[1].type, 'heading');
+
+      const secondContent = results[1].content.children;
+      assert.strictEqual(secondContent.length, 2);
+      assert.strictEqual(secondContent[0].type, 'heading');
+    });
+  });
 });

src/generators/metadata/utils/parse.mjs

@@ -102,8 +102,10 @@ export const parseApiDoc = ({ path, tree }, typeMap) => {
         ? tree.children.length
         : tree.children.indexOf(nextHeadingNode);
 
-    // Create subtree for this section
-    const subTree = createTree('root', tree.children.slice(index, stop));
+    // Create subtree for this section. If it's the first entry, we start from the
+    // beginning of the tree to ensure top-level nodes (like YAML) are captured.
+    const startIndex = metadataCollection.length === 0 ? 0 : index;
+    const subTree = createTree('root', tree.children.slice(startIndex, stop));
 
     visit(subTree, UNIST.isStabilityNode, node =>
       visitStability(node, ignoreStability ? undefined : metadata)