FilesExpand file tree

main

/

mini-toc-items.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

129 lines (115 loc) · 4.59 KB

main

/

mini-toc-items.ts

Copy path

Top

File metadata and controls

• Code
• Blame

129 lines (115 loc) · 4.59 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import { describe, expect, test } from 'vitest'

import { buildMiniTocFromCollected } from '@/frame/lib/get-mini-toc-items'

import type { CollectedHeading } from '@/frame/lib/get-mini-toc-items'

function heading(slug: string, level: number, title?: string, platform = ''): CollectedHeading {

return {

href: `#${slug}`,

title: title ?? slug,

headingLevel: level,

platform,

}

}

describe('buildMiniTocFromCollected', () => {

// Mock scenario from: /en/rest/reference/activity

test('basic nested structure is created', () => {

const collected = [

heading('section-1', 2),

heading('section-1-A', 3),

heading('section-1-B', 3),

heading('section-1-C', 3),

heading('section-2', 2),

heading('section-2-A', 3),

]

const tocItems = buildMiniTocFromCollected(collected, 3)

expect(tocItems.length).toBe(2)

expect(tocItems[0].items?.length).toBe(3)

})

// /en/rest/reference/apps begins with unnested levels 3, 3, then continues 2, 3, 2, 3.

test('creates toc that starts with lower importance headers', () => {

const collected = [

heading('section-1-A', 3),

heading('section-1-B', 3),

heading('section-2', 2),

heading('section-2-A', 3),

heading('section-3', 2),

heading('section-3-A', 3),

]

const tocItems = buildMiniTocFromCollected(collected, 3)

expect(tocItems.length).toBe(4)

expect(tocItems[3].items?.length).toBe(1)

})

// Scenario from: /en/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization

test('creates empty toc', () => {

const tocItems = buildMiniTocFromCollected([], 3)

expect(tocItems.length).toBe(0)

})

// Mock scenario from: /en/repositories/creating-and-managing-repositories/about-repositories

test('creates flat toc', () => {

const collected = [heading('section-1', 2), heading('section-2', 2)]

const tocItems = buildMiniTocFromCollected(collected, 3)

expect(tocItems.length).toBe(2)

expect(tocItems[0].items).toBeUndefined()

})

test('handles deeply nested toc', () => {

const collected = [

heading('section-1', 2),

heading('section-2', 2),

heading('section-2-A', 3),

heading('section-2-A-1', 4),

heading('section-2-A-1-a', 5),

heading('section-3', 2),

]

const tocItems = buildMiniTocFromCollected(collected, 5)

expect(tocItems.length).toBe(3)

expect(tocItems[1].items?.[0].items?.[0].items?.length).toBe(1)

})

test('builds nested structure from collected headings', () => {

const collected = [

heading('s1', 2, 'Section 1'),

heading('s1a', 3, 'Section 1A'),

heading('s1b', 3, 'Section 1B'),

heading('s2', 2, 'Section 2'),

]

const tocItems = buildMiniTocFromCollected(collected, 3)

expect(tocItems.length).toBe(2)

expect(tocItems[0].contents.title).toBe('Section 1')

expect(tocItems[0].items?.length).toBe(2)

expect(tocItems[1].contents.title).toBe('Section 2')

})

test('filters by maxHeadingLevel', () => {

const collected = [heading('s1', 2, 'Section 1'), heading('s1a', 3, 'Section 1A')]

const tocItems = buildMiniTocFromCollected(collected, 2)

expect(tocItems.length).toBe(1)

expect(tocItems[0].items).toBeUndefined()

})

test('returns empty for no headings', () => {

const tocItems = buildMiniTocFromCollected([], 3)

expect(tocItems.length).toBe(0)

})

test('extracts title and href correctly', () => {

const collected = [heading('my-section', 2, 'My Section')]

const tocItems = buildMiniTocFromCollected(collected, 2)

expect(tocItems.length).toBe(1)

expect(tocItems[0].contents.title).toBe('My Section')

expect(tocItems[0].contents.href).toBe('#my-section')

})

test('preserves platform from collected data', () => {

const collected = [heading('mac-section', 2, 'Mac Section', 'ghd-tool mac')]

const tocItems = buildMiniTocFromCollected(collected, 2)

expect(tocItems.length).toBe(1)

expect(tocItems[0].platform).toBe('ghd-tool mac')

})

test('no platform when not set in collected data', () => {

const collected = [heading('plain', 2, 'Plain')]

const tocItems = buildMiniTocFromCollected(collected, 2)

expect(tocItems.length).toBe(1)

expect(tocItems[0].platform).toBeUndefined()

})

test('maxHeadingLevel=0 shows only h2 (same as default)', () => {

const collected = [heading('s1', 2, 'Section 1'), heading('s1a', 3, 'Section 1A')]

const tocItems = buildMiniTocFromCollected(collected, 0)

expect(tocItems.length).toBe(1)

expect(tocItems[0].contents.title).toBe('Section 1')

expect(tocItems[0].items).toBeUndefined()

})

})