chore: fix code formatting

Feat: Update Readme

README.md

@@ -3,9 +3,23 @@
 This is a plugin for Obsidian (https://obsidian.md).
 
 Obsidian Dataview Autocomplete enhances the functionality of the popular [Dataview plugin](https://github.com/blacksmithgu/obsidian-dataview)
-by providing autocomplete suggestions for metadata fields in the editor.
+by providing autocomplete suggestions for metadata fields in the editor. This makes it easy to reuse existing fields and reduces typing errors.
 
-![Demo](./assets/demo.gif)
+<img src="./assets/demo.gif" alt="Demo" width="400" >
+
+## Features
+
+- Provides autocomplete suggestions for inline metadata fields used by Dataview.
+- Customizable ignored fields and files for suggestions.
+  
+## Installation
+
+While plugin is [waiting](https://github.com/obsidianmd/obsidian-releases/pull/4913) to be reviewed and added to the community plugin list, you can install it manually following the steps below:
+
+1. Download the latest release files (manifest.json, styles.css, main.js) from the Releases page.
+2. Create a folder named "dataview-autocompletion" in the Obsidian plugins folder (.obsidian/plugins).
+3. Copy the files from step 1 into the new folder.
+4. Enable the plugin in the Obsidian settings under the "Community plugins" section. You might have to restart Obsidian to rsee the plugin.
 
 ## License
 

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "dataview-autocompletion",
   "name": "Dataview Autocompletion",
-  "version": "0.8.3",
+  "version": "0.9.1",
   "minAppVersion": "0.15.0",
   "description": "Adds autocompletion to Dataview metadata fields",
   "author": "Daniel Bauer",

package.json

@@ -1,12 +1,13 @@
 {
   "name": "obsidian-dataview-autocompletion",
-  "version": "0.8.3",
+  "version": "0.9.1",
   "description": "This is a plugin for Obsidian that provides autocompletion for Dataview metadata fields",
   "main": "main.js",
   "scripts": {
     "dev": "npx rollup --config rollup.config.js -w",
     "build": "npx rollup --config rollup.config.js --environment BUILD:production",
     "check-format": "npx prettier --check src",
+    "fix-format": "npx prettier --write src",
     "test": "npx jest",
     "bdd": "npx jest -i --watch --no-cache",
     "version": "node ersion-bump.mjs && git add manifest.json versions.json"

src/DataviewSuggester.ts

@@ -5,6 +5,9 @@ import {
     EditorSuggest,
     EditorSuggestContext,
     EditorSuggestTriggerInfo,
+    htmlToMarkdown,
+    MarkdownRenderer,
+    MarkdownView,
     TFile,
 } from "obsidian";
 import { getTriggerText } from "./trigger";
@@ -67,31 +70,57 @@ export class DataviewSuggester extends EditorSuggest<String> {
         return [];
     }
 
-    renderSuggestion(value: string, el: HTMLElement): void {
-        // Split the value into parts based on the <mark> tags and their content
-        const parts = value.split(/(<mark>.*?<\/mark>)/g);
+    renderMarkdownSuggestion(value: string, el: HTMLElement): void {
+        // render markdown preview of inline dataview metadata field
+        let suggestionText = this.context!.editor.getLine(this.context!.start.line).slice(
+            this.context!.start.ch - 1,
+            this.context!.start.ch,
+        )!;
+        suggestionText += value.replace(/<mark>(.*?)<\/mark>/g, "$1");
+        suggestionText += suggestionText.startsWith("(") ? ")" : "]";
 
-        // We cannot use inner HTML; Create a span for each part
-        parts.forEach((part) => {
-            if (part.startsWith("<mark>") && part.endsWith("</mark>")) {
-                const text = part.slice(6, -7); // Remove <mark> and </mark>
-                el.createEl("span", { text, cls: "suggestion-highlight" });
+        MarkdownRenderer.render(
+            this.app,
+            htmlToMarkdown(suggestionText),
+            el,
+            this.context!.file.path,
+            this.app.workspace.getActiveViewOfType(MarkdownView)!,
+        );
+    }
+
+    renderSourceSuggestion(value: string, el: HTMLElement): void {
+        // render source text with highlights
+        // replaces <mark>...</mark> with <span>...</span>
+        const parts = value.split(/(<mark>.*?<\/mark>)/g);
+        parts.forEach((textPart) => {
+            if (textPart.startsWith("<mark>") && textPart.endsWith("</mark>")) {
+                const text = textPart.slice(6, -7); // Remove <mark> and </mark>
+                el.createEl("span", { text, cls: "dataview-suggestion-highlight" });
             } else {
-                // For normal text, create a text node or <span>
-                el.createEl("span", { text: part });
+                el.appendText(textPart);
             }
         });
     }
 
+    renderSuggestion(value: string, el: HTMLElement): void {
+        const container = el.createDiv("dataview-suggestion-content");
+        const titleDiv = container.createDiv("dataview-suggestion-title");
+        const noteDiv = container.createDiv("dataview-suggestion-note");
+
+        this.renderMarkdownSuggestion(value, titleDiv);
+        this.renderSourceSuggestion(value, noteDiv);
+    }
+
     selectSuggestion(value: string, evt: MouseEvent | KeyboardEvent): void {
-        const { editor, start, end } = this.context!;
         // remove marks from selection
         value = value.replace(/<mark>(.*?)<\/mark>/g, "$1");
+
+        const { editor, start, end } = this.context!;
         editor.replaceRange(value, start, end);
 
         const newCursorPos = {
-            line: end.line + 1,
-            ch: 0,
+            line: end.line,
+            ch: start.ch + value.length + 1,
         };
         editor.setCursor(newCursorPos);
     }
@@ -122,14 +151,16 @@ export class DataviewSuggester extends EditorSuggest<String> {
         // If the value is a string, number or boolean, we can simply convert it to a string
         if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
             stringValue = value.toString();
-        } else if (dataviewAPI.value.typeOf(value) === "link" && value.type === "file" && value.display !== undefined) {
-            // value.toString always adds a display value to wiki-style links.
-            // parse wiki-style links without display value manually here to prevent this from happening for [[filename]]
-            stringValue = `[[${value.path.split("/").pop().replace(".md", "")}]]`;
+        } else if (dataviewAPI.value.typeOf(value) === "link" && value.type === "file") {
+            // parse wiki-style links
+            if (value.display !== undefined) {
+                stringValue = `[[${value.path.split("/").pop().replace(".md", "")}|${value.display}]]`;
+            } else {
+                stringValue = `[[${value.path.split("/").pop().replace(".md", "")}]]`;
+            }
         } else {
             stringValue = dataviewAPI.value.toString(value);
         }
-
         return `${key}:: ${stringValue}`;
     }
 

src/trigger.ts

@@ -51,7 +51,6 @@ export function getTriggerText(line: string, cursorPos: number): [string, number
  */
 function getTriggerTextFromRegex(line: string, cursorPos: number, regex: RegExp): [string, number, number] | null {
     let matches = Array.from(line.matchAll(regex));
-    console.log(matches);
     for (const match of matches) {
         if (match.index === undefined) {
             continue;

styles.css

@@ -1,3 +1,29 @@
-span.suggestion-highlight {
+div.dataview-suggestion-content {
+  display: flex;
+  flex-direction: column;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  margin-inline-end: auto;
+}
+
+div.dataview-suggestion-title {
+  overflow-wrap: break-word;
+}
+
+div.dataview-suggestion-title p {
+  margin-block: 0px;
+}
+
+div.dataview-suggestion-note{
+  font-size: 0.8em;
+  color: var(--text-muted);
+  width: 100%;
+  flex-basis: 100%;
+  overflow-wrap: break-word;
+  padding-left: 8px;
+}
+
+span.dataview-suggestion-highlight {
   font-weight: bold;
 }
+