490 lines
18 KiB
JavaScript
490 lines
18 KiB
JavaScript
/*
|
|
This is the web builder script that generates the web files.
|
|
Run using `npm run webber`.
|
|
*/
|
|
// Load modules
|
|
const fs = require('fs-extra'),
|
|
path = require('path'),
|
|
{ green, red } = require('kleur'),
|
|
md = require('markdown-it')(),
|
|
minify = require('html-minifier').minify;
|
|
const util = require('./util');
|
|
var Prism = require('prismjs');
|
|
const minifyHTML = str =>
|
|
minify(str, {
|
|
collapseBooleanAttributes: true,
|
|
collapseWhitespace: true,
|
|
decodeEntities: false,
|
|
minifyCSS: true,
|
|
minifyJS: true,
|
|
keepClosingSlash: true,
|
|
processConditionalComments: true,
|
|
removeAttributeQuotes: false,
|
|
removeComments: true,
|
|
removeEmptyAttributes: false,
|
|
removeOptionalTags: false,
|
|
removeScriptTypeAttributes: false,
|
|
removeStyleLinkTypeAttributes: false,
|
|
trimCustomFragments: true
|
|
});
|
|
const unescapeHTML = str =>
|
|
str.replace(
|
|
/&|<|>|'|"/g,
|
|
tag =>
|
|
({
|
|
'&': '&',
|
|
'<': '<',
|
|
'>': '>',
|
|
''': "'",
|
|
'"': '"'
|
|
}[tag] || tag)
|
|
);
|
|
const generateSnippetCard = (
|
|
snippetList,
|
|
snippetKey,
|
|
addCornerTag = false
|
|
) => `<div class="card code-card">
|
|
${
|
|
addCornerTag
|
|
? `<div class="corner ${
|
|
snippetKey[1].includes('advanced')
|
|
? 'advanced'
|
|
: snippetKey[1].includes('beginner')
|
|
? 'beginner'
|
|
: 'intermediate'
|
|
}" aria-label="${
|
|
snippetKey[1].includes('advanced')
|
|
? 'advanced'
|
|
: snippetKey[1].includes('beginner')
|
|
? 'beginner'
|
|
: 'intermediate'
|
|
}" title="${
|
|
snippetKey[1].includes('advanced')
|
|
? 'advanced'
|
|
: snippetKey[1].includes('beginner')
|
|
? 'beginner'
|
|
: 'intermediate'
|
|
}" ></div>`
|
|
: ''
|
|
}
|
|
${md
|
|
.render(`\n${addCornerTag ? snippetList[snippetKey[0] + '.md'] : snippetList[snippetKey[0]]}`)
|
|
.replace(/<h3/g, `<div class="section card-content"><h4 id="${snippetKey[0].toLowerCase()}"`)
|
|
.replace(/<\/h3>/g, '</h4>')
|
|
.replace(
|
|
/<pre><code class="language-js">/m,
|
|
'</div><div class="copy-button-container"><button class="copy-button" aria-label="Copy to clipboard"></button></div><pre><code class="language-js">'
|
|
)
|
|
.replace(
|
|
/<pre><code class="language-js">([^\0]*?)<\/code><\/pre>/gm,
|
|
(match, p1) =>
|
|
`<pre class="language-js">${Prism.highlight(
|
|
unescapeHTML(p1),
|
|
Prism.languages.javascript
|
|
)}</pre>`
|
|
)
|
|
.replace(/<\/div>\s*<pre class="/g, '</div><pre class="section card-code ')
|
|
.replace(
|
|
/<\/pre>\s+<pre class="/g,
|
|
'</pre><label class="collapse">examples</label><pre class="section card-examples '
|
|
)}
|
|
</div>`;
|
|
const embedCard = tag => `<div class="card code-card"><div class="section card-content">
|
|
${['adapter','array','function','object'].includes(tag) ?
|
|
'<h4><a href="https://frontendmasters.com/courses/es6-right-parts/" target="_blank" rel="noopener noreferrer">Recommended Resource - ES6: The Right Parts</a></h4><p>Learn new ES6 JavaScript language features like arrow function, destructuring, generators & more to write cleaner and more productive, readable programs.</p>'
|
|
: ['browser', 'node', 'date'].includes(tag) ?
|
|
'<h4><a href="https://frontendmasters.com/courses/javascript-hard-parts/" target="_blank" rel="noopener noreferrer">Recommended Resource - JavaScript: The Hard Parts</a></h4><p>Take your JavaScript to the next level. Gain an understanding of callbacks, higher order functions, closure, asynchronous and object-oriented JavaScript!</p>'
|
|
: '<h4><a href="https://frontendmasters.com/courses/js-fundamentals-functional-v2/" target="_blank" rel="noopener noreferrer">Recommended Resource - JavaScript: From Fundamentals to Functional JS</a></h4><p>Learn higher-order functions, closures, scope, master key functional methods like map, reduce and filter and promises and ES6+ asynchronous JavaScript.</p>'
|
|
}</div></div>`;
|
|
const filterSnippets = (snippetList, excludedFiles) =>
|
|
Object.keys(snippetList)
|
|
.filter(key => !excludedFiles.includes(key))
|
|
.reduce((obj, key) => {
|
|
obj[key] = snippetList[key];
|
|
return obj;
|
|
}, {});
|
|
if (
|
|
util.isTravisCI() &&
|
|
/^Travis build: \d+/g.test(process.env['TRAVIS_COMMIT_MESSAGE']) &&
|
|
process.env['TRAVIS_EVENT_TYPE'] !== 'cron' &&
|
|
process.env['TRAVIS_EVENT_TYPE'] !== 'api'
|
|
) {
|
|
console.log(
|
|
`${green('NOBUILD')} website build terminated, parent commit is a Travis build!`
|
|
);
|
|
process.exit(0);
|
|
}
|
|
// Compile the SCSS file, using `node-sass`.
|
|
const sass = require('node-sass');
|
|
sass.render(
|
|
{
|
|
file: path.join('docs', 'scss', 'style.scss'),
|
|
outFile: path.join('docs', 'style.css'),
|
|
outputStyle: 'compressed'
|
|
},
|
|
function(err, result) {
|
|
if (!err) {
|
|
fs.writeFile(path.join('docs', 'style.css'), result.css, function(err2) {
|
|
if (!err2) console.log(`${green('SUCCESS!')} style.css file generated!`);
|
|
else console.log(`${red('ERROR!')} During style.css file generation: ${err}`);
|
|
});
|
|
} else
|
|
console.log(`${red('ERROR!')} During style.css file generation: ${err}`);
|
|
|
|
}
|
|
);
|
|
// Set variables for paths
|
|
const snippetsPath = './snippets',
|
|
archivedSnippetsPath = './snippets_archive',
|
|
glossarySnippetsPath = './glossary',
|
|
staticPartsPath = './static-parts',
|
|
docsPath = './docs',
|
|
staticFiles = ['about.html', 'contributing.html', 'array.html'];
|
|
// Set variables for script
|
|
let snippets = {},
|
|
archivedSnippets = {},
|
|
glossarySnippets = {},
|
|
startPart = '',
|
|
endPart = '',
|
|
output = '',
|
|
archivedOutput = '',
|
|
glossaryOutput = '',
|
|
pagesOutput = [],
|
|
tagDbData = {};
|
|
// Start the timer of the script
|
|
console.time('Webber');
|
|
// Synchronously read all snippets and sort them as necessary (case-insensitive)
|
|
snippets = util.readSnippets(snippetsPath);
|
|
archivedSnippets = util.readSnippets(archivedSnippetsPath);
|
|
glossarySnippets = util.readSnippets(glossarySnippetsPath);
|
|
|
|
// Load static parts for all pages
|
|
try {
|
|
[startPart, endPart, staticPageStartPart, staticPageEndPart] = [
|
|
'page-start.html',
|
|
'page-end.html',
|
|
'static-page-start.html',
|
|
'static-page-end.html'
|
|
].map(filename => fs.readFileSync(path.join(staticPartsPath, filename), 'utf8'));
|
|
} catch (err) {
|
|
// Handle errors (hopefully not!)
|
|
console.log(`${red('ERROR!')} During static part loading: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
// Load tag data from the database
|
|
tagDbData = util.readTags();
|
|
|
|
// Create the output for individual category pages
|
|
try {
|
|
let taggedData = util.prepTaggedData(tagDbData);
|
|
// Add the start static part
|
|
output += `${startPart}${'\n'}`;
|
|
// Loop over tags and snippets to create the table of contents
|
|
for (let tag of taggedData) {
|
|
output +=
|
|
'<h4 class="collapse">' +
|
|
md
|
|
.render(`${util.capitalize(tag, true)}\n`)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '') +
|
|
'</h4><ul>';
|
|
for (let taggedSnippet of Object.entries(tagDbData).filter(v => v[1][0] === tag)) {
|
|
output += md
|
|
.render(
|
|
`[${taggedSnippet[0]}](./${
|
|
tag === 'array' ? 'index' : tag
|
|
}#${taggedSnippet[0].toLowerCase()})\n`
|
|
)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '</li>')
|
|
.replace(/<a/g, `<li><a tags="${taggedSnippet[1].join(',')}"`);
|
|
}
|
|
output += '</ul>\n';
|
|
}
|
|
output += `<h4 class="static-link"><a href="./archive">Archive</a></h4>
|
|
<h4 class="static-link"><a href="./glossary">Glossary</a></h4>
|
|
<h4 class="static-link"><a href="./contributing">Contributing</a></h4>
|
|
<h4 class="static-link"><a href="./about">About</a></h4>
|
|
<div><button class="social fb"></button><button class="social instagram"></button><button class="social twitter"></button></div>
|
|
</nav><main class="col-centered"><span id="top"><br/><br/></span>`;
|
|
// Loop over tags and snippets to create the list of snippets
|
|
for (let tag of taggedData){
|
|
let notEmbedded = true;
|
|
let localOutput = output
|
|
.replace(/\$tag/g, util.capitalize(tag))
|
|
.replace(new RegExp(`./${tag}#`, 'g'), '#');
|
|
if (tag === 'array') localOutput = localOutput.replace(new RegExp('./index#', 'g'), '#');
|
|
localOutput += md
|
|
.render(`## ${util.capitalize(tag, true)}\n`)
|
|
.replace(/<h2>/g, '<h2 class="category-name">');
|
|
if (tag === 'array')
|
|
localOutput += `<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CK7IVKJ7&placement=30secondsofcodeorg" id="_carbonads_js"></script><style>#carbonads {
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu,
|
|
Cantarell, "Helvetica Neue", Helvetica, Arial, sans-serif;
|
|
}
|
|
|
|
#carbonads {
|
|
display: flex;
|
|
max-width: 330px;
|
|
background-color: hsl(0, 0%, 98%);
|
|
box-shadow: 0 1px 4px 1px hsla(0, 0%, 0%, .1);
|
|
}
|
|
|
|
#carbonads a {
|
|
color: inherit;
|
|
text-decoration: none;
|
|
}
|
|
|
|
#carbonads a:hover {
|
|
color: inherit;
|
|
}
|
|
|
|
#carbonads span {
|
|
position: relative;
|
|
display: block;
|
|
overflow: hidden;
|
|
}
|
|
|
|
#carbonads .carbon-wrap {
|
|
display: flex;
|
|
}
|
|
|
|
.carbon-img {
|
|
display: block;
|
|
margin: 0;
|
|
line-height: 1;
|
|
}
|
|
|
|
.carbon-img img {
|
|
display: block;
|
|
}
|
|
|
|
.carbon-text {
|
|
font-size: 13px;
|
|
padding: 10px;
|
|
line-height: 1.5;
|
|
text-align: left;
|
|
}
|
|
|
|
.carbon-poweredby {
|
|
display: block;
|
|
padding: 8px 10px;
|
|
background: repeating-linear-gradient(-45deg, transparent, transparent 5px, hsla(0, 0%, 0%, .025) 5px, hsla(0, 0%, 0%, .025) 10px) hsla(203, 11%, 95%, .4);
|
|
text-align: center;
|
|
text-transform: uppercase;
|
|
letter-spacing: .5px;
|
|
font-weight: 600;
|
|
font-size: 9px;
|
|
line-height: 1;
|
|
}</style>`;
|
|
for (let taggedSnippet of Object.entries(tagDbData).filter(v => v[1][0] === tag)) {
|
|
localOutput += generateSnippetCard(snippets, taggedSnippet, true);
|
|
if (Object.entries(tagDbData).filter(v => v[1][0] === tag).findIndex(v => v[0] === taggedSnippet[0]) >= Object.entries(tagDbData).filter(v => v[1][0] === tag).length * 0.5 && notEmbedded) {
|
|
notEmbedded = !notEmbedded;
|
|
localOutput += embedCard(tag);
|
|
}
|
|
}
|
|
// Add the ending static part
|
|
localOutput += `\n${endPart + '\n'}`;
|
|
// Optimize punctuation nodes
|
|
localOutput = util.optimizeNodes(
|
|
localOutput,
|
|
/<span class="token punctuation">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token punctuation">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token punctuation">${p1}${p2}${p3}</span>`
|
|
);
|
|
// Optimize operator nodes
|
|
localOutput = util.optimizeNodes(
|
|
localOutput,
|
|
/<span class="token operator">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token operator">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token operator">${p1}${p2}${p3}</span>`
|
|
);
|
|
// Optimize keyword nodes
|
|
localOutput = util.optimizeNodes(
|
|
localOutput,
|
|
/<span class="token keyword">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token keyword">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token keyword">${p1}${p2}${p3}</span>`
|
|
);
|
|
pagesOutput.push({ tag, content: localOutput });
|
|
}
|
|
// Minify output
|
|
pagesOutput.forEach(page => {
|
|
page.content = minifyHTML(page.content);
|
|
fs.writeFileSync(
|
|
path.join(docsPath, (page.tag === 'array' ? 'index' : page.tag) + '.html'),
|
|
page.content
|
|
);
|
|
console.log(
|
|
`${green('SUCCESS!')} ${page.tag === 'array' ? 'index' : page.tag}.html file generated!`
|
|
);
|
|
});
|
|
} catch (err) {
|
|
// Handle errors (hopefully not!)
|
|
console.log(`${red('ERROR!')} During category page generation: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
|
|
const generateMenuForStaticPage = staticPart => {
|
|
let taggedData = util.prepTaggedData(tagDbData);
|
|
// Add the start static part
|
|
let htmlCode;
|
|
|
|
for (let tag of taggedData) {
|
|
htmlCode +=
|
|
'<h4 class="collapse">' +
|
|
md
|
|
.render(`${util.capitalize(tag, true)}\n`)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '') +
|
|
'</h4><ul>';
|
|
for (let taggedSnippet of Object.entries(tagDbData).filter(v => v[1][0] === tag)) {
|
|
htmlCode += md
|
|
.render(
|
|
`[${taggedSnippet[0]}](./${
|
|
tag === 'array' ? 'index' : tag
|
|
}#${taggedSnippet[0].toLowerCase()})\n`
|
|
)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '</li>')
|
|
.replace(/<a/g, `<li><a tags="${taggedSnippet[1].join(',')}"`);
|
|
}
|
|
htmlCode += '</ul>\n';
|
|
}
|
|
return staticPart.replace('$nav-menu-data', htmlCode);
|
|
};
|
|
|
|
const staticPageStartGenerator = (staticPart, heading, description) => {
|
|
let taggedData = util.prepTaggedData(tagDbData);
|
|
// Add the start static part
|
|
let htmlCode = `${staticPart}\n`;
|
|
|
|
// Loop over tags and snippets to create the table of contents
|
|
for (let tag of taggedData) {
|
|
htmlCode +=
|
|
'<h4 class="collapse">' +
|
|
md
|
|
.render(`${util.capitalize(tag, true)}\n`)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '') +
|
|
'</h4><ul>';
|
|
for (let taggedSnippet of Object.entries(tagDbData).filter(v => v[1][0] === tag)) {
|
|
htmlCode += md
|
|
.render(
|
|
`[${taggedSnippet[0]}](./${
|
|
tag === 'array' ? 'index' : tag
|
|
}#${taggedSnippet[0].toLowerCase()})\n`
|
|
)
|
|
.replace(/<p>/g, '')
|
|
.replace(/<\/p>/g, '</li>')
|
|
.replace(/<a/g, `<li><a tags="${taggedSnippet[1].join(',')}"`);
|
|
}
|
|
htmlCode += '</ul>\n';
|
|
}
|
|
htmlCode += `<h4 class="static-link"><a href="./archive">Archive</a></h4>
|
|
<h4 class="static-link"><a href="./glossary">Glossary</a></h4>
|
|
<h4 class="static-link"><a href="./contributing">Contributing</a></h4>
|
|
<h4 class="static-link"><a href="./about">About</a></h4>
|
|
<div><button class="social fb"></button><button class="social instagram"></button><button class="social twitter"></button></div>
|
|
</nav><main class="col-centered"><span id="top"><br/><br/></span><h2 class="category-name">${heading}</h2>
|
|
<p style="text-align: justify">${description}</p><br />`;
|
|
return htmlCode.replace(/\$page_name/g, util.capitalize(heading));
|
|
};
|
|
|
|
|
|
// Create the output for the archive.html file
|
|
try {
|
|
// Add the static part
|
|
let heading = 'Snippets Archive';
|
|
let description = "These snippets, while useful and interesting, didn't quite make it into the repository due to either having very specific use-cases or being outdated. However we felt like they might still be useful to some readers, so here they are.";
|
|
let htmlCode = staticPageStartGenerator(staticPageStartPart, heading, description);
|
|
|
|
archivedOutput += htmlCode;
|
|
|
|
// Filter README.md from folder
|
|
const filteredArchivedSnippets = filterSnippets(archivedSnippets, ['README.md']);
|
|
|
|
// Generate archived snippets from md files
|
|
for (let snippet of Object.entries(filteredArchivedSnippets))
|
|
archivedOutput += generateSnippetCard(filteredArchivedSnippets, snippet, false);
|
|
|
|
// Optimize punctuation nodes
|
|
archivedOutput = util.optimizeNodes(
|
|
archivedOutput,
|
|
/<span class="token punctuation">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token punctuation">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token punctuation">${p1}${p2}${p3}</span>`
|
|
);
|
|
// Optimize operator nodes
|
|
archivedOutput = util.optimizeNodes(
|
|
archivedOutput,
|
|
/<span class="token operator">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token operator">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token operator">${p1}${p2}${p3}</span>`
|
|
);
|
|
// Optimize keyword nodes
|
|
archivedOutput = util.optimizeNodes(
|
|
archivedOutput,
|
|
/<span class="token keyword">([^\0<]*?)<\/span>([\n\r\s]*)<span class="token keyword">([^\0]*?)<\/span>/gm,
|
|
(match, p1, p2, p3) => `<span class="token keyword">${p1}${p2}${p3}</span>`
|
|
);
|
|
|
|
archivedOutput += `${staticPageEndPart}`;
|
|
|
|
// Generate and minify 'archive.html' file
|
|
const minifiedArchivedOutput = minifyHTML(archivedOutput);
|
|
|
|
fs.writeFileSync(path.join(docsPath, 'archive.html'), minifiedArchivedOutput);
|
|
console.log(`${green('SUCCESS!')} archive.html file generated!`);
|
|
} catch (err) {
|
|
console.log(`${red('ERROR!')} During archive.html generation: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
|
|
// Create the output for the glossary.html file
|
|
try {
|
|
// Add the static part
|
|
let heading = 'Glossary';
|
|
let description = 'Developers use a lot of terminology daily. Every once in a while, you might find a term you do not know. We know how frustrating that can get, so we provide you with a handy glossary of frequently used web development terms.';
|
|
let htmlCode = staticPageStartGenerator(staticPageStartPart, heading, description);
|
|
glossaryOutput += htmlCode;
|
|
|
|
// Filter README.md from folder
|
|
const filteredGlossarySnippets = filterSnippets(glossarySnippets, ['README.md']);
|
|
|
|
// Generate glossary snippets from md files
|
|
for (let snippet of Object.entries(filteredGlossarySnippets)) {
|
|
glossaryOutput +=
|
|
'<div class="card code-card"><div class="section card-content">' +
|
|
md
|
|
.render(`\n${filteredGlossarySnippets[snippet[0]]}`)
|
|
.replace(/<h3/g, `<h4 id="${snippet[0].toLowerCase()}"`)
|
|
.replace(/<\/h3>/g, '</h4>') +
|
|
'</div></div>';
|
|
}
|
|
|
|
glossaryOutput += `${staticPageEndPart}`;
|
|
|
|
// Generate and minify 'glossary.html' file
|
|
const minifiedGlossaryOutput = minifyHTML(glossaryOutput);
|
|
fs.writeFileSync(path.join(docsPath, 'glossary.html'), minifiedGlossaryOutput);
|
|
console.log(`${green('SUCCESS!')} glossary.html file generated!`);
|
|
} catch (err) {
|
|
console.log(`${red('ERROR!')} During glossary.html generation: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
|
|
// Copy static files
|
|
staticFiles.forEach(f => {
|
|
try {
|
|
if(f !== 'array.html') {
|
|
let fileData = fs.readFileSync(path.join(staticPartsPath, f), 'utf8');
|
|
fs.writeFileSync(path.join(docsPath, f), generateMenuForStaticPage(fileData));
|
|
} else
|
|
fs.copyFileSync(path.join(staticPartsPath, f), path.join(docsPath, f));
|
|
console.log(`${green('SUCCESS!')} ${f} file copied!`);
|
|
} catch (err) {
|
|
console.log(`${red('ERROR!')} During ${f} copying: ${err}`);
|
|
process.exit(1);
|
|
}
|
|
});
|
|
|
|
// Log the time taken
|
|
console.timeEnd('Webber');
|