-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Expand file tree
/
Copy pathgeneratePageMDX.js
More file actions
236 lines (187 loc) · 5.49 KB
/
generatePageMDX.js
File metadata and controls
236 lines (187 loc) · 5.49 KB
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
const config = require('../docusaurus.config');
const { baseUrl, customFields } = config;
function renderBadge(annotation) {
const [annotType, ...annotLabel] = annotation.split(' ');
// eslint-disable-next-line prettier/prettier
return `<span class="badge badge-${annotType.replace('@', '')} "><span class="badge-text">${annotLabel.join(' ')}</span></span>`;
}
function generateKnownIssues(componentName) {
const componentKnownIssues = customFields.knownIssues[componentName];
if (!componentKnownIssues) {
return `<span />`;
}
const issues = Object.entries(componentKnownIssues)
.map(([key, value]) => {
return `
<li key="${key}">
<a href="${value}">${key}</a>
</li>
`;
})
.join('');
return `
## Known Issues
<details>
<ul>
${issues}
</ul>
</details>
`;
}
function generateMoreExamples(componentName) {
const componentMoreExamples = customFields.moreExamples[componentName];
if (!componentMoreExamples) {
return `<span />`;
}
const links = Object.entries(componentMoreExamples)
.map(([key, value]) => {
return `
<li key="${key}">
<a href="${value}">${key}</a>
</li>
`;
})
.join('');
return `
## More Examples
<details>
<summary>Toggle to grab more examples</summary>
<ul>
${links}
</ul>
</details>
`;
}
function generateThemeColors(componentName, themeColorsData) {
if (!themeColorsData) {
return `<span />`;
}
return `
## Theme colors
<ThemeColorsTable themeColorsData={${themeColorsData}} componentName="${componentName}" />
`;
}
function generateScreenshots(componentName, screenshotData) {
if (!screenshotData) {
return `<span />`;
}
return `
<ScreenshotTabs screenshotData={${screenshotData}} baseUrl="${baseUrl}"/>
`;
}
function generatePropsTable(data, link, extendsAttributes) {
const ANNOTATION_OPTIONAL = '@optional';
const ANNOTATION_INTERNAL = '@internal';
const props = Object.entries(data)
.map(([prop, value]) => {
if (!value.description) {
value.description = '';
}
// Remove @optional annotations from descriptions.
if (value.description.includes(ANNOTATION_OPTIONAL)) {
value.description = value.description.replace(ANNOTATION_OPTIONAL, '');
}
// Hide props with @internal annotations.
if (value.description.includes(ANNOTATION_INTERNAL)) {
return;
}
let leadingBadge = '';
let descriptionByLines = value.description?.split('\n');
// Find leading badge and put it next after prop name.
if (descriptionByLines?.[0].includes('@')) {
leadingBadge = descriptionByLines[0];
}
return `
<div>
### ${prop} ${value.required ? '(required)' : ''} ${
leadingBadge && renderBadge(leadingBadge)
}
</div>
<PropTable componentLink="${link}" prop="${prop}" />
`;
})
.join('');
return `
## Props
${
extendsAttributes.length === 0
? `<span />`
: `### ${extendsAttributes?.[0]?.name}`
}
${extendsAttributes
.map((attr) => {
return `<ExtendsLink name="${attr.name}" link="${attr.link}" />`;
})
.join('')}
${props}
`;
}
function generateExtendsAttributes(doc) {
const ANNOTATION_EXTENDS = '@extends';
const extendsAttributes = [];
doc?.description
.split('\n')
.filter((line) => {
if (line.startsWith(ANNOTATION_EXTENDS)) {
const parts = line.split(' ').slice(1);
const link = parts.pop();
extendsAttributes.push({
name: parts.join(' '),
link,
});
return false;
}
return true;
})
.join('\n');
return extendsAttributes;
}
function generateExtendedExamples(usage, extendedExamplesData) {
if (!extendedExamplesData) {
return usage;
}
const data = JSON.parse(extendedExamplesData);
const exampleHeader = Object.keys(data)[0];
return `
${usage}
### ${exampleHeader}
<ExtendedExample extendedExamplesData={${extendedExamplesData}} />
`;
}
function generatePageMDX(doc, link) {
const summaryRegex = /([\s\S]*?)## Usage/;
const description = doc.description
.replace(/<\/br>/g, '')
.replace(/style="[a-zA-Z0-9:;.\s()\-,]*"/gi, '')
.replace(/src="screenshots/g, `src="${baseUrl}screenshots`)
.replace(/@extends.+$/, '');
const summary = summaryRegex.exec(description)
? summaryRegex.exec(description)[1]
: '';
const usage = description.replace(summary, '');
const themeColorsData = JSON.stringify(customFields.themeColors[doc.title]);
const screenshotData = JSON.stringify(customFields.screenshots[doc.title]);
const extendedExamplesData = JSON.stringify(
customFields.extendedExamples[doc.title]
);
const extendsAttributes = generateExtendsAttributes(doc);
const mdx = `
---
title: ${doc.title}
---
import PropTable from '@site/src/components/PropTable.tsx';
import ExtendsLink from '@site/src/components/ExtendsLink.tsx';
import ThemeColorsTable from '@site/src/components/ThemeColorsTable.tsx';
import ScreenshotTabs from '@site/src/components/ScreenshotTabs.tsx';
import ExtendedExample from '@site/src/components/ExtendedExample.tsx';
${summary}
${generateScreenshots(doc.title, screenshotData)}
${generateExtendedExamples(usage, extendedExamplesData)}
${generatePropsTable(doc.data.props, link, extendsAttributes)}
${generateMoreExamples(doc.title)}
${generateThemeColors(doc.title, themeColorsData)}
${generateKnownIssues(doc.title)}
`;
return mdx.slice(1);
}
module.exports = generatePageMDX;