Initial support for folder notes

Author: PrOF-kk

src/helpers/filetreeUtils.js

@@ -70,7 +70,7 @@ function getPermalinkMeta(note, key) {
     }
     if (note.data.tags && note.data.tags.indexOf("gardenEntry") != -1) {
       permalink = "/";
-    }    
+    }
     if (note.data.title) {
       name = note.data.title;
     }
@@ -112,12 +112,36 @@ function assignNested(obj, keyPath, value) {
   obj[keyPath[lastKeyIndex]] = value;
 }
 
+/**
+ * A folder note is a note with the same filename as the parent folder.
+ * Hide the folder note and link to it from the folder to treat it as a special case.
+ *
+ * @returns {void}
+ */
+function detectFoldersWithFolderNotes(tree) {
+  for (const [fileOrFolderName, fileOrFolder] of Object.entries(tree)) {
+    if (fileOrFolder.isFolder) {
+      // Check if any of the children are notes with the same name
+      for (const [childName, child] of Object.entries(fileOrFolder)) {
+        if (child.isNote && childName === (fileOrFolderName + ".md")) {
+          // Found, hide the standalone note
+          child.hide = true;
+          fileOrFolder.folderNote = child
+        } else if (child.isFolder) {
+          detectFoldersWithFolderNotes(child);
+        }
+      }
+    }
+  }
+}
+
 function getFileTree(data) {
   const tree = {};
   (data.collections.note || []).forEach((note) => {
     const [meta, folders] = getPermalinkMeta(note);
     assignNested(tree, folders, { isNote: true, ...meta });
   });
+  detectFoldersWithFolderNotes(tree);
   const fileTree = sortTree(tree);
   return fileTree;
 }

src/site/_includes/components/filetree.njk

@@ -3,14 +3,18 @@
         <div x-show="isOpen" style="display:none" class="{{'filelist' if step>0}}">
             {% if fileOrFolder.isNote and not fileOrFolder.hide %}
                 <div @click.stop class="notelink {{ 'active-note' if fileOrFolder.permalink === permalink}}">
-                    <a data-note-icon="{{fileOrFolder.noteIcon}}" style="text-decoration: none;" class="filename" href="{{fileOrFolder.permalink}}">{{fileOrFolder.name}} </a>
+                    <a data-note-icon="{{fileOrFolder.noteIcon}}" style="text-decoration: none;" class="filename" href="{{fileOrFolder.permalink}}">{{fileOrFolder.name}}</a>
                 </div>
             {% elif fileOrFolder.isFolder %}
                 <div class="folder inner-folder" x-data="{isOpen: $persist(false).as({{currentPath | dump}})}" @click.stop="isOpen=!isOpen">
                     <div class="foldername-wrapper align-icon">
                         <i x-show="isOpen" style="display: none;" data-lucide="chevron-down"></i>
                         <i x-show="!isOpen" data-lucide="chevron-right"></i>
-                        <span class="foldername">{{fileOrFolderName}}</span>
+                        {% if fileOrFolder.folderNote %}
+                            <a @click.stop class="filename" href="{{fileOrFolder.folderNote.permalink}}">{{fileOrFolderName}}</a>
+                        {% else %}
+                            <span class="foldername">{{fileOrFolderName}}</span>
+                        {% endif %}
                     </div>
                     {% for fileOrFolderName, child in fileOrFolder %}
                         {{menuItem(fileOrFolderName, child, step+1, (currentPath+"/"+fileOrFolderName))}}