summaryrefslogtreecommitdiff
path: root/packages/integrations/mdx/test/mdx-syntax-highlighting.test.js
blob: 662c1a0cdc0f3e6a9b9004dc730c9439c32e0baa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
import mdx from '@astrojs/mdx';

import * as assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { parseHTML } from 'linkedom';
import rehypePrettyCode from 'rehype-pretty-code';
import shikiTwoslash from 'remark-shiki-twoslash';
import { loadFixture } from '../../../astro/test/test-utils.js';

const FIXTURE_ROOT = new URL('./fixtures/mdx-syntax-hightlighting/', import.meta.url);

describe('MDX syntax highlighting', () => {
	describe('shiki', () => {
		it('works', async () => {
			const fixture = await loadFixture({
				root: FIXTURE_ROOT,
				markdown: {
					syntaxHighlight: 'shiki',
				},
				integrations: [mdx()],
			});
			await fixture.build();

			const html = await fixture.readFile('/index.html');
			const { document } = parseHTML(html);

			const shikiCodeBlock = document.querySelector('pre.astro-code');
			assert.notEqual(shikiCodeBlock, null);
			assert.equal(shikiCodeBlock.getAttribute('style').includes('background-color:#24292e'), true);
		});

		it('respects markdown.shikiConfig.theme', async () => {
			const fixture = await loadFixture({
				root: FIXTURE_ROOT,
				markdown: {
					syntaxHighlight: 'shiki',
					shikiConfig: {
						theme: 'dracula',
					},
				},
				integrations: [mdx()],
			});
			await fixture.build();

			const html = await fixture.readFile('/index.html');
			const { document } = parseHTML(html);

			const shikiCodeBlock = document.querySelector('pre.astro-code');
			assert.notEqual(shikiCodeBlock, null);
			assert.equal(shikiCodeBlock.getAttribute('style').includes('background-color:#282A36'), true);
		});
	});

	describe('prism', () => {
		it('works', async () => {
			const fixture = await loadFixture({
				root: FIXTURE_ROOT,
				markdown: {
					syntaxHighlight: 'prism',
				},
				integrations: [mdx()],
			});
			await fixture.build();

			const html = await fixture.readFile('/index.html');
			const { document } = parseHTML(html);

			const prismCodeBlock = document.querySelector('pre.language-astro');
			assert.notEqual(prismCodeBlock, 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');
				assert.equal(shikiCodeBlock, null, 'Markdown config syntaxHighlight used unexpectedly');
				const prismCodeBlock = document.querySelector('pre.language-astro');
				assert.notEqual(prismCodeBlock, null);
			});
		}
	});

	it('supports custom highlighter - shiki-twoslash', async () => {
		const fixture = await loadFixture({
			root: FIXTURE_ROOT,
			markdown: {
				syntaxHighlight: false,
			},
			integrations: [
				mdx({
					remarkPlugins: [shikiTwoslash.default ?? shikiTwoslash],
				}),
			],
		});
		await fixture.build();

		const html = await fixture.readFile('/index.html');
		const { document } = parseHTML(html);

		const twoslashCodeBlock = document.querySelector('pre.shiki');
		assert.notEqual(twoslashCodeBlock, null);
	});

	it('supports custom highlighter - rehype-pretty-code', async () => {
		const fixture = await loadFixture({
			root: FIXTURE_ROOT,
			markdown: {
				syntaxHighlight: false,
			},
			integrations: [
				mdx({
					rehypePlugins: [
						[
							rehypePrettyCode,
							{
								onVisitHighlightedLine(node) {
									node.properties.style = 'background-color:#000000';
								},
							},
						],
					],
				}),
			],
		});
		await fixture.build();

		const html = await fixture.readFile('/index.html');
		assert.equal(html.includes('style="background-color:#000000"'), true);
	});
});