Merge branch 'release/7.1.0'

Author: dwightjack

build/gulp-config/properties.js

@@ -8,5 +8,7 @@ module.exports = {
 
     buildOnly: false, //set to `true` when paired with Phing
 
-    viewsExt: ['html', 'njk'] //for php projects use: '*.{html,php,phtml}'
+    viewsExt: ['html', 'njk'], //for php projects use: '*.{html,php,phtml}'
+
+    enableNotify: true //set to `false` to disable gulp-notify plugin
 };

build/gulp-tasks/fonts.js

@@ -3,17 +3,19 @@
  * ===============================
  */
 
-module.exports = (gulp, $, options) => () => {
+const { getNotifier } = require('./lib/plugins');
 
+module.exports = (gulp, $, options) => () => {
     const paths = require('../gulp-config/paths');
-
     const destFolder = paths.toPath('dist.assets/fonts');
     const filesMatch = '**/*.{eot,svg,ttf,woff,woff2}';
 
+    const { notify } = getNotifier(options);
+
     return gulp.src([paths.toPath(`src.assets/fonts/${filesMatch}`)])
         .pipe($.changed(destFolder))
         .pipe(gulp.dest(destFolder))
-        .pipe($.if(options.isWatching, $.notify({ message: 'Fonts synced', onLast: true })))
+        .pipe(notify({ message: 'Fonts synced', onLast: true }))
         .pipe($.size({ title: 'fonts' }));
 
 };

build/gulp-tasks/images.js

@@ -3,12 +3,14 @@
  * ===============================
  */
 const paths = require('../gulp-config/paths');
+const { getNotifier } = require('./lib/plugins');
 
 module.exports = (gulp, $, options) => () => {
     const destPath = paths.toPath('dist.assets/images');
     const filesMatch = '**/*.{png,jpg,gif,svg,webp}';
     const plugins = [];
-    const { production, isWatching } = options;
+    const { production } = options;
+    const { notify } = getNotifier(options);
 
     plugins.push($.imagemin.svgo({
         plugins: [
@@ -31,7 +33,7 @@ module.exports = (gulp, $, options) => () => {
         .pipe(gulp.dest(destPath))
         .pipe($.if(production, $.rev.manifest({ merge: true, path: paths.toPath('dist.root/dist.revmap') })))
         .pipe($.if(production, gulp.dest('.')))
-        .pipe($.if(isWatching, $.notify({ message: 'Images Processed', onLast: true })))
+        .pipe(notify({ message: 'Images Processed', onLast: true }))
         .pipe($.size({ title: 'images' }));
 
 };

build/gulp-tasks/lib/plugins.js

@@ -4,8 +4,9 @@
 
 const through = require('through2');
 const PluginError = require('plugin-error');
+const notify = require('gulp-notify');
 
-module.exports.map = function map(fn) {
+const map = function map(fn) {
 
     const mapFn = typeof fn === 'function' ? fn : (val) => val;
 
@@ -32,4 +33,34 @@ module.exports.map = function map(fn) {
 
         cb();
     });
+};
+
+const noop = () => through.obj();
+
+let reloadStream;
+const getReloadStream = ({ isWatching, livereload, buildHash }) => {
+    if (isWatching && livereload) {
+        return reloadStream || (reloadStream = require('browser-sync').get(buildHash).stream); //eslint-disable-line no-return-assign
+    }
+    return noop;
+};
+
+const getNotifier = ({ isWatching, enableNotify }) => {
+    if (isWatching && enableNotify) {
+        return {
+            notify,
+            errorHandler: notify.onError('Error: <%= error.message %>')
+        };
+    }
+    return {
+        notify: noop,
+        errorHandler: true
+    };
+};
+
+module.exports = {
+    map,
+    noop,
+    getReloadStream,
+    getNotifier
 };

build/gulp-tasks/media.js

@@ -4,15 +4,17 @@
  */
 
 const paths = require('../gulp-config/paths');
+const { getNotifier } = require('./lib/plugins');
 
 module.exports = (gulp, $, options) => () => {
 
     const distPath = paths.toPath('dist.assets/media');
+    const { notify } = getNotifier(options);
 
     return gulp.src(paths.toPath('src.assets/media/**/*.*'))
         .pipe($.changed(distPath))
         .pipe(gulp.dest(distPath))
-        .pipe($.if(options.isWatching, $.notify({ message: 'Media files synced', onLast: true })))
+        .pipe(notify({ message: 'Media files synced', onLast: true }))
         .pipe($.size({ title: 'media' }));
 
 };

build/gulp-tasks/scripts.js

@@ -8,18 +8,18 @@ const paths = require('../gulp-config/paths');
 const srcPath = paths.toPath('src.assets/js');
 const jsPath = paths.toPath('dist.assets/js');
 const rootPath = paths.toPath('dist.root');
+const { getNotifier } = require('./lib/plugins');
 
 module.exports = (gulp, $, options) => () => {
-
-    const destPath = options.production ? jsPath.replace(rootPath, paths.get('tmp')) : jsPath;
+    const { production } = options;
+    const destPath = production ? jsPath.replace(rootPath, paths.get('tmp')) : jsPath;
+    const { notify, errorHandler } = getNotifier(options);
 
     return gulp.src([`${srcPath}/**/*.js`, `!${srcPath}/**/*.{spec,conf}.js`])
-        .pipe($.plumber({
-            errorHandler: $.notify.onError('Error: <%= error.message %>')
-        }))
+        .pipe($.plumber({ errorHandler }))
         .pipe($.babel())
         .pipe(gulp.dest(destPath))
-        .pipe($.if(options.isWatching, $.notify({ message: 'Scripts Compiled', onLast: true })))
+        .pipe(notify({ message: 'Scripts Compiled', onLast: true }))
         .pipe($.size({ title: 'scripts' }));
 
 };

build/gulp-tasks/styles.js

@@ -7,11 +7,9 @@ module.exports = (gulp, $, options) => {
 
     const path = require('path');
     const autoprefixer = require('autoprefixer');
-    const through = require('through2');
+    const { noop, getReloadStream, getNotifier } = require('./lib/plugins');
     const paths = require('../gulp-config/paths');
     const sassFunctions = require('./lib/sass-functions')(options);
-    const noop = () => through.obj();
-
     const { production, banners } = options;
     let destPath = paths.toPath('dist.assets/css');
     let optimizePipe = noop;
@@ -35,21 +33,13 @@ module.exports = (gulp, $, options) => {
 
     return () => {
 
+        const { notify, errorHandler } = getNotifier(options);
 
-        let reloadStream;
-        function reloadStreamFn() {
-            if (options.isWatching && options.livereload) {
-                return reloadStream || (reloadStream = require('browser-sync').get(options.buildHash).stream); //eslint-disable-line no-return-assign
-            }
-            return noop;
-        }
 
         return gulp.src([
             paths.toPath('src.assets/styles/**/*.{sass,scss}')
         ])
-            .pipe($.plumber({
-                errorHandler: $.notify.onError('Error: <%= error.message %>')
-            }))
+            .pipe($.plumber({ errorHandler }))
             .pipe($.sourcemaps.init())
             .pipe($.sass({
                 precision: 10,
@@ -63,8 +53,8 @@ module.exports = (gulp, $, options) => {
             .pipe($.if(production, optimizePipe()))
             .pipe($.sourcemaps.write('.'))
             .pipe(gulp.dest(paths.toPath('dist.assets/css')))
-            .pipe(reloadStreamFn()({ match: '**/*.css' }))
-            .pipe($.if(options.isWatching, $.notify({ message: 'SASS Compiled', onLast: true })))
+            .pipe(getReloadStream(options)({ match: '**/*.css' }))
+            .pipe(notify({ message: 'SASS Compiled', onLast: true }))
             .pipe($.size({ title: 'styles' }));
     };
 

build/gulp-tasks/views.js

@@ -12,7 +12,7 @@ module.exports = (gulp, $, options) => {
     const _ = require('lodash');
     const glob = require('globby');
     const through = require('through2');
-    const { map } = require('./lib/plugins');
+    const { map, getNotifier } = require('./lib/plugins');
     const rendererCreator = require('./lib/renderers');
 
     const baseData = {};
@@ -70,6 +70,7 @@ module.exports = (gulp, $, options) => {
     return () => {
 
         const htmlFilter = $.filter(`**/${viewmatch}`, { restore: true });
+        const { notify, errorHandler } = getNotifier(options);
 
         const data = glob.sync('{,*/}*.json', { cwd: fixturesPath }).reduce((obj, filename) => {
             const id = _.camelCase(filename.toLowerCase().replace('.json', ''));
@@ -78,9 +79,7 @@ module.exports = (gulp, $, options) => {
         }, {});
 
         return gulp.src([`${viewPath}/{,*/}${viewmatch}`, `!${viewPath}/{,*/}_*.*`])
-            .pipe($.plumber({
-                errorHandler: $.notify.onError('Error: <%= error.message %>')
-            }))
+            .pipe($.plumber({ errorHandler }))
             .pipe(map((code, filepath) => {
                 const engine = renderer.match(filepath);
                 if (engine) {
@@ -97,6 +96,6 @@ module.exports = (gulp, $, options) => {
             .pipe(htmlFilter.restore)
             .pipe($.if(production, $.rev.manifest(paths.toPath('dist.root/dist.revmap'), { merge: true })))
             .pipe($.if(production, gulp.dest('.')))
-            .pipe($.if(options.isWatching, $.notify({ message: 'Views rendered', onLast: true })));
+            .pipe(notify({ message: 'Views rendered', onLast: true }));
     };
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "wok",
   "description": "A Static Website Boilerplate",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -26,7 +26,9 @@
     "node": ">=6.9.0"
   },
   "scripts": {
-    "lint:build": "eslint -c ./.eslintrc.json ./build/**/*.js"
+    "lint:build": "eslint -c ./.eslintrc.json ./build/**/*.js",
+    "start": "gulp serve",
+    "build": "gulp --production"
   },
   "browserslist": [
     "last 1 major version",