diff --git a/.changeset/old-planets-battle.md b/.changeset/old-planets-battle.md new file mode 100644 index 00000000..f613b29c --- /dev/null +++ b/.changeset/old-planets-battle.md @@ -0,0 +1,5 @@ +--- +'@portaljs/remark-wiki-link': major +--- + +Changed regex to permit any symbols other than # diff --git a/packages/remark-wiki-link/src/lib/fromMarkdown.ts b/packages/remark-wiki-link/src/lib/fromMarkdown.ts index 50824c00..d9e9a0ef 100644 --- a/packages/remark-wiki-link/src/lib/fromMarkdown.ts +++ b/packages/remark-wiki-link/src/lib/fromMarkdown.ts @@ -79,7 +79,7 @@ function fromMarkdown(opts: FromMarkdownOptions = {}) { data: { isEmbed, target, alias }, } = wikiLink; // eslint-disable-next-line no-useless-escape - const wikiLinkWithHeadingPattern = /([\p{Letter}\d\s\/\.-_-]*)(#.*)?/u; + const wikiLinkWithHeadingPattern = /^(.*?)(#.*)?$/u; const [, path, heading = ""] = target.match(wikiLinkWithHeadingPattern); const possibleWikiLinkPermalinks = wikiLinkResolver(path); diff --git a/packages/remark-wiki-link/src/lib/html.ts b/packages/remark-wiki-link/src/lib/html.ts index d4a7996f..021970a8 100644 --- a/packages/remark-wiki-link/src/lib/html.ts +++ b/packages/remark-wiki-link/src/lib/html.ts @@ -64,7 +64,7 @@ function html(opts: HtmlOptions = {}) { const { target, alias } = wikiLink; const isEmbed = token.isType === "embed"; // eslint-disable-next-line no-useless-escape - const wikiLinkWithHeadingPattern = /([\w\s\/\.-]*)(#.*)?/; + const wikiLinkWithHeadingPattern = /^(.*?)(#.*)?$/u; const [, path, heading = ""] = target.match(wikiLinkWithHeadingPattern); const possibleWikiLinkPermalinks = wikiLinkResolver(path); diff --git a/packages/remark-wiki-link/test/getPermalinks.spec.ts b/packages/remark-wiki-link/test/getPermalinks.spec.ts index 1e1f51d3..de916171 100644 --- a/packages/remark-wiki-link/test/getPermalinks.spec.ts +++ b/packages/remark-wiki-link/test/getPermalinks.spec.ts @@ -6,7 +6,7 @@ import { getPermalinks } from "../src/utils"; // const markdownFolder = path.join(__dirname, "/fixtures/content"); const markdownFolder = path.join( ".", - "/packages/remark-wiki-link/test/fixtures/content" + "test/fixtures/content" ); describe("getPermalinks", () => { diff --git a/packages/remark-wiki-link/test/remarkWikiLink.spec.ts b/packages/remark-wiki-link/test/remarkWikiLink.spec.ts index 6b4e9cc5..5c5ce5b3 100644 --- a/packages/remark-wiki-link/test/remarkWikiLink.spec.ts +++ b/packages/remark-wiki-link/test/remarkWikiLink.spec.ts @@ -6,10 +6,14 @@ import { Node } from "unist"; import wikiLinkPlugin from "../src/lib/remarkWikiLink"; +function createMarkdownProcessorWithWikiLinkPlugin() { + return unified().use(markdown).use(wikiLinkPlugin); +} + describe("remark-wiki-link", () => { describe("parses a wikilink", () => { test("with 'raw' file format (default) that has no matching permalink", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[Wiki Link]]"); ast = processor.runSync(ast); @@ -161,7 +165,7 @@ describe("remark-wiki-link", () => { describe("aliases and headings", () => { test("parses a wiki link with heading", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[Wiki Link#Some Heading]]"); ast = processor.runSync(ast); @@ -185,8 +189,32 @@ describe("remark-wiki-link", () => { }); }); + test("Alias with accent", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[link|Alias with àcèôíã]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("link"); + expect(node.data?.alias).toEqual("Alias with àcèôíã"); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "link" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "Alias with àcèôíã" + ); + }) + }) + test("parses a wiki link with heading and alias", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[Wiki Link#Some Heading|Alias]]"); ast = processor.runSync(ast); @@ -209,7 +237,7 @@ describe("remark-wiki-link", () => { }); test("parses a wiki link to a heading on the same page", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[#Some Heading]]"); ast = processor.runSync(ast); @@ -228,11 +256,35 @@ describe("remark-wiki-link", () => { expect((node.data?.hChildren as any)[0].value).toEqual("Some Heading"); }); }); + + test("parses a link and alias with accent", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[link|Alias-with-dashes]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("link"); + expect(node.data?.alias).toEqual("Alias-with-dashes"); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "link" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "Alias-with-dashes" + ); + }) + }) }); describe("image embeds", () => { test("parses an image embed of supported file format", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("![[My Image.png]]"); ast = processor.runSync(ast); @@ -250,7 +302,7 @@ describe("remark-wiki-link", () => { }); test("parses an image embed of unsupported file format", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("![[My Image.xyz]]"); ast = processor.runSync(ast); @@ -324,7 +376,7 @@ describe("remark-wiki-link", () => { }); test("parses an image embed with an alt text", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("![[My Image.png|Alt Text]]"); ast = processor.runSync(ast); @@ -342,7 +394,7 @@ describe("remark-wiki-link", () => { }); test("parses a pdf embed", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("![[My Document.pdf]]"); ast = processor.runSync(ast); @@ -361,9 +413,131 @@ describe("remark-wiki-link", () => { }); }); + describe("Links with special characters", () => { + test("parses a link with accent", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[link with àcèôíã]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("link with àcèôíã"); + expect(node.data?.alias).toEqual(null); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "link with àcèôíã" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "link with àcèôíã" + ); + }) + }); + + test("parses a link with dashes", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[link-with-dashes]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("link-with-dashes"); + expect(node.data?.alias).toEqual(null); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "link-with-dashes" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "link-with-dashes" + ); + }) + }); + + test("parses a link with underline", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[link_with_dashes]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("link_with_dashes"); + expect(node.data?.alias).toEqual(null); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "link_with_dashes" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "link_with_dashes" + ); + }) + }); + + test("parses a link with parenthesis", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[(link wi(th) (p)arenthesis)]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("(link wi(th) (p)arenthesis)"); + expect(node.data?.alias).toEqual(null); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "(link wi(th) (p)arenthesis)" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "(link wi(th) (p)arenthesis)" + ); + }) + }); + + test("parses a link with random symbols", () => { + const processor = createMarkdownProcessorWithWikiLinkPlugin(); + + let ast = processor.parse("[[my file !:ª%@'*º$#°~./\\]]"); + ast = processor.runSync(ast); + expect(select("wikiLink", ast)).not.toEqual(null); + + visit(ast, "wikiLink", (node: Node) => { + expect(node.data?.exists).toEqual(false); + expect(node.data?.permalink).toEqual("my file !:ª%@'*º$"); + expect(node.data?.alias).toEqual(null); + expect(node.data?.hName).toEqual("a"); + expect((node.data?.hProperties as any).className).toEqual( + "internal new" + ); + expect((node.data?.hProperties as any).href).toEqual( + "my file !:ª%@'*º$#°~./\\" + ); + expect((node.data?.hChildren as any)[0].value).toEqual( + "my file !:ª%@'*º$#°~./\\" + ); + }) + }); + }) + describe("invalid wiki links", () => { test("doesn't parse a wiki link with two missing closing brackets", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[Wiki Link"); ast = processor.runSync(ast); @@ -372,7 +546,7 @@ describe("remark-wiki-link", () => { }); test("doesn't parse a wiki link with one missing closing bracket", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[Wiki Link]"); ast = processor.runSync(ast); @@ -381,7 +555,7 @@ describe("remark-wiki-link", () => { }); test("doesn't parse a wiki link with a missing opening bracket", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("Wiki Link]]"); ast = processor.runSync(ast); @@ -390,7 +564,7 @@ describe("remark-wiki-link", () => { }); test("doesn't parse a wiki link in single brackets", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[Wiki Link]"); ast = processor.runSync(ast); @@ -434,7 +608,7 @@ describe("remark-wiki-link", () => { }); test("parses wiki links to index files", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[/some/folder/index]]"); ast = processor.runSync(ast); @@ -456,7 +630,7 @@ describe("remark-wiki-link", () => { describe("other", () => { test("parses a wiki link to some index page in a folder with no matching permalink", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[/some/folder/index]]"); ast = processor.runSync(ast); @@ -498,7 +672,7 @@ describe("remark-wiki-link", () => { }); test("parses a wiki link to home index page with no matching permalink", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("[[/index]]"); ast = processor.runSync(ast); @@ -538,7 +712,7 @@ describe("remark-wiki-link", () => { describe("transclusions", () => { test("replaces a transclusion with a regular wiki link", () => { - const processor = unified().use(markdown).use(wikiLinkPlugin); + const processor = createMarkdownProcessorWithWikiLinkPlugin(); let ast = processor.parse("![[Some Page]]"); ast = processor.runSync(ast); @@ -560,3 +734,4 @@ describe("remark-wiki-link", () => { }); }); }); +