forked from grafana/k6-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gatsby-node.js
367 lines (334 loc) · 10.1 KB
/
gatsby-node.js
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
const utils = require('./src/utils/utils');
const Path = require('path');
// auxilary flag to determine the environment (staging/prod)
const isProduction = process.env.GATSBY_DEFAULT_MAIN_URL === 'https://k6.io';
exports.onCreateWebpackConfig = ({ getConfig, actions, stage, loaders }) => {
const { replaceWebpackConfig, setWebpackConfig } = actions;
const existingConfig = getConfig();
const PRODUCTION = stage !== 'develop';
const isSSR = stage.includes('html');
const rules = existingConfig.module.rules
// .filter(
// rule =>
// // Remove default url loader for fonts
// String(rule.test) !== String(/\.(eot|otf|ttf|woff(2)?)(\?.*)?$/),
// )
.map((rule) => {
if (
String(rule.test) ===
String(/\.(ico|svg|jpg|jpeg|png|gif|webp)(\?.*)?$/)
) {
return { ...rule, test: /\.(ico|jpg|jpeg|png|gif|webp)(\?.*)?$/ };
}
return rule;
});
replaceWebpackConfig({
...existingConfig,
module: {
...existingConfig.module,
rules,
},
});
const sassLoader = {
loader: 'sass-loader',
options: {
sourceMap: !PRODUCTION,
implementation: require('sass'),
},
};
const sassResourcesLoader = {
loader: 'sass-resources-loader',
options: {
resources: [
`${__dirname}/src/styles/variables.scss`,
`${__dirname}/src/styles/mixins.scss`,
],
},
};
const sassRuleModules = {
test: /\.module\.s(a|c)ss$/,
use: [
!isSSR && loaders.miniCssExtract({ hmr: false }),
loaders.css({
localIdentName: '[local]_[hash:base64:5]',
modules: true,
importLoaders: 2,
}),
loaders.postcss(),
sassLoader,
sassResourcesLoader,
].filter(Boolean),
};
const sassRule = {
test: /\.s(a|c)ss$/,
use: isSSR
? [loaders.null()]
: [
loaders.miniCssExtract(),
loaders.css({ importLoaders: 2 }),
loaders.postcss(),
sassLoader,
sassResourcesLoader,
],
};
const inlineSvgRule = {
test: /\.inline.svg$/,
use: [
{
loader: require.resolve('@svgr/webpack'),
options: {
svgoConfig: {
removeViewBox: false,
cleanupIDs: {
prefix: {
toString() {
this.counter = this.counter || 0;
return `id-${this.counter++}`;
},
},
},
},
},
},
],
issuer: {
test: /\.(js|jsx|ts|tsx)$/,
},
};
const svgRule = {
test: /\.svg$/,
use: [loaders.url()],
issuer: {
test: /\.(js|jsx|ts|tsx)$/,
},
};
const nonJsSVGRule = {
test: /\.svg$/,
use: [loaders.url()],
issuer: {
test: /\.(?!(js|jsx|ts|tsx)$)([^.]+$)/,
},
};
let configRules = [];
switch (stage) {
case 'develop':
case 'build-javascript':
case 'build-html':
case 'develop-html':
configRules = configRules.concat([
{ oneOf: [sassRuleModules, sassRule] },
{ oneOf: [inlineSvgRule, svgRule, nonJsSVGRule] },
]);
break;
}
setWebpackConfig({
module: {
rules: configRules,
},
});
};
async function createDocPages({ graphql, actions, pathPrefix }) {
/*
* custom path processing rules
*/
// guides category is the root: / or /docs in prod, so we removing that part
const removeGuides = (path) => path.replace(/guides\//, '');
// examples page contains `examples` folder which causing path
// duplication, removing it as well
const dedupeExamples = (path) =>
path.replace(/examples\/examples/, 'examples');
// no /guides route; welcome is redirecting to the root path
// difference from removeGuides: this one is for sidebar links processing and
// the former is for creatingPages
const removeGuidesAndRedirectWelcome = (path) =>
path.replace(/guides\/(getting-started\/welcome)?/, '');
// ensures that no trailing slash is left
const noTrailingSlash = (path) =>
path === '/' ? '/' : path.replace(/(.+)\/$/, '$1');
const { data } = await graphql(`
query docPagesQuery {
allFile(
filter: { ext: { eq: ".md" }, relativeDirectory: { regex: "/docs/" } }
sort: { fields: absolutePath, order: ASC }
) {
nodes {
name
relativeDirectory
children {
... on MarkdownRemark {
html
frontmatter {
title
excerpt
redirect
hideFromSidebar
draft
}
}
}
}
}
}
`);
// Build a tree for a sidebar
const sidebarTreeBuilder = utils.buildFileTree(utils.buildFileTreeNode);
data.allFile.nodes.forEach((file) => {
const { name, relativeDirectory, children } = file;
const {
frontmatter: { title, redirect, hideFromSidebar, draft },
} = children[0];
// skip altogether if this content has draft flag
// OR hideFromSidebar
if ((draft === 'true' && isProduction) || hideFromSidebar) return;
const path = utils.slugify(
`/${utils.stripDirectoryPath(relativeDirectory, 'docs')}/${title.replace(
/\//g,
'-',
)}`,
);
// titles like k6/html treated like paths otherwise
sidebarTreeBuilder.addNode(
utils.unorderify(utils.stripDirectoryPath(relativeDirectory, 'docs')),
utils.unorderify(name),
{
path: utils.compose(
noTrailingSlash,
dedupeExamples,
removeGuidesAndRedirectWelcome,
utils.unorderify,
)(path),
title,
redirect,
},
);
});
// tree representation of a data/markdown/docs folder
const sidebar = sidebarTreeBuilder.getTree();
// local helper function that uses carrying, expects one more arg
const getSidebar = utils.getChildSidebar(sidebar);
const docPageNav = Object.keys(sidebar.children);
// create data for rendering docs navigation
const docPageNavLinks = docPageNav
.map((item) => ({
label: item === 'cloud' ? 'Cloud Docs' : item.toUpperCase(),
to: item === 'guides' ? `/` : `/${utils.slugify(item)}`,
}))
.filter(Boolean);
// creating actual docs pages
data.allFile.nodes.forEach((file) => {
const { relativeDirectory, children, name } = file;
const strippedDirectory = utils.stripDirectoryPath(
relativeDirectory,
'docs',
);
const remarkNode = children[0];
const { title, redirect, draft } = remarkNode.frontmatter;
// if there is value in redirect field, skip page creation
// OR there is draft flag and mode is prod
if ((draft === 'true' && isProduction) || redirect) return;
const path = utils.slugify(
`${strippedDirectory}/${title.replace(/\//g, '-')}`,
);
const breadcrumbs = utils.compose(
utils.buildBreadcrumbs,
removeGuides,
utils.unorderify,
)(path);
// injecting the slug, replacing guides with nothing cuz its real path is /doc
remarkNode.frontmatter.slug = utils.compose(
noTrailingSlash,
dedupeExamples,
removeGuides,
utils.unorderify,
)(path);
// injection of a link to an article in git repo
remarkNode.frontmatter.fileOrigin = encodeURI(
`https://github.com/loadimpact/k6-docs/blob/master/src/data/${relativeDirectory}/${name}.md`,
);
actions.createPage({
path: utils.compose(dedupeExamples, removeGuides, utils.unorderify)(path),
component: Path.resolve('./src/templates/doc-page.js'),
context: {
remarkNode,
// dynamically evalute which part of the sidebar tree are going to be used
sidebarTree: utils.compose(
getSidebar,
utils.getDocSection,
utils.unorderify,
)(strippedDirectory),
breadcrumbs,
navLinks: docPageNavLinks,
},
});
});
// generating pages currently presented in templates/docs/ folder
[...docPageNav].forEach((item) => {
const slug = utils.slugify(item);
actions.createPage({
path: slug === 'guides' ? `/` : `/${slug}`,
component: Path.resolve(`./src/templates/docs/${slug}.js`),
context: {
sidebarTree: getSidebar(item),
navLinks: docPageNavLinks,
},
});
});
// generating a bunch of breadcrumbs stubs for top level non-links categories
// ! attention: filtering here because of unplanned case with actual pages for top level sidebar sections. Removing breadcrumbs stub generation manually.
[...docPageNav]
.filter((s) => s !== 'javascript api')
.forEach((section) => {
utils.childrenToList(getSidebar(section).children).forEach(({ name }) => {
const path = utils.compose(
removeGuides,
utils.slugify,
)(`${section}/${name}`);
const breadcrumbs = utils.buildBreadcrumbs(path);
actions.createPage({
path: noTrailingSlash(path),
component: Path.resolve('./src/templates/docs/breadcrumb-stub.js'),
context: {
sidebarTree: getSidebar(section),
breadcrumbs,
title: name,
navLinks: docPageNavLinks,
directChildren: getSidebar(section).children[name].children,
},
});
});
});
}
const createRedirects = ({ actions, pathPrefix }) => {
actions.createRedirect({
fromPath: `${pathPrefix}/getting-started/welcome`,
toPath: pathPrefix ? pathPrefix : `/`,
redirectInBrowser: true,
isPermanent: true,
});
};
exports.createPages = async (options) => {
await createDocPages(options);
await createRedirects(options);
};
exports.onCreateNode = ({ node, getNode, actions }) => {
const { createNodeField } = actions;
// Adding default values for some fields and moving them under node.fields
// because that how createNodeField works
if (node.frontmatter) {
createNodeField({
node,
name: 'redirect',
value: node.frontmatter.redirect || '',
});
createNodeField({
node,
name: 'hideFromSidebar',
value: node.frontmatter.hideFromSidebar || false,
});
createNodeField({
node,
name: 'draft',
value: node.frontmatter.draft || 'false',
});
}
};