fix: Update child packages parseUrl functions

typedoc2md · Feb 6, 2024 · cbf62fa · cbf62fa
1 parent c8c2902
commit cbf62fa
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 22 deletions.
diff --git a/.changeset/five-cobras-bake.md b/.changeset/five-cobras-bake.md
@@ -0,0 +1,7 @@
+---
+"typedoc-github-wiki-theme": patch
+"typedoc-gitlab-wiki-theme": patch
+"typedoc-vitepress-theme": patch
+---
+
+- Updates to typedoc-plugin-markdown internal apis
diff --git a/packages/typedoc-github-wiki-theme/src/theme.ts b/packages/typedoc-github-wiki-theme/src/theme.ts
@@ -44,7 +44,10 @@ export class GithubWikiTheme extends MarkdownTheme {
 }
 
 class ThemeRenderContext extends MarkdownThemeRenderContext {
-  parseUrl = (url: string) => {
-    return encodeURI('../wiki/' + url.replace('.md', ''));
+  override helpers = {
+    ...this.helpers,
+    parseUrl: (url: string) => {
+      return encodeURI('../wiki/' + url.replace('.md', ''));
+    },
   };
 }
diff --git a/packages/typedoc-gitlab-wiki-theme/package.json b/packages/typedoc-gitlab-wiki-theme/package.json
@@ -22,7 +22,8 @@
     "build": "tsc",
     "build-and-test": "npm run build && npm run test",
     "pretest": "ts-node ./test/__scripts__/prepare.ts",
-    "test": "jest"
+    "test": "jest",
+    "test:update": "npm run build && npm test -- -u"
   },
   "author": "Thomas Grey",
   "license": "MIT",

diff --git a/packages/typedoc-gitlab-wiki-theme/src/theme.ts b/packages/typedoc-gitlab-wiki-theme/src/theme.ts
@@ -12,10 +12,13 @@ export class GitlabWikiTheme extends MarkdownTheme {
 }
 
 class ThemeRenderContext extends MarkdownThemeRenderContext {
-  parseUrl = (url: string) => {
-    const relativeUrl = url?.replace(/(.*).md/, '$1').replace(/ /g, '-');
-    return encodeURI(
-      relativeUrl?.startsWith('..') ? relativeUrl : './' + relativeUrl,
-    );
+  override helpers = {
+    ...this.helpers,
+    parseUrl: (url: string) => {
+      const relativeUrl = url?.replace(/(.*).md/, '$1').replace(/ /g, '-');
+      return encodeURI(
+        relativeUrl?.startsWith('..') ? relativeUrl : './' + relativeUrl,
+      );
+    },
   };
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/theme-render-context.ts b/packages/typedoc-plugin-markdown/src/theme/theme-render-context.ts
@@ -41,13 +41,6 @@ export class MarkdownThemeRenderContext {
    */
   text = text(this.theme);
 
-  /**
-   * @deprecated - moved to helpers
-   */
-  parseUrl = (url: string) => {
-    return encodeURI(url);
-  };
-
   /**
    * Hook into the TypeDoc rendering system.
    */

diff --git a/packages/typedoc-vitepress-theme/src/theme.ts b/packages/typedoc-vitepress-theme/src/theme.ts
@@ -12,13 +12,16 @@ export class VitepressTheme extends MarkdownTheme {
 }
 
 class ThemeRenderContext extends MarkdownThemeRenderContext {
-  parseUrl = (url: string) => {
-    const urlWithAnchor = url.split('#');
-    if (urlWithAnchor.length > 1) {
-      const anchorPart = slugify(urlWithAnchor[1]);
-      return encodeURI(`${urlWithAnchor[0]}#${anchorPart}`);
-    }
-    return encodeURI(url);
+  override helpers = {
+    ...this.helpers,
+    parseUrl: (url: string) => {
+      const urlWithAnchor = url.split('#');
+      if (urlWithAnchor.length > 1) {
+        const anchorPart = slugify(urlWithAnchor[1]);
+        return encodeURI(`${urlWithAnchor[0]}#${anchorPart}`);
+      }
+      return encodeURI(url);
+    },
   };
 }