npm - @astrojs/markdoc - Versions diffs - 0.0.5 → 0.1.1 - Mend

@astrojs/markdoc 0.0.5 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

package/test/fixtures/content-collections/package.json CHANGED Viewed

@@ -4,10 +4,6 @@
   "private": true,
   "dependencies": {
     "@astrojs/markdoc": "workspace:*",
-    "@markdoc/markdoc": "^0.2.2",
     "astro": "workspace:*"
-  },
-  "devDependencies": {
-    "shiki": "^0.11.1"
   }
 }

package/test/fixtures/content-collections/src/content/blog/post-1.mdoc ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: Post 1
+---
+## Post 1
+This is the contents of post 1.

package/test/fixtures/content-collections/src/content/blog/post-2.mdoc ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: Post 2
+---
+## Post 2
+This is the contents of post 2.

package/test/fixtures/content-collections/src/content/blog/post-3.mdoc ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: Post 3
+---
+## Post 3
+This is the contents of post 3.

package/test/fixtures/content-collections/src/pages/entry.json.js CHANGED Viewed

@@ -3,7 +3,7 @@ import { stringify } from 'devalue';
 import { stripRenderFn } from '../../utils.js';
 export async function get() {
-	const post = await getEntryBySlug('blog', 'simple');
+	const post = await getEntryBySlug('blog', 'post-1');
 	return {
 		body: stringify(stripRenderFn(post)),
 	};

package/test/fixtures/render-null/astro.config.mjs ADDED Viewed

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-null/markdoc.config.mjs ADDED Viewed

@@ -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 },
+			},
+		}
+	}
+})

package/test/fixtures/render-null/node_modules/.bin/astro ADDED Viewed

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/render-null/package.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "name": "@test/markdoc-render-null",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/render-null/src/content/blog/render-null.mdoc ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: Post with render null
+---
+## Post with render null
+This should render the contents inside a fragment!

package/test/fixtures/render-null/src/pages/index.astro ADDED Viewed

@@ -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>

package/test/fixtures/render-simple/astro.config.mjs ADDED Viewed

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-simple/node_modules/.bin/astro ADDED Viewed

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/render-simple/package.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "name": "@test/markdoc-render-simple",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/{content-collections/src/pages/content-simple.astro → render-simple/src/pages/index.astro} RENAMED Viewed

@@ -1,5 +1,6 @@
 ---
 import { getEntryBySlug } from "astro:content";
 const post = await getEntryBySlug('blog', 'simple');
 const { Content } = await post.render();
 ---
@@ -10,7 +11,7 @@ const { Content } = await post.render();
 	<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 - Simple</title>
+	<title>Content</title>
 </head>
 <body>
 	<Content />

package/test/fixtures/render-with-components/astro.config.mjs ADDED Viewed

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-with-components/markdoc.config.mjs ADDED Viewed

@@ -0,0 +1,28 @@
+import Code from './src/components/Code.astro';
+import CustomMarquee from './src/components/CustomMarquee.astro';
+import { defineMarkdocConfig } from '@astrojs/markdoc/config';
+export default defineMarkdocConfig({
+	nodes: {
+		fence: {
+			render: Code,
+			attributes: {
+				language: { type: String },
+				content: { type: String },
+			},
+		},
+	},
+	tags: {
+		mq: {
+			render: CustomMarquee,
+			attributes: {
+				direction: {
+					type: String,
+					default: 'left',
+					matches: ['left', 'right', 'up', 'down'],
+					errorLevel: 'critical',
+				},
+			},
+		},
+	},
+})

package/test/fixtures/render-with-components/node_modules/.bin/astro ADDED Viewed

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/render-with-components/package.json ADDED Viewed

@@ -0,0 +1,12 @@
+{
+  "name": "@test/markdoc-render-with-components",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  },
+  "devDependencies": {
+    "shiki": "^0.11.1"
+  }
+}

package/test/fixtures/{content-collections/src/pages/content-with-components.astro → render-with-components/src/pages/index.astro} RENAMED Viewed

@@ -1,7 +1,5 @@
 ---
 import { getEntryBySlug } from "astro:content";
-import Code from '../components/Code.astro';
-import CustomMarquee from '../components/CustomMarquee.astro';
 const post = await getEntryBySlug('blog', 'with-components');
 const { Content } = await post.render();
@@ -13,11 +11,9 @@ const { Content } = await post.render();
 	<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 - with components</title>
+	<title>Content</title>
 </head>
 <body>
-	<Content
-		components={{ CustomMarquee, Code }}
-	/>
+	<Content />
 </body>
 </html>

package/test/fixtures/render-with-config/astro.config.mjs ADDED Viewed

@@ -0,0 +1,7 @@
+import { defineConfig } from 'astro/config';
+import markdoc from '@astrojs/markdoc';
+// https://astro.build/config
+export default defineConfig({
+	integrations: [markdoc()],
+});

package/test/fixtures/render-with-config/markdoc.config.mjs ADDED Viewed

@@ -0,0 +1,15 @@
+import { defineMarkdocConfig } from '@astrojs/markdoc/config';
+export default defineMarkdocConfig({
+	variables: {
+		countries: ['ES', 'JP'],
+	},
+	functions: {
+		includes: {
+			transform(parameters) {
+				const [array, value] = Object.values(parameters);
+				return Array.isArray(array) ? array.includes(value) : false;
+			},
+		},
+	},
+})

package/test/fixtures/render-with-config/node_modules/.bin/astro ADDED Viewed

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="$NODE_PATH:/home/runner/work/astro/astro/node_modules/.pnpm/node_modules"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../../../../../../../astro/astro.js" "$@"
+else
+  exec node  "$basedir/../../../../../../../astro/astro.js" "$@"
+fi

package/test/fixtures/render-with-config/package.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "name": "@test/markdoc-render-with-config",
+  "version": "0.0.0",
+  "private": true,
+  "dependencies": {
+    "@astrojs/markdoc": "workspace:*",
+    "astro": "workspace:*"
+  }
+}

package/test/fixtures/{content-collections → render-with-config}/src/content/blog/with-config.mdoc RENAMED Viewed

@@ -7,3 +7,7 @@ title: Post with config
 {% if includes($countries, "EN") %} Hello {% /if %}
 {% if includes($countries, "ES") %} Hola {% /if %}
 {% if includes($countries, "JP") %} Konnichiwa {% /if %}
+## Runtime variables
+{% $runtimeVariable %} {% #runtime-variable %}

package/test/fixtures/{content-collections/src/pages/content-with-config.astro → render-with-config/src/pages/index.astro} RENAMED Viewed

@@ -11,9 +11,9 @@ const { Content } = await post.render();
 	<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 - with config</title>
+	<title>Content</title>
 </head>
 <body>
-	<Content />
+	<Content runtimeVariable="working!" />
 </body>
 </html>

package/test/render.test.js ADDED Viewed

@@ -0,0 +1,150 @@
+import { parseHTML } from 'linkedom';
+import { expect } from 'chai';
+import { loadFixture } from '../../../astro/test/test-utils.js';
+async function getFixture(name) {
+	return await loadFixture({
+		root: new URL(`./fixtures/${name}/`, import.meta.url),
+	});
+}
+describe('Markdoc - render', () => {
+	describe('dev', () => {
+		it('renders content - simple', async () => {
+			const fixture = await getFixture('render-simple');
+			const server = await fixture.startDevServer();
+			const res = await fixture.fetch('/');
+			const html = await res.text();
+			renderSimpleChecks(html);
+			await server.stop();
+		});
+		it('renders content - with config', async () => {
+			const fixture = await getFixture('render-with-config');
+			const server = await fixture.startDevServer();
+			const res = await fixture.fetch('/');
+			const html = await res.text();
+			renderConfigChecks(html);
+			await server.stop();
+		});
+		it('renders content - with components', async () => {
+			const fixture = await getFixture('render-with-components');
+			const server = await fixture.startDevServer();
+			const res = await fixture.fetch('/');
+			const html = await res.text();
+			renderComponentsChecks(html);
+			await server.stop();
+		});
+		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();
+		});
+	});
+	describe('build', () => {
+		it('renders content - simple', async () => {
+			const fixture = await getFixture('render-simple');
+			await fixture.build();
+			const html = await fixture.readFile('/index.html');
+			renderSimpleChecks(html);
+		});
+		it('renders content - with config', async () => {
+			const fixture = await getFixture('render-with-config');
+			await fixture.build();
+			const html = await fixture.readFile('/index.html');
+			renderConfigChecks(html);
+		});
+		it('renders content - with components', async () => {
+			const fixture = await getFixture('render-with-components');
+			await fixture.build();
+			const html = await fixture.readFile('/index.html');
+			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.');
+}

/package/test/fixtures/{content-collections → render-simple}/src/content/blog/simple.mdoc RENAMED Viewed

File without changes

/package/test/fixtures/{content-collections → render-with-components}/src/components/Code.astro RENAMED Viewed

File without changes

/package/test/fixtures/{content-collections → render-with-components}/src/components/CustomMarquee.astro RENAMED Viewed

File without changes

/package/test/fixtures/{content-collections → render-with-components}/src/content/blog/with-components.mdoc RENAMED Viewed

File without changes