Implement useLinkRef config and add unit tests

lib/lexer/index.js

@@ -39,7 +39,9 @@ class Lexer {
 
 	run() {
 		this.#skipFrontMatter()
-		this.#checkForLinkRefs()
+		if (this.#config.useLinkRefs) {
+			this.#checkForLinkRefs()
+		}
 
 		for (this.#cursor = 0; this.#cursor < this.#lines.length; this.#cursor++) {
 			this.#runPrep()

lib/regex/index.js

@@ -31,7 +31,7 @@ const REGEX = {
 	},
 	HTML: /^\s*<(?<tag>\w+)\s+(?<attrs>\b[^>]*)>(?<content>.*)<\/(?<endTag>\w+)>/s,
 	LINK_REF: {
-		DECLARATION: /\s*\[(?<text>.+)]:\s+(?<href>\S+(?:\s'(?<title>.+?)')?)/g,
+		DECLARATION: /\s*\[(?<text>.+)]:\s+(?<href>\S+)(?:\s['"](?<title>.+?)['"])?/g,
 		WITH_TEXT: /^(?<!!)\[(?<text>.+?)](?!\(.+\))(?<!!)\[(?<ref>.+?)](?!\(.+\))/,
 		WITHOUT_TEXT: /^(?<!!)\[(?<ref>.+?)](?!\(.+\))/
 	},

tests/unit/lexer/__snapshots__/codeblock.spec.js.snap

@@ -363,6 +363,22 @@ const a = 1
 ]
 `;
 
+exports[`codeblock should remove the link refs inside codeblock but do not change the usage 1`] = `
+Array [
+  Object {
+    "indent": 0,
+    "language": "markdown",
+    "raw": "\`\`\` markdown
+
+[foo][]
+\`\`\`",
+    "type": "code-block",
+    "value": "
+[foo][]",
+  },
+]
+`;
+
 exports[`codeblock should set incomplete codeblock as a code block 1`] = `
 Array [
   Object {

tests/unit/lexer/codeblock.spec.js

@@ -179,4 +179,15 @@ describe("codeblock", () => {
 		const tokens = lexer.run()
 		expect(tokens).toMatchSnapshot()
 	})
+	it("should remove the link refs inside codeblock but do not change the usage", () => {
+		const lines = `\`\`\` markdown
+[foo]: /url1
+[foo]: /url2
+
+[foo][]
+\`\`\``
+		const lexer = new Lexer(lines.split("\n"))
+		const tokens = lexer.run()
+		expect(tokens).toMatchSnapshot()
+	})
 })

tests/unit/parser/__snapshots__/linkRefs.spec.js.snap

@@ -0,0 +1,23 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Link Reference should not use the link references for link construction when disabled from config 1`] = `
+"<p><a href=\\"https://www.somewebsite.com\\">I&#39;m an inline-style link</a></p>
+<p><a href=\\"https://www.somewebsite.com\\" title=\\"somewebsite's Homepage\\">I&#39;m an inline-style link with title</a></p>
+<p>[I&#39;m a reference-style link][Arbitrary case-insensitive reference text]</p>
+<p><a href=\\"../blob/master/LICENSE\\">I&#39;m a relative reference to a repository file</a></p>
+<p><a href=\\"http://somewebsite.org\\" title=\\"somewebsite\\">You can use numbers for reference-style link definitions</a></p>
+<p>Or leave it empty and use the <a href=\\"http://www.somewebsite.com\\">link text itself</a></p>
+<p>Some text to show that the reference links can follow later.</p>
+"
+`;
+
+exports[`Link Reference should use the link references for link construction 1`] = `
+"<p><a href=\\"https://www.somewebsite.com\\">I&#39;m an inline-style link</a></p>
+<p><a href=\\"https://www.somewebsite.com\\" title=\\"somewebsite's Homepage\\">I&#39;m an inline-style link with title</a></p>
+<p>[I&#39;m a reference-style link][Arbitrary case-insensitive reference text]</p>
+<p><a href=\\"../blob/master/LICENSE\\">I&#39;m a relative reference to a repository file</a></p>
+<p><a href=\\"http://somewebsite.org\\" title=\\"somewebsite\\">You can use numbers for reference-style link definitions</a></p>
+<p>Or leave it empty and use the <a href=\\"http://www.somewebsite.com\\">link text itself</a></p>
+<p>Some text to show that the reference links can follow later.</p>
+"
+`;

tests/unit/parser/linkRefs.spec.js

@@ -0,0 +1,35 @@
+import HtmlMark from "../../../lib/index.js"
+
+
+describe("Link Reference", () => {
+	const htmlMarkWithLinkRefsOn = new HtmlMark()
+	const htmlMarkWithLinkRefsOff = new HtmlMark({ useLinkRefs: false })
+
+	const lines = `[I'm an inline-style link](https://www.somewebsite.com)
+
+[I'm an inline-style link with title](https://www.somewebsite.com "somewebsite's Homepage")
+
+[I'm a reference-style link][Arbitrary case-insensitive reference text]
+
+[I'm a relative reference to a repository file](../blob/master/LICENSE)
+
+[You can use numbers for reference-style link definitions][1]
+
+Or leave it empty and use the [link text itself]
+
+Some text to show that the reference links can follow later.
+
+[arbitrary case-insensitive reference text]: https://www.somewebsite.org
+[1]: http://somewebsite.org "somewebsite's Homepage"
+[link text itself]: http://www.somewebsite.com`
+
+	it("should use the link references for link construction", () => {
+		const html = htmlMarkWithLinkRefsOn.parse(lines)
+		expect(html).toMatchSnapshot()
+	})
+
+	it("should not use the link references for link construction when disabled from config", () => {
+		const html = htmlMarkWithLinkRefsOff.parse(lines)
+		expect(html).toMatchSnapshot()
+	})
+})