@astrojs/mdx 0.11.1 → 0.11.3

package/test/mdx-vite-env-vars.test.js

@@ -0,0 +1,54 @@
+import { expect } from 'chai';
+import { parseHTML } from 'linkedom';
+import { loadFixture } from '../../../astro/test/test-utils.js';
+
+describe('MDX - Vite env vars', () => {
+	let fixture;
+	before(async () => {
+		fixture = await loadFixture({
+			root: new URL('./fixtures/mdx-vite-env-vars/', import.meta.url),
+		});
+		await fixture.build();
+	});
+
+	it('Avoids transforming `import.meta.env` outside JSX expressions', async () => {
+		const html = await fixture.readFile('/vite-env-vars/index.html');
+		const { document } = parseHTML(html);
+
+		expect(document.querySelector('h1')?.innerHTML).to.contain('import.meta.env.SITE');
+		expect(document.querySelector('code')?.innerHTML).to.contain('import.meta.env.SITE');
+		expect(document.querySelector('pre')?.innerHTML).to.contain('import.meta.env.SITE');
+	});
+	it('Allows referencing `import.meta.env` in frontmatter', async () => {
+		const { title = '' } = JSON.parse(await fixture.readFile('/frontmatter.json'));
+		expect(title).to.contain('import.meta.env.SITE');
+	});
+	it('Transforms `import.meta.env` in {JSX expressions}', async () => {
+		const html = await fixture.readFile('/vite-env-vars/index.html');
+		const { document } = parseHTML(html);
+
+		expect(document.querySelector('[data-env-site]')?.innerHTML).to.contain(
+			'https://mdx-is-neat.com/blog/cool-post'
+		);
+	});
+	it('Transforms `import.meta.env` in variable exports', async () => {
+		const html = await fixture.readFile('/vite-env-vars/index.html');
+		const { document } = parseHTML(html);
+
+		expect(document.querySelector('[data-env-variable-exports]')?.innerHTML).to.contain(
+			'MODE works'
+		);
+	});
+	it('Transforms `import.meta.env` in HTML attributes', async () => {
+		const html = await fixture.readFile('/vite-env-vars/index.html');
+		const { document } = parseHTML(html);
+
+		const dataAttrDump = document.querySelector('[data-env-dump]');
+		expect(dataAttrDump).to.not.be.null;
+
+		expect(dataAttrDump.getAttribute('data-env-prod')).to.not.be.null;
+		expect(dataAttrDump.getAttribute('data-env-dev')).to.be.null;
+		expect(dataAttrDump.getAttribute('data-env-base-url')).to.equal('/');
+		expect(dataAttrDump.getAttribute('data-env-mode')).to.equal('production');
+	});
+});

package/dist/astro-data-utils.d.ts

@@ -1,9 +0,0 @@
-import type { MarkdownAstroData } from 'astro';
-import type { Data, VFile } from 'vfile';
-export declare function remarkInitializeAstroData(): (tree: any, vfile: VFile) => void;
-export declare function rehypeApplyFrontmatterExport(pageFrontmatter: Record<string, any>): (tree: any, vfile: VFile) => void;
-/**
- * Copied from markdown utils
- * @see "vite-plugin-utils"
- */
-export declare function safelyGetAstroData(vfileData: Data): MarkdownAstroData;

package/dist/astro-data-utils.js

@@ -1,86 +0,0 @@
-import { jsToTreeNode } from "./utils.js";
-function remarkInitializeAstroData() {
-  return function(tree, vfile) {
-    if (!vfile.data.astro) {
-      vfile.data.astro = { frontmatter: {} };
-    }
-  };
-}
-const EXPORT_NAME = "frontmatter";
-function rehypeApplyFrontmatterExport(pageFrontmatter) {
-  return function(tree, vfile) {
-    const { frontmatter: injectedFrontmatter } = safelyGetAstroData(vfile.data);
-    const frontmatter = { ...injectedFrontmatter, ...pageFrontmatter };
-    const exportNodes = [
-      jsToTreeNode(`export const ${EXPORT_NAME} = ${JSON.stringify(frontmatter)};`)
-    ];
-    if (frontmatter.layout) {
-      exportNodes.unshift(
-        jsToTreeNode(
-          `import { jsx as layoutJsx } from 'astro/jsx-runtime';
-				
-				export default async function ({ children }) {
-					const Layout = (await import(${JSON.stringify(frontmatter.layout)})).default;
-					const { layout, ...content } = frontmatter;
-					content.file = file;
-					content.url = url;
-					content.astro = {};
-					Object.defineProperty(content.astro, 'headings', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "headings" from your layout, try using "Astro.props.headings."')
-						}
-					});
-					Object.defineProperty(content.astro, 'html', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "html" from your layout, try using "Astro.props.compiledContent()."')
-						}
-					});
-					Object.defineProperty(content.astro, 'source', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "source" from your layout, try using "Astro.props.rawContent()."')
-						}
-					});
-					return layoutJsx(Layout, {
-						file,
-						url,
-						content,
-						frontmatter: content,
-						headings: getHeadings(),
-						'server:root': true,
-						children,
-					});
-				};`
-        )
-      );
-    }
-    tree.children = exportNodes.concat(tree.children);
-  };
-}
-function isValidAstroData(obj) {
-  if (typeof obj === "object" && obj !== null && obj.hasOwnProperty("frontmatter")) {
-    const { frontmatter } = obj;
-    try {
-      JSON.stringify(frontmatter);
-    } catch {
-      return false;
-    }
-    return typeof frontmatter === "object" && frontmatter !== null;
-  }
-  return false;
-}
-function safelyGetAstroData(vfileData) {
-  const { astro } = vfileData;
-  if (!astro)
-    return { frontmatter: {} };
-  if (!isValidAstroData(astro)) {
-    throw Error(
-      `[MDX] A remark or rehype plugin tried to add invalid frontmatter. Ensure "astro.frontmatter" is a JSON object!`
-    );
-  }
-  return astro;
-}
-export {
-  rehypeApplyFrontmatterExport,
-  remarkInitializeAstroData,
-  safelyGetAstroData
-};

package/src/astro-data-utils.ts

@@ -1,103 +0,0 @@
-import type { MarkdownAstroData } from 'astro';
-import type { Data, VFile } from 'vfile';
-import { jsToTreeNode } from './utils.js';
-
-export function remarkInitializeAstroData() {
-	return function (tree: any, vfile: VFile) {
-		if (!vfile.data.astro) {
-			vfile.data.astro = { frontmatter: {} };
-		}
-	};
-}
-
-const EXPORT_NAME = 'frontmatter';
-
-export function rehypeApplyFrontmatterExport(pageFrontmatter: Record<string, any>) {
-	return function (tree: any, vfile: VFile) {
-		const { frontmatter: injectedFrontmatter } = safelyGetAstroData(vfile.data);
-		const frontmatter = { ...injectedFrontmatter, ...pageFrontmatter };
-		const exportNodes = [
-			jsToTreeNode(`export const ${EXPORT_NAME} = ${JSON.stringify(frontmatter)};`),
-		];
-		if (frontmatter.layout) {
-			// NOTE(bholmesdev) 08-22-2022
-			// Using an async layout import (i.e. `const Layout = (await import...)`)
-			// Preserves the dev server import cache when globbing a large set of MDX files
-			// Full explanation: 'https://github.com/withastro/astro/pull/4428'
-			exportNodes.unshift(
-				jsToTreeNode(
-					/** @see 'vite-plugin-markdown' for layout props reference */
-					`import { jsx as layoutJsx } from 'astro/jsx-runtime';
-				
-				export default async function ({ children }) {
-					const Layout = (await import(${JSON.stringify(frontmatter.layout)})).default;
-					const { layout, ...content } = frontmatter;
-					content.file = file;
-					content.url = url;
-					content.astro = {};
-					Object.defineProperty(content.astro, 'headings', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "headings" from your layout, try using "Astro.props.headings."')
-						}
-					});
-					Object.defineProperty(content.astro, 'html', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "html" from your layout, try using "Astro.props.compiledContent()."')
-						}
-					});
-					Object.defineProperty(content.astro, 'source', {
-						get() {
-							throw new Error('The "astro" property is no longer supported! To access "source" from your layout, try using "Astro.props.rawContent()."')
-						}
-					});
-					return layoutJsx(Layout, {
-						file,
-						url,
-						content,
-						frontmatter: content,
-						headings: getHeadings(),
-						'server:root': true,
-						children,
-					});
-				};`
-				)
-			);
-		}
-		tree.children = exportNodes.concat(tree.children);
-	};
-}
-
-/**
- * Copied from markdown utils
- * @see "vite-plugin-utils"
- */
-function isValidAstroData(obj: unknown): obj is MarkdownAstroData {
-	if (typeof obj === 'object' && obj !== null && obj.hasOwnProperty('frontmatter')) {
-		const { frontmatter } = obj as any;
-		try {
-			// ensure frontmatter is JSON-serializable
-			JSON.stringify(frontmatter);
-		} catch {
-			return false;
-		}
-		return typeof frontmatter === 'object' && frontmatter !== null;
-	}
-	return false;
-}
-
-/**
- * Copied from markdown utils
- * @see "vite-plugin-utils"
- */
-export function safelyGetAstroData(vfileData: Data): MarkdownAstroData {
-	const { astro } = vfileData;
-
-	if (!astro) return { frontmatter: {} };
-	if (!isValidAstroData(astro)) {
-		throw Error(
-			`[MDX] A remark or rehype plugin tried to add invalid frontmatter. Ensure "astro.frontmatter" is a JSON object!`
-		);
-	}
-
-	return astro;
-}