gulp-image-process

A Gulp task for processing images base on sharp for its speed, features and easiness of deployement.

Installation

  npm install gulp gulp-image-process --save-dev

Usage

'use strict'
const imageProcess = require('gulp-image-process')
const gulp = require('gulp')
const path = require('path')

gulp.task('images', () => {
  let imageFolder = path.resolve('test', 'resources', 'src', '*.jpg')
  return gulp
    .src(imageFolder)
    .pipe(
      imageProcess({
        verboseLogging: true,
        progressive:true,
        width:200,
        height:200,
        output: 'webp',
        ignoreRatio:false,
        multipleResize: [150,300],
        watermark: {
          filePath: 'test/resources/src/watermark.png',
          position: 'north',
          maxSize: 20,
          margin: 30,
          isCover: true
        }
      })
    )
    .pipe(gulp.dest(path.resolve('test', 'result')))
})

API

options

options.output

Type: String
Default: false

Force the output format. Possible values jpeg|png|webp

options.quality

Type: Number
Default: 100

Quality of the output image. From 0 to 100.

options.verboseLogging

Type: Boolean
Default: false

Enable the verbose logging.

options.multipleResize

Type: Array<Number>
Default: false

Will perform multiple resize of the values passed in parameter. Resizes are made on the rendered images, for example it will resize the image with the watermark.

options.keepMetadata

Type: Boolean
Default: false

Keep the EXIF file on the output file.

options.progressive

Type: Boolean
Default: false

Output using progressive scan. Only available for jpeg output.

options.ignoreRatio

Type: Boolean
Default: false

While resizing it will ignore the base ratio of the image with a crop.

options.watermark

Type: Object
Default: null

options.watermark.filePath

Type: String
Default: ''
Is Mandatory: True

Path of the watermark file.

options.watermark.isCover

Type: Boolean
Is Mandatory: True

If true & watermark size bigger
then image - clipped by edges

options.watermark.sizePattern

Type: Number
Is Mandatory: True

Size water mark pattern. Use if isCover=true.
If sizePattern bigger than waterMark width or
height set min value from this values

options.watermark.positionPattern

Type: String
Default: 'left top' Is Mandatory: False

options.watermark.position

Type: String
Default: ''
Is Mandatory: True

Position of the watermark on the image.
Possible values:

  center
  north
  south
  west
  east
  northwest
  northeast
  southwest
  southeast

Little reminder:

northwest   north     northeast
        \     |     /
          \   |   /
west   ---- center ----   east
          /   |   \
        /     |     \
southwest   south     southeast

options.watermark.maxSize

Type: Number
Default: -1

Max Size in Percent of the watermark on the image. If default value is used, the watermark will get its original size.

options.watermark.margin

Type: Number
Default: 0

Margin of the watermark from the border of the image. Applied to all coordinates. Similar of css attribute margin:<value>px;

TODO

• Unit tests :v
• Optimization prompt (diff input / ouput size)

License

MIT License