refactor: use Obsidian builtin function for link sanitization

The Obsidian API now provides stripHeadingForLink() to sanitize heading text for the purposes of creating links. Use this function instead of our custom implementation.
darlal · Nov 30, 2024 · ba09d9b · ba09d9b
1 parent 60d3b3b
commit ba09d9b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 22 deletions.
diff --git a/src/__mocks__/obsidian/index.ts b/src/__mocks__/obsidian/index.ts
@@ -18,6 +18,7 @@ import {
   MarkdownRenderer,
   prepareFuzzySearch,
   prepareSimpleSearch,
+  stripHeadingForLink,
 } from 'obsidian';
 import {
   MockSetting,
@@ -86,6 +87,9 @@ const mockRenderResults = mockFn<typeof renderResults>().mockImplementation();
 const mockDebounce = mockFn<typeof debounce>().mockImplementation();
 const mockSetIcon = mockFn<typeof setIcon>().mockImplementation();
 const mockParseLinktext = mockFn<typeof parseLinktext>().mockImplementation();
+const mockStripHeadingForLink = mockFn<typeof stripHeadingForLink>().mockImplementation(
+  (heading) => heading,
+);
 
 export {
   mockPlatform as Platform,
@@ -101,6 +105,7 @@ export {
   mockNormalizePath as normalizePath,
   mockSetIcon as setIcon,
   mockParseLinktext as parseLinktext,
+  mockStripHeadingForLink as stripHeadingForLink,
   mockKeymap as Keymap,
   mockMarkdownRenderer as MarkdownRenderer,
   mockComponent as Component,

diff --git a/src/utils/__tests__/utils.test.ts b/src/utils/__tests__/utils.test.ts
@@ -308,22 +308,6 @@ describe('utils', () => {
       );
     });
 
-    test('generated links for Heading subpath should not contain illegal link characters', () => {
-      const illegalChar = ':#|^\\%%[[]]';
-      const heading = `head ${illegalChar} tail`;
-      const expectedLinkHeadingStr = 'head tail';
-      const sugg = makeHeadingSuggestion(makeHeading(heading, 1), destFile);
-
-      generateMarkdownLink(mockFileManager, mockVault, sugg, activeFilePath);
-
-      expect(mockFileManager.generateMarkdownLink).toHaveBeenCalledWith(
-        destFile,
-        activeFilePath,
-        `#${expectedLinkHeadingStr}`,
-        expectedLinkHeadingStr,
-      );
-    });
-
     test('with useHeadingAsAlias disabled, it should generate a link for Heading suggestions with file basename as alias', () => {
       const heading = chance.sentence();
       const sugg = makeHeadingSuggestion(makeHeading(heading, 1), destFile);

diff --git a/src/utils/utils.ts b/src/utils/utils.ts
@@ -13,6 +13,7 @@ import {
   Vault,
   normalizePath,
   WorkspaceLeaf,
+  stripHeadingForLink,
 } from 'obsidian';
 import {
   SymbolSuggestion,
@@ -346,12 +347,7 @@ function sanitizeStringForLinkSubpath(
   input: string,
   useInputAsAlias: boolean,
 ): { subpath: string; alias: string | null } {
-  // May 2024: shamelessly borrowed from Obsidian
-  const illegalLinkCharsRegex = /([:#|^\\\r\n]|%%|\[\[|]])/g;
-  const sanitizedInput = input
-    .replace(illegalLinkCharsRegex, ' ')
-    .replace(/\s+/g, ' ')
-    .trim();
+  const sanitizedInput = stripHeadingForLink(input);
 
   return {
     subpath: `#${sanitizedInput}`,