fix: start and end position for matches

Author: phortx

docs/openapi.yaml

@@ -1583,11 +1583,17 @@ paths:
                             properties:
                               end:
                                 type: "number"
+                                description: "Line number or 0 when the filename matched"
                               start:
                                 type: "number"
+                                description: "Line number or 0 when the filename matched"
+                              source:
+                                type: "string"
+                                description: "Where the search term matched: 'filename' or 'content'"
                             required:
                               - "start"
                               - "end"
+                              - "source"
                             type: "object"
                         required:
                           - "match"

src/requestHandler.ts

@@ -1010,17 +1010,40 @@ export default class RequestHandler {
       });
     }
 
+    // Below we virtually add the headline to the search text with 2 line breaks.
+    // That causes the start and end line numbers to be wrong with an offset of 3.
+    // This is fixed by substracting 3 from the start and end position.
+    const positionOffset = 3;
+
     for (const file of this.app.vault.getMarkdownFiles()) {
       const cachedContents = await this.app.vault.cachedRead(file);
+
+      // Add the headline to the search text to include it in the search.
       const result = search(file.basename + "\n\n" + cachedContents);
+
       if (result) {
         const contextMatches: SearchContext[] = [];
         for (const match of result.matches) {
+          let matchDetails;
+
+          if (match[0] == 1) {
+            // When start position is line 1, that means the search term matched within the headline.
+            matchDetails = {
+              start: 1,
+              end: 1,
+              source: "filename"
+            }
+          } else {
+            // Otherwise, the match was in the content
+            matchDetails = {
+              start: match[0] - positionOffset,
+              end: match[1] - positionOffset,
+              source: "content"
+            }
+          }
+
           contextMatches.push({
-            match: {
-              start: match[0],
-              end: match[1],
-            },
+            match: matchDetails,
             context: cachedContents.slice(
               Math.max(match[0] - contextLength, 0),
               match[1] + contextLength