fix: markdown anchor links in package readme.md broken #2712

verdaccio · Dec 1, 2021 · 820c9d5 · 820c9d5
1 parent 60cd25c
commit 820c9d5
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 36 deletions.
diff --git a/.pnp.js b/.pnp.js
diff --git a/.yarn/cache/@verdaccio-readme-npm-10.0.1-dd3c1c7def-fa9671f10d.zip b/.yarn/cache/@verdaccio-readme-npm-10.0.1-dd3c1c7def-fa9671f10d.zip
diff --git a/.yarn/cache/@verdaccio-readme-npm-10.1.0-b5e92d038e-0d116bbd32.zip b/.yarn/cache/@verdaccio-readme-npm-10.1.0-b5e92d038e-0d116bbd32.zip
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
   "dependencies": {
     "@verdaccio/commons-api": "10.0.2",
     "@verdaccio/local-storage": "10.0.8",
-    "@verdaccio/readme": "10.0.1",
+    "@verdaccio/readme": "10.1.0",
     "@verdaccio/streams": "10.0.1",
     "@verdaccio/ui-theme": "3.2.1",
     "JSONStream": "1.3.5",

diff --git a/src/api/web/endpoint/package.ts b/src/api/web/endpoint/package.ts
@@ -100,7 +100,9 @@ function addPackageWebApi(route: Router, storage: IStorageHandler, auth: IAuth,
         }
 
         res.set(HEADER_TYPE.CONTENT_TYPE, HEADERS.TEXT_PLAIN);
-        next(parseReadme(info.name, info.readme));
+        const referer = req.get('Referer');
+        const pathname = referer ? (new URL(referer)).pathname : undefined;
+        next(parseReadme(info.name, info.readme, {pathname}));
       },
     });
   });

diff --git a/src/lib/utils.ts b/src/lib/utils.ts
@@ -489,11 +489,14 @@ export function addGravatarSupport(pkgInfo: Package, online = true): AuthorAvata
  * parse package readme - markdown/ascii
  * @param {String} packageName name of package
  * @param {String} readme package readme
+ * @param {Object} options sanitizyReadme options
  * @return {String} converted html template
  */
-export function parseReadme(packageName: string, readme: string): string | void {
+export function parseReadme(packageName: string,
+                            readme: string,
+                            options: { pathname?: string | void } = {}): string | void {
   if (_.isEmpty(readme) === false) {
-    return sanitizyReadme(readme);
+    return sanitizyReadme(readme, options);
   }
 
   // logs readme not found error

diff --git a/yarn.lock b/yarn.lock
@@ -3516,14 +3516,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@verdaccio/readme@npm:10.0.1":
-  version: 10.0.1
-  resolution: "@verdaccio/readme@npm:10.0.1"
+"@verdaccio/readme@npm:10.1.0":
+  version: 10.1.0
+  resolution: "@verdaccio/readme@npm:10.1.0"
   dependencies:
     dompurify: ^2.2.6
     jsdom: 15.2.1
     marked: ^2.0.1
-  checksum: fa9671f10dcc84058051aea33212904b383354c3f9aaa0e74f16deb3c7d5dee8396c2804f42b5f636a3b8787ed3a4c9de7908dae8a907196182c7e80019d261f
+  checksum: 0d116bbd32b9f880d9cea7b6fe1a0fee0923f06472144c2c9001bf0680f76845704762c825cc372ea64f955af7817d4f21e685caec11b2fad93b9cc9c63c43e8
   languageName: node
   linkType: hard
 
@@ -14010,7 +14010,7 @@ typescript@4.1.3:
     "@verdaccio/commons-api": 10.0.2
     "@verdaccio/eslint-config": ^8.5.0
     "@verdaccio/local-storage": 10.0.8
-    "@verdaccio/readme": 10.0.1
+    "@verdaccio/readme": 10.1.0
     "@verdaccio/streams": 10.0.1
     "@verdaccio/types": ^9.7.2
     "@verdaccio/ui-theme": 3.2.1