diff --git a/gulpconfig.json b/gulpconfig.json new file mode 100644 index 0000000..e279b3f --- /dev/null +++ b/gulpconfig.json @@ -0,0 +1,21 @@ +{ + "browserSyncOptions" : { + "proxy": "localhost/wordpress/", + "notify": false + }, + "browserSyncWatchFiles" : [ + "./css/*.min.css", + "./js/*.min.js", + "./**/*.php" + ], + "paths" : { + "js": "./js", + "css": "./css", + "sass": "./sass", + "node": "./node_modules/", + "bower": "./bower_components/", + "dev": "./src", + "dist": "./dist", + "distprod": "./dist-product" + } +} diff --git a/gulpfile.js b/gulpfile.js index e546e19..e7ab013 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1,28 +1,3 @@ -// Defining base paths -var basePaths = { - js: './js/', - node: './node_modules/', - dev: './src/' -}; - - -// browser-sync watched files -// automatically reloads the page when files changed -var browserSyncWatchFiles = [ - './css/*.min.css', - './js/*.min.js', - './**/*.php' -]; - - -// browser-sync options -// see: https://www.browsersync.io/docs/options/ -var browserSyncOptions = { - proxy: "localhost/wordpress/", - notify: false -}; - - // Defining requirements var gulp = require('gulp'); var plumber = require('gulp-plumber'); @@ -44,12 +19,15 @@ var del = require('del'); var cleanCSS = require('gulp-clean-css'); var gulpSequence = require('gulp-sequence'); +// Configuration file to keep your code DRY +var cfg = require('./gulpconfig.json'); +var paths = cfg.paths; // Run: // gulp sass + cssnano + rename // Prepare the min.css for production (with 2 pipes to be sure that "theme.css" == "theme.min.css") gulp.task('scss-for-prod', function() { - var source = gulp.src('./sass/*.scss') + var source = gulp.src(paths.sass + '/*.scss') .pipe(plumber({ errorHandler: function (err) { console.log(err); @@ -61,14 +39,14 @@ gulp.task('scss-for-prod', function() { var pipe1 = source.pipe(clone()) .pipe(sourcemaps.write(undefined, { sourceRoot: null })) - .pipe(gulp.dest('./css')) + .pipe(gulp.dest(paths.css)) .pipe(rename('custom-editor-style.css')) var pipe2 = source.pipe(clone()) .pipe(minify-css()) .pipe(rename({suffix: '.min'})) - .pipe(gulp.dest('./css')); + .pipe(gulp.dest(paths.css)); return merge(pipe1, pipe2); }); @@ -78,7 +56,7 @@ gulp.task('scss-for-prod', function() { // gulp sourcemaps + sass + reload(browserSync) // Prepare the child-theme.css for the development environment gulp.task('scss-for-dev', function() { - gulp.src('./sass/*.scss') + gulp.src(paths.sass + '/*.scss') .pipe(plumber({ errorHandler: function (err) { console.log(err); @@ -88,11 +66,11 @@ gulp.task('scss-for-dev', function() { .pipe(sourcemaps.init({loadMaps: true})) .pipe(sass()) .pipe(sourcemaps.write(undefined, { sourceRoot: null })) - .pipe(gulp.dest('./css')) + .pipe(gulp.dest(paths.css)) }); gulp.task('watch-scss', ['browser-sync'], function () { - gulp.watch('./sass/**/*.scss', ['scss-for-dev']); + gulp.watch(paths.sass + '/**/*.scss', ['scss-for-dev']); }); @@ -100,7 +78,7 @@ gulp.task('watch-scss', ['browser-sync'], function () { // gulp sass // Compiles SCSS files in CSS gulp.task('sass', function () { - var stream = gulp.src('./sass/*.scss') + var stream = gulp.src(paths.sass + '/*.scss') .pipe(plumber({ errorHandler: function (err) { console.log(err); @@ -108,7 +86,7 @@ gulp.task('sass', function () { } })) .pipe(sass()) - .pipe(gulp.dest('./css')) + .pipe(gulp.dest(paths.css)) .pipe(rename('custom-editor-style.css')) return stream; }); @@ -118,8 +96,8 @@ gulp.task('sass', function () { // gulp watch // Starts watcher. Watcher runs gulp sass task on changes gulp.task('watch', function () { - gulp.watch('./sass/**/*.scss', ['styles']); - gulp.watch([basePaths.dev + 'js/**/*.js','js/**/*.js','!js/theme.js','!js/theme.min.js'], ['scripts']); + gulp.watch(paths.sass + '/**/*.scss', ['styles']); + gulp.watch([paths.dev + '/js/**/*.js','js/**/*.js','!js/theme.js','!js/theme.min.js'], ['scripts']); //Inside the watch task. gulp.watch('./img/**', ['imagemin']) @@ -139,7 +117,7 @@ gulp.task('imagemin', function(){ // gulp cssnano // Minifies CSS files gulp.task('cssnano', function(){ - return gulp.src('./css/theme.css') + return gulp.src(paths.css + '/theme.css') .pipe(sourcemaps.init({loadMaps: true})) .pipe(plumber({ errorHandler: function (err) { @@ -150,11 +128,11 @@ gulp.task('cssnano', function(){ .pipe(rename({suffix: '.min'})) .pipe(cssnano({discardComments: {removeAll: true}})) .pipe(sourcemaps.write('./')) - .pipe(gulp.dest('./css/')) + .pipe(gulp.dest(paths.css)) }); gulp.task('minify-css', function() { - return gulp.src('./css/theme.css') + return gulp.src(paths.css + '/theme.css') .pipe(sourcemaps.init({loadMaps: true})) .pipe(cleanCSS({compatibility: '*'})) .pipe(plumber({ @@ -165,11 +143,11 @@ gulp.task('minify-css', function() { })) .pipe(rename({suffix: '.min'})) .pipe(sourcemaps.write('./')) - .pipe(gulp.dest('./css/')); + .pipe(gulp.dest(paths.css)); }); gulp.task('cleancss', function() { - return gulp.src('./css/*.min.css', { read: false }) // much faster + return gulp.src(paths.css + '/*.min.css', { read: false }) // much faster .pipe(ignore('theme.css')) .pipe(rimraf()); }); @@ -181,7 +159,7 @@ gulp.task('styles', function(callback){ gulpSequence('sass', 'minify-css')(callb // gulp browser-sync // Starts browser-sync task for starting the server. gulp.task('browser-sync', function() { - browserSync.init(browserSyncWatchFiles, browserSyncOptions); + browserSync.init(cfg.browserSyncWatchFiles, cfg.browserSyncOptions); }); @@ -198,20 +176,20 @@ gulp.task('scripts', function() { var scripts = [ // Start - All BS4 stuff - basePaths.dev + 'js/bootstrap4/bootstrap.js', + paths.dev + '/js/bootstrap4/bootstrap.js', // End - All BS4 stuff - basePaths.dev + 'js/skip-link-focus-fix.js' + paths.dev + '/js/skip-link-focus-fix.js' ]; gulp.src(scripts) .pipe(concat('theme.min.js')) .pipe(uglify()) - .pipe(gulp.dest('./js/')); + .pipe(gulp.dest(paths.js)); gulp.src(scripts) .pipe(concat('theme.js')) - .pipe(gulp.dest('./js/')); + .pipe(gulp.dest(paths.js)); }); // Deleting any file inside the /src folder @@ -229,42 +207,42 @@ gulp.task('copy-assets', function() { ////////////////// All Bootstrap 4 Assets ///////////////////////// // Copy all JS files - var stream = gulp.src(basePaths.node + 'bootstrap/dist/js/**/*.js') - .pipe(gulp.dest(basePaths.dev + '/js/bootstrap4')); + var stream = gulp.src(paths.node + 'bootstrap/dist/js/**/*.js') + .pipe(gulp.dest(paths.dev + '/js/bootstrap4')); // Copy all Bootstrap SCSS files - gulp.src(basePaths.node + 'bootstrap/scss/**/*.scss') - .pipe(gulp.dest(basePaths.dev + '/sass/bootstrap4')); + gulp.src(paths.node + 'bootstrap/scss/**/*.scss') + .pipe(gulp.dest(paths.dev + '/sass/bootstrap4')); return stream; ////////////////// End Bootstrap 4 Assets ///////////////////////// // Copy all Font Awesome Fonts - var stream = gulp.src(basePaths.node + 'font-awesome/fonts/**/*.{ttf,woff,woff2,eof,svg}') + var stream = gulp.src(paths.node + 'font-awesome/fonts/**/*.{ttf,woff,woff2,eof,svg}') .pipe(gulp.dest('./fonts')); // Copy all Font Awesome SCSS files - gulp.src(basePaths.node + 'font-awesome/scss/*.scss') - .pipe(gulp.dest(basePaths.dev + '/sass/fontawesome')); + gulp.src(paths.node + 'font-awesome/scss/*.scss') + .pipe(gulp.dest(paths.dev + '/sass/fontawesome')); // _s SCSS files - gulp.src(basePaths.node + 'undescores-for-npm/sass/media/*.scss') - .pipe(gulp.dest(basePaths.dev + '/sass/underscores')); + gulp.src(paths.node + 'undescores-for-npm/sass/media/*.scss') + .pipe(gulp.dest(paths.dev + '/sass/underscores')); // _s JS files into /src/js - gulp.src(basePaths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') - .pipe(gulp.dest(basePaths.dev + '/js')); + gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') + .pipe(gulp.dest(paths.dev + '/js')); // _s JS files into /js - gulp.src(basePaths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') - .pipe(gulp.dest(basePaths.js)); + gulp.src(paths.node + 'undescores-for-npm/js/skip-link-focus-fix.js') + .pipe(gulp.dest(paths.js + paths.vendor)); // Copy Popper JS files - gulp.src(basePaths.node + 'popper.js/dist/umd/popper.min.js') - .pipe(gulp.dest(basePaths.js)); - gulp.src(basePaths.node + 'popper.js/dist/umd/popper.js') - .pipe(gulp.dest(basePaths.js)); + gulp.src(paths.node + 'popper.js/dist/umd/popper.min.js') + .pipe(gulp.dest(paths.js + paths.vendor)); + gulp.src(paths.node + 'popper.js/dist/umd/popper.js') + .pipe(gulp.dest(paths.js + paths.vendor)); return stream; }); @@ -272,24 +250,24 @@ gulp.task('copy-assets', function() { // gulp dist // Copies the files to the /dist folder for distribution as simple theme gulp.task('dist', ['clean-dist'], function() { - gulp.src(['**/*','!bower_components','!bower_components/**','!node_modules','!node_modules/**','!src','!src/**','!dist','!dist/**','!dist-product','!dist-product/**','!sass','!sass/**','!readme.txt','!readme.md','!package.json','!gulpfile.js','!CHANGELOG.md','!.travis.yml','!jshintignore', '!codesniffer.ruleset.xml', '*']) - .pipe(gulp.dest('dist/')) + 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', '!gulpfile.js', '!CHANGELOG.md', '!.travis.yml', '!jshintignore', '!codesniffer.ruleset.xml', '*']) + .pipe(gulp.dest(paths.dist)); }); // Deleting any file inside the /dist folder gulp.task('clean-dist', function () { - return del(['dist/**/*',]); + 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() { - gulp.src(['**/*','!bower_components','!bower_components/**','!node_modules','!node_modules/**','!dist','!dist/**','!dist-product','!dist-product/**', '*']) - .pipe(gulp.dest('dist-product/')) + 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(['dist-product/**/*',]); + return del([paths.distprod + '/**',]); });