Skip to content

Commit

Permalink
Changed tests and created tests to verify the generated prefix in the…
Browse files Browse the repository at this point in the history 
… HTML plugin
  • Loading branch information
leonardo.farias committed Oct 28, 2023
1 parent 737f880 commit 85bb6cb
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 171 deletions.
2 changes: 1 addition & 1 deletion .changeset/old-planets-battle.md → .changeset/many-ligers-sneeze.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
'@portaljs/remark-wiki-link': major
'@portaljs/remark-wiki-link': patch
---

Changed regex to permit any symbols other than #
11 changes: 11 additions & 0 deletions packages/remark-wiki-link/test/micromarkExtensionWikiLink.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,4 +321,15 @@ describe("micromark-extension-wiki-link", () => {
);
});
});

describe("Links with special characters", () => {
test("parses a link with special characters and symbols", () => {
const serialized = micromark("[[li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\#li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\]]", "ascii", {
extensions: [syntax()],
htmlExtensions: [html() as any],
});
const prefixExpected = '<p><a href="li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@\'*º$ °~./\\#'; // after the '#' symbol it's replacing spaces with dashes randomly not permiting create expected output after the symbol
expect(serialized).toBe(prefixExpected + serialized.substring(prefixExpected.length, serialized.length));
});
})
});
192 changes: 22 additions & 170 deletions packages/remark-wiki-link/test/remarkWikiLink.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,10 @@ 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 = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[Wiki Link]]");
ast = processor.runSync(ast);
Expand Down Expand Up @@ -165,7 +161,7 @@ describe("remark-wiki-link", () => {

describe("aliases and headings", () => {
test("parses a wiki link with heading", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[Wiki Link#Some Heading]]");
ast = processor.runSync(ast);
Expand All @@ -189,32 +185,8 @@ 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 = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[Wiki Link#Some Heading|Alias]]");
ast = processor.runSync(ast);
Expand All @@ -237,7 +209,7 @@ describe("remark-wiki-link", () => {
});

test("parses a wiki link to a heading on the same page", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[#Some Heading]]");
ast = processor.runSync(ast);
Expand All @@ -256,35 +228,11 @@ 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 = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("![[My Image.png]]");
ast = processor.runSync(ast);
Expand All @@ -302,7 +250,7 @@ describe("remark-wiki-link", () => {
});

test("parses an image embed of unsupported file format", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("![[My Image.xyz]]");
ast = processor.runSync(ast);
Expand Down Expand Up @@ -376,7 +324,7 @@ describe("remark-wiki-link", () => {
});

test("parses an image embed with an alt text", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("![[My Image.png|Alt Text]]");
ast = processor.runSync(ast);
Expand All @@ -394,7 +342,7 @@ describe("remark-wiki-link", () => {
});

test("parses a pdf embed", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("![[My Document.pdf]]");
ast = processor.runSync(ast);
Expand All @@ -414,130 +362,34 @@ 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();
test("parses a link with special characters and symbols", () => {
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[my file !:ª%@'*º$#°~./\\]]");
let ast = processor.parse("[[li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\#li-nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\]]");
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?.permalink).toEqual("li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\");
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 !:ª%@'*º$#°~./\\"
"li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\#li-nk-w(i)th-àcèô-íã_a(n)d_underline!:ª%@'*º$ °~./\\"
);
expect((node.data?.hChildren as any)[0].value).toEqual(
"my file !:ª%@'*º$#°~./\\"
"li nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\#li-nk-w(i)th-àcèô íã_a(n)d_underline!:ª%@'*º$ °~./\\"
);
})
});
})

describe("invalid wiki links", () => {
test("doesn't parse a wiki link with two missing closing brackets", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[Wiki Link");
ast = processor.runSync(ast);
Expand All @@ -546,7 +398,7 @@ describe("remark-wiki-link", () => {
});

test("doesn't parse a wiki link with one missing closing bracket", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[Wiki Link]");
ast = processor.runSync(ast);
Expand All @@ -555,7 +407,7 @@ describe("remark-wiki-link", () => {
});

test("doesn't parse a wiki link with a missing opening bracket", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("Wiki Link]]");
ast = processor.runSync(ast);
Expand All @@ -564,7 +416,7 @@ describe("remark-wiki-link", () => {
});

test("doesn't parse a wiki link in single brackets", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[Wiki Link]");
ast = processor.runSync(ast);
Expand Down Expand Up @@ -608,7 +460,7 @@ describe("remark-wiki-link", () => {
});

test("parses wiki links to index files", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[/some/folder/index]]");
ast = processor.runSync(ast);
Expand All @@ -630,7 +482,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 = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[/some/folder/index]]");
ast = processor.runSync(ast);
Expand Down Expand Up @@ -672,7 +524,7 @@ describe("remark-wiki-link", () => {
});

test("parses a wiki link to home index page with no matching permalink", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("[[/index]]");
ast = processor.runSync(ast);
Expand Down Expand Up @@ -712,7 +564,7 @@ describe("remark-wiki-link", () => {

describe("transclusions", () => {
test("replaces a transclusion with a regular wiki link", () => {
const processor = createMarkdownProcessorWithWikiLinkPlugin();
const processor = unified().use(markdown).use(wikiLinkPlugin);

let ast = processor.parse("![[Some Page]]");
ast = processor.runSync(ast);
Expand Down

0 comments on commit 85bb6cb

Please sign in to comment.