fix(vitepress): updated anchor slugs to correctly handle all use-cases (#725)

Author: tgreyuk

.changeset/grumpy-carrots-swim.md

@@ -0,0 +1,5 @@
+---
+'typedoc-vitepress-theme': patch
+---
+
+- Updated anchor slugs to correctly handle all use-cases.

packages/typedoc-vitepress-theme/src/index.ts

@@ -14,6 +14,7 @@ import { DEFAULT_SIDEBAR_OPTIONS } from './options.js';
 import * as options from './options/declarations.js';
 import { presets } from './options/presets.js';
 import { getSidebar } from './sidebars/sidebars.js';
+import { slugifyAnchor } from './utils/utils.js';
 
 export function load(app: MarkdownApplication) {
   Object.entries(options).forEach(([name, option]) => {
@@ -74,12 +75,3 @@ export function load(app: MarkdownApplication) {
     }
   });
 }
-
-function slugifyAnchor(anchor: string) {
-  return anchor
-    .toLowerCase()
-    .trim()
-    .replace(/[^\w\s-]/g, '')
-    .replace(/[\s_-]+/g, '-')
-    .replace(/^-+|-+$/g, '');
-}

packages/typedoc-vitepress-theme/src/utils/utils.spec.ts

@@ -0,0 +1,13 @@
+import { slugifyAnchor } from './utils';
+
+describe('slugifyAnchor', () => {
+  it('should anchors with underscores', () => {
+    expect(slugifyAnchor('_prop_with_underscore_')).toBe(
+      'prop-with-underscore',
+    );
+  });
+
+  it('should anchors with colons', () => {
+    expect(slugifyAnchor('prop:colon')).toBe('prop-colon');
+  });
+});

packages/typedoc-vitepress-theme/src/utils/utils.ts

@@ -0,0 +1,22 @@
+// eslint-disable-next-line no-control-regex
+const rControl = /[\u0000-\u001f]/g;
+const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’<>,.?/]+/g;
+const rCombining = /[\u0300-\u036F]/g;
+
+export const slugifyAnchor = (str: string): string =>
+  str
+    .normalize('NFKD')
+    // Remove accents
+    .replace(rCombining, '')
+    // Remove control characters
+    .replace(rControl, '')
+    // Replace special characters
+    .replace(rSpecial, '-')
+    // Remove continuos separators
+    .replace(/-{2,}/g, '-')
+    // Remove prefixing and trailing separators
+    .replace(/^-+|-+$/g, '')
+    // ensure it doesn't start with a number (#121)
+    .replace(/^(\d)/, '_$1')
+    // lowercase
+    .toLowerCase();