v7.19.0 — Updated docs image related tasks. (#123)

* v7.19.0 — Updated docs image related tasks.

* v7.19.0 — Grammar.

* v7.19.0 — Package version bump.

* v7.19.0 — Wrap conditional array syntax.

CHANGELOG.md

@@ -4,6 +4,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+v7.19.0
+------------------------------
+*April 11, 2018*
+
+### Added
+- Added `copy:img:docs` task and documentation.
+
+### Changed
+- The `images:optimise` no longer copies images into the docs asset dist folder.
+- The `images` task now copies all of the images in the assets dist folder over to the docs dist folder if running a docs task.
+
+
 v7.18.0
 ------------------------------
 *April 11, 2018*

README.md

@@ -196,7 +196,9 @@ Runs the following tasks
 
 - #### `images:svg-sprite`
 
-Generate an SVG sprite and copy into the dist directory
+  Generate an SVG sprite and copy into the dist directory
+
+It also runs the [`copy:img`](#copyjs-copycss-copyimg--copyfonts) and [`copy:assets`](#copyassets) tasks.
 
 ### `service-worker`
 
@@ -267,6 +269,10 @@ Pushes the documentation dist directory to the `gh-pages` branch.
 
 Removes document files already in the docs dist directory.
 
+- #### `copy:img:docs`
+
+Copies all of the images in the assets dist folder over to the docs dist folder.
+
 - #### `browser-sync`
 
 Watches for changes to files and reloads a local website instance.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeat/gulp-build-fozzie",
-  "version": "7.18.0",
+  "version": "7.19.0",
   "description": "Gulp build tasks for use across Fozzie modules",
   "main": "index.js",
   "author": "Damian Mullins <[email protected]> (http://www.damianmullins.com)",

tasks/copy.js

@@ -73,6 +73,17 @@ gulp.task('copy:img', () => {
     copy('img');
 });
 
+/**
+ * `copy:img:docs` Task
+ * ---------------------
+ * Copy all of the images in the assets dist folder over to the docs dist folder.
+ *
+ */
+gulp.task('copy:img:docs', () => gulp.src(`${pathBuilder.imgDistDir}/**/*`)
+    .pipe(plumber(config.gulp.onError))
+    .pipe(gulp.dest(pathBuilder.docsImgDistDir))
+);
+
 /**
  * `copy:fonts` Task
  * ---------------------

tasks/default.js

@@ -15,7 +15,7 @@ gulp.task('default', callback => {
         ['copy:fonts', 'images'],
         ['css', 'scripts'],
         ['logger:createFile'],
-        ...config.sw.isEnabled ? ['service-worker'] : [],
+        ...(config.sw.isEnabled ? ['service-worker'] : []),
         callback
     );
 

tasks/images.js

@@ -22,6 +22,7 @@ gulp.task('images', callback => {
         'clean:images',
         ['copy:img', 'copy:assets'],
         'images:optimise',
+        ...(config.docs.outputAssets ? ['copy:img:docs'] : []),
         'images:svg-sprite',
         callback
     );
@@ -51,13 +52,6 @@ gulp.task('images:optimise', () => gulp.src(`${pathBuilder.imgSrcDir}/**`)
         })
     ], { verbose: config.isDev }))
 
-    .pipe(
-        gulpif(config.docs.outputAssets,
-            // write the files to the docs directory
-            gulp.dest(pathBuilder.docsImgDistDir)
-        )
-    )
-
     // write the files to disk
     .pipe(gulp.dest(`${pathBuilder.imgDistDir}`))