@astrojs/mdx 0.14.0 → 0.15.0-beta.1

package/test/mdx-plugins.test.js

@@ -36,6 +36,19 @@ describe('MDX plugins', () => {
 		expect(selectGfmLink(document)).to.not.be.null;
 	});
 
+	it('Applies SmartyPants by default', async () => {
+		const fixture = await buildFixture({
+			integrations: [mdx()],
+		});
+
+		const html = await fixture.readFile(FILE);
+		const { document } = parseHTML(html);
+
+		const quote = selectSmartypantsQuote(document);
+		expect(quote).to.not.be.null;
+		expect(quote.textContent).to.contain('“Smartypants” is — awesome');
+	});
+
 	it('supports custom rehype plugins', async () => {
 		const fixture = await buildFixture({
 			integrations: [
@@ -80,91 +93,75 @@ describe('MDX plugins', () => {
 		expect(selectTocLink(document)).to.be.null;
 	});
 
-	it('respects "extendDefaultPlugins" when extending markdown', async () => {
-		const fixture = await buildFixture({
-			markdown: {
-				remarkPlugins: [remarkExamplePlugin],
-				rehypePlugins: [rehypeExamplePlugin],
-				extendDefaultPlugins: true,
-			},
-			integrations: [mdx()],
-		});
-
-		const html = await fixture.readFile(FILE);
-		const { document } = parseHTML(html);
-
-		expect(selectRemarkExample(document)).to.not.be.null;
-		expect(selectRehypeExample(document)).to.not.be.null;
-		expect(selectGfmLink(document)).to.not.be.null;
-	});
-
-	it('extends markdown config with extendPlugins: "markdown"', async () => {
-		const fixture = await buildFixture({
-			markdown: {
-				remarkPlugins: [remarkExamplePlugin],
-				rehypePlugins: [rehypeExamplePlugin],
-			},
-			integrations: [
-				mdx({
-					extendPlugins: 'markdown',
-					remarkPlugins: [remarkToc],
-				}),
-			],
+	for (const extendMarkdownConfig of [true, false]) {
+		describe(`extendMarkdownConfig = ${extendMarkdownConfig}`, () => {
+			let fixture;
+			before(async () => {
+				fixture = await buildFixture({
+					markdown: {
+						remarkPlugins: [remarkToc],
+						gfm: false,
+						smartypants: false,
+					},
+					integrations: [
+						mdx({
+							extendMarkdownConfig,
+							remarkPlugins: [remarkExamplePlugin],
+							rehypePlugins: [rehypeExamplePlugin],
+						}),
+					],
+				});
+			});
+
+			it('Handles MDX plugins', async () => {
+				const html = await fixture.readFile(FILE);
+				const { document } = parseHTML(html);
+
+				expect(selectRemarkExample(document, 'MDX remark plugins not applied.')).to.not.be.null;
+				expect(selectRehypeExample(document, 'MDX rehype plugins not applied.')).to.not.be.null;
+			});
+
+			it('Handles Markdown plugins', async () => {
+				const html = await fixture.readFile(FILE);
+				const { document } = parseHTML(html);
+
+				expect(
+					selectTocLink(
+						document,
+						'`remarkToc` plugin applied unexpectedly. Should override Markdown config.'
+					)
+				).to.be.null;
+			});
+
+			it('Handles gfm', async () => {
+				const html = await fixture.readFile(FILE);
+				const { document } = parseHTML(html);
+
+				if (extendMarkdownConfig === true) {
+					expect(selectGfmLink(document), 'Does not respect `markdown.gfm` option.').to.be.null;
+				} else {
+					expect(selectGfmLink(document), 'Respects `markdown.gfm` unexpectedly.').to.not.be.null;
+				}
+			});
+
+			it('Handles smartypants', async () => {
+				const html = await fixture.readFile(FILE);
+				const { document } = parseHTML(html);
+
+				const quote = selectSmartypantsQuote(document);
+
+				if (extendMarkdownConfig === true) {
+					expect(quote.textContent, 'Does not respect `markdown.smartypants` option.').to.contain(
+						'"Smartypants" is -- awesome'
+					);
+				} else {
+					expect(quote.textContent, 'Respects `markdown.smartypants` unexpectedly.').to.contain(
+						'“Smartypants” is — awesome'
+					);
+				}
+			});
 		});
-
-		const html = await fixture.readFile(FILE);
-		const { document } = parseHTML(html);
-
-		expect(selectRemarkExample(document)).to.not.be.null;
-		expect(selectRehypeExample(document)).to.not.be.null;
-		expect(selectTocLink(document)).to.not.be.null;
-	});
-
-	it('extends default plugins with extendPlugins: "astroDefaults"', async () => {
-		const fixture = await buildFixture({
-			markdown: {
-				// should NOT be applied to MDX
-				remarkPlugins: [remarkToc],
-			},
-			integrations: [
-				mdx({
-					remarkPlugins: [remarkExamplePlugin],
-					rehypePlugins: [rehypeExamplePlugin],
-					extendPlugins: 'astroDefaults',
-				}),
-			],
-		});
-
-		const html = await fixture.readFile(FILE);
-		const { document } = parseHTML(html);
-
-		expect(selectGfmLink(document)).to.not.be.null;
-		// remark and rehype plugins still respected
-		expect(selectRemarkExample(document)).to.not.be.null;
-		expect(selectRehypeExample(document)).to.not.be.null;
-		// Does NOT inherit TOC from markdown config
-		expect(selectTocLink(document)).to.be.null;
-	});
-
-	it('does not extend default plugins with extendPlugins: false', async () => {
-		const fixture = await buildFixture({
-			markdown: {
-				remarkPlugins: [remarkExamplePlugin],
-			},
-			integrations: [
-				mdx({
-					remarkPlugins: [],
-					extendPlugins: false,
-				}),
-			],
-		});
-
-		const html = await fixture.readFile(FILE);
-		const { document } = parseHTML(html);
-
-		expect(selectGfmLink(document)).to.be.null;
-		expect(selectRemarkExample(document)).to.be.null;
-	});
+	}
 
 	it('supports custom recma plugins', async () => {
 		const fixture = await buildFixture({
@@ -236,6 +233,10 @@ function selectGfmLink(document) {
 	return document.querySelector('a[href="https://handle-me-gfm.com"]');
 }
 
+function selectSmartypantsQuote(document) {
+	return document.querySelector('blockquote');
+}
+
 function selectRemarkExample(document) {
 	return document.querySelector('div[data-remark-plugin-works]');
 }

package/test/mdx-syntax-highlighting.test.js

@@ -67,6 +67,32 @@ describe('MDX syntax highlighting', () => {
 			const prismCodeBlock = document.querySelector('pre.language-astro');
 			expect(prismCodeBlock).to.not.be.null;
 		});
+
+		for (const extendMarkdownConfig of [true, false]) {
+			it(`respects syntaxHighlight when extendMarkdownConfig = ${extendMarkdownConfig}`, async () => {
+				const fixture = await loadFixture({
+					root: FIXTURE_ROOT,
+					markdown: {
+						syntaxHighlight: 'shiki',
+					},
+					integrations: [
+						mdx({
+							extendMarkdownConfig,
+							syntaxHighlight: 'prism',
+						}),
+					],
+				});
+				await fixture.build();
+
+				const html = await fixture.readFile('/index.html');
+				const { document } = parseHTML(html);
+
+				const shikiCodeBlock = document.querySelector('pre.astro-code');
+				expect(shikiCodeBlock, 'Markdown config syntaxHighlight used unexpectedly').to.be.null;
+				const prismCodeBlock = document.querySelector('pre.language-astro');
+				expect(prismCodeBlock).to.not.be.null;
+			});
+		}
 	});
 
 	it('supports custom highlighter - shiki-twoslash', async () => {

package/test/fixtures/mdx-frontmatter-injection/src/pages/with-overrides.mdx

@@ -1,7 +0,0 @@
----
-title: 'Overridden title'
-injectedReadingTime: 
-  text: '1000 min read'
----
-
-# Working!