gulp-sharp2

This plugin is a modern version of @forward-software/gulp-sharp and other gulp plugins for images processing with sharp.

Contents

• Install
• Examples
  • Convert SVG to monochrome PNG
  • Replace @forward-software/gulp-sharp plugin
    • Convert images to JPEG format
    • Convert images to PNG format
    • Convert images to TIFF format
    • Convert images to WebP format
• API
• License

Install

npm install --save-dev gulp-sharp2

Examples

Convert SVG to monochrome PNG

sharp2 can create monochrome PNG from .svg files.

import { sharp2 } from '#gulp-sharp2';
import GulpClient from 'gulp';
import rename from 'gulp-rename';

function task1() {
  return GulpClient.src('fixtures/*.svg', { encoding: false })
    .pipe(sharp2((sharpObject) => sharpObject
      .resize({ width: 600 })
      .toColorspace('b-w')
      .png({
        compressionLevel: 9,
        colors: 2
      }),
      {
        sharpOptions: {
          density: 600,
          ignoreIcc: true
        }
      }
    ))
    .pipe(rename({ extname: '.png' }))
    .pipe(GulpClient.dest('output'));
};
task1.description = 'Test gulp task for converting SVG to monochrome PNG';
GulpClient.task(task1);

Source SVG image:

Output PNG image:

Replace @forward-software/gulp-sharp plugin

This plugin provides interface, compatible with @forward-software/gulp-sharp plugin.

Convert images to JPEG format

import { jpeg as gulpJpeg } from '#gulp-sharp2/gulp-sharp';
import GulpClient from 'gulp';

function task1() {
  return GulpClient.src('fixtures/*.png', { encoding: false })
    .pipe(gulpJpeg({ quality: 90 }))
    .pipe(GulpClient.dest('output'));
};
task1.description = 'Test gulp task for converting PNG to JPEG';
GulpClient.task(task1);

Source and output images:

Convert images to PNG format

import { png } from '#gulp-sharp2/gulp-sharp';
import GulpClient from 'gulp';

function task1() {
  return GulpClient.src('fixtures/*.jpeg', { encoding: false })
    .pipe(png({ palette: true }))
    .pipe(GulpClient.dest('output'));
};
task1.description = 'Test gulp task for converting JPEG to PNG';
GulpClient.task(task1);

Source and output images:

Convert images to TIFF format

import { tiff } from '#gulp-sharp2/gulp-sharp';
import GulpClient from 'gulp';

function task1() {
  return GulpClient.src('fixtures/*.png', { encoding: false })
    .pipe(tiff({ quality: 90 }))
    .pipe(GulpClient.dest('output'));
};
task1.description = 'Test gulp task for converting PNG to TIFF';
GulpClient.task(task1);

Source and output images:

Convert images to WebP format

import { webp } from '#gulp-sharp2/gulp-sharp';
import GulpClient from 'gulp';

function task1() {
  return GulpClient.src('fixtures/*.jpeg', { encoding: false })
    .pipe(webp({ preset: 'drawing' }))
    .pipe(GulpClient.dest('output'));
};
task1.description = 'Test gulp task for converting JPEG to WebP';
GulpClient.task(task1);

Source and output images:

API

Please, read the API reference.

License

MIT © Sergei S. Betke