Improved parsing of tags (fixes #1434)

Author: riccardoferretti

packages/foam-vscode/src/core/services/markdown-parser.test.ts

@@ -320,20 +320,55 @@ this is some #text that includes #tags we #care-about.
       ]);
     });
 
-    it('provides rough range for tags in yaml', () => {
+    it('provides a specific range for tags in yaml', () => {
       // For now it's enough to just get the YAML block range
       // in the future we might want to be more specific
 
       const noteA = createNoteFromMarkdown(`
 ---
+prop: hello world
 tags: [hello, world, this_is_good]
+another: i love the world
 ---
 # this is a heading
 this is some text
     `);
       expect(noteA.tags[0]).toEqual({
         label: 'hello',
-        range: Range.create(1, 0, 3, 3),
+        range: Range.create(3, 7, 3, 12),
+      });
+      expect(noteA.tags[1]).toEqual({
+        label: 'world',
+        range: Range.create(3, 14, 3, 19),
+      });
+      expect(noteA.tags[2]).toEqual({
+        label: 'this_is_good',
+        range: Range.create(3, 21, 3, 33),
+      });
+
+      const noteB = createNoteFromMarkdown(`
+---
+prop: hello world
+tags: 
+- hello
+- world
+- this_is_good
+another: i love the world
+---
+# this is a heading
+this is some text
+            `);
+      expect(noteB.tags[0]).toEqual({
+        label: 'hello',
+        range: Range.create(4, 2, 4, 7),
+      });
+      expect(noteB.tags[1]).toEqual({
+        label: 'world',
+        range: Range.create(5, 2, 5, 7),
+      });
+      expect(noteB.tags[2]).toEqual({
+        label: 'this_is_good',
+        range: Range.create(6, 2, 6, 14),
       });
     });
   });

packages/foam-vscode/src/core/services/markdown-parser.ts

@@ -173,15 +173,51 @@ const getTextFromChildren = (root: Node): string => {
   return text;
 };
 
+function getPropertiesInfoFromYAML(yamlText: string): {
+  [key: string]: { key: string; value: string; text: string; line: number };
+} {
+  const yamlProps = yamlText
+    .split(/(\w+:)/g)
+    .filter(item => item.trim() !== '');
+  const lines = yamlText.split('\n');
+  let result: { line: number; key: string; text: string; value: string }[] = [];
+  for (let i = 0; i < yamlProps.length / 2; i++) {
+    const key = yamlProps[i * 2].replace(':', '');
+    const value = yamlProps[i * 2 + 1].trim();
+    const text = yamlProps[i * 2] + yamlProps[i * 2 + 1];
+    result.push({ key, value, text, line: -1 });
+  }
+  result = result.map(p => {
+    const line = lines.findIndex(l => l.startsWith(p.key + ':'));
+    return { ...p, line };
+  });
+  return result.reduce((acc, curr) => {
+    acc[curr.key] = curr;
+    return acc;
+  }, {});
+}
+
 const tagsPlugin: ParserPlugin = {
   name: 'tags',
   onDidFindProperties: (props, note, node) => {
     if (isSome(props.tags)) {
+      const tagPropertyInfo = getPropertiesInfoFromYAML((node as any).value)[
+        'tags'
+      ];
+      const tagPropertyStartLine =
+        node.position!.start.line + tagPropertyInfo.line;
+      const tagPropertyLines = tagPropertyInfo.text.split('\n');
       const yamlTags = extractTagsFromProp(props.tags);
       for (const tag of yamlTags) {
+        const tagLine = tagPropertyLines.findIndex(l => l.includes(tag));
+        const line = tagPropertyStartLine + tagLine;
+        const charStart = tagPropertyLines[tagLine].indexOf(tag);
         note.tags.push({
           label: tag,
-          range: astPositionToFoamRange(node.position!),
+          range: Range.createFromPosition(
+            Position.create(line, charStart),
+            Position.create(line, charStart + tag.length)
+          ),
         });
       }
     }