This repository has been archived on 2020-05-08. You can view files and clone it, but cannot push or open issues or pull requests.
understrap/gulpfile.js

293 lines
9.5 KiB
JavaScript
Raw Normal View History

2015-08-21 13:35:15 +00:00
// Defining requirements
2018-03-04 14:21:25 +00:00
var gulp = require('gulp');
var plumber = require('gulp-plumber');
var sass = require('gulp-sass');
var watch = require('gulp-watch');
var cssnano = require('gulp-cssnano');
var rename = require('gulp-rename');
var concat = require('gulp-concat');
var uglify = require('gulp-uglify');
var merge2 = require('merge2');
var imagemin = require('gulp-imagemin');
var ignore = require('gulp-ignore');
var rimraf = require('gulp-rimraf');
var clone = require('gulp-clone');
var merge = require('gulp-merge');
var sourcemaps = require('gulp-sourcemaps');
var browserSync = require('browser-sync').create();
var del = require('del');
var cleanCSS = require('gulp-clean-css');
var gulpSequence = require('gulp-sequence');
var replace = require('gulp-replace');
var autoprefixer = require('gulp-autoprefixer')
2015-08-12 07:06:27 +00:00
// Configuration file to keep your code DRY
2018-03-04 14:21:25 +00:00
var cfg = require('./gulpconfig.json');
var paths = cfg.paths;
// Run:
// gulp sass + cssnano + rename
2017-03-08 12:13:16 +00:00
// Prepare the min.css for production (with 2 pipes to be sure that "theme.css" == "theme.min.css")
2018-03-04 14:21:25 +00:00
gulp.task('scss-for-prod', function() {
var source = gulp.src(paths.sass + '/*.scss')
.pipe(plumber({
errorHandler: function (err) {
console.log(err);
this.emit('end');
}
2018-03-04 14:21:25 +00:00
}))
.pipe(sourcemaps.init({loadMaps: true}))
.pipe(sass());
2018-03-04 14:21:25 +00:00
var pipe1 = source.pipe(clone())
.pipe(sourcemaps.write(undefined, { sourceRoot: null }))
.pipe(gulp.dest(paths.css))
.pipe(rename('custom-editor-style.css'))
2017-03-08 12:13:16 +00:00
2018-03-04 14:21:25 +00:00
var pipe2 = source.pipe(clone())
.pipe(minify-css())
.pipe(rename({suffix: '.min'}))
.pipe(gulp.dest(paths.css));
return merge(pipe1, pipe2);
});
// Run:
// gulp sourcemaps + sass + reload(browserSync)
2016-12-29 14:01:26 +00:00
// Prepare the child-theme.css for the development environment
2018-03-04 14:21:25 +00:00
gulp.task('scss-for-dev', function() {
gulp.src(paths.sass + '/*.scss')
.pipe(plumber({
2018-03-04 14:21:25 +00:00
errorHandler: function (err) {
console.log(err);
this.emit('end');
}
}))
2018-03-04 14:21:25 +00:00
.pipe(sourcemaps.init({loadMaps: true}))
.pipe(sass())
.pipe(sourcemaps.write(undefined, { sourceRoot: null }))
.pipe(gulp.dest(paths.css))
});
2018-03-04 14:21:25 +00:00
gulp.task('watch-scss', ['browser-sync'], function () {
gulp.watch(paths.sass + '/**/*.scss', ['scss-for-dev']);
});
// Run:
2016-01-18 13:57:52 +00:00
// gulp sass
// Compiles SCSS files in CSS
2018-03-04 14:21:25 +00:00
gulp.task('sass', function () {
var stream = gulp.src(paths.sass + '/*.scss')
.pipe(plumber({
errorHandler: function (err) {
console.log(err);
this.emit('end');
}
2018-03-04 14:21:25 +00:00
}))
.pipe(sass())
.pipe(autoprefixer('last 2 versions'))
.pipe(gulp.dest(paths.css))
.pipe(rename('custom-editor-style.css'))
return stream;
});
2016-12-22 08:55:28 +00:00
// Run:
2016-01-18 13:57:52 +00:00
// gulp watch
// Starts watcher. Watcher runs gulp sass task on changes
2018-03-04 14:21:25 +00:00
gulp.task('watch', function () {
gulp.watch(paths.sass + '/**/*.scss', ['styles']);
gulp.watch([paths.dev + '/js/**/*.js','js/**/*.js','!js/theme.js','!js/theme.min.js'], ['scripts']);
2017-03-21 13:53:49 +00:00
//Inside the watch task.
2018-03-04 14:21:25 +00:00
gulp.watch(paths.imgsrc + '/**', ['imagemin-watch']);
});
/**
* Ensures the 'imagemin' task is complete before reloading browsers
* @verbose
*/
2018-03-04 14:21:25 +00:00
gulp.task('imagemin-watch', ['imagemin'], function(done) {
browserSync.reload();
done();
2017-03-21 13:53:49 +00:00
});
// Run:
// gulp imagemin
// Running image optimizing task
2018-03-04 14:21:25 +00:00
gulp.task('imagemin', function(){
gulp.src(paths.imgsrc + '/**')
.pipe(imagemin())
.pipe(gulp.dest(paths.img))
2015-08-12 07:06:27 +00:00
});
2016-12-22 08:55:28 +00:00
// Run:
2016-12-29 14:01:26 +00:00
// gulp cssnano
2016-01-18 13:57:52 +00:00
// Minifies CSS files
2018-03-04 14:21:25 +00:00
gulp.task('cssnano', function(){
return gulp.src(paths.css + '/theme.css')
.pipe(sourcemaps.init({loadMaps: true}))
.pipe(plumber({
errorHandler: function (err) {
console.log(err);
this.emit('end');
}
2018-03-04 14:21:25 +00:00
}))
.pipe(rename({suffix: '.min'}))
.pipe(cssnano({discardComments: {removeAll: true}}))
.pipe(sourcemaps.write('./'))
.pipe(gulp.dest(paths.css))
});
2016-02-15 12:30:16 +00:00
2018-03-04 14:21:25 +00:00
gulp.task('minify-css', function() {
return gulp.src(paths.css + '/theme.css')
.pipe(sourcemaps.init({loadMaps: true}))
.pipe(cleanCSS({compatibility: '*'}))
.pipe(plumber({
errorHandler: function (err) {
console.log(err);
this.emit('end');
}
2018-03-04 14:21:25 +00:00
}))
.pipe(rename({suffix: '.min'}))
.pipe(sourcemaps.write('./'))
.pipe(gulp.dest(paths.css));
2017-04-21 12:08:39 +00:00
});
2018-03-04 14:21:25 +00:00
gulp.task('cleancss', function() {
return gulp.src(paths.css + '/*.min.css', { read: false }) // much faster
.pipe(ignore('theme.css'))
.pipe(rimraf());
2015-08-12 07:06:27 +00:00
});
2018-03-04 14:21:25 +00:00
gulp.task('styles', function(callback){ gulpSequence('sass', 'minify-css')(callback) });
2017-05-23 18:16:28 +00:00
2016-12-22 08:55:28 +00:00
// Run:
2016-04-15 21:06:10 +00:00
// gulp browser-sync
// Starts browser-sync task for starting the server.
2018-03-04 14:21:25 +00:00
gulp.task('browser-sync', function() {
browserSync.init(cfg.browserSyncWatchFiles, cfg.browserSyncOptions);
2016-04-15 21:06:10 +00:00
});
2016-12-22 08:55:28 +00:00
// Run:
2016-04-15 21:06:10 +00:00
// gulp watch-bs
// Starts watcher with browser-sync. Browser-sync reloads page automatically on your browser
2018-03-04 14:21:25 +00:00
gulp.task('watch-bs', ['browser-sync', 'watch', 'scripts'], function () { });
2016-04-15 21:06:10 +00:00
2016-12-22 08:55:28 +00:00
// Run:
// gulp scripts.
2016-03-20 09:33:18 +00:00
// Uglifies and concat all JS files into one
2018-03-04 14:21:25 +00:00
gulp.task('scripts', function() {
var scripts = [
2016-04-29 09:23:13 +00:00
// Start - All BS4 stuff
paths.dev + '/js/bootstrap4/bootstrap.js',
// End - All BS4 stuff
2016-04-29 09:23:13 +00:00
paths.dev + '/js/skip-link-focus-fix.js'
];
gulp.src(scripts)
2018-03-04 14:21:25 +00:00
.pipe(concat('theme.min.js'))
.pipe(uglify())
.pipe(gulp.dest(paths.js));
gulp.src(scripts)
2018-03-04 14:21:25 +00:00
.pipe(concat('theme.js'))
.pipe(gulp.dest(paths.js));
2016-03-20 08:49:32 +00:00
});
2017-01-18 06:51:37 +00:00
// Deleting any file inside the /src folder
2018-03-04 14:21:25 +00:00
gulp.task('clean-source', function () {
return del(['src/**/*',]);
});
2016-12-22 08:55:28 +00:00
// Run:
// gulp copy-assets.
2015-09-15 14:59:29 +00:00
// Copy all needed dependency assets files from bower_component assets to themes /js, /scss and /fonts folder. Run this task after bower install or bower update
2016-01-18 13:57:52 +00:00
////////////////// All Bootstrap SASS Assets /////////////////////////
2018-03-04 14:21:25 +00:00
gulp.task('copy-assets', function() {
////////////////// All Bootstrap 4 Assets /////////////////////////
2017-10-23 10:21:08 +00:00
// Copy all JS files
2017-10-23 09:53:15 +00:00
var stream = gulp.src(paths.node + 'bootstrap/dist/js/**/*.js')
.pipe(gulp.dest(paths.dev + '/js/bootstrap4'));
// Copy all Bootstrap SCSS files
gulp.src(paths.node + 'bootstrap/scss/**/*.scss')
.pipe(gulp.dest(paths.dev + '/sass/bootstrap4'));
////////////////// End Bootstrap 4 Assets /////////////////////////
2016-01-18 13:25:55 +00:00
2016-01-18 13:57:52 +00:00
// Copy all Font Awesome Fonts
2018-03-07 09:01:24 +00:00
gulp.src(paths.node + 'font-awesome/fonts/**/*.{ttf,woff,woff2,eot,svg}')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest('./fonts'));
2016-01-18 13:25:55 +00:00
2016-01-18 13:57:52 +00:00
// Copy all Font Awesome SCSS files
gulp.src(paths.node + 'font-awesome/scss/*.scss')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.dev + '/sass/fontawesome'));
2016-01-18 13:25:55 +00:00
// _s SCSS files
gulp.src(paths.node + 'undescores-for-npm/sass/media/*.scss')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.dev + '/sass/underscores'));
// _s JS files into /src/js
gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.dev + '/js'));
2016-04-29 09:23:13 +00:00
// _s JS files into /js
gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.js + paths.vendor));
2017-08-14 09:15:52 +00:00
// Copy Popper JS files
2017-08-17 07:54:13 +00:00
gulp.src(paths.node + 'popper.js/dist/umd/popper.min.js')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.js + paths.vendor));
gulp.src(paths.node + 'popper.js/dist/umd/popper.js')
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.js + paths.vendor));
return stream;
});
// Deleting the files distributed by the copy-assets task
2018-03-04 14:21:25 +00:00
gulp.task('clean-vendor-assets', function () {
2018-03-07 09:00:32 +00:00
return del([paths.dev+'/js/bootstrap4/**', paths.dev+'/sass/bootstrap4/**', './fonts/*wesome*.{ttf,woff,woff2,eot,svg}', paths.dev+'/sass/fontawesome/**', paths.dev+'/sass/underscores/**', paths.dev+'/js/skip-link-focus-fix.js', paths.js+'/**/skip-link-focus-fix.js', paths.js+'/**/popper.min.js', paths.js+'/**/popper.js', (paths.vendor!=''?(paths.js+paths.vendor+'/**'):'')]);
});
// Run
// gulp dist
2017-09-02 21:52:35 +00:00
// Copies the files to the /dist folder for distribution as simple theme
2018-03-04 14:21:25 +00:00
gulp.task('dist', ['clean-dist'], function() {
return gulp.src(['**/*', '!'+paths.bower, '!'+paths.bower+'/**', '!'+paths.node, '!'+paths.node+'/**', '!'+paths.dev, '!'+paths.dev+'/**', '!'+paths.dist, '!'+paths.dist+'/**', '!'+paths.distprod, '!'+paths.distprod+'/**', '!'+paths.sass, '!'+paths.sass+'/**', '!readme.txt', '!readme.md', '!package.json', '!package-lock.json', '!gulpfile.js', '!gulpconfig.json', '!CHANGELOG.md', '!.travis.yml', '!jshintignore', '!codesniffer.ruleset.xml', '*'], {'buffer': false})
2018-03-04 14:21:25 +00:00
.pipe(replace('/js/jquery.slim.min.js', '/js'+paths.vendor+'/jquery.slim.min.js', {'skipBinary': true}))
.pipe(replace('/js/popper.min.js', '/js'+paths.vendor+'/popper.min.js', {'skipBinary': true}))
.pipe(replace('/js/skip-link-focus-fix.js', '/js'+paths.vendor+'/skip-link-focus-fix.js', {'skipBinary': true}))
.pipe(gulp.dest(paths.dist));
});
2017-11-27 08:02:16 +00:00
// Deleting any file inside the /dist folder
2018-03-04 14:21:25 +00:00
gulp.task('clean-dist', function () {
return del([paths.dist + '/**',]);
});
// Run
// gulp dist-product
2017-09-02 21:52:35 +00:00
// Copies the files to the /dist-prod folder for distribution as theme with all assets
2018-03-04 14:21:25 +00:00
gulp.task('dist-product', ['clean-dist-product'], function() {
return gulp.src(['**/*', '!'+paths.bower, '!'+paths.bower+'/**', '!'+paths.node, '!'+paths.node+'/**', '!'+paths.dist, '!'+paths.dist+'/**', '!'+paths.distprod, '!'+paths.distprod+'/**', '*'])
2018-03-04 14:21:25 +00:00
.pipe(gulp.dest(paths.distprod))
});
2017-11-27 08:02:16 +00:00
// Deleting any file inside the /dist-product folder
2018-03-04 14:21:25 +00:00
gulp.task('clean-dist-product', function () {
return del([paths.distprod + '/**',]);
});