rayelliott
/
understrap
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated to gulp4

This commit is contained in:
0dp 2018-04-02 22:16:04 +02:00
parent 5eae85e137
commit 9edc1164df
2 changed files with 108 additions and 227 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

312
gulpfile.js
View File

@ -1,224 +1,106 @@
// Defining requirements // Defining requirements
var gulp = require( 'gulp' ); var autoprefixer = require( 'autoprefixer' ),
var plumber = require( 'gulp-plumber' ); browserSync = require('browser-sync').create(),
var sass = require( 'gulp-sass' ); cleanCSS = require( 'gulp-clean-css' ),
var watch = require( 'gulp-watch' ); concat = require( 'gulp-concat' ),
var cssnano = require( 'gulp-cssnano' ); del = require( 'del' ),
var rename = require( 'gulp-rename' ); gulp = require( 'gulp' ),
var concat = require( 'gulp-concat' ); imagemin = require( 'gulp-imagemin' ),
var uglify = require( 'gulp-uglify' ); postcss = require( 'gulp-postcss' ),
var merge2 = require( 'merge2' ); rename = require( 'gulp-rename' ),
var imagemin = require( 'gulp-imagemin' ); replace = require( 'gulp-replace' ),
var ignore = require( 'gulp-ignore' ); sass = require( 'gulp-sass' ),
var rimraf = require( 'gulp-rimraf' ); sourcemaps = require( 'gulp-sourcemaps' ),
var clone = require( 'gulp-clone' ); uglify = require( 'gulp-uglify' );
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' );
// Configuration file to keep your code DRY // Configuration file to keep your code DRY
var cfg = require( './gulpconfig.json' ); const cfg = require( './gulpconfig.json' );
var paths = cfg.paths; const paths = cfg.paths;
// Run: // Compile SCSS to CSS
// gulp sass + cssnano + rename function scss( ) {
// Prepare the min.css for production (with 2 pipes to be sure that "theme.css" == "theme.min.css") return gulp.src( paths.sass + '/*.scss' )
gulp.task( 'scss-for-prod', function() {
var source = gulp.src( paths.sass + '/*.scss' )
.pipe( plumber({
errorHandler: function( err ) {
console.log( err );
this.emit( 'end' );
}
}) )
.pipe( sourcemaps.init({ loadMaps: true }) )
.pipe( sass() );
var pipe1 = source.pipe( clone() )
.pipe( sourcemaps.write( undefined, { sourceRoot: null } ) )
.pipe( gulp.dest( paths.css ) )
.pipe( rename( 'custom-editor-style.css' ) );
var pipe2 = source.pipe( clone() )
.pipe( cleanCSS( { compatibility: '*' } ) )
.pipe( rename( { suffix: '.min' } ) )
.pipe( sourcemaps.write( './' ) )
.pipe( gulp.dest( paths.css ) );
return merge( pipe1, pipe2 );
});
// Run:
// gulp sourcemaps + sass + reload(browserSync)
// Prepare the child-theme.css for the development environment
gulp.task( 'scss-for-dev', function() {
gulp.src( paths.sass + '/*.scss' )
.pipe( plumber( {
errorHandler: function( err ) {
console.log( err );
this.emit( 'end' );
}
} ) )
.pipe( sourcemaps.init({ loadMaps: true }) )
.pipe( sass() )
.pipe( sourcemaps.write( undefined, { sourceRoot: null } ) )
.pipe( gulp.dest( paths.css ) );
});
gulp.task( 'watch-scss', ['browser-sync'], function() {
gulp.watch( paths.sass + '/**/*.scss', ['scss-for-dev'] );
});
// 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' );
}
} ) )
.pipe(sourcemaps.init({loadMaps: true})) .pipe(sourcemaps.init({loadMaps: true}))
.pipe( sass( { errLogToConsole: true } ) ) .pipe(sass()).on('error', sass.logError)
.pipe( autoprefixer( 'last 2 versions' ) ) .pipe(postcss([
autoprefixer()
]))
.pipe(sourcemaps.write(undefined, { sourceRoot: null })) .pipe(sourcemaps.write(undefined, { sourceRoot: null }))
.pipe( gulp.dest( paths.css ) );
}
exports.scss = scss;
// Minify CSS
function minifycss( done ) {
gulp.src( paths.css + '/theme.css' )
.pipe( sourcemaps.init( { loadMaps: true } ) )
.pipe( cleanCSS( { compatibility: '*' } ) )
.pipe( rename( { suffix: '.min' } ) )
.pipe( sourcemaps.write( './' ) )
.pipe( gulp.dest( paths.css ) ) .pipe( gulp.dest( paths.css ) )
return stream;
});
// Run: gulp.src( paths.css + '/custom-editor-style.css' )
// gulp watch .pipe( sourcemaps.init( { loadMaps: true } ) )
// Starts watcher. Watcher runs gulp sass task on changes .pipe( cleanCSS( { compatibility: '*' } ) )
gulp.task( 'watch', function() { .pipe( rename( { suffix: '.min' } ) )
gulp.watch( paths.sass + '/**/*.scss', ['styles'] ); .pipe( sourcemaps.write( './' ) )
gulp.watch( [paths.dev + '/js/**/*.js', 'js/**/*.js', '!js/theme.js', '!js/theme.min.js'], ['scripts'] ); .pipe( gulp.dest( paths.css ) );
//Inside the watch task. done();
gulp.watch( paths.imgsrc + '/**', ['imagemin-watch'] ); };
});
/** exports.minifycss = minifycss;
* Ensures the 'imagemin' task is complete before reloading browsers
* @verbose
*/
gulp.task( 'imagemin-watch', ['imagemin'], function( done ) {
browserSync.reload();
done();
});
// Run: // Concatinate scripts and minify them
// gulp imagemin function scripts( done ) {
// Running image optimizing task
gulp.task( 'imagemin', function() {
gulp.src( paths.imgsrc + '/**' )
.pipe( imagemin() )
.pipe( gulp.dest( paths.img ) );
});
// 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 ) );
});
gulp.task( 'minifycss', 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' );
}
} ) )
.pipe( rename( { suffix: '.min' } ) )
.pipe( sourcemaps.write( './' ) )
.pipe( gulp.dest( paths.css ) );
});
gulp.task( 'cleancss', function() {
return gulp.src( paths.css + '/*.min.css', { read: false } ) // Much faster
.pipe( ignore( 'theme.css' ) )
.pipe( rimraf() );
});
gulp.task( 'styles', function( callback ) {
gulpSequence( 'sass', 'minifycss' )( callback );
} );
// Run:
// gulp browser-sync
// Starts browser-sync task for starting the server.
gulp.task( 'browser-sync', function() {
browserSync.init( cfg.browserSyncWatchFiles, cfg.browserSyncOptions );
} );
// Run:
// gulp watch-bs
// Starts watcher with browser-sync. Browser-sync reloads page automatically on your browser
gulp.task( 'watch-bs', ['browser-sync', 'watch', 'scripts'], function() {
} );
// Run:
// gulp scripts.
// Uglifies and concat all JS files into one
gulp.task( 'scripts', function() {
var scripts = [ var scripts = [
// Start - All BS4 stuff
paths.dev + '/js/bootstrap4/bootstrap.js', paths.dev + '/js/bootstrap4/bootstrap.js',
// End - All BS4 stuff
paths.dev + '/js/skip-link-focus-fix.js', paths.dev + '/js/skip-link-focus-fix.js',
// Adding currently empty javascript file to add on for your own themes´ customizations // Adding currently empty javascript file to add on for your own themes´ customizations
// Please add any customizations to this .js file only! // Please add any customizations to this .js file only!
paths.dev + '/js/custom-javascript.js' paths.dev + '/js/custom-javascript.js'
]; ];
gulp.src( scripts )
.pipe( concat( 'theme.min.js' ) )
.pipe( uglify() )
.pipe( gulp.dest( paths.js ) );
gulp.src( scripts ) gulp.src( scripts )
.pipe( concat( 'theme.js' ) ) .pipe( concat( 'theme.js' ) )
.pipe( gulp.dest( paths.js ) ); .pipe( gulp.dest( paths.js ) )
});
// Deleting any file inside the /src folder gulp.src( scripts )
gulp.task( 'clean-source', function() { .pipe( concat( 'theme.min.js' ) )
return del( ['src/**/*'] ); .pipe( uglify() )
}); .pipe( gulp.dest( paths.js ) );
done();
}
exports.scripts = scripts;
// Compress image assets
function imagemin() {
return gulp.src( paths.imgsrc + '/**' )
.pipe( imagemin() )
.pipe( gulp.dest( paths.img ) );
}
exports.imagemin = imagemin;
// Run: // Run:
// gulp copy-assets. // gulp copy-assets.
// 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 // 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
////////////////// All Bootstrap SASS Assets ///////////////////////// ////////////////// All Bootstrap SASS Assets /////////////////////////
gulp.task( 'copy-assets', function() { gulp.task( 'copy-assets', function(done) {
////////////////// All Bootstrap 4 Assets ///////////////////////// ////////////////// All Bootstrap 4 Assets /////////////////////////
// Copy all JS files // Copy all JS files
var stream = gulp.src( paths.node + 'bootstrap/dist/js/**/*.js' ) gulp.src( paths.node + 'bootstrap/dist/js/**/*.js' )
.pipe( gulp.dest( paths.dev + '/js/bootstrap4' ) ); .pipe( gulp.dest( paths.dev + '/js/bootstrap4' ) );
// Copy all Bootstrap SCSS files // Copy all Bootstrap SCSS files
@ -252,39 +134,45 @@ gulp.task( 'copy-assets', function() {
.pipe( gulp.dest( paths.js + paths.vendor ) ); .pipe( gulp.dest( paths.js + paths.vendor ) );
gulp.src( paths.node + 'popper.js/dist/umd/popper.js' ) gulp.src( paths.node + 'popper.js/dist/umd/popper.js' )
.pipe( gulp.dest( paths.js + paths.vendor ) ); .pipe( gulp.dest( paths.js + paths.vendor ) );
return stream;
done();
}); });
// Deleting the files distributed by the copy-assets task // Deleting any file inside the /src folder
gulp.task( 'clean-vendor-assets', function() { gulp.task( 'clean-source', 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 + '/**' ):'' )] ); return del( ['src/**/*', '!src'] );
});
// Deleting any file inside the /dist folder
gulp.task( 'clean-dist', function() {
return del( ['dist/**/*', '!dist'] );
}); });
// Run // Run
// gulp dist // gulp dist
// Copies the files to the /dist folder for distribution as simple theme // Copies the files to the /dist folder for distribution as simple theme
gulp.task( 'dist', ['clean-dist'], function() { 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': false } ) 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 } )
.pipe( replace( '/js/jquery.slim.min.js', '/js' + paths.vendor + '/jquery.slim.min.js', { 'skipBinary': true } ) ) .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/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( replace( '/js/skip-link-focus-fix.js', '/js' + paths.vendor + '/skip-link-focus-fix.js', { 'skipBinary': true } ) )
.pipe( gulp.dest( paths.dist ) ); .pipe( gulp.dest( paths.dist ) );
}));
// BrowserSync reload helper function
function reload( done ){
browserSync.reload();
done();
}
// BrowserSync main task
gulp.task( 'watch-bs', function( done ) {
browserSync.init( cfg.browserSyncWatchFiles, cfg.browserSyncOptions );
gulp.watch( paths.sass + '/**/*.scss', gulp.series(scss, minifycss, reload) );
gulp.watch( [paths.dev + '/js/**/*.js', 'js/**/*.js', '!js/theme.js', '!js/theme.min.js'], gulp.series( scripts, reload ) );
//Inside the watch task.
gulp.watch( paths.imgsrc + '/**', gulp.series( imagemin, reload ) );
done();
}); });
// Deleting any file inside the /dist folder
gulp.task( 'clean-dist', function() {
return del( [paths.dist + '/**'] );
});
// Run
// gulp dist-product
// Copies the files to the /dist-prod folder for distribution as theme with all assets
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 + '/**', '*'] )
.pipe( gulp.dest( paths.distprod ) );
} );
// Deleting any file inside the /dist-product folder
gulp.task( 'clean-dist-product', function() {
return del( [paths.distprod + '/**'] );
} );

23
package.json
View File

@ -27,31 +27,24 @@
}, },
"homepage": "https://understrap.com", "homepage": "https://understrap.com",
"dependencies": { "dependencies": {
"autoprefixer": "^8.2.0",
"bootstrap": "4.0.0", "bootstrap": "4.0.0",
"browser-sync": "^2.23.6", "browser-sync": "^2.23.6",
"del": "^3.0.0", "del": "^3.0.0",
"font-awesome": "^4.7.0", "font-awesome": "^4.7.0",
"gulp": "3.9.1", "gulp": "^4.0.0",
"gulp-clean-css": "^3.9.2", "gulp-clean-css": "^3.9.3",
"gulp-clone": "2.0.1",
"gulp-concat": "^2.6.1", "gulp-concat": "^2.6.1",
"gulp-cssnano": "^2.1.2",
"gulp-ignore": "^2.0.2",
"gulp-imagemin": "^4.1.0", "gulp-imagemin": "^4.1.0",
"gulp-merge": "^0.1.1", "gulp-postcss": "^7.0.1",
"gulp-plumber": "^1.2.0",
"gulp-rename": "^1.2.2", "gulp-rename": "^1.2.2",
"gulp-replace": "^0.6.1", "gulp-replace": "^0.6.1",
"gulp-rimraf": "^0.2.2", "gulp-sass": "^3.2.1",
"gulp-sass": "^3.1.0", "gulp-sourcemaps": "2.6.4",
"gulp-sequence": "1.0.0",
"gulp-sourcemaps": "2.6.2",
"gulp-uglify": "^3.0.0", "gulp-uglify": "^3.0.0",
"gulp-watch": "5.0.0", "gulp-watch": "5.0.0",
"merge2": "^1.2.1", "merge2": "^1.2.1",
"popper.js": "^1.12.9", "popper.js": "^1.14.1",
"run-sequence": "^2.2.1", "undescores-for-npm": "^1.0.0"
"undescores-for-npm": "^1.0.0",
"gulp-autoprefixer": "^5.0.0"
} }
} }