-
Notifications
You must be signed in to change notification settings - Fork 4
/
generate-wiki-summary.js
89 lines (66 loc) · 2.92 KB
/
generate-wiki-summary.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
const fs = require('fs');
const wikiFolder = process.argv[2] || './wiki'; // [2] Should be the path to the wiki folder
function log(message, level)
{
const prefix = '--'.repeat(level);
console.log(`${prefix} ${message}`);
}
function extractFolderNamesFromContentList(contentList)
{
return contentList.filter(item => !item.startsWith('.') && !item.endsWith('.md'));
}
function extractMarkdownDocsFromContentList(contentList)
{
return contentList.filter(item => item.endsWith('.md'));
}
function createFolderMap(folders)
{
return folders.reduce((folderMap, folderName) => ({ ...folderMap, [folderName]: folderName }), {});
}
// Creates a map of filename -> order index to easily pull and compare order indexes
function createMarkdownOrderMap(path)
{
const orderFile = `${path}/.order`;
const order = fs.existsSync(orderFile) ? fs.readFileSync(orderFile, 'utf8').split('\r\n') : [];
// Reduce to map object and add '.md' to filenames as that's how they will be received from the sort function
return order.reduce((map, fileName, index) => ({ ...map, [`${fileName}.md`]: index }), {});
}
function generateDirectorySummary(path, level)
{
path = path || '';
level = level || 0;
log(`🔍 Scanning ${path}...`, level);
const scannedPath = `${wikiFolder}/${path}`;
const contentList = fs.readdirSync(scannedPath);
const folders = extractFolderNamesFromContentList(contentList);
const docs = extractMarkdownDocsFromContentList(contentList);
const folderMap = createFolderMap(folders);
const order = createMarkdownOrderMap(scannedPath);
log(`📃 Found ${docs.length} .md files.`, level);
return docs.sort((doc1, doc2) => order[doc1] - order[doc2])
.map(doc =>
{
const fileName = doc.substring(0, doc.length - 3);
const description = {
title: fileName.replace(/-/g, ' '),
file : `${path}/${doc}`
};
if (folderMap[fileName])
{
log(`📂 Scanning '${fileName}' childern...`, level);
const childFolder = `${path}/${fileName}`;
description.children = generateDirectorySummary(childFolder, level + 1);
}
return description;
});
}
log('---------------------------------------------');
log('---- ⚙ Generating new summary.json file ----');
log('---------------------------------------------');
const summary = generateDirectorySummary();
const summaryFile = `${wikiFolder}/summary.json`;
log('Writing generated summary object to file...');
fs.writeFileSync(summaryFile, JSON.stringify(summary, null, 2));
log('------------------------------------------');
log('----- ✔ Generated summary.json file -----');
log('------------------------------------------');