npm - @astrojs/markdoc - Versions diffs - 0.0.4 → 0.1.0 - Mend

@astrojs/markdoc 0.0.4 → 0.1.0

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 (60) hide show

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/image-assets.test.js ADDED Viewed

@@ -0,0 +1,76 @@
+import { parseHTML } from 'linkedom';
+import { expect } from 'chai';
+import { loadFixture } from '../../../astro/test/test-utils.js';
+const root = new URL('./fixtures/image-assets/', import.meta.url);
+describe('Markdoc - Image assets', () => {
+	let baseFixture;
+	before(async () => {
+		baseFixture = await loadFixture({
+			root,
+		});
+	});
+	describe('dev', () => {
+		let devServer;
+		before(async () => {
+			devServer = await baseFixture.startDevServer();
+		});
+		after(async () => {
+			await devServer.stop();
+		});
+		it('uses public/ image paths unchanged', async () => {
+			const res = await baseFixture.fetch('/');
+			const html = await res.text();
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#public > img')?.src).to.equal('/favicon.svg');
+		});
+		it('transforms relative image paths to optimized path', async () => {
+			const res = await baseFixture.fetch('/');
+			const html = await res.text();
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#relative > img')?.src).to.equal(
+				'/_image?href=%2Fsrc%2Fassets%2Frelative%2Foar.jpg%3ForigWidth%3D420%26origHeight%3D630%26origFormat%3Djpg&f=webp'
+			);
+		});
+		it('transforms aliased image paths to optimized path', async () => {
+			const res = await baseFixture.fetch('/');
+			const html = await res.text();
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#alias > img')?.src).to.equal(
+				'/_image?href=%2Fsrc%2Fassets%2Falias%2Fcityscape.jpg%3ForigWidth%3D420%26origHeight%3D280%26origFormat%3Djpg&f=webp'
+			);
+		});
+	});
+	describe('build', () => {
+		before(async () => {
+			await baseFixture.build();
+		});
+		it('uses public/ image paths unchanged', async () => {
+			const html = await baseFixture.readFile('/index.html');
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#public > img')?.src).to.equal('/favicon.svg');
+		});
+		it('transforms relative image paths to optimized path', async () => {
+			const html = await baseFixture.readFile('/index.html');
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#relative > img')?.src).to.match(/^\/_astro\/oar.*\.webp$/);
+		});
+		it('transforms aliased image paths to optimized path', async () => {
+			const html = await baseFixture.readFile('/index.html');
+			const { document } = parseHTML(html);
+			expect(document.querySelector('#alias > img')?.src).to.match(/^\/_astro\/cityscape.*\.webp$/);
+		});
+	});
+});

package/test/render.test.js ADDED Viewed

@@ -0,0 +1,124 @@
+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();
+			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.');
+			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();
+			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!');
+			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();
+			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');
+			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');
+			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.');
+		});
+		it('renders content - with config', async () => {
+			const fixture = await getFixture('render-with-config');
+			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!');
+		});
+		it('renders content - with components', async () => {
+			const fixture = await getFixture('render-with-components');
+			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');
+		});
+	});
+});

/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