Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gulp: Refactoring #1780

Merged
merged 3 commits into from
Mar 2, 2019
Merged

gulp: Refactoring #1780

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b0412e
Refactored gulpfile.js
RunDevelopment Mar 1, 2019
d0abd30
Removed @ts-check
RunDevelopment Mar 1, 2019
767eed9
Template strings FTW
RunDevelopment Mar 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 123 additions & 130 deletions gulpfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,110 +1,99 @@
var gulp = require('gulp'),
rename = require('gulp-rename'),
uglify = require('gulp-uglify'),
header = require('gulp-header'),
concat = require('gulp-concat'),
replace = require('gulp-replace'),
pump = require('pump'),
fs = require('fs'),

paths = {
componentsFile: 'components.json',
componentsFileJS: 'components.js',
components: ['components/**/*.js', '!components/index.js', '!components/**/*.min.js'],
main: [
'components/prism-core.js',
'components/prism-markup.js',
'components/prism-css.js',
'components/prism-clike.js',
'components/prism-javascript.js',
'plugins/file-highlight/prism-file-highlight.js'
],
plugins: ['plugins/**/*.js', '!plugins/**/*.min.js'],
showLanguagePlugin: 'plugins/show-language/prism-show-language.js',
autoloaderPlugin: 'plugins/autoloader/prism-autoloader.js',
changelog: 'CHANGELOG.md'
},

componentsPromise = new Promise(function (resolve, reject) {
fs.readFile(paths.componentsFile, {
encoding: 'utf-8'
}, function (err, data) {
if (!err) {
resolve(JSON.parse(data));
} else {
reject(err);
}
});
}),

inlineRegexSource = function () {
return replace(
/\/((?:[^\n\r[\\\/]|\\.|\[(?:[^\n\r\\\]]|\\.)*\])*)\/\.source\b/g,
function (m, source) {
// escape backslashes
source = source.replace(/\\/g, '\\\\');
// escape single quotes
source = source.replace(/'/g, "\\'");
// unescape characters like \\n and \\t to \n and \t
source = source.replace(/(^|[^\\])\\\\([nrt0])/g, '$1\\$2');
// wrap source in single quotes
return "'" + source + "'";
}
);
};

gulp.task('components', function(cb) {
pump(
[
gulp.src(paths.components),
inlineRegexSource(),
uglify(),
rename({ suffix: '.min' }),
gulp.dest('components')
],
cb
);
});

gulp.task('build', function() {
return gulp.src(paths.main)
.pipe(header('\n/* **********************************************\n' +
' Begin <%= file.relative %>\n' +
'********************************************** */\n\n'))
.pipe(concat('prism.js'))
.pipe(gulp.dest('./'));
const { src, dest, series, parallel, watch } = require('gulp');

const rename = require('gulp-rename');
const uglify = require('gulp-uglify');
const header = require('gulp-header');
const concat = require('gulp-concat');
const replace = require('gulp-replace');
const pump = require('pump');
const fs = require('fs');

const paths = {
componentsFile: 'components.json',
componentsFileJS: 'components.js',
components: ['components/**/*.js', '!components/index.js', '!components/**/*.min.js'],
main: [
'components/prism-core.js',
'components/prism-markup.js',
'components/prism-css.js',
'components/prism-clike.js',
'components/prism-javascript.js',
'plugins/file-highlight/prism-file-highlight.js'
],
plugins: ['plugins/**/*.js', '!plugins/**/*.min.js'],
showLanguagePlugin: 'plugins/show-language/prism-show-language.js',
autoloaderPlugin: 'plugins/autoloader/prism-autoloader.js',
changelog: 'CHANGELOG.md'
};

const componentsPromise = new Promise((resolve, reject) => {
fs.readFile(paths.componentsFile, {
encoding: 'utf-8'
}, (err, data) => {
if (!err) {
resolve(JSON.parse(data));
} else {
reject(err);
}
});
});

function plugins(cb) {
pump(
[
gulp.src(paths.plugins),
inlineRegexSource(),
uglify(),
rename({ suffix: '.min' }),
gulp.dest('plugins')
],
cb
function inlineRegexSource() {
return replace(
/\/((?:[^\n\r[\\\/]|\\.|\[(?:[^\n\r\\\]]|\\.)*\])*)\/\.source\b/g,
(m, source) => {
// escape backslashes
source = source.replace(/\\/g, '\\\\');
// escape single quotes
source = source.replace(/'/g, "\\'");
// unescape characters like \\n and \\t to \n and \t
source = source.replace(/(^|[^\\])\\\\([nrt0])/g, '$1\\$2');
// wrap source in single quotes
return "'" + source + "'";
}
);
}

gulp.task('components-json', function (cb) {
componentsPromise.then(function (data) {
data = 'var components = ' + JSON.stringify(data) + ';\n' +
'if (typeof module !== \'undefined\' && module.exports) { module.exports = components; }';
fs.writeFile(paths.componentsFileJS, data, cb);
function minifyJS() {
return [
inlineRegexSource(),
uglify()
];
}


function minifyComponents(cb) {
pump([src(paths.components), ...minifyJS(), rename({ suffix: '.min' }), dest('components')], cb);
}
function minifyPlugins(cb) {
pump([src(paths.plugins), ...minifyJS(), rename({ suffix: '.min' }), dest('plugins')], cb);
}
function build(cb) {
pump([src(paths.main), header(`
/* **********************************************
Begin <%= file.relative %>
********************************************** */

`), concat('prism.js'), dest('./')], cb);
}

function componentsJsonToJs(cb) {
componentsPromise.then(data => {
const js = `var components = ${JSON.stringify(data)};
if (typeof module !== 'undefined' && module.exports) { module.exports = components; }`;
fs.writeFile(paths.componentsFileJS, js, cb);
});
});
}

gulp.task('watch', function() {
gulp.watch(paths.components, gulp.parallel('components', 'build'));
gulp.watch(paths.plugins, gulp.parallel('plugins', 'build'));
});
function watchComponentsAndPlugins() {
watch(paths.components, parallel(minifyComponents, build));
watch(paths.plugins, parallel(minifyPlugins, build));
}

gulp.task('languages-plugins', function (cb) {
componentsPromise.then(function (data) {
var languagesMap = {};
var dependenciesMap = {};
function languagePlugins(cb) {
componentsPromise.then(data => {
const languagesMap = {};
const dependenciesMap = {};

/**
* Tries to guess the name of a language given its id.
Expand All @@ -127,13 +116,13 @@ gulp.task('languages-plugins', function (cb) {
}
}

for (var p in data.languages) {
for (const p in data.languages) {
if (p !== 'meta') {
var title = data.languages[p].displayTitle || data.languages[p].title;
const title = data.languages[p].displayTitle || data.languages[p].title;

addLanguageTitle(p, title);

for (var name in data.languages[p].aliasTitles) {
for (const name in data.languages[p].aliasTitles) {
addLanguageTitle(name, data.languages[p].aliasTitles[name]);
}

Expand All @@ -153,52 +142,56 @@ gulp.task('languages-plugins', function (cb) {
}
}

var jsonLanguagesMap = JSON.stringify(languagesMap);
var jsonDependenciesMap = JSON.stringify(dependenciesMap);
const jsonLanguagesMap = JSON.stringify(languagesMap);
const jsonDependenciesMap = JSON.stringify(dependenciesMap);

var tasks = [
{plugin: paths.showLanguagePlugin, map: jsonLanguagesMap},
{plugin: paths.autoloaderPlugin, map: jsonDependenciesMap}
const tasks = [
{ plugin: paths.showLanguagePlugin, map: jsonLanguagesMap },
{ plugin: paths.autoloaderPlugin, map: jsonDependenciesMap }
];

var cpt = 0;
var l = tasks.length;
var done = function() {
let cpt = 0;
const l = tasks.length;
const done = () => {
cpt++;
if(cpt === l) {
if (cpt === l) {
cb && cb();
}
};

tasks.forEach(function(task) {
var stream = gulp.src(task.plugin)
for (const task of tasks) {
const stream = src(task.plugin)
.pipe(replace(
/\/\*languages_placeholder\[\*\/[\s\S]*?\/\*\]\*\//,
'/*languages_placeholder[*/' + task.map + '/*]*/'
))
.pipe(gulp.dest(task.plugin.substring(0, task.plugin.lastIndexOf('/'))));
.pipe(dest(task.plugin.substring(0, task.plugin.lastIndexOf('/'))));

stream.on('error', done);
stream.on('end', done);
});
}
});
});

gulp.task('plugins', gulp.series('languages-plugins', plugins));
}

gulp.task('changelog', function (cb) {
return gulp.src(paths.changelog)
.pipe(replace(
function changelog(cb) {
return pump([
src(paths.changelog),
replace(
/#(\d+)(?![\d\]])/g,
'[#$1](https://github.com/PrismJS/prism/issues/$1)'
))
.pipe(replace(
),
replace(
/\[[\da-f]+(?:, *[\da-f]+)*\]/g,
function (match) {
return match.replace(/([\da-f]{7})[\da-f]*/g, '[`$1`](https://github.com/PrismJS/prism/commit/$1)');
}
))
.pipe(gulp.dest('.'));
});
m => m.replace(/([\da-f]{7})[\da-f]*/g, '[`$1`](https://github.com/PrismJS/prism/commit/$1)')
),
dest('.')
], cb);
}

const components = minifyComponents;
const plugins = series(languagePlugins, minifyPlugins);


gulp.task('default', gulp.parallel('components', 'components-json', 'plugins', 'build'));
exports.watch = watchComponentsAndPlugins;
exports.default = parallel(components, plugins, componentsJsonToJs, build);
exports.changelog = changelog;