83 lines
4.0 KiB
JavaScript
83 lines
4.0 KiB
JavaScript
/*
|
|
This is the builder script that generates the README file.
|
|
Run using `npm run builder`.
|
|
*/
|
|
// Load modules
|
|
const fs = require('fs-extra'), path = require('path'), chalk = require('chalk'),
|
|
md = require('markdown-it')();
|
|
// Set variables for paths
|
|
const snippetsPath = './snippets', staticPartsPath = './static-parts', docsPath = './docs';
|
|
// Set variables for script
|
|
let snippets = {}, startPart = '', endPart = '', output = '', tagDbData = {};
|
|
// Load helper functions (these are from existing snippets in 30 seconds of code!)
|
|
const objectFromPairs = arr => arr.reduce((a, v) => (a[v[0]] = v[1], a), {});
|
|
const capitalize = (str, lowerRest = false) => str.slice(0, 1).toUpperCase() + (lowerRest ? str.slice(1).toLowerCase() : str.slice(1));
|
|
// Start the timer of the script
|
|
console.time('Builder');
|
|
// Synchronously read all snippets and sort them as necessary (case-insensitive)
|
|
try {
|
|
let snippetFilenames = fs.readdirSync(snippetsPath);
|
|
snippetFilenames.sort((a, b) => {
|
|
a = a.toLowerCase();
|
|
b = b.toLowerCase();
|
|
if (a < b) return -1;
|
|
if (a > b) return 1;
|
|
return 0;
|
|
});
|
|
// Store the data read from each snippet in the appropriate object
|
|
for(let snippet of snippetFilenames) snippets[snippet] = fs.readFileSync(path.join(snippetsPath,snippet),'utf8');
|
|
}
|
|
catch (err){ // Handle errors (hopefully not!)
|
|
console.log(`${chalk.red('ERROR!')} During snippet loading: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
// Load static parts for the index.html file
|
|
try {
|
|
startPart = fs.readFileSync(path.join(staticPartsPath,'index-start.html'),'utf8');
|
|
endPart = fs.readFileSync(path.join(staticPartsPath,'index-end.html'),'utf8');
|
|
}
|
|
catch (err){ // Handle errors (hopefully not!)
|
|
console.log(`${chalk.red('ERROR!')} During static part loading: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
// Load tag data from the database
|
|
try {
|
|
tagDbData = objectFromPairs(fs.readFileSync('tag_database','utf8').split('\n').slice(0,-1).map(v => v.split(':').slice(0,2)));
|
|
}
|
|
catch (err){ // Handle errors (hopefully not!)
|
|
console.log(`${chalk.red('ERROR!')} During tag database loading: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
// Create the output for the index.html file
|
|
try {
|
|
// Add the start static part
|
|
output += `${startPart+'\n'}`;
|
|
// Loop over tags and snippets to create the table of contents
|
|
for(let tag of [...new Set(Object.entries(tagDbData).map(t => t[1]))].filter(v => v).sort((a,b) => a.localeCompare(b))){
|
|
output +=`<h3>`+md.render(`${capitalize(tag, true)}\n`).replace(/<p>/g,'').replace(/<\/p>/g,'')+`</h3>`;
|
|
for(let taggedSnippet of Object.entries(tagDbData).filter(v => v[1] === tag))
|
|
output += md.render(`[${taggedSnippet[0]}](#${taggedSnippet[0].toLowerCase()})\n`).replace(/<p>/g,'').replace(/<\/p>/g,'').replace(/<a/g,'<a class="sublink-1"');
|
|
output += '\n';
|
|
}
|
|
output += `</nav><main class="col-sm-12 col-md-8 col-lg-9" style="height: 100%;overflow-y: auto; background: #eee;">`;
|
|
output += `<a id="top"> </a>`;
|
|
// Loop over tags and snippets to create the list of snippets
|
|
for(let tag of [...new Set(Object.entries(tagDbData).map(t => t[1]))].filter(v => v).sort((a,b) => a.localeCompare(b))){
|
|
output +=md.render(`## ${capitalize(tag, true)}\n`).replace(/<h2>/g,'<h2 style="text-align:center;">');
|
|
for(let taggedSnippet of Object.entries(tagDbData).filter(v => v[1] === tag))
|
|
output += '<div class="card fluid"><div class="section double-padded">' + md.render(`\n${snippets[taggedSnippet[0]+'.md']}`).replace(/<h3/g,`<h3 id="${taggedSnippet[0].toLowerCase()}"`).replace(/<\/h3>/g,'</h3></div><div class="section double-padded">') + '</div></div><br/>';
|
|
}
|
|
// Add the ending static part
|
|
output += `\n${endPart+'\n'}`;
|
|
// Write to the index.html file
|
|
fs.writeFileSync(path.join(docsPath,'index.html'), output);
|
|
}
|
|
catch (err){ // Handle errors (hopefully not!)
|
|
console.log(`${chalk.red('ERROR!')} During index.html generation: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
// Log a success message
|
|
console.log(`${chalk.green('SUCCESS!')} index.html file generated!`);
|
|
// Log the time taken
|
|
console.timeEnd('Builder');
|