Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/TorstenDittmann/svelte-mark…
Browse files Browse the repository at this point in the history 
…doc-preprocess
  • Loading branch information
@TorstenDittmann
TorstenDittmann committed Aug 31, 2023
2 parents 72990a5 + 7968cee commit 75baf10
Show file tree
Hide file tree
Showing 32 changed files with 151 additions and 325 deletions.
0 ...emo/src/routes/playground/+page.server.js → ...emo/src/routes/playground/+page.server.ts
View file
File renamed without changes.
1 change: 1 addition & 0 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/process/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"@types/html-escaper": "^3.0.0",
"@types/js-yaml": "^4.0.5",
"@types/node": "^20.4.5",
"fast-glob": "^3.3.1",
"prettier": "*",
"publint": "^0.1.16"
}
Expand Down
350 changes: 25 additions & 325 deletions packages/process/tests/processor.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { test } from 'node:test';
import fg from 'fast-glob';
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { basename, dirname, join } from 'node:path';
import { markdoc } from '../dist/module.js';
import { absoulute } from './utils.mjs';
import { absoulute, read_file } from './utils.mjs';
import { fileURLToPath } from 'node:url';

test('preprocessor', async (context) => {
const preprocess = markdoc();
Expand All @@ -10,20 +13,6 @@ test('preprocessor', async (context) => {
assert.ok(preprocess.name === 'markdoc');
assert.ok('markup' in preprocess);
});
await context.test('respects default config', async () => {
const preprocess = markdoc({
generateSchema: false,
});
assert.deepEqual(
await preprocess.markup({
content: '# Hello World',
filename: 'test.markdoc',
}),
{
code: '<article><h1>Hello World</h1></article>',
},
);
});
await context.test('ignores non-extension files', async () => {
assert.equal(
await preprocess.markup({
Expand Down Expand Up @@ -70,315 +59,26 @@ test('preprocessor', async (context) => {
},
);
});
await context.test('exports frontmatter', async () => {
const preprocess = markdoc();
const content = `---\nlorem: ipsum\n---\n# Hello World`;
assert.deepEqual(
await preprocess.markup({
content,
filename: 'test.markdoc',
}),
{
code: '<script context="module">export const frontmatter = {"lorem":"ipsum"};</script><article><h1>Hello World</h1></article>',
},
);
});
await context.test('uses tags', async () => {
const module_path = absoulute(import.meta.url, './tags/module.svelte');
const script = `<script>import * as INTERNAL__TAGS from '${module_path}';</script>`;
const preprocess = markdoc({
tags: module_path,
});
assert.deepEqual(
await preprocess.markup({
content: '{% hello %}',
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__TAGS.Hello></INTERNAL__TAGS.Hello></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% slot %}slot content{% /slot %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><p><INTERNAL__TAGS.Slot>slot content</INTERNAL__TAGS.Slot></p></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: '{% unknown %}',
filename: 'test.markdoc',
}),
{
code: `${script}<article></article>`,
},
);
});
await context.test('uses nodes', async () => {
const module_path = absoulute(import.meta.url, './nodes/module.svelte');
const script = `<script>import * as INTERNAL__NODES from '${module_path}';</script>`;
const preprocess = markdoc({
nodes: module_path,
});
assert.deepEqual(
await preprocess.markup({
content: '# Hello World',
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `## Hello World`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={2}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `# Hello World{% #my-id %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading id="my-id" level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `# Hello World{% .my-class %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading class="my-class" level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
});
await context.test('uses nodes and tags', async () => {
const nodes_module_path = absoulute(
import.meta.url,
'./nodes/module.svelte',
);
const tags_module_path = absoulute(
import.meta.url,
'./tags/module.svelte',
);
const script = `<script>import * as INTERNAL__TAGS from '${tags_module_path}';import * as INTERNAL__NODES from '${nodes_module_path}';</script>`;
const preprocess = markdoc({
nodes: nodes_module_path,
tags: tags_module_path,
});
assert.deepEqual(
await preprocess.markup({
content: '# Hello World',
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `## Hello World`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={2}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `# Hello World{% #my-id %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading id="my-id" level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `# Hello World{% .my-class %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading class="my-class" level={1}>Hello World</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: '{% hello %}',
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__TAGS.Hello></INTERNAL__TAGS.Hello></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% slot %}slot content{% /slot %}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><p><INTERNAL__TAGS.Slot>slot content</INTERNAL__TAGS.Slot></p></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: '{% unknown %}',
filename: 'test.markdoc',
}),
{
code: `${script}<article></article>`,
},
);
});
await context.test('uses partials', async () => {
const partials_module_path = absoulute(import.meta.url, './partials');
const preprocess = markdoc({
partials: partials_module_path,
});
assert.deepEqual(
await preprocess.markup({
content: '{% partial file="test.md" /%}',
filename: 'test.markdoc',
}),
{
code: `<article><h1>I am a partial</h1></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="variables.md" variables={lorem: "Lorem", ipsum: "Ipsum"} /%}`,
filename: 'test.markdoc',
}),
{
code: `<article><h1>Lorem Ipsum</h1></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="nested/file.md" /%}`,
filename: 'test.markdoc',
}),
{
code: `<article><h1>I am nested</h1></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="unknown.md" /%}`,
filename: 'test.markdoc',
}),
{
code: `<article></article>`,
},
);
});
await context.test('uses partials with nodes and tags', async () => {
const partials_module_path = absoulute(import.meta.url, './partials');
const nodes_module_path = absoulute(
import.meta.url,
'./nodes/module.svelte',
);
const tags_module_path = absoulute(
import.meta.url,
'./tags/module.svelte',
);
const script = `<script>import * as INTERNAL__TAGS from '${tags_module_path}';import * as INTERNAL__NODES from '${nodes_module_path}';</script>`;
const preprocess = markdoc({
partials: partials_module_path,
nodes: nodes_module_path,
tags: tags_module_path,
});
assert.deepEqual(
await preprocess.markup({
content: '{% partial file="test.md" /%}',
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={1}>I am a partial</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="variables.md" variables={lorem: "Lorem", ipsum: "Ipsum"} /%}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={1}>Lorem Ipsum</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="tags.md" /%}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__TAGS.Hello></INTERNAL__TAGS.Hello><INTERNAL__TAGS.Slot><p>slot content</p></INTERNAL__TAGS.Slot></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="nested/file.md" /%}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article><INTERNAL__NODES.Heading level={1}>I am nested</INTERNAL__NODES.Heading></article>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `{% partial file="unknown.md" /%}`,
filename: 'test.markdoc',
}),
{
code: `${script}<article></article>`,
},
);
});
await context.test('uses layout', async () => {
const layout_default = absoulute(
import.meta.url,
'./layouts/default.svelte',
);
const layout_named = absoulute(
import.meta.url,
'./layouts/named.svelte',
);
const preprocess = markdoc({
extensions: ['.markdoc'],
layouts: {
default: layout_default,
named: layout_named,
},
});
assert.deepEqual(
await preprocess.markup({
content: '# Hello World',
filename: 'test.markdoc',
}),
{
code: `<script>import INTERNAL__LAYOUT from '${layout_default}';</script><INTERNAL__LAYOUT><article><h1>Hello World</h1></article></INTERNAL__LAYOUT>`,
},
);
assert.deepEqual(
await preprocess.markup({
content: `---
layout: named
---

# Hello World`,
filename: 'test.markdoc',
}),
{
code: `<script context="module">export const frontmatter = {"layout":"named"};</script><script>import INTERNAL__LAYOUT from '${layout_named}';</script><INTERNAL__LAYOUT {...frontmatter}><article><h1>Hello World</h1></article></INTERNAL__LAYOUT>`,
},
);
const stream = fg.globStream(absoulute(import.meta.url, './processor/**'), {
onlyDirectories: true,
});
const current_dir = dirname(fileURLToPath(import.meta.url));
for await (const entry of stream) {
await context.test('tests ' + basename(entry), async () => {
const before = await read_file(join(entry, 'source.markdoc'));
const after = await read_file(join(entry, 'compiled.txt'));
const preprocess = await import(join(entry, 'config.mjs')).then(
(m) => m.default,
);
const markup = await preprocess.markup({
content: before,
filename: 'test.markdoc',
});
assert.equal(
markup.code,
after.replaceAll('__PATH__', current_dir),
);
});
}
});
1 change: 1 addition & 0 deletions packages/process/tests/processor/default config merge/compiled.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<article><h1>Hello World</h1></article>
5 changes: 5 additions & 0 deletions packages/process/tests/processor/default config merge/config.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { markdoc } from '../../../dist/module.js';

export default markdoc({
generateSchema: false,
});
1 change: 1 addition & 0 deletions packages/process/tests/processor/default config merge/source.markdoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Hello World
Loading

0 comments on commit 75baf10

Please sign in to comment.