forked from
npmx.dev/npmx.dev
[READ-ONLY]
a fast, modern browser for the npm registry
test: add tests for parse-basic-frontmatter (#961)
authored by
James Garbutt
and committed by
GitHub
e54df82b
c8fcc6ee
+130
-25
2 changed files
shared
test
unit
shared
+22
-25
shared/utils/parse-basic-frontmatter.ts
+22
-25
shared/utils/parse-basic-frontmatter.ts
···
2
2
const match = fileContent.match(/^---\s*\n([\s\S]*?)\n---\s*(?:\n|$)/)
3
3
if (!match?.[1]) return {}
4
4
5
5
-
return match[1].split('\n').reduce(
6
6
-
(acc, line) => {
7
7
-
const idx = line.indexOf(':')
8
8
-
if (idx === -1) return acc
5
5
+
return match[1].split('\n').reduce<Record<string, unknown>>((acc, line) => {
6
6
+
const idx = line.indexOf(':')
7
7
+
if (idx === -1) return acc
9
8
10
10
-
const key = line.slice(0, idx).trim()
9
9
+
const key = line.slice(0, idx).trim()
11
10
12
12
-
// Remove surrounding quotes
13
13
-
let value = line
14
14
-
.slice(idx + 1)
15
15
-
.trim()
16
16
-
.replace(/^["']|["']$/g, '')
11
11
+
// Remove surrounding quotes
12
12
+
let value = line
13
13
+
.slice(idx + 1)
14
14
+
.trim()
15
15
+
.replace(/^["']|["']$/g, '')
17
16
18
18
-
// Type coercion (handles 123, 45.6, boolean, arrays)
19
19
-
if (value === 'true') acc[key] = true
20
20
-
else if (value === 'false') acc[key] = false
21
21
-
else if (/^-?\d+$/.test(value)) acc[key] = parseInt(value, 10)
22
22
-
else if (/^-?\d+\.\d+$/.test(value)) acc[key] = parseFloat(value)
23
23
-
else if (value.startsWith('[') && value.endsWith(']')) {
24
24
-
acc[key] = value
25
25
-
.slice(1, -1)
26
26
-
.split(',')
27
27
-
.map(s => s.trim().replace(/^["']|["']$/g, ''))
28
28
-
} else acc[key] = value
17
17
+
// Type coercion (handles 123, 45.6, boolean, arrays)
18
18
+
if (value === 'true') acc[key] = true
19
19
+
else if (value === 'false') acc[key] = false
20
20
+
else if (/^-?\d+$/.test(value)) acc[key] = parseInt(value, 10)
21
21
+
else if (/^-?\d+\.\d+$/.test(value)) acc[key] = parseFloat(value)
22
22
+
else if (value.startsWith('[') && value.endsWith(']')) {
23
23
+
acc[key] = value
24
24
+
.slice(1, -1)
25
25
+
.split(',')
26
26
+
.map(s => s.trim().replace(/^["']|["']$/g, ''))
27
27
+
} else acc[key] = value
29
28
30
30
-
return acc
31
31
-
},
32
32
-
{} as Record<string, unknown>,
33
33
-
)
29
29
+
return acc
30
30
+
}, {})
34
31
}
+108
test/unit/shared/utils/parse-basic-frontmatter.spec.ts
+108
test/unit/shared/utils/parse-basic-frontmatter.spec.ts
···
1
1
+
import { describe, expect, it } from 'vitest'
2
2
+
import { parseBasicFrontmatter } from '../../../../shared/utils/parse-basic-frontmatter'
3
3
+
4
4
+
describe('parseBasicFrontmatter', () => {
5
5
+
it('returns empty object for content without frontmatter', () => {
6
6
+
expect(parseBasicFrontmatter('just some text')).toEqual({})
7
7
+
})
8
8
+
9
9
+
it('returns empty object for empty string', () => {
10
10
+
expect(parseBasicFrontmatter('')).toEqual({})
11
11
+
})
12
12
+
13
13
+
it('returns empty object for empty frontmatter block', () => {
14
14
+
expect(parseBasicFrontmatter('---\n---\n')).toEqual({})
15
15
+
})
16
16
+
17
17
+
it('parses string values', () => {
18
18
+
const input = '---\ntitle: Hello World\nauthor: James\n---\n'
19
19
+
expect(parseBasicFrontmatter(input)).toEqual({
20
20
+
title: 'Hello World',
21
21
+
author: 'James',
22
22
+
})
23
23
+
})
24
24
+
25
25
+
it('strips surrounding quotes from values', () => {
26
26
+
const input = '---\ntitle: "Hello World"\nauthor: \'James\'\n---\n'
27
27
+
expect(parseBasicFrontmatter(input)).toEqual({
28
28
+
title: 'Hello World',
29
29
+
author: 'James',
30
30
+
})
31
31
+
})
32
32
+
33
33
+
it('parses boolean true', () => {
34
34
+
const input = '---\ndraft: true\n---\n'
35
35
+
expect(parseBasicFrontmatter(input)).toEqual({ draft: true })
36
36
+
})
37
37
+
38
38
+
it('parses boolean false', () => {
39
39
+
const input = '---\ndraft: false\n---\n'
40
40
+
expect(parseBasicFrontmatter(input)).toEqual({ draft: false })
41
41
+
})
42
42
+
43
43
+
it('parses integer values', () => {
44
44
+
const input = '---\ncount: 42\nnegative: -7\n---\n'
45
45
+
expect(parseBasicFrontmatter(input)).toEqual({ count: 42, negative: -7 })
46
46
+
})
47
47
+
48
48
+
it('parses float values', () => {
49
49
+
const input = '---\nrating: 4.5\nnegative: -3.14\n---\n'
50
50
+
expect(parseBasicFrontmatter(input)).toEqual({ rating: 4.5, negative: -3.14 })
51
51
+
})
52
52
+
53
53
+
it('parses array values', () => {
54
54
+
const input = '---\ntags: [foo, bar, baz]\n---\n'
55
55
+
expect(parseBasicFrontmatter(input)).toEqual({
56
56
+
tags: ['foo', 'bar', 'baz'],
57
57
+
})
58
58
+
})
59
59
+
60
60
+
it('strips quotes from array items', () => {
61
61
+
const input = '---\ntags: ["foo", \'bar\']\n---\n'
62
62
+
expect(parseBasicFrontmatter(input)).toEqual({
63
63
+
tags: ['foo', 'bar'],
64
64
+
})
65
65
+
})
66
66
+
67
67
+
it('does not support nested arrays', () => {
68
68
+
const input = '---\nmatrix: [[1, 2], [3, 4]]\n---\n'
69
69
+
const result = parseBasicFrontmatter(input)
70
70
+
expect(result.matrix).toEqual(['[1', '2]', '[3', '4]'])
71
71
+
})
72
72
+
73
73
+
it('handles values with colons', () => {
74
74
+
const input = '---\nurl: https://example.com\n---\n'
75
75
+
expect(parseBasicFrontmatter(input)).toEqual({
76
76
+
url: 'https://example.com',
77
77
+
})
78
78
+
})
79
79
+
80
80
+
it('skips lines without colons', () => {
81
81
+
const input = '---\ntitle: Hello\ninvalid line\nauthor: James\n---\n'
82
82
+
expect(parseBasicFrontmatter(input)).toEqual({
83
83
+
title: 'Hello',
84
84
+
author: 'James',
85
85
+
})
86
86
+
})
87
87
+
88
88
+
it('trims keys and values', () => {
89
89
+
const input = '---\n title : Hello \n---\n'
90
90
+
expect(parseBasicFrontmatter(input)).toEqual({ title: 'Hello' })
91
91
+
})
92
92
+
93
93
+
it('handles frontmatter at end of file without trailing newline', () => {
94
94
+
const input = '---\ntitle: Hello\n---'
95
95
+
expect(parseBasicFrontmatter(input)).toEqual({ title: 'Hello' })
96
96
+
})
97
97
+
98
98
+
it('handles mixed types', () => {
99
99
+
const input = '---\ntitle: My Post\ncount: 5\nrating: 9.8\npublished: true\ntags: [a, b]\n---\n'
100
100
+
expect(parseBasicFrontmatter(input)).toEqual({
101
101
+
title: 'My Post',
102
102
+
count: 5,
103
103
+
rating: 9.8,
104
104
+
published: true,
105
105
+
tags: ['a', 'b'],
106
106
+
})
107
107
+
})
108
108
+
})