🆕 Add mystToHtml as a simple wrapper function (#234)

* 📦 Add rehype-stringify

.changeset/nasty-deers-rescue.md

@@ -0,0 +1,5 @@
+---
+'myst-to-html': patch
+---
+
+Add rehype-stringify as a dependency

.changeset/neat-ducks-do.md

@@ -0,0 +1,5 @@
+---
+'myst-to-html': patch
+---
+
+Add mystToHtml utility

packages/myst-parser/tests/commonmark.spec.ts

@@ -10,7 +10,7 @@
 import fs from 'fs';
 import path from 'path';
 import { createTokenizer, mystParse } from '../src';
-import { renderMdast } from './renderMdast';
+import { mystToHtml } from 'myst-to-html';
 
 type Spec = {
   section: string;
@@ -81,7 +81,7 @@ describe('Common Mark Spec with unified', () => {
         frontmatter: false, // Frontmatter screws with some tests!
       },
     });
-    const output = renderMdast(tree, {
+    const output = mystToHtml(tree, {
       formatHtml: false,
       hast: {
         clobberPrefix: 'm-',

packages/myst-parser/tests/myst.spec.ts

@@ -4,7 +4,7 @@ import yaml from 'js-yaml';
 import { visit } from 'unist-util-visit';
 import type { Root } from 'mdast';
 import { mystParse } from '../src';
-import { renderMdast } from './renderMdast';
+import { mystToHtml } from 'myst-to-html';
 
 type TestFile = {
   cases: TestCase[];
@@ -112,7 +112,7 @@ describe('Testing mdast --> html conversions', () => {
   test.each(htmlCases)('%s', (name, { html, mdast }) => {
     if (html) {
       if (name.includes('cmark_spec_0.30')) {
-        const output = renderMdast(mdast, {
+        const output = mystToHtml(mdast, {
           formatHtml: false,
           hast: {
             clobberPrefix: 'm-',
@@ -138,7 +138,7 @@ describe('Testing mdast --> html conversions', () => {
 
         expect(normalize(o)).toEqual(normalize(i));
       } else {
-        const newHTML = renderMdast(mdast, {
+        const newHTML = mystToHtml(mdast, {
           formatHtml: true,
           hast: {
             clobberPrefix: 'm-',

packages/myst-to-html/README.md

@@ -1,3 +1,11 @@
 # myst-to-html
 
 Convert a MyST AST to HTML.
+
+```typescript
+import { u } from 'unist-builder';
+import { mystToHtml } from 'myst-to-html';
+
+const html = mystToHtml(u('root', [u('paragraph', [u('text', 'hello world')])]));
+// '<p>hello world</p>'
+```

packages/myst-to-html/package.json

@@ -57,6 +57,7 @@
     "rehype-format": "^4.0.1",
     "rehype-parse": "^8.0.4",
     "rehype-remark": "^9.1.2",
+    "rehype-stringify": "^9.0.3",
     "unified": "^10.1.2",
     "unist-builder": "^3.0.1",
     "unist-util-find-after": "^4.0.0"

packages/myst-to-html/src/index.ts

@@ -3,3 +3,4 @@ export { addMathRenderers, renderMath } from './renderer';
 export { mystToHast } from './schema';
 export { State } from './state';
 export { transform } from './transforms';
+export { mystToHtml } from './renderMdast';

packages/myst-to-html/src/renderMdast.ts

@@ -0,0 +1,32 @@
+import type { Root } from 'mdast';
+import rehypeStringify from 'rehype-stringify';
+import { unified } from 'unified';
+import { formatHtml } from './format';
+import { mystToHast } from './schema';
+import { State } from './state';
+import { transform } from './transforms';
+
+export function mystToHtml(
+  tree: Root,
+  opts?: {
+    formatHtml?: boolean;
+    hast?: {
+      clobberPrefix?: 'm-';
+      allowDangerousHtml?: boolean;
+    };
+    stringifyHtml?: {
+      closeSelfClosing?: boolean;
+      allowDangerousHtml?: boolean;
+    };
+  },
+) {
+  const state = new State();
+  const pipe = unified()
+    .use(transform, state)
+    .use(mystToHast, opts?.hast)
+    .use(formatHtml, opts?.formatHtml)
+    .use(rehypeStringify, opts?.stringifyHtml);
+  const result = pipe.runSync(tree);
+  const html = pipe.stringify(result);
+  return html.trim();
+}

packages/myst-to-html/tests/html.spec.ts

@@ -0,0 +1,9 @@
+import { u } from 'unist-builder';
+import { mystToHtml } from '../src';
+
+describe('mystToHtml', () => {
+  it('Converts a tag schema to a string', () => {
+    const html = mystToHtml(u('root', [u('paragraph', [u('text', 'hello world')])]));
+    expect(html).toBe('<p>hello world</p>');
+  });
+});