Merge pull request #85 from kortina/ak-github-slugger

add github-slugger option

Author: kortina

.vscode/settings.json

@@ -27,6 +27,7 @@
     "basenames",
     "davovscapcom",
     "digiguru",
+    "dont",
     "filepath",
     "fullwidth",
     "jumplist",

package-lock.json

@@ -85,6 +85,15 @@
           "default": "-",
           "description": "When creating new notes from a 'Title Case Note Name', slugify non-word characters with '-' (default) or '_', or don't slugify non-word characters by setting to 'NONE.'"
         },
+        "vscodeMarkdownNotes.slugifyMethod": {
+          "type": "string",
+          "enum": [
+            "classic",
+            "github-slugger"
+          ],
+          "default": "classic",
+          "description": "Method converting 'Title Case Note Names' to 'slug-file-names.' Defaults to 'classic.' See unit tests in vscode-markdown-notes GitHub project for more details."
+        },
         "vscodeMarkdownNotes.defaultFileExtension": {
           "type": "string",
           "default": "md",
@@ -178,11 +187,15 @@
     "vscode:prepublish": "npm run compile",
     "watch": "tsc -watch -p ./"
   },
+  "dependencies": {
+    "github-slugger": "^1.3.0"
+  },
   "devDependencies": {
     "@babel/core": "^7.10.1",
     "@babel/preset-env": "^7.10.1",
     "@babel/preset-typescript": "^7.10.1",
     "babel-jest": "^26.0.1",
+    "@types/github-slugger": "^1.3.0",
     "@types/glob": "^7.1.1",
     "@types/jest": "^25.2.3",
     "@types/jest-cli": "^24.3.0",

package.json

@@ -1,6 +1,8 @@
 import * as vscode from 'vscode';
 import { basename, dirname, isAbsolute, join, normalize, relative } from 'path';
 import { existsSync, writeFileSync } from 'fs';
+const GithubSlugger = require('github-slugger');
+const SLUGGER = new GithubSlugger();
 
 export const foo = () => {
   return 1;
@@ -23,7 +25,12 @@ enum SlugifyCharacter {
   none = 'NONE',
 }
 
-enum PipedWikiLinksSyntax {
+export enum SlugifyMethod {
+  github = 'github-slugger',
+  classic = 'classic',
+}
+
+export enum PipedWikiLinksSyntax {
   fileDesc = 'file|desc',
   descFile = 'desc|file',
 }
@@ -39,6 +46,7 @@ type Config = {
   defaultFileExtension: string;
   noteCompletionConvention: NoteCompletionConvention;
   slugifyCharacter: SlugifyCharacter;
+  slugifyMethod: SlugifyMethod;
   workspaceFilenameConvention: WorkspaceFilenameConvention;
   newNoteTemplate: string;
   compileSuggestionDetails: boolean;
@@ -63,25 +71,21 @@ export class NoteWorkspace {
   static _rxTitle = '(?<=^( {0,3}#[^\\S\\r\\n]+)).+';
   static _rxMarkdownWordPattern = '([\\_\\w\\#\\.\\/\\\\]+)'; // had to add [".", "/", "\"] to get relative path completion working and ["#"] to get tag completion working
   static _rxFileExtensions = '\\.(md|markdown|mdx|fountain)$';
-  static _defaultFileExtension = 'md';
-  static _defaultNoteTemplate = '# ${noteName}\n\n';
-  static _defaultTriggerSuggestOnReplacement = true;
   static SLUGIFY_NONE = 'NONE';
   static NEW_NOTE_SAME_AS_ACTIVE_NOTE = 'SAME_AS_ACTIVE_NOTE';
   static NEW_NOTE_WORKSPACE_ROOT = 'WORKSPACE_ROOT';
-  static _defaultSlugifyChar = '-';
-  static _slugifyChar = '-';
   static DEFAULT_CONFIG: Config = {
     createNoteOnGoToDefinitionWhenMissing: true,
     compileSuggestionDetails: false,
-    defaultFileExtension: NoteWorkspace._defaultFileExtension,
+    defaultFileExtension: 'md',
     noteCompletionConvention: NoteCompletionConvention.rawFilename,
     slugifyCharacter: SlugifyCharacter.dash,
+    slugifyMethod: SlugifyMethod.classic,
     workspaceFilenameConvention: WorkspaceFilenameConvention.uniqueFilenames,
-    newNoteTemplate: NoteWorkspace._defaultNoteTemplate,
-    triggerSuggestOnReplacement: NoteWorkspace._defaultTriggerSuggestOnReplacement,
+    newNoteTemplate: '# ${noteName}\n\n',
+    triggerSuggestOnReplacement: true,
     allowPipedWikiLinks: false,
-    pipedWikiLinksSyntax: PipedWikiLinksSyntax.descFile,
+    pipedWikiLinksSyntax: PipedWikiLinksSyntax.fileDesc,
     pipedWikiLinksSeparator: '\\|',
     newNoteDirectory: NoteWorkspace.NEW_NOTE_SAME_AS_ACTIVE_NOTE,
     previewLabelStyling: PreviewLabelStyling.brackets,
@@ -106,6 +110,7 @@ export class NoteWorkspace {
       defaultFileExtension: c.get('defaultFileExtension') as string,
       noteCompletionConvention: c.get('noteCompletionConvention') as NoteCompletionConvention,
       slugifyCharacter: c.get('slugifyCharacter') as SlugifyCharacter,
+      slugifyMethod: c.get('slugifyMethod') as SlugifyMethod,
       workspaceFilenameConvention: c.get(
         'workspaceFilenameConvention'
       ) as WorkspaceFilenameConvention,
@@ -125,6 +130,10 @@ export class NoteWorkspace {
     return this.cfg().slugifyCharacter;
   }
 
+  static slugifyMethod(): string {
+    return this.cfg().slugifyMethod;
+  }
+
   static defaultFileExtension(): string {
     return this.cfg().defaultFileExtension;
   }
@@ -283,7 +292,9 @@ export class NoteWorkspace {
   }
 
   // Compare 2 wiki-links for a fuzzy match.
-  // All of the following will return true
+  // In general, we expect
+  // `left` to be fsPath
+  // `right` to be the ref word [[wiki-link]]
   static noteNamesFuzzyMatch(left: string, right: string): boolean {
     return (
       this.normalizeNoteNameForFuzzyMatch(left).toLowerCase() ==
@@ -303,14 +314,28 @@ export class NoteWorkspace {
       .toLowerCase() // lower
       .replace(/[-_－＿ ]*$/g, ''); // removing trailing slug chars
   }
-  static slugifyTitle(title: string): string {
+
+  static slugifyClassic(title: string): string {
     let t =
       this.slugifyChar() == 'NONE'
         ? title
         : title.replace(/[!"\#$%&'()*+,\-./:;<=>?@\[\\\]^_‘{|}~\s]+/gi, this.slugifyChar()); // punctuation and whitespace to hyphens (or underscores)
     return this.cleanTitle(t);
   }
 
+  static slugifyGithub(title: string): string {
+    SLUGGER.reset(); // otherwise it will increment repeats with -1 -2 -3 etc.
+    return SLUGGER.slug(title);
+  }
+
+  static slugifyTitle(title: string): string {
+    if (this.slugifyMethod() == SlugifyMethod.classic) {
+      return this.slugifyClassic(title);
+    } else {
+      return this.slugifyGithub(title);
+    }
+  }
+
   static noteFileNameFromTitle(title: string): string {
     let t = this.slugifyTitle(title);
     return t.match(this.rxFileExtensions()) ? t : `${t}.${this.defaultFileExtension()}`;