andre/30-seconds-of-code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Travis build: 407

Browse Source
This commit is contained in:
30secondsofcode
2019-08-26 10:03:49 +00:00
parent 2776b342dd
commit 983bc086c1
57 changed files with 376 additions and 873 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
scripts/build.js
View File

@ -3,29 +3,22 @@
Run using `npm run builder`.
*/
// Load modules
const fs = require('fs-extra');
const path = require('path');
const { green, red } = require('kleur');
const util = require('./util');
const markdown = require('markdown-builder');
const { headers, misc, lists } = markdown;
const config = require('../config');
const fs = require('fs-extra')
const path = require('path')
const { green, red } = require('kleur')
const util = require('./util')
const markdown = require('markdown-builder')
const { headers, misc, lists } = markdown
const config = require('../config')
// Paths (relative to package.json)
const SNIPPETS_PATH = `./${config.snippetPath}`;
const STATIC_PARTS_PATH = `./${config.staticPartsPath}`;
const SNIPPETS_PATH = `./${config.snippetPath}`
const STATIC_PARTS_PATH = `./${config.staticPartsPath}`
// Terminate if parent commit is a Travis build
if (
util.isTravisCI() &&
/^Travis build: \d+/g.test(process.env['TRAVIS_COMMIT_MESSAGE'])
) {
console.log(
`${green(
'NOBUILD',
)} README build terminated, parent commit is a Travis build!`,
);
process.exit(0);
if (util.isTravisCI() && /^Travis build: \d+/g.test(process.env['TRAVIS_COMMIT_MESSAGE'])) {
console.log(`${green('NOBUILD')} README build terminated, parent commit is a Travis build!`)
process.exit(0)
}
// Setup everything
@ -33,51 +26,43 @@ let snippets = {},
snippetsArray = [],
startPart = '',
endPart = '',
output = '';
const EMOJIS = {};
output = ''
const EMOJIS = {}
console.time('Builder');
console.time('Builder')
// Synchronously read all snippets from snippets folder and sort them as necessary (case-insensitive)
snippets = util.readSnippets(SNIPPETS_PATH);
snippets = util.readSnippets(SNIPPETS_PATH)
snippetsArray = Object.keys(snippets).reduce((acc, key) => {
acc.push(snippets[key]);
return acc;
}, []);
acc.push(snippets[key])
return acc
}, [])
// Load static parts for the README file
try {
startPart = fs.readFileSync(
path.join(STATIC_PARTS_PATH, 'README-start.md'),
'utf8',
);
endPart = fs.readFileSync(
path.join(STATIC_PARTS_PATH, 'README-end.md'),
'utf8',
);
startPart = fs.readFileSync(path.join(STATIC_PARTS_PATH, 'README-start.md'), 'utf8')
endPart = fs.readFileSync(path.join(STATIC_PARTS_PATH, 'README-end.md'), 'utf8')
} catch (err) {
console.log(`${red('ERROR!')} During static part loading: ${err}`);
process.exit(1);
console.log(`${red('ERROR!')} During static part loading: ${err}`)
process.exit(1)
}
// Create the output for the README file
try {
const tags = util.prepTaggedData(
Object.keys(snippets).reduce((acc, key) => {
acc[key] = snippets[key].attributes.tags;
return acc;
}, {}),
);
acc[key] = snippets[key].attributes.tags
return acc
}, {})
)
output += `${startPart}\n`;
output += `${startPart}\n`
// Loop over tags and snippets to create the table of contents
for (const tag of tags) {
const capitalizedTag = util.capitalize(tag, true);
const taggedSnippets = snippetsArray.filter(
snippet => snippet.attributes.tags[0] === tag,
);
output += headers.h3((EMOJIS[tag] || '') + ' ' + capitalizedTag).trim();
const capitalizedTag = util.capitalize(tag, true)
const taggedSnippets = snippetsArray.filter(snippet => snippet.attributes.tags[0] === tag)
output += headers.h3((EMOJIS[tag] || '') + ' ' + capitalizedTag).trim()
output +=
misc.collapsible(
@ -87,56 +72,49 @@ try {
`\`${snippet.title}\``,
`${misc.anchor(snippet.title)}${
snippet.attributes.tags.includes('advanced') ? '-' : ''
}`,
),
),
) + '\n';
}`
)
)
) + '\n'
}
for (const tag of tags) {
const capitalizedTag = util.capitalize(tag, true);
const taggedSnippets = snippetsArray.filter(
snippet => snippet.attributes.tags[0] === tag,
);
const capitalizedTag = util.capitalize(tag, true)
const taggedSnippets = snippetsArray.filter(snippet => snippet.attributes.tags[0] === tag)
output +=
misc.hr() + headers.h2((EMOJIS[tag] || '') + ' ' + capitalizedTag) + '\n';
output += misc.hr() + headers.h2((EMOJIS[tag] || '') + ' ' + capitalizedTag) + '\n'
for (let snippet of taggedSnippets) {
if (snippet.attributes.tags.includes('advanced'))
output +=
headers.h3(
snippet.title + ' ' + misc.image('advanced', '/advanced.svg'),
) + '\n';
else output += headers.h3(snippet.title) + '\n';
output += headers.h3(snippet.title + ' ' + misc.image('advanced', '/advanced.svg')) + '\n'
else output += headers.h3(snippet.title) + '\n'
output += snippet.attributes.text;
output += snippet.attributes.text
output += `\`\`\`${config.secondLanguage}\n${snippet.attributes.codeBlocks.html}\n\`\`\`\n\n`;
output += `\`\`\`${config.language}\n${snippet.attributes.codeBlocks.css}\n\`\`\`\n\n`;
output += `\`\`\`${config.secondLanguage}\n${snippet.attributes.codeBlocks.html}\n\`\`\`\n\n`
output += `\`\`\`${config.language}\n${snippet.attributes.codeBlocks.css}\n\`\`\`\n\n`
if (snippet.attributes.codeBlocks.js)
output += `\`\`\`${config.optionalLanguage}\n${snippet.attributes.codeBlocks.js}\n\`\`\`\n\n`;
output += `\`\`\`${config.optionalLanguage}\n${snippet.attributes.codeBlocks.js}\n\`\`\`\n\n`
output += headers.h4('Explanation');
output += snippet.attributes.explanation;
output += headers.h4('Explanation')
output += snippet.attributes.explanation
output += headers.h4('Browser support') + '\n';
output += snippet.attributes.browserSupport.supportPercentage.toFixed(1) + '%';
output += snippet.attributes.browserSupport.text;
output += headers.h4('Browser support') + '\n'
output += snippet.attributes.browserSupport.supportPercentage.toFixed(1) + '%'
output += snippet.attributes.browserSupport.text
output +=
'\n<br>' + misc.link('⬆ Back to top', misc.anchor('Contents')) + '\n';
output += '\n<br>' + misc.link('⬆ Back to top', misc.anchor('Contents')) + '\n'
}
}
// Add the ending static part
output += `\n${endPart}\n`;
output += `\n${endPart}\n`
// Write to the README file
fs.writeFileSync('README.md', output);
fs.writeFileSync('README.md', output)
} catch (err) {
console.log(`${red('ERROR!')} During README generation: ${err}`);
process.exit(1);
console.log(`${red('ERROR!')} During README generation: ${err}`)
process.exit(1)
}
console.log(`${green('SUCCESS!')} README file generated!`);
console.timeEnd('Builder');
console.log(`${green('SUCCESS!')} README file generated!`)
console.timeEnd('Builder')