summaryrefslogtreecommitdiff
path: root/packages/integrations/markdoc/test
diff options
context:
space:
mode:
authorGravatar Ben Holmes <hey@bholmes.dev> 2023-04-03 11:27:51 -0400
committerGravatar GitHub <noreply@github.com> 2023-04-03 11:27:51 -0400
commit73fcc7627e27a001d3ed2f4d046999d91f1aef85 (patch)
treeadffd143bcf3374bd9d6262a2543347a9d32ecd5 /packages/integrations/markdoc/test
parentad80d830a2bfcb460f5ab19568382d40074e6e56 (diff)
downloadastro-73fcc7627e27a001d3ed2f4d046999d91f1aef85.tar.gz
astro-73fcc7627e27a001d3ed2f4d046999d91f1aef85.tar.zst
astro-73fcc7627e27a001d3ed2f4d046999d91f1aef85.zip
[Markdoc] Fix: Support `render: null` (#6723)
* fix: handle array of tree nodes * test: render null in document node * chore: lock * refactor: consolidate render test logic * chore: changeset
Diffstat (limited to 'packages/integrations/markdoc/test')
-rw-r--r--packages/integrations/markdoc/test/fixtures/render-null/astro.config.mjs7
-rw-r--r--packages/integrations/markdoc/test/fixtures/render-null/markdoc.config.mjs26
-rw-r--r--packages/integrations/markdoc/test/fixtures/render-null/package.json9
-rw-r--r--packages/integrations/markdoc/test/fixtures/render-null/src/content/blog/render-null.mdoc7
-rw-r--r--packages/integrations/markdoc/test/fixtures/render-null/src/pages/index.astro19
-rw-r--r--packages/integrations/markdoc/test/render.test.js134
6 files changed, 148 insertions, 54 deletions
diff --git a/packages/integrations/markdoc/test/fixtures/render-null/astro.config.mjs b/packages/integrations/markdoc/test/fixtures/render-null/astro.config.mjs
new file mode 100644
index 000000000..29d846359
--- /dev/null
+++ b/packages/integrations/markdoc/test/fixtures/render-null/astro.config.mjs
@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+ integrations: [markdoc()],
+});
diff --git a/packages/integrations/markdoc/test/fixtures/render-null/markdoc.config.mjs b/packages/integrations/markdoc/test/fixtures/render-null/markdoc.config.mjs
new file mode 100644
index 000000000..2f87f6de0
--- /dev/null
+++ b/packages/integrations/markdoc/test/fixtures/render-null/markdoc.config.mjs
@@ -0,0 +1,26 @@
+import { defineMarkdocConfig } from '@astrojs/markdoc/config';
+
+export default defineMarkdocConfig({
+ nodes: {
+ document: {
+ render: null,
+
+ // Defaults from `Markdoc.nodes.document`
+ children: [
+ 'heading',
+ 'paragraph',
+ 'image',
+ 'table',
+ 'tag',
+ 'fence',
+ 'blockquote',
+ 'comment',
+ 'list',
+ 'hr',
+ ],
+ attributes: {
+ frontmatter: { render: false },
+ },
+ }
+ }
+})
diff --git a/packages/integrations/markdoc/test/fixtures/render-null/package.json b/packages/integrations/markdoc/test/fixtures/render-null/package.json
new file mode 100644
index 000000000..e9529b693
--- /dev/null
+++ b/packages/integrations/markdoc/test/fixtures/render-null/package.json
@@ -0,0 +1,9 @@
+{
+ "name": "@test/markdoc-render-null",
+ "version": "0.0.0",
+ "private": true,
+ "dependencies": {
+ "@astrojs/markdoc": "workspace:*",
+ "astro": "workspace:*"
+ }
+}
diff --git a/packages/integrations/markdoc/test/fixtures/render-null/src/content/blog/render-null.mdoc b/packages/integrations/markdoc/test/fixtures/render-null/src/content/blog/render-null.mdoc
new file mode 100644
index 000000000..7b7b193cb
--- /dev/null
+++ b/packages/integrations/markdoc/test/fixtures/render-null/src/content/blog/render-null.mdoc
@@ -0,0 +1,7 @@
+---
+title: Post with render null
+---
+
+## Post with render null
+
+This should render the contents inside a fragment!
diff --git a/packages/integrations/markdoc/test/fixtures/render-null/src/pages/index.astro b/packages/integrations/markdoc/test/fixtures/render-null/src/pages/index.astro
new file mode 100644
index 000000000..ed8417c5b
--- /dev/null
+++ b/packages/integrations/markdoc/test/fixtures/render-null/src/pages/index.astro
@@ -0,0 +1,19 @@
+---
+import { getEntryBySlug } from "astro:content";
+
+const post = await getEntryBySlug('blog', 'render-null');
+const { Content } = await post.render();
+---
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Content</title>
+</head>
+<body>
+ <Content />
+</body>
+</html>
diff --git a/packages/integrations/markdoc/test/render.test.js b/packages/integrations/markdoc/test/render.test.js
index acb17577b..48d13a759 100644
--- a/packages/integrations/markdoc/test/render.test.js
+++ b/packages/integrations/markdoc/test/render.test.js
@@ -16,11 +16,8 @@ describe('Markdoc - render', () => {
const res = await fixture.fetch('/');
const html = await res.text();
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Simple post');
- const p = document.querySelector('p');
- expect(p.textContent).to.equal('This is a simple Markdoc post.');
+
+ renderSimpleChecks(html);
await server.stop();
});
@@ -31,17 +28,8 @@ describe('Markdoc - render', () => {
const res = await fixture.fetch('/');
const html = await res.text();
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Post with config');
- const textContent = html;
-
- expect(textContent).to.not.include('Hello');
- expect(textContent).to.include('Hola');
- expect(textContent).to.include(`Konnichiwa`);
- const runtimeVariable = document.querySelector('#runtime-variable');
- expect(runtimeVariable?.textContent?.trim()).to.equal('working!');
+ renderConfigChecks(html);
await server.stop();
});
@@ -52,19 +40,20 @@ describe('Markdoc - render', () => {
const res = await fixture.fetch('/');
const html = await res.text();
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Post with components');
- // Renders custom shortcode component
- const marquee = document.querySelector('marquee');
- expect(marquee).to.not.be.null;
- expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
+ renderComponentsChecks(html);
+
+ await server.stop();
+ });
- // Renders Astro Code component
- const pre = document.querySelector('pre');
- expect(pre).to.not.be.null;
- expect(pre.className).to.equal('astro-code');
+ it('renders content - with `render: null` in document', async () => {
+ const fixture = await getFixture('render-null');
+ const server = await fixture.startDevServer();
+
+ const res = await fixture.fetch('/');
+ const html = await res.text();
+
+ renderNullChecks(html);
await server.stop();
});
@@ -76,11 +65,8 @@ describe('Markdoc - render', () => {
await fixture.build();
const html = await fixture.readFile('/index.html');
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Simple post');
- const p = document.querySelector('p');
- expect(p.textContent).to.equal('This is a simple Markdoc post.');
+
+ renderSimpleChecks(html);
});
it('renders content - with config', async () => {
@@ -88,17 +74,8 @@ describe('Markdoc - render', () => {
await fixture.build();
const html = await fixture.readFile('/index.html');
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Post with config');
- const textContent = html;
-
- expect(textContent).to.not.include('Hello');
- expect(textContent).to.include('Hola');
- expect(textContent).to.include(`Konnichiwa`);
- const runtimeVariable = document.querySelector('#runtime-variable');
- expect(runtimeVariable?.textContent?.trim()).to.equal('working!');
+ renderConfigChecks(html);
});
it('renders content - with components', async () => {
@@ -106,19 +83,68 @@ describe('Markdoc - render', () => {
await fixture.build();
const html = await fixture.readFile('/index.html');
- const { document } = parseHTML(html);
- const h2 = document.querySelector('h2');
- expect(h2.textContent).to.equal('Post with components');
-
- // Renders custom shortcode component
- const marquee = document.querySelector('marquee');
- expect(marquee).to.not.be.null;
- expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
-
- // Renders Astro Code component
- const pre = document.querySelector('pre');
- expect(pre).to.not.be.null;
- expect(pre.className).to.equal('astro-code');
+
+ renderComponentsChecks(html);
+ });
+
+ it('renders content - with `render: null` in document', async () => {
+ const fixture = await getFixture('render-null');
+ await fixture.build();
+
+ const html = await fixture.readFile('/index.html');
+
+ renderNullChecks(html);
});
});
});
+
+/**
+ * @param {string} html
+ */
+function renderNullChecks(html) {
+ const { document } = parseHTML(html);
+ const h2 = document.querySelector('h2');
+ expect(h2.textContent).to.equal('Post with render null');
+ expect(h2.parentElement?.tagName).to.equal('BODY');
+}
+
+/** @param {string} html */
+function renderComponentsChecks(html) {
+ const { document } = parseHTML(html);
+ const h2 = document.querySelector('h2');
+ expect(h2.textContent).to.equal('Post with components');
+
+ // Renders custom shortcode component
+ const marquee = document.querySelector('marquee');
+ expect(marquee).to.not.be.null;
+ expect(marquee.hasAttribute('data-custom-marquee')).to.equal(true);
+
+ // Renders Astro Code component
+ const pre = document.querySelector('pre');
+ expect(pre).to.not.be.null;
+ expect(pre.className).to.equal('astro-code');
+}
+
+/** @param {string} html */
+function renderConfigChecks(html) {
+ const { document } = parseHTML(html);
+ const h2 = document.querySelector('h2');
+ expect(h2.textContent).to.equal('Post with config');
+ const textContent = html;
+
+ expect(textContent).to.not.include('Hello');
+ expect(textContent).to.include('Hola');
+ expect(textContent).to.include(`Konnichiwa`);
+
+ const runtimeVariable = document.querySelector('#runtime-variable');
+ expect(runtimeVariable?.textContent?.trim()).to.equal('working!');
+}
+
+/** @param {string} html */
+function renderSimpleChecks(html) {
+ const { document } = parseHTML(html);
+ const h2 = document.querySelector('h2');
+ expect(h2.textContent).to.equal('Simple post');
+ const p = document.querySelector('p');
+ expect(p.textContent).to.equal('This is a simple Markdoc post.');
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-06 20:32:59 +0000