Merge pull request #9 from Mitranim/master

added missing flatten option

Author: atufkas

README.md

@@ -60,86 +60,97 @@ gulp.task('default', function () {
 
 #### options.width
 
-Type: `Number`  
+Type: `Number`
+
 Default value: `0` (only if height is defined)
 
 A number value that is passed as pixel or percentage value to imagemagick.
 
 
 #### options.height
 
-Type: `Number`  
+Type: `Number`
+
 Default value: `0` (only if width is defined)
 
 A number value that is passed as pixel or percentage value to imagemagick.
 
 
 #### options.upscale
 
-Type: `Boolean`  
+Type: `Boolean`
+
 Default value: `false`
 
 Determines whether images will be upscaled. If set to `false` (default), image will be copied instead of resized if it would be upscaled by resizing.
 
 
 #### options.crop
 
-Type: `Boolean`  
+Type: `Boolean`
+
 Default value: `false`
 
 Determines whether images will be cropped after resizing to exactly match `options.width` and `options.height`.
 
 
 #### options.gravity
 
-Type: `String`  
-Default value: `Center`  
+Type: `String`
+
+Default value: `Center`
 Possible values: `NorthWest`, `North`, `NorthEast`, `West`, `Center`, `East`, `SouthWest`, `South`, `SouthEast`
 
 When cropping images this sets the image gravity. Doesn't have any effect, if `options.crop` is `false`.
 
 
 #### options.quality
 
-Type: `Number`  
+Type: `Number`
+
 Default value: `1`
 
 Determines the output quality of the resized image. Ranges from `0` (really bad) to `1` (almost lossless). Only applies to jpg images.
 
 
 #### options.format
 
-Type: `String`  
-Default value: Format of the input file  
+Type: `String`
+
+Default value: Format of the input file
 Possible values: `gif`, `png`, `jpeg` etc.
 
 Override the output format of the processed file.
 
 #### options.filter
 
-Type: `String`  
+Type: `String`
+
 Possible values: `Point`, `Box`, `Triangle`, `Hermite`, `Hanning`, `Hamming`, `Blackman`, `Gaussian`, `Quadratic`, `Cubic`, `Catrom`, `Mitchell`, `Lanczos`, `Bessel`, `Sinc`
 
 Set the filter to use when resizing (e.g. Catrom is very good for reduction, while hermite is good for enlargement).
 
 #### options.sharpen
 
-Type: `Boolean | String`  
+Type: `Boolean | String`
+
 Default value: `false`
 
 Set to `true` to apply a slight unsharp mask after resizing.
 Or set a string to setup the unsharp. See [gm unsharp documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-unsharp). (e.g. '0.5x0.5+0.5+0.008')
 
 #### options.samplingFactor
 
-Type: `Array[Cr, Cb]`  
+Type: `Array[Cr, Cb]`
+
 Possible values: `[2, 2]` for 4:2:2, `[1, 1]` for 4:1:1
 
 Define chroma subsampling
 
 #### options.noProfile
 
-Type: `Boolean`  
+Type: `Boolean`
+
 Default value: `false`
 
 Set to `true` to enforce removal of all embedded profile data like icc, exif, iptc, xmp
@@ -149,21 +160,31 @@ cases where thumbnails are generated for web preview purposes. For details look
 
 #### options.imageMagick
 
-Type: `Boolean`  
+Type: `Boolean`
+
 Default value: `false`
 
 Set to `true` when using ImageMagick instead of GraphicsMagick.
 
 ### options.background
 
 Type: `String`
+
 Possible values: `none` to keep transparency, `beige` to set beige background, `#888` for gray.
 
 Define background color (default is white), for example when converting SVG images to PNGs.
 See [gm background documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-background)
 
+### options.flatten
+
+Type: `Boolean`
+
+Default value: `false`
+
+Combines image layers into one. Can be used for layered formats such as PNG. See [gm flatten documentation](http://www.graphicsmagick.org/GraphicsMagick.html#details-flatten).
 
 ## More Examples
+
 ```js
 // Converting from png to jpeg. No resizing.
 gulp.task('convert_png', function () {

gulpfile.js

@@ -134,6 +134,11 @@ resize("test/fixtures/hamburg.jpg", "noProfile", {
   noProfile: true
 });
 
+resize("test/fixtures/wikipedia.png", "flatten", {
+  format: "jpg",
+  flatten: true
+});
+
 gulp.task("image_resize", resizeTasks);
 
 gulp.task("test", function(callback) {

index.js

@@ -21,7 +21,8 @@ module.exports = function imageResizer(_options) {
     noProfile   : false,
     sharpen     : false,
     imageMagick : false,
-    format      : null
+    format      : null,
+    flatten     : false
   });
 
   return gm(function(gmfile, done) {
@@ -97,6 +98,10 @@ module.exports = function imageResizer(_options) {
           gmfile = gmfile.unsharp(options.sharpen);
         }
 
+        if (options.flatten) {
+          gmfile = gmfile.flatten();
+        }
+
         if (options.background) {
           gmfile = gmfile.background(options.background);
         }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gulp-image-resize",
   "description": "Resizing images made easy.",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "homepage": "https://github.com/scalableminds/gulp-image-resize",
   "author": {
     "name": "Norman Rzepka",

test/expected/flatten/wikipedia.jpg

@@ -173,3 +173,7 @@ describe("noProfile", function () {
     });
   });
 });
+
+describe("flatten", function () {
+  it("should flatten the wikipedia image", createTests("flatten", "wikipedia.jpg"));
+});