feat: refined rendering note metadata to markdown

Now include full paths

Author: yuriykulikov

src/agent-render.test.ts

@@ -13,27 +13,30 @@ describe("agent-render", () => {
         path: "one/two/Test Note.md",
         parentPath: "one/two",
         content: "This is the content of the note.",
-        links: ["Link1", "Link2", "Bidirectional"],
-        backlinks: ["Backlink1", "Bidirectional"],
+        links: ["other/Link1", "one/two/Link2", "one/two/Bidirectional"],
+        backlinks: ["one/two/Backlink1", "one/two/Bidirectional"],
         tags: ["#tag1", "#tag2"],
         folderSiblings: ["Sibling1"],
       };
 
       const result = renderNoteToMarkdown(note);
 
-      const expected = `## Note [[Test Note]]
-### Note metadata
+      const expected = `# Test Note
+## Metadata
 \`\`\`yaml
-path: one/two/Test Note.md
+path: one/two/Test Note
 bidirectional_links:
-  - [[Bidirectional]]
+  - one/two/Bidirectional
 links:
-  - [[Link1]]
-  - [[Link2]]
+  - other/Link1
+  - one/two/Link2
 backlinks:
-  - [[Backlink1]]
+  - one/two/Backlink1
+tags:
+  - #tag1
+  - #tag2
 \`\`\`
-### Content
+## Content
 \`\`\`
 This is the content of the note.
 \`\`\`
@@ -45,6 +48,7 @@ This is the content of the note.
       const note: Note = {
         filename: "Structured Note",
         path: "one/two/three/Structured Note.md",
+        parentPath: "one/two/three",
         content: null,
         structure: `
 # Header 1
@@ -57,17 +61,17 @@ This is the content of the note.
       };
 
       const result = renderNoteToMarkdown(note);
-
-      const expected = `## Note [[Structured Note]]
-### Note metadata
+      const expected = `# Structured Note
+## Metadata
 \`\`\`yaml
-path: one/two/three/Structured Note.md
+path: one/two/three/Structured Note
 bidirectional_links:
 links:
 backlinks:
+tags:
 \`\`\`
 
-### Structure
+## Structure
 \`\`\`
 # Header 1
 ## Header 2
@@ -80,6 +84,7 @@ backlinks:
       const note: Note = {
         filename: "Empty Note",
         path: "Deep/Path/To/Empty Note.md",
+        parentPath: "Deep/Path/To",
         content: "Empty",
         links: [],
         backlinks: [],
@@ -88,15 +93,16 @@ backlinks:
       };
 
       const result = renderNoteToMarkdown(note);
-      const expected = `## Note [[Empty Note]]
-### Note metadata
+      const expected = `# Empty Note
+## Metadata
 \`\`\`yaml
-path: Deep/Path/To/Empty Note.md
+path: Deep/Path/To/Empty Note
 bidirectional_links:
 links:
 backlinks:
+tags:
 \`\`\`
-### Content
+## Content
 \`\`\`
 Empty
 \`\`\`
@@ -108,6 +114,7 @@ Empty
       const note: Note = {
         filename: "Meta Only Note",
         path: "Meta Only Note.md",
+        parentPath: "/",
         content: null,
         structure: null,
         links: [],
@@ -117,20 +124,57 @@ Empty
       };
 
       const result = renderNoteToMarkdown(note);
-      const expected = `## Note [[Meta Only Note]]
-### Note metadata
+      const expected = `# Meta Only Note
+## Metadata
 \`\`\`yaml
-path: Meta Only Note.md
+path: Meta Only Note
 bidirectional_links:
 links:
 backlinks:
+tags:
 \`\`\`
 
 Only note metadata is available. Use tools to read the note text or note structure.
+`;
+      expect(result).toBe(expected);
+    });
+
+    it("should render frontmatter properties in metadata", () => {
+      const note: Note = {
+        filename: "FM Note",
+        path: "FM Note.md",
+        parentPath: "/",
+        content: "Hello",
+        links: [],
+        backlinks: [],
+        tags: ["#test"],
+        frontmatter: { status: "draft", priority: 1 },
+        folderSiblings: [],
+      };
+
+      const result = renderNoteToMarkdown(note);
+      const expected = `# FM Note
+## Metadata
+\`\`\`yaml
+path: FM Note
+bidirectional_links:
+links:
+backlinks:
+tags:
+  - #test
+properties:
+  status: "draft"
+  priority: 1
+\`\`\`
+## Content
+\`\`\`
+Hello
+\`\`\`
 `;
       expect(result).toBe(expected);
     });
   });
+
   describe("renderDiscoveredStructure", () => {
     it("should return a message when no paths are provided", () => {
       expect(renderDiscoveredStructure([])).toBe(
@@ -142,12 +186,10 @@ Only note metadata is available. Use tools to read the note text or note structu
       const paths = ["folder/sub/note1.md", "folder/sub/note2.md"];
       const result = renderDiscoveredStructure(paths);
       expect(result).toBe(
-        `
-- 📁 folder
+        `- 📁 folder
   - 📁 sub
     - 📄 note1.md
-    - 📄 note2.md
-`.trim(),
+    - 📄 note2.md`,
       );
     });
 
@@ -175,12 +217,10 @@ Only note metadata is available. Use tools to read the note text or note structu
       const paths = ["b.md", "a.md", "c/d.md"];
       const result = renderDiscoveredStructure(paths);
       expect(result).toBe(
-        `
-- 📄 a.md
+        `- 📄 a.md
 - 📄 b.md
 - 📁 c
-  - 📄 d.md
-`.trim(),
+  - 📄 d.md`,
       );
     });
   });

src/agent-render.ts

@@ -90,18 +90,18 @@ export function renderDiscoveredStructure(paths: readonly string[]): string {
  * (LLM-facing) rather than note manipulation.
  */
 export function renderNoteToMarkdown(note: Note): string {
-  let noteHeader = `[[${note.filename}]]`;
+  let noteHeader = note.filename;
   if (
     note.state?.originalFilename &&
     note.state.originalFilename !== note.filename
   ) {
     noteHeader = `${note.filename} (renamed from ${note.state.originalFilename})`;
   }
-  let noteMd = `## Note ${noteHeader}\n`;
+  let noteMd = `# ${noteHeader}\n`;
 
-  noteMd += "### Note metadata\n";
+  noteMd += "## Metadata\n";
   noteMd += "```yaml\n";
-  noteMd += `path: ${note.path}\n`;
+  noteMd += `path: ${note.path.replace(/\.md$/, "")}\n`;
   const links = note.links || [];
   const backlinks = note.backlinks || [];
 
@@ -113,36 +113,50 @@ export function renderNoteToMarkdown(note: Note): string {
 
   noteMd += "bidirectional_links:\n";
   for (const l of bidirectionalLinks) {
-    noteMd += `  - [[${l}]]\n`;
+    noteMd += `  - ${l}\n`;
   }
 
   noteMd += "links:\n";
   for (const l of uniqueLinks) {
-    noteMd += `  - [[${l}]]\n`;
+    noteMd += `  - ${l}\n`;
   }
 
   noteMd += "backlinks:\n";
   for (const b of uniqueBacklinks) {
-    noteMd += `  - [[${b}]]\n`;
+    noteMd += `  - ${b}\n`;
   }
+
+  const tags = note.tags || [];
+  noteMd += "tags:\n";
+  for (const t of tags) {
+    noteMd += `  - ${t}\n`;
+  }
+
+  if (note.frontmatter && Object.keys(note.frontmatter).length > 0) {
+    noteMd += "properties:\n";
+    for (const [key, value] of Object.entries(note.frontmatter)) {
+      noteMd += `  ${key}: ${JSON.stringify(value)}\n`;
+    }
+  }
+
   noteMd += "```\n";
 
   const highlight = note.state?.highlight;
   if (highlight && highlight.trim().length > 0) {
     noteMd +=
-      "### Highlighted text (subset of the note)\n" +
+      "## Highlighted text (subset of the note)\n" +
       "The user highlighted this exact excerpt. Prefer acting on this section; any edits/suggestions should apply within it.\n" +
       "```\n";
     noteMd += highlight.trim();
     noteMd += "\n```\n";
   }
 
   if (note.content) {
-    noteMd += "### Content\n```\n";
+    noteMd += "## Content\n```\n";
     noteMd += note.content.trim();
     noteMd += "\n```\n";
   } else if (note.structure) {
-    noteMd += "\n### Structure\n```\n";
+    noteMd += "\n## Structure\n```\n";
     noteMd += note.structure.trim();
     noteMd += "\n```\n";
   } else {

src/types.ts

@@ -243,6 +243,7 @@ export interface Note {
   links: string[];
   backlinks: string[];
   tags: string[];
+  frontmatter?: Record<string, unknown> | null;
   parentPath?: string;
   folderSiblings?: string[] | null;
   state?: {

src/utils/read-note.ts

@@ -19,7 +19,17 @@ export async function readNote(
   const cache = app.metadataCache.getFileCache(file);
   if (cache?.links) {
     for (const link of cache.links) {
-      links.push(link.link);
+      const dest = app.metadataCache.getFirstLinkpathDest(link.link, file.path);
+      if (dest) {
+        const parentPath = dest.parent?.path;
+        const displayPath =
+          parentPath && parentPath !== "/" && parentPath !== ""
+            ? `${parentPath}/${dest.basename}`
+            : dest.basename;
+        links.push(displayPath);
+      } else {
+        links.push(link.link);
+      }
     }
   }
 
@@ -51,7 +61,12 @@ export async function readNote(
     if (targets[file.path]) {
       const sourceFile = app.vault.getAbstractFileByPath(sourcePath);
       if (sourceFile instanceof TFile) {
-        backlinks.push(sourceFile.basename);
+        const parentPath = sourceFile.parent?.path;
+        const displayPath =
+          parentPath && parentPath !== "/" && parentPath !== ""
+            ? `${parentPath}/${sourceFile.basename}`
+            : sourceFile.basename;
+        backlinks.push(displayPath);
       }
     }
   }
@@ -88,6 +103,15 @@ export async function readNote(
       .map((child) => (child as TFile).basename);
   }
 
+  // Extract frontmatter properties (excluding internal keys and tags, which are handled separately)
+  let frontmatter: Record<string, unknown> | null = null;
+  if (cache?.frontmatter) {
+    const { position, tags: _tags, ...rest } = cache.frontmatter;
+    if (Object.keys(rest).length > 0) {
+      frontmatter = rest;
+    }
+  }
+
   const structureOrText = detail === "structure" || detail === "text";
   return {
     filename: filename,
@@ -96,6 +120,7 @@ export async function readNote(
     links: [...new Set(links)],
     backlinks: [...new Set(backlinks)],
     tags: [...new Set(tags)],
+    frontmatter,
     structure: structureOrText ? structure.join("\n") : null,
     parentPath: parentFolder?.path || "/",
     folderSiblings: structureOrText ? folderSiblings : null,