feature(tag-tree-data-provider): Add support for yaml frontmatter (#42)

* feat(yaml): Add yaml frontmatter support * docs(readme): Add yaml frontmatter documentation
blakedietz · Apr 22, 2019 · 615e932 · 615e932
1 parent 7b2188f
commit 615e932
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -9,10 +9,19 @@ View your notes without being limited by your file system's hierarchy.
 Markdown files with the directive
 
 ```markdown
-<!--@nested-tags:topic,example-->
+<!--@nested-tags:topic,here/is/a/nested/example-->
 ```
 
-Will be visible from the file tab under a "Tag Tree" view.
+or yaml frontmatter with a tags property
+
+```
+---
+title: Hello nested tags
+tags: topic,here/is/a/nested/example
+---
+```
+
+will be visible from the file tab under a "Tag Tree" view.
 
 ## Requirements
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -53,7 +53,8 @@
     "vscode": "^1.1.25"
   },
   "dependencies": {
-    "debounce": "^1.2.0"
+    "debounce": "^1.2.0",
+    "gray-matter": "4.0.2"
   },
   "activationEvents": [
     "onView:tagTreeView"
@@ -94,25 +95,25 @@
   },
   "release": {
     "plugins": [
-          [
-            "@semantic-release/release-notes-generator",
-            {
-              "preset": "angular",
-              "parserOpts": {
-                "noteKeywords": [
-                  "BREAKING CHANGE",
-                  "BREAKING CHANGES",
-                  "BREAKING"
-                ]
-              },
-              "writerOpts": {
-                "commitsSort": [
-                  "subject",
-                  "scope"
-                ]
-              }
-            }
-          ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "angular",
+          "parserOpts": {
+            "noteKeywords": [
+              "BREAKING CHANGE",
+              "BREAKING CHANGES",
+              "BREAKING"
+            ]
+          },
+          "writerOpts": {
+            "commitsSort": [
+              "subject",
+              "scope"
+            ]
+          }
+        }
+      ],
       [
         "@semantic-release/changelog",
         {

diff --git a/src/tag-tree-data-provider.ts b/src/tag-tree-data-provider.ts
@@ -5,6 +5,7 @@ import { setsAreEqual } from "./sets";
 import { FileNode, fileNodeSort } from "./tag-tree/file-node";
 import { TagNode, tagNodeSort } from "./tag-tree/tag-node";
 import { TagTree } from "./tag-tree/tag-tree";
+import * as grayMatter from "gray-matter";
 
 interface IFileInfo {
   tags: Set<string>;
@@ -184,6 +185,14 @@ class TagTreeDataProvider
    * @param filePath The local filesystem path
    */
   private getTagsFromFileText(fileContents: string, filePath: string): IFileInfo {
+
+    // Parse any yaml frontmatter and check for tags within that frontmatter
+    const { data }= grayMatter(fileContents) ;
+    let yamlTags = new Set();
+    if (data.tags) {
+      yamlTags = new Set([data.tags.split(',')]);
+    }
+
     return fileContents
         .split("\n")
         .reduce((accumulator, currentLine) => {
@@ -198,7 +207,7 @@ class TagTreeDataProvider
           }
 
           return accumulator;
-        }, { tags: new Set(), filePath });
+        }, { tags: new Set(...yamlTags), filePath });
   }
 
   /**