OpenSlides/gulpfile.js

363 lines
13 KiB
JavaScript
Raw Normal View History

/**
* Gulp tasks for development and production.
*
* Run
*
* $ ./node_modules/.bin/gulp
*
* for development and
*
* $ ./node_modules/.bin/gulp --production
*
* for production mode.
*/
var argv = require('yargs').argv,
gulp = require('gulp'),
concat = require('gulp-concat'),
cssnano = require('gulp-cssnano'),
gulpif = require('gulp-if'),
gettext = require('gulp-angular-gettext'),
inject = require('gulp-inject-string'),
jshint = require('gulp-jshint'),
mainBowerFiles = require('main-bower-files'),
path = require('path'),
2017-12-01 15:36:26 +01:00
rename = require('gulp-rename'),
sass = require('gulp-sass'),
2016-09-09 00:50:27 +02:00
sourcemaps = require('gulp-sourcemaps'),
templateCache = require('gulp-angular-templatecache'),
2015-12-08 18:34:22 +01:00
through = require('through2'),
uglify = require('gulp-uglify'),
vsprintf = require('sprintf-js').vsprintf;
2018-05-28 12:45:46 +02:00
2015-12-08 18:34:22 +01:00
// Directory where the results go to
var output_directory = path.join('openslides', 'static');
2018-05-28 12:45:46 +02:00
// Container for all watchers
var watchers = [];
/**
* Default tasks to be run before start.
*/
// Catches all JavaScript files (excluded worker files) from all core apps and concats them to one
2016-09-09 00:50:27 +02:00
// file js/openslides.js. In production mode the file is uglified.
2018-05-28 12:45:46 +02:00
var js_src = [
path.join('openslides', '*', 'static', 'js', '**', '*.js'),
'!' + path.join('openslides', 'core', 'static', 'js', 'core', 'pdf-worker.js'),
];
2016-09-09 00:50:27 +02:00
gulp.task('js', function () {
2018-05-28 12:45:46 +02:00
return gulp.src(js_src)
2016-09-09 00:50:27 +02:00
.pipe(sourcemaps.init())
.pipe(concat('openslides.js'))
.pipe(sourcemaps.write())
//TODO: Needs rework in all js files that uglified code works correctly.
//.pipe(gulpif(argv.production, uglify()))
2016-09-09 00:50:27 +02:00
.pipe(gulp.dest(path.join(output_directory, 'js')));
});
2018-05-28 12:45:46 +02:00
watchers.push(function () {
gulp.watch(js_src, gulp.series('js'));
});
// Catches all JavaScript files from all bower components and concats them to
// one file js/openslides-libs.js. In production mode the file is uglified.
2018-05-28 12:45:46 +02:00
gulp.task('js_libs', function () {
return gulp.src(mainBowerFiles({
filter: /\.js$/
}))
2016-09-09 00:50:27 +02:00
.pipe(sourcemaps.init())
.pipe(concat('openslides-libs.js'))
2016-09-09 00:50:27 +02:00
.pipe(sourcemaps.write())
.pipe(inject.prepend("/* set basepath of CKEditor */\n" +
"window.CKEDITOR_BASEPATH = '/static/ckeditor/';\n\n"))
2018-04-17 15:23:15 +02:00
.pipe(inject.prepend("/* Workaround for IE and pdfjs-dist#1.3.100 (see PR#3714) */\n" +
"PDFJS = {workerSrc: 'not used but set'};\n\n"))
2016-09-09 00:50:27 +02:00
.pipe(gulpif(argv.production, uglify()))
.pipe(gulp.dest(path.join(output_directory, 'js')));
});
2018-05-28 12:45:46 +02:00
// Catches all pdfmake files for pdf worker and pdfmake library.
var pdf_worker_src = path.join('openslides', 'core', 'static', 'js', 'core', 'pdf-worker.js');
gulp.task('pdf_worker', function () {
return gulp.src(pdf_worker_src)
.pipe(gulpif(argv.production, uglify()))
.pipe(gulp.dest(path.join(output_directory, 'js', 'workers')));
});
2018-05-28 12:45:46 +02:00
gulp.task('pdf_worker_libs', function () {
return gulp.src(path.join('bower_components', 'pdfmake', 'build', 'pdfmake.min.js'))
2018-01-30 16:12:02 +01:00
.pipe(gulpif(argv.production, uglify()))
.pipe(rename('pdf-worker-libs.js'))
.pipe(gulp.dest(path.join(output_directory, 'js', 'workers')));
});
2018-05-28 12:45:46 +02:00
watchers.push(function () {
gulp.watch(pdf_worker_src, gulp.series('pdf_worker'));
});
2016-09-09 00:50:27 +02:00
// Catches all template files from all core apps and concats them to one
// file js/openslides-templates.js. In production mode the file is uglified.
2018-05-28 12:45:46 +02:00
var templates_src = path.join('openslides', '*', 'static', 'templates', '**', '*.html');
2016-09-09 00:50:27 +02:00
gulp.task('templates', function () {
2018-05-28 12:45:46 +02:00
return gulp.src(templates_src)
2016-09-09 00:50:27 +02:00
.pipe(templateCache('openslides-templates.js', {
module: 'OpenSlidesApp-templates',
standalone: true,
moduleSystem: 'IIFE',
transformUrl: function (url) {
var pathList = url.split(path.sep);
pathList.shift();
return pathList.join(path.sep);
},
}))
.pipe(gulpif(argv.production, uglify()))
.pipe(gulp.dest(path.join(output_directory, 'js')));
});
2018-05-28 12:45:46 +02:00
watchers.push(function () {
gulp.watch(templates_src, gulp.series('templates'));
});
2017-12-01 15:36:26 +01:00
// Build the openslides-site.css file from the main file core/static/css/site.scss.
// Minimizes the outputfile if the production flag is given.
2018-05-28 12:45:46 +02:00
gulp.task('css_site', function () {
return gulp.src(path.join('openslides', 'core', 'static', 'css', 'site.scss'))
2017-12-01 15:36:26 +01:00
.pipe(sass().on('error', sass.logError))
.pipe(gulpif(argv.production, cssnano({safe: true})))
.pipe(rename('openslides-site.css'))
.pipe(gulp.dest(path.join(output_directory, 'css')));
});
2018-05-28 12:45:46 +02:00
2017-12-01 15:36:26 +01:00
// Build the openslides-projector.css file from the main file core/static/css/projector.scss.
// Minimizes the outputfile if the production flag is given.
2018-05-28 12:45:46 +02:00
gulp.task('css_projector', function () {
return gulp.src(path.join('openslides', 'core', 'static', 'css', 'projector.scss'))
2017-12-01 15:36:26 +01:00
.pipe(sass().on('error', sass.logError))
.pipe(gulpif(argv.production, cssnano({safe: true})))
.pipe(rename('openslides-projector.css'))
.pipe(gulp.dest(path.join(output_directory, 'css')));
});
2018-05-28 12:45:46 +02:00
// Watcher for scss files.
// We cannot differentiate between all scss files which belong to each realm. So if
// one scss file changes the site and projector css is rebuild.
watchers.push(function () {
gulp.watch(path.join('openslides', '*', 'static', 'css', '**', '*.scss'), gulp.parallel('css_site', 'css_projector'));
});
// Catches all CSS files from all bower components and concats them to one file
// css/openslides-libs.css. In production mode the file is uglified.
2018-05-28 12:45:46 +02:00
gulp.task('css_libs', function () {
return gulp.src(mainBowerFiles({
filter: /\.css$/
}))
.pipe(concat('openslides-libs.css'))
2017-01-15 00:39:07 +01:00
.pipe(gulpif(argv.production, cssnano({safe: true})))
.pipe(gulp.dest(path.join(output_directory, 'css')));
});
2018-05-28 12:45:46 +02:00
2015-01-17 13:31:06 +01:00
// Catches all font files from all bower components.
2018-05-28 12:45:46 +02:00
gulp.task('fonts_libs', function () {
return gulp.src(mainBowerFiles({
filter: /\.(woff)|(woff2)$/
}))
2015-01-17 13:31:06 +01:00
.pipe(gulp.dest(path.join(output_directory, 'fonts')));
});
2018-05-28 12:45:46 +02:00
// Catches image files for angular-chosen.
2018-05-28 12:45:46 +02:00
gulp.task('angular_chosen_img', function () {
return gulp.src(path.join('bower_components', 'chosen', '*.png'))
.pipe(gulp.dest(path.join(output_directory, 'css')));
});
2018-05-28 12:45:46 +02:00
// Tasks for CKEditor
gulp.task('ckeditor_defaults', function () {
return gulp.src([
path.join('bower_components', 'ckeditor', 'styles.js'),
path.join('bower_components', 'ckeditor', 'contents.css'),
])
.pipe(gulp.dest(path.join(output_directory, 'ckeditor')));
});
2018-05-28 12:45:46 +02:00
gulp.task('ckeditor_skins', function () {
2016-12-16 22:11:51 +01:00
return gulp.src(
[
path.join('bower_components', 'ckeditor', 'skins', 'moono-lisa', '**', '*'),
],
{
base: path.join('bower_components', 'ckeditor', 'skins')
}
)
.pipe(gulp.dest(path.join(output_directory, 'ckeditor', 'skins')));
});
2018-05-28 12:45:46 +02:00
gulp.task('ckeditor_plugins', function () {
2016-12-16 22:11:51 +01:00
return gulp.src(
[
path.join('bower_components', 'ckeditor', 'plugins', 'clipboard', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'colorbutton', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'colordialog', '**', '*'),
2016-12-16 22:11:51 +01:00
path.join('bower_components', 'ckeditor', 'plugins', 'dialog', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'find', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'image', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'justify', '**', '*'),
2017-01-06 11:08:32 +01:00
path.join('bower_components', 'ckeditor', 'plugins', 'link', '**', '*'),
2016-12-16 22:11:51 +01:00
path.join('bower_components', 'ckeditor', 'plugins', 'liststyle', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'magicline', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'pastefromword', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'panelbutton', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'showblocks', '**', '*'),
2017-01-06 11:08:32 +01:00
path.join('bower_components', 'ckeditor', 'plugins', 'specialchar', '**', '*'),
2016-12-16 22:11:51 +01:00
path.join('bower_components', 'ckeditor', 'plugins', 'sourcedialog', '**', '*'),
path.join('bower_components', 'ckeditor', 'plugins', 'table', '**', '*'),
],
{
base: path.join('bower_components', 'ckeditor', 'plugins')
}
)
.pipe(gulp.dest(path.join(output_directory, 'ckeditor', 'plugins')));
});
2018-05-28 12:45:46 +02:00
gulp.task('ckeditor_lang', function () {
return gulp.src([
path.join('bower_components', 'ckeditor', 'lang', 'en.js'),
path.join('bower_components', 'ckeditor', 'lang', 'de.js'),
path.join('bower_components', 'ckeditor', 'lang', 'pt.js'),
path.join('bower_components', 'ckeditor', 'lang', 'es.js'),
path.join('bower_components', 'ckeditor', 'lang', 'fr.js'),
path.join('bower_components', 'ckeditor', 'lang', 'cs.js'),
path.join('bower_components', 'ckeditor', 'lang', 'ru.js'),
])
.pipe(gulp.dest(path.join(output_directory, 'ckeditor', 'lang')));
});
2018-05-28 12:45:46 +02:00
gulp.task('ckeditor', gulp.parallel('ckeditor_defaults', 'ckeditor_skins', 'ckeditor_plugins', 'ckeditor_lang'));
2016-02-16 00:56:56 +01:00
2015-12-08 18:34:22 +01:00
// Compiles translation files (*.po) to *.json and saves them in the directory
// openslides/static/i18n/.
gulp.task('translations', function () {
return gulp.src(path.join('openslides', 'locale', 'angular-gettext', '*.po'))
.pipe(gettext.compile({
format: 'json'
}))
.pipe(gulp.dest(path.join(output_directory, 'i18n')));
});
2018-05-28 12:45:46 +02:00
// Gulp default task. Runs all other tasks before.
2018-05-28 12:45:46 +02:00
gulp.task('default', gulp.parallel(
'js',
2018-05-28 12:45:46 +02:00
'js_libs',
'pdf_worker',
'pdf_worker_libs',
'templates',
2018-05-28 12:45:46 +02:00
'css_site',
'css_projector',
'css_libs',
'fonts_libs',
'angular_chosen_img',
'ckeditor',
'translations'
2018-05-28 12:45:46 +02:00
));
/**
2015-12-08 18:34:22 +01:00
* Extra tasks that have to be called manually. Useful for development.
*/
2016-09-09 00:50:27 +02:00
// Watches changes in JavaScript and templates.
2018-05-28 12:45:46 +02:00
gulp.task('watching', function () {
// This tasks never completes because it starts all watchers and let them
// watch forever ...
for (var i = 0; i < watchers.length; i++) {
watchers[i]();
}
2016-09-09 00:50:27 +02:00
});
2018-05-28 12:45:46 +02:00
gulp.task('watch', gulp.series(gulp.parallel('js', 'pdf_worker', 'templates', 'css_site', 'css_projector'), 'watching'));
// Extracts translatable strings using angular-gettext and saves them in file
// openslides/locale/angular-gettext/template-en.pot.
gulp.task('pot', function () {
2016-01-27 22:44:42 +01:00
return gulp.src([
2018-05-28 12:45:46 +02:00
templates_src,
path.join('openslides', '*', 'static', 'js', '**', '*.js'),
2016-01-27 22:44:42 +01:00
])
.pipe(gettext.extract('template-en.pot', {}))
.pipe(gulp.dest('openslides/locale/angular-gettext/'));
});
2018-05-28 12:45:46 +02:00
// Checks JavaScript using JSHint
2015-12-08 18:34:22 +01:00
gulp.task('jshint', function () {
2016-02-16 00:56:56 +01:00
return gulp.src([
'gulpfile.js',
2018-05-28 12:45:46 +02:00
path.join('openslides', '*', 'static', 'js', '**', '*.js'),
2016-02-16 00:56:56 +01:00
])
.pipe(jshint())
2016-03-02 16:51:40 +01:00
.pipe(jshint.reporter('default'))
.pipe(jshint.reporter('fail'));
});
2015-12-08 18:34:22 +01:00
2018-05-28 12:45:46 +02:00
2015-12-08 18:34:22 +01:00
// Extracts names, URLs and licensed of all uses bower components and prints
// it to the console. This is useful to update the README.rst during release
// process.
gulp.task('bower-components-for-readme', function () {
var files = [];
return gulp.src([
path.join('bower_components', '*', 'bower.json'),
2016-03-21 20:22:57 +01:00
path.join('bower_components', '*', 'package.json'),
2015-12-08 18:34:22 +01:00
path.join('bower_components', '*', 'component.json'),
])
.pipe(
through.obj(
function (chunk, encoding, callback) {
files.push(chunk);
callback();
},
function (callback) {
// Extract JSON from bower.json or components.json file.
var extracted = [];
for (var index = 0; index < files.length; index++) {
extracted.push(JSON.parse(files[index].contents.toString()));
}
// Sort files.
extracted.sort(function (a, b) {
return a.name < b.name ? -1 : 1;
});
// Print out line for README.rst.
for (var index2 = 0; index2 < extracted.length; index2++) {
var data = [
extracted[index2].name,
extracted[index2].homepage,
extracted[index2].license,
];
console.log(vsprintf(' * `%s <%s>`_, License: %s', data));
}
// End stream without further file processing.
callback();
}
)
);
});