add tests, fix markdown-style links.

This commit is contained in:
Maxime Cannoodt 2022-07-06 14:16:54 +02:00
parent d72024007e
commit e603cbc94b
8 changed files with 93 additions and 50 deletions

View File

@ -1,8 +1,9 @@
<script lang="ts"> <script lang="ts">
import FaRegQuestionCircle from 'svelte-icons/fa/FaRegQuestionCircle.svelte'; import FaRegQuestionCircle from 'svelte-icons/fa/FaRegQuestionCircle.svelte';
export let text: string; export let text: string = '';
export let displayText: string; export let displayText: string = '';
export let useSlot = false;
if (!displayText) { if (!displayText) {
const aliasMatch = text.match(/^(?:.+)\|(.*)$/); const aliasMatch = text.match(/^(?:.+)\|(.*)$/);
@ -19,7 +20,13 @@
<dfn class="not-italic" title="Internal link"> <dfn class="not-italic" title="Internal link">
<span class="underline cursor-not-allowed inline-flex items-center"> <span class="underline cursor-not-allowed inline-flex items-center">
<span class="text-[#705dcf] opacity-50">{displayText}</span> <span class="text-[#705dcf] opacity-50">
{#if useSlot}
<slot />
{:else}
{displayText}
{/if}
</span>
<span class="h-3 mb-2 text-zinc-400 ml-0.5"><FaRegQuestionCircle /></span> <span class="h-3 mb-2 text-zinc-400 ml-0.5"><FaRegQuestionCircle /></span>
</span> </span>
</dfn> </dfn>

View File

@ -1,12 +1,23 @@
<script lang="ts"> <script lang="ts">
import LinkIcon from 'svelte-icons/md/MdOpenInNew.svelte';
import InternalLink from './InternalLink.svelte';
export let href = ''; export let href = '';
export let title: string; export let title: string;
import LinkIcon from 'svelte-icons/md/MdOpenInNew.svelte'; let isWebLink = true;
$: if (href) {
if (!href.match(/^http[s]?:\/\//)) {
isWebLink = false;
}
}
</script> </script>
<!-- <a {href} {title}><slot /></a> --> {#if isWebLink}
<span class="underline cursor-not-allowed inline-flex items-center font-normal">
<span class="underline cursor-not-allowed inline-flex items-center font-normal"> <a {href} {title} class="text-[#705dcf]"><slot /></a>
<a {href} {title} class="text-[#705dcf]"><slot /></a> <span class="h-3 mb-2 text-zinc-400 ml-0.5"><LinkIcon /></span>
<span class="h-3 mb-2 text-zinc-400 ml-0.5"><LinkIcon /></span> </span>
</span> {:else}
<InternalLink useSlot><slot /></InternalLink>
{/if}

View File

@ -0,0 +1,21 @@
import { render, screen } from '@testing-library/svelte';
import { readMd } from './util';
import MarkdownRenderer from '$lib/components/MarkdownRenderer.svelte';
describe('Rendering callouts', async () => {
const plaintext = await readMd('callout.md');
it('Renders callout title correctly ', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const titleEl = await screen.findByText('Don!t forget to account for non-letters! //fsd \\n');
expect(titleEl).toBeInTheDocument();
expect(titleEl).toHaveClass('callout-title');
});
it('Renders callout content correctly ', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const contentEl = await screen.findByText('Sample text.');
expect(contentEl).toBeInTheDocument();
expect(contentEl.parentElement).toHaveClass('callout-content');
});
});

View File

@ -12,9 +12,9 @@
## Internal links (classic style) ## Internal links (classic style)
- [Classic internal link (URL encoded)](internal%20page) - [Classic internal link (URL encoded)](internal%20page)
- [Classic internal link (tag format)](<Slides Demo>) - [Classic internal link (tag format)](<Internal Page>)
## External links ## External links
- [Wikipedia](http://www.wikipedia.org) (link to the internet) - [Wikipedia (http)](http://www.wikipedia.org) (link to the internet)
- [Wikipedia](https://www.wikipedia.org) (link to the secure internet) - [Wikipedia (https)](https://www.wikipedia.org) (link to the secure internet)

View File

@ -1,9 +1,6 @@
import { readFile } from 'fs/promises';
import { join } from 'path';
import { render, screen } from '@testing-library/svelte'; import { render, screen } from '@testing-library/svelte';
import MarkdownRenderer from './MarkdownRenderer.svelte'; import { readMd } from './util';
import MarkdownRenderer from '$lib/components/MarkdownRenderer.svelte';
const TEST_FILES_DIR = 'test/markdown/';
// rendering links // rendering links
describe('rendering [[internal]] links', async () => { describe('rendering [[internal]] links', async () => {
@ -45,35 +42,3 @@ describe('rendering [[internal]] links', async () => {
expect(textEl).toBeInTheDocument(); expect(textEl).toBeInTheDocument();
}); });
}); });
describe('rendering [md style](links)', async () => {
const plaintext = await readMd('links.md');
it('Renders URL-encoded internal links correctly', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const linkEl = await screen.findByText(/^Classic internal link (URL encoded)$/);
expect(linkEl).toBeInTheDocument();
});
});
describe('Rendering callouts', async () => {
const plaintext = await readMd('callout.md');
it('Renders callout title correctly ', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const titleEl = await screen.findByText('Don!t forget to account for non-letters! //fsd \\n');
expect(titleEl).toBeInTheDocument();
expect(titleEl).toHaveClass('callout-title');
});
it('Renders callout content correctly ', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const contentEl = await screen.findByText('Sample text.');
expect(contentEl).toBeInTheDocument();
expect(contentEl.parentElement).toHaveClass('callout-content');
});
});
async function readMd(file: string) {
return await readFile(join(TEST_FILES_DIR, file), { encoding: 'utf8' });
}

View File

@ -0,0 +1,31 @@
import { render, screen } from '@testing-library/svelte';
import { readMd } from './util';
import MarkdownRenderer from '$lib/components/MarkdownRenderer.svelte';
describe('rendering [md style](links)', async () => {
const plaintext = await readMd('links.md');
it('Renders URL-encoded internal links correctly', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const linkEl = await screen.findByText(/^Classic internal link \(URL encoded\)$/);
expect(linkEl).toBeInTheDocument();
});
it('Renders URL-encoded internal links correctly', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const linkEl = await screen.findByText(/^Classic internal link \(tag format\)$/);
expect(linkEl).toBeInTheDocument();
});
it('Renders http links correctly', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const linkEl = await screen.findByText(/^Wikipedia \(http\)$/);
expect(linkEl).toBeInTheDocument();
});
it('Renders https links correctly', async () => {
render(MarkdownRenderer, { plaintext: plaintext });
const linkEl = await screen.findByText(/Wikipedia \(https\)$/);
expect(linkEl).toBeInTheDocument();
});
});

View File

@ -0,0 +1,8 @@
import { readFile } from 'fs/promises';
import { join } from 'path';
const TEST_FILES_DIR = 'src/test/markdown/input/';
export async function readMd(file: string) {
return await readFile(join(TEST_FILES_DIR, file), { encoding: 'utf8' });
}