summaryrefslogtreecommitdiff
path: root/packages/markdown/remark/test/frontmatter.test.js
blob: 336245106d1e885e7ff63f8928e9ec40fb78c441 (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
import assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { extractFrontmatter, parseFrontmatter } from '../dist/index.js';

const bom = '\uFEFF';

describe('extractFrontmatter', () => {
	it('handles YAML', () => {
		const yaml = `\nfoo: bar\n`;
		assert.equal(extractFrontmatter(`---${yaml}---`), yaml);
		assert.equal(extractFrontmatter(`${bom}---${yaml}---`), yaml);
		assert.equal(extractFrontmatter(`\n---${yaml}---`), yaml);
		assert.equal(extractFrontmatter(`\n  \n---${yaml}---`), yaml);
		assert.equal(extractFrontmatter(`---${yaml}---\ncontent`), yaml);
		assert.equal(extractFrontmatter(`${bom}---${yaml}---\ncontent`), yaml);
		assert.equal(extractFrontmatter(`\n\n---${yaml}---\n\ncontent`), yaml);
		assert.equal(extractFrontmatter(`\n  \n---${yaml}---\n\ncontent`), yaml);
		assert.equal(extractFrontmatter(` ---${yaml}---`), undefined);
		assert.equal(extractFrontmatter(`---${yaml} ---`), undefined);
		assert.equal(extractFrontmatter(`text\n---${yaml}---\n\ncontent`), undefined);
	});

	it('handles TOML', () => {
		const toml = `\nfoo = "bar"\n`;
		assert.equal(extractFrontmatter(`+++${toml}+++`), toml);
		assert.equal(extractFrontmatter(`${bom}+++${toml}+++`), toml);
		assert.equal(extractFrontmatter(`\n+++${toml}+++`), toml);
		assert.equal(extractFrontmatter(`\n  \n+++${toml}+++`), toml);
		assert.equal(extractFrontmatter(`+++${toml}+++\ncontent`), toml);
		assert.equal(extractFrontmatter(`${bom}+++${toml}+++\ncontent`), toml);
		assert.equal(extractFrontmatter(`\n\n+++${toml}+++\n\ncontent`), toml);
		assert.equal(extractFrontmatter(`\n  \n+++${toml}+++\n\ncontent`), toml);
		assert.equal(extractFrontmatter(` +++${toml}+++`), undefined);
		assert.equal(extractFrontmatter(`+++${toml} +++`), undefined);
		assert.equal(extractFrontmatter(`text\n+++${toml}+++\n\ncontent`), undefined);
	});
});

describe('parseFrontmatter', () => {
	it('works for YAML', () => {
		const yaml = `\nfoo: bar\n`;
		assert.deepEqual(parseFrontmatter(`---${yaml}---`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '',
		});
		assert.deepEqual(parseFrontmatter(`${bom}---${yaml}---`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: bom,
		});
		assert.deepEqual(parseFrontmatter(`\n---${yaml}---`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '\n',
		});
		assert.deepEqual(parseFrontmatter(`\n  \n---${yaml}---`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '\n  \n',
		});
		assert.deepEqual(parseFrontmatter(`---${yaml}---\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '\ncontent',
		});
		assert.deepEqual(parseFrontmatter(`${bom}---${yaml}---\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: `${bom}\ncontent`,
		});
		assert.deepEqual(parseFrontmatter(`\n\n---${yaml}---\n\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '\n\n\n\ncontent',
		});
		assert.deepEqual(parseFrontmatter(`\n  \n---${yaml}---\n\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: yaml,
			content: '\n  \n\n\ncontent',
		});
		assert.deepEqual(parseFrontmatter(` ---${yaml}---`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: ` ---${yaml}---`,
		});
		assert.deepEqual(parseFrontmatter(`---${yaml} ---`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: `---${yaml} ---`,
		});
		assert.deepEqual(parseFrontmatter(`text\n---${yaml}---\n\ncontent`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: `text\n---${yaml}---\n\ncontent`,
		});
	});

	it('works for TOML', () => {
		const toml = `\nfoo = "bar"\n`;
		assert.deepEqual(parseFrontmatter(`+++${toml}+++`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '',
		});
		assert.deepEqual(parseFrontmatter(`${bom}+++${toml}+++`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: bom,
		});
		assert.deepEqual(parseFrontmatter(`\n+++${toml}+++`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '\n',
		});
		assert.deepEqual(parseFrontmatter(`\n  \n+++${toml}+++`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '\n  \n',
		});
		assert.deepEqual(parseFrontmatter(`+++${toml}+++\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '\ncontent',
		});
		assert.deepEqual(parseFrontmatter(`${bom}+++${toml}+++\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: `${bom}\ncontent`,
		});
		assert.deepEqual(parseFrontmatter(`\n\n+++${toml}+++\n\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '\n\n\n\ncontent',
		});
		assert.deepEqual(parseFrontmatter(`\n  \n+++${toml}+++\n\ncontent`), {
			frontmatter: { foo: 'bar' },
			rawFrontmatter: toml,
			content: '\n  \n\n\ncontent',
		});
		assert.deepEqual(parseFrontmatter(` +++${toml}+++`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: ` +++${toml}+++`,
		});
		assert.deepEqual(parseFrontmatter(`+++${toml} +++`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: `+++${toml} +++`,
		});
		assert.deepEqual(parseFrontmatter(`text\n+++${toml}+++\n\ncontent`), {
			frontmatter: {},
			rawFrontmatter: '',
			content: `text\n+++${toml}+++\n\ncontent`,
		});
	});

	it('frontmatter style for YAML', () => {
		const yaml = `\nfoo: bar\n`;
		const parse1 = (style) => parseFrontmatter(`---${yaml}---`, { frontmatter: style }).content;
		assert.deepEqual(parse1('preserve'), `---${yaml}---`);
		assert.deepEqual(parse1('remove'), '');
		assert.deepEqual(parse1('empty-with-spaces'), `   \n        \n   `);
		assert.deepEqual(parse1('empty-with-lines'), `\n\n`);

		const parse2 = (style) =>
			parseFrontmatter(`\n  \n---${yaml}---\n\ncontent`, { frontmatter: style }).content;
		assert.deepEqual(parse2('preserve'), `\n  \n---${yaml}---\n\ncontent`);
		assert.deepEqual(parse2('remove'), '\n  \n\n\ncontent');
		assert.deepEqual(parse2('empty-with-spaces'), `\n  \n   \n        \n   \n\ncontent`);
		assert.deepEqual(parse2('empty-with-lines'), `\n  \n\n\n\n\ncontent`);
	});

	it('frontmatter style for TOML', () => {
		const toml = `\nfoo = "bar"\n`;
		const parse1 = (style) => parseFrontmatter(`+++${toml}+++`, { frontmatter: style }).content;
		assert.deepEqual(parse1('preserve'), `+++${toml}+++`);
		assert.deepEqual(parse1('remove'), '');
		assert.deepEqual(parse1('empty-with-spaces'), `   \n           \n   `);
		assert.deepEqual(parse1('empty-with-lines'), `\n\n`);

		const parse2 = (style) =>
			parseFrontmatter(`\n  \n+++${toml}+++\n\ncontent`, { frontmatter: style }).content;
		assert.deepEqual(parse2('preserve'), `\n  \n+++${toml}+++\n\ncontent`);
		assert.deepEqual(parse2('remove'), '\n  \n\n\ncontent');
		assert.deepEqual(parse2('empty-with-spaces'), `\n  \n   \n           \n   \n\ncontent`);
		assert.deepEqual(parse2('empty-with-lines'), `\n  \n\n\n\n\ncontent`);
	});
});