Merged preview extension

package.json

@@ -24,6 +24,7 @@
     "Programming Languages"
   ],
   "contributes": {
+    "markdown.markdownItPlugins": true,
     "languages": [
       {
         "id": "markdown-notes",
@@ -134,6 +135,21 @@
           "type": "boolean",
           "default": true,
           "description": "Trigger suggest on both insertion AND replacement of new character inside a wiki-link. Defaults true. Set false to only trigger suggest on insertion. See PR #69 for details."
+        },
+        "vscodeMarkdownNotes.previewShowFileExtension": {
+          "type": "boolean",
+          "default": false,
+          "description": "Specifies whether or not to show the linked file's extension in the preview."
+        },
+        "vscodeMarkdownNotes.previewLabelStyling": {
+          "type": "string",
+          "default": "[[label]]",
+          "enum": [
+            "[[label]]",
+            "[label]",
+            "label"
+          ],
+          "description": "Changes how the link to a file should be shown, either with or without brackets."
         }
       }
     },
@@ -187,6 +203,7 @@
     "unified": "^9.0.0",
     "unist-util-find": "^1.0.1",
     "unist-util-visit": "^2.0.2",
+    "@thomaskoppelaar/markdown-it-wikilinks": "1.3.0",
     "vsce": "^1.75.0",
     "vscode-test": "^1.3.0"
   }

src/MarkdownRenderingPlugin.ts

@@ -0,0 +1,63 @@
+import { MarkdownDefinitionProvider } from './MarkdownDefinitionProvider';
+import { NoteWorkspace } from './NoteWorkspace';
+import { RefType } from './Ref';
+
+// See also: https://github.com/tomleesm/markdown-it-wikilinks
+// Function that returns a filename based on the given wikilink.
+// Initially uses filesForWikiLinkRefFromCache() to try and find a matching file.
+// If this fails, it will attempt to make a (relative) link based on the label given.
+export function PageNameGenerator(label: string) {
+    const ref = {
+        type: RefType.WikiLink,
+        word: label,
+        hasExtension: false,
+        range: undefined
+    }
+    const results = MarkdownDefinitionProvider.filesForWikiLinkRefFromCache(ref, null);
+
+    label = NoteWorkspace.stripExtension(label);
+
+    // Either use the first result of the cache, or in the case that it's empty use the label to create a path
+    let path: string = (results.length != 0) ? results[0].path : NoteWorkspace.noteFileNameFromTitle(label);
+
+    return path;
+}
+
+// Transformation that only gets applied to the page name (ex: the "test-file.md" part of [[test-file.md | Description goes here]]).
+export function postProcessPageName(pageName: string) {
+    return NoteWorkspace.stripExtension(pageName);
+}
+
+// Transformation that only gets applied to the link label (ex: the " Description goes here" part of [[test-file.md | Description goes here]])
+export function postProcessLabel(label: string) {
+    // Trim whitespaces
+    label = label.trim();
+
+    // De-slugify label into whitespaces
+    label = label.split(NoteWorkspace.slugifyChar()).join(" ");
+
+    if (NoteWorkspace.previewShowFileExtension()) {
+        label += `.${NoteWorkspace.defaultFileExtension()}`;
+    }
+
+    switch (NoteWorkspace.previewLabelStyling()) {
+        case "[[label]]":
+            return `[[${label}]]`;
+        case "[label]":
+            return `[${label}]`;
+        case "label":
+            return label;
+    }
+    ;
+}
+
+export function pluginSettings(): any {
+    return require('@thomaskoppelaar/markdown-it-wikilinks')({ 
+        generatePageNameFromLabel: PageNameGenerator, 
+        postProcessPageName: postProcessPageName, 
+        postProcessLabel: postProcessLabel,
+        uriSuffix: `.${NoteWorkspace.defaultFileExtension()}`,
+        description_then_file: NoteWorkspace.pipedWikiLinksSyntax() == "desc|file",
+        separator: NoteWorkspace.pipedWikiLinksSeparator(),
+    });
+}

src/NoteWorkspace.ts

@@ -28,6 +28,12 @@ enum PipedWikiLinksSyntax {
   descFile = 'desc|file',
 }
 
+enum PreviewLabelStyling {
+    brackets = "[[label]]",
+    bracket = "[label]",
+    none = "label"
+}
+
 type Config = {
   createNoteOnGoToDefinitionWhenMissing: boolean;
   defaultFileExtension: string;
@@ -41,6 +47,8 @@ type Config = {
   pipedWikiLinksSyntax: PipedWikiLinksSyntax;
   pipedWikiLinksSeparator: string;
   newNoteDirectory: string;
+  previewLabelStyling: PreviewLabelStyling;
+  previewShowFileExtension: boolean;
 };
 // This class contains:
 // 1. an interface to some of the basic user configurable settings or this extension
@@ -76,6 +84,8 @@ export class NoteWorkspace {
     pipedWikiLinksSyntax: PipedWikiLinksSyntax.descFile,
     pipedWikiLinksSeparator: '\\|',
     newNoteDirectory: NoteWorkspace.NEW_NOTE_SAME_AS_ACTIVE_NOTE,
+    previewLabelStyling: PreviewLabelStyling.brackets,
+    previewShowFileExtension: false,
   };
   static DOCUMENT_SELECTOR = [
     // { scheme: 'file', language: 'markdown' },
@@ -84,6 +94,9 @@ export class NoteWorkspace {
     { language: 'mdx' },
   ];
 
+  // Cache object to store results from noteFiles() in order to provide a synchronous method to the preview renderer.
+  static noteFileCache: vscode.Uri[] = [];
+
   static cfg(): Config {
     let c = vscode.workspace.getConfiguration('vscodeMarkdownNotes');
     return {
@@ -103,6 +116,8 @@ export class NoteWorkspace {
       pipedWikiLinksSyntax: c.get('pipedWikiLinksSyntax') as PipedWikiLinksSyntax,
       pipedWikiLinksSeparator: c.get('pipedWikiLinksSeparator') as string,
       newNoteDirectory: c.get('newNoteDirectory') as string,
+      previewLabelStyling: c.get('previewLabelStyling') as PreviewLabelStyling,
+      previewShowFileExtension: c.get('previewShowFileExtension') as boolean,
     };
   }
 
@@ -138,6 +153,14 @@ export class NoteWorkspace {
     return this.cfg().newNoteDirectory;
   }
 
+  static previewLabelStyling(): string {
+      return this.cfg().previewLabelStyling;
+  }
+
+  static previewShowFileExtension(): boolean {
+      return this.cfg().previewShowFileExtension;
+  }
+
   static rxTagNoAnchors(): RegExp {
     // NB: MUST have g flag to match multiple words per line
     // return /\#[\w\-\_]+/i; // used to match tags that appear within lines
@@ -421,6 +444,11 @@ export class NoteWorkspace {
     let files = (await vscode.workspace.findFiles('**/*')).filter(
       (f) => f.scheme == 'file' && f.path.match(that.rxFileExtensions())
     );
+    this.noteFileCache = files;
     return files;
   }
+
+  static noteFilesFromCache(): Array<vscode.Uri> {
+    return this.noteFileCache;
+  }
 }

src/extension.ts

@@ -7,6 +7,7 @@ import { MarkdownFileCompletionItemProvider } from './MarkdownFileCompletionItem
 import { NoteWorkspace } from './NoteWorkspace';
 import { NoteParser } from './NoteParser';
 import { getRefAt, RefType } from './Ref';
+import { pluginSettings } from './MarkdownRenderingPlugin';
 // import { debug } from 'util';
 // import { create } from 'domain';
 
@@ -62,4 +63,13 @@ export function activate(context: vscode.ExtensionContext) {
   const treeView = vscode.window.createTreeView('vscodeMarkdownNotesBacklinks', {
     treeDataProvider: backlinksTreeDataProvider,
   });
+
+  // See: https://code.visualstudio.com/api/extension-guides/markdown-extension
+  // For more information on how this works.
+  return {
+    extendMarkdownIt(md: any) {
+        return md.use(
+            pluginSettings()
+        )}
+    };
 }