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

238 lines
8.5 KiB
JavaScript
Raw Normal View History

2015-08-21 13:35:15 +00:00
// Defining requirements
2018-07-04 09:37:13 +00:00
var gulp = require( 'gulp' );
var plumber = require( 'gulp-plumber' );
var sass = require( 'gulp-sass' );
var watch = require( 'gulp-watch' );
var rename = require( 'gulp-rename' );
var concat = require( 'gulp-concat' );
var uglify = require( 'gulp-uglify' );
var imagemin = require( 'gulp-imagemin' );
var ignore = require( 'gulp-ignore' );
var rimraf = require( 'gulp-rimraf' );
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' );
2018-04-02 20:16:04 +00:00
// Configuration file to keep your code DRY
2018-07-04 09:37:13 +00:00
var cfg = require( './gulpconfig.json' );
var paths = cfg.paths;
// Run:
// gulp sass
// Compiles SCSS files in CSS
gulp.task( 'sass', function() {
var stream = gulp.src( paths.sass + '/*.scss' )
.pipe( plumber( {
errorHandler: function( err ) {
console.log( err );
this.emit( 'end' );
}
} ) )
2018-03-21 04:13:10 +00:00
.pipe(sourcemaps.init({loadMaps: true}))
2018-07-04 09:37:13 +00:00
.pipe( sass( { errLogToConsole: true } ) )
.pipe( autoprefixer( 'last 2 versions' ) )
2018-03-21 04:13:10 +00:00
.pipe(sourcemaps.write(undefined, { sourceRoot: null }))
2018-07-04 09:37:13 +00:00
.pipe( gulp.dest( paths.css ) )
return stream;
});
// Run:
// gulp watch
// Starts watcher. Watcher runs gulp sass task on changes
gulp.task( 'watch', function() {
gulp.watch( `${paths.sass}/**/*.scss`, gulp.series('styles') );
gulp.watch( [`${paths.dev}/js/**/*.js`, 'js/**/*.js', '!js/theme.js', '!js/theme.min.js'], gulp.series('scripts') );
2018-07-04 09:37:13 +00:00
//Inside the watch task.
gulp.watch( `${paths.imgsrc}/**`, gulp.series('imagemin-watch') );
2018-07-04 09:37:13 +00:00
});
2015-08-12 07:06:27 +00:00
2018-07-04 09:37:13 +00:00
// Run:
// gulp imagemin
// Running image optimizing task
gulp.task( 'imagemin', function() {
gulp.src( `${paths.imgsrc}/**` )
2018-07-04 09:37:13 +00:00
.pipe( imagemin() )
.pipe( gulp.dest( paths.img ) );
});
2016-02-15 12:30:16 +00:00
/**
* Ensures the 'imagemin' task is complete before reloading browsers
* @verbose
*/
gulp.task( 'imagemin-watch', gulp.series('imagemin', function( ) {
browserSync.reload();
}));
2018-07-04 09:37:13 +00:00
// Run:
// gulp cssnano
// Minifies CSS files
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' );
}
} ) )
.pipe( rename( { suffix: '.min' } ) )
.pipe( cssnano( { discardComments: { removeAll: true } } ) )
.pipe( sourcemaps.write( './' ) )
.pipe( gulp.dest( paths.css ) );
});
2017-04-21 12:08:39 +00:00
2018-07-04 09:37:13 +00:00
gulp.task( 'minifycss', function() {
return gulp.src( `${paths.css}/theme.css` )
2018-07-04 09:37:13 +00:00
.pipe( sourcemaps.init( { loadMaps: true } ) )
.pipe( cleanCSS( { compatibility: '*' } ) )
.pipe( plumber( {
errorHandler: function( err ) {
console.log( err ) ;
this.emit( 'end' );
}
} ) )
.pipe( rename( { suffix: '.min' } ) )
.pipe( sourcemaps.write( './' ) )
.pipe( gulp.dest( paths.css ) );
});
2015-08-12 07:06:27 +00:00
2018-07-04 09:37:13 +00:00
gulp.task( 'cleancss', function() {
return gulp.src( `${paths.css}/*.min.css`, { read: false } ) // Much faster
2018-07-04 09:37:13 +00:00
.pipe( ignore( 'theme.css' ) )
.pipe( rimraf() );
});
gulp.task( 'styles', function( callback ) {
gulp.series( 'sass', 'minifycss' )( callback );
2018-07-04 09:37:13 +00:00
} );
// Run:
// gulp browser-sync
// Starts browser-sync task for starting the server.
gulp.task( 'browser-sync', function() {
browserSync.init( cfg.browserSyncWatchFiles, cfg.browserSyncOptions );
} );
2018-03-07 12:32:41 +00:00
// Run:
// gulp scripts.
2018-07-04 09:37:13 +00:00
// Uglifies and concat all JS files into one
gulp.task( 'scripts', function() {
var scripts = [
2016-04-29 09:23:13 +00:00
2018-07-04 09:37:13 +00:00
// Start - All BS4 stuff
`${paths.dev}/js/bootstrap4/bootstrap.bundle.js`,
2018-07-04 09:37:13 +00:00
// End - All BS4 stuff
`${paths.dev}/js/skip-link-focus-fix.js`,
2018-07-04 09:37:13 +00:00
// Adding currently empty javascript file to add on for your own themes´ customizations
// Please add any customizations to this .js file only!
`${paths.dev}/js/custom-javascript.js`
];
gulp.src( scripts, { allowEmpty: true } )
2018-07-04 09:37:13 +00:00
.pipe( concat( 'theme.min.js' ) )
.pipe( uglify() )
.pipe( gulp.dest( paths.js ) );
return gulp.src( scripts, { allowEmpty: true } )
2018-07-04 09:37:13 +00:00
.pipe( concat( 'theme.js' ) )
.pipe( gulp.dest( paths.js ) );
});
2016-03-20 08:49:32 +00:00
2018-07-04 09:37:13 +00:00
// Deleting any file inside the /src folder
gulp.task( 'clean-source', function() {
return del( ['src/**/*'] );
});
2016-12-22 08:55:28 +00:00
// Run:
// gulp watch-bs
// Starts watcher with browser-sync. Browser-sync reloads page automatically on your browser
gulp.task( 'watch-bs', gulp.series('browser-sync', 'watch', 'scripts'));
// 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 /////////////////////////
gulp.task( 'copy-assets', function(done) {
////////////////// All Bootstrap 4 Assets /////////////////////////
2017-10-23 10:21:08 +00:00
// Copy all JS files
var stream = gulp.src( `${paths.node}bootstrap/dist/js/**/*.js` )
.pipe( gulp.dest( `${paths.dev}/js/bootstrap4` ) );
2018-03-07 11:04:51 +00:00
// 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
gulp.src( `${paths.node}font-awesome/fonts/**/*.{ttf,woff,woff2,eot,svg}` )
2018-03-07 11:04:51 +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` )
.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` )
.pipe( gulp.dest( `${paths.dev}/sass/underscores` ) );
2018-04-11 18:48:08 +00:00
// _s JS files into /src/js
gulp.src( `${paths.node}undescores-for-npm/js/skip-link-focus-fix.js` )
.pipe( gulp.dest( `${paths.dev}/js` ) );
done();
2018-09-16 18:46:23 +00:00
});
2018-04-11 18:48:08 +00:00
2018-07-04 09:37:13 +00:00
// Deleting the files distributed by the copy-assets task
gulp.task( 'clean-vendor-assets', function() {
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 + '/**' ):'' )] );
});
// Deleting any file inside the /dist folder
gulp.task( 'clean-dist', function() {
return del( [paths.dist + '/**'] );
});
// Run
// gulp dist
2017-09-02 21:52:35 +00:00
// Copies the files to the /dist folder for distribution as simple theme
gulp.task( 'dist', gulp.series(['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': true } )
2018-03-07 11:19:00 +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 } ) )
2018-07-04 09:37:13 +00:00
.pipe( replace( '/js/skip-link-focus-fix.js', '/js' + paths.vendor + '/skip-link-focus-fix.js', { 'skipBinary': true } ) )
.pipe( gulp.dest( paths.dist ) );
}));
2018-04-02 20:16:04 +00:00
// Deleting any file inside the /dist-product folder
gulp.task( 'clean-dist-product', function() {
return del( [paths.distprod + '/**'] );
} );
2018-07-04 09:37:13 +00:00
// Run
// gulp dist-product
// Copies the files to the /dist-prod folder for distribution as theme with all assets
gulp.task( 'dist-product', gulp.series(['clean-dist-product'], function() {
return gulp.src( ['**/*', `!${paths.bower}`, `!${paths.bower}/**`, `!${paths.node}`, `!${paths.node}/**`, `!${paths.dist}`, `!${paths.dist}/**`, `!${paths.distprod}`, `!${paths.distprod}/**`, '*'] )
2018-07-04 09:37:13 +00:00
.pipe( gulp.dest( paths.distprod ) );
} ));
2018-07-04 09:37:13 +00:00
// Run
// gulp compile
// Compiles the styles and scripts and runs the dist task
gulp.task( 'compile', gulp.series( 'styles', 'scripts', 'dist' ));
2018-10-16 07:00:14 +00:00
// Run:
// gulp
// Starts watcher (default task)
gulp.task('default', gulp.series('watch'));