Escape XML characters in anchors

Closes #37

Author: mihaeu

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.17.2] - 2023-01-09
+
+### Fixed
+
+-   Escape XML characters in anchors due to Confluence API validation errors
+
 ## [0.17.1] - 2023-01-09
 
 ### Fixed

package.json

@@ -1,6 +1,6 @@
 {
     "name": "cosmere",
-    "version": "0.17.1",
+    "version": "0.17.2",
     "description": "Sync your markdown files to confluence.",
     "main": "dist/index.js",
     "bin": {

src/ConfluenceRenderer.ts

@@ -86,7 +86,7 @@ export default class ConfluenceRenderer extends Renderer<string> {
         if (href) {
             href = this.resolveLinks(href);
         }
-        return super.link(href, title, text);
+        return super.link(escapeXmlCharacters(href ?? ""), title, text);
     }
 
     private resolveLinks(href: string): string {

tests/ConfluenceRenderer.test.ts

@@ -138,6 +138,12 @@ describe("ConfluenceRenderer", () => {
         );
     });
 
+    it("renders links to websites and converts XML characters", () => {
+        expect(confluenceRenderer.link("http://example.com?test=<>&'\"", "test", "nothing")).toBe(
+            `<a href="http://example.com?test=&lt;&gt;&amp;&apos;&quot;" title="test">nothing</a>`,
+        );
+    });
+
     it("renders links to other matching markdown files as Confluence links", () => {
         expect(confluenceRenderer.link("./other.md", "", "")).toBe(
             `<a href="https://my-confluence.com/pages/viewpage.action?pageId=456"></a>`,