npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-imgconv

v0.9.2

Published

a gulp plugin to convert images (format conversion, resizing, cutting in/out, watermarking etc.) for distribution or batch image processing

Downloads

19

Readme

gulp-imgconv

A gulp plugin to convert images (format conversion, resizing, cutting in/out, watermarking etc.) for distribution or batch image processing

Installation

npm install gulp-imgconv --save-dev

Change Log

  • v0.9.x: refactored pipeline construction to Fluent-API (or method-chainning model)

Usage

  • DISTRIBUTION: resize all images under src/, cutin with a round shape, add a watermark, sharpen, grascale, boolean with a 5-pointed star and save them to dst/ in PNG format
const gulp = require('gulp'), 
    gic = require('gulp-imgconv');

exports.imgconv = () => {
    gulp.src('src/*')
    .pipe(gic(gic
        .begin()
        .resize({
            width: 640,
            height: 480,
            fit: 'contain',
            background: '#00000000'    
        })
        .cutin(Buffer.from(`<?xml version="1.0" encoding="utf-8"?>
            <svg xmlns="http://www.w3.org/2000/svg" width="360" height="360" viewBox="0 0 480 480">
                <circle r="240" cx="240" cy="240"/>
            </svg>`))
        .watermark('png/watermark.png', {
            left: 400,
            top: 280
        })
        .sharpen()
        .grayscale()
        .boolean(Buffer.from(`<?xml version="1.0" encoding="utf-8"?>
            <svg xmlns="http://www.w3.org/2000/svg" width="255" height="240" viewBox="-20 0 71 48">
                <title>Five Pointed Star</title>
                <path fill="none" stroke="#000" d="m25,1 6,17h18l-14,11 5,17-15-10-15,10 5-17-14-11h18z"/>
            </svg>`),
            'eor'
        )
        .toFormat('png', {
            quality: 80
        })
        .commit()
    ))
    .pipe(gulp.dest('dst/')); 
};

Click below links to see the conversion effect

Original

Converted

  • PROCESSING: resize the original images in src/ to width = 800, sharpen, grayscale them and save to dst/ in corresponding formats (SVG, GIF -> PNG, otherwise the original format)
const gulp = require('gulp'), 
gic = require('gulp-imgconv');

exports.imgconv = () => {
gulp.src('src/*')
    .pipe(gic(gic
        .begin()
        .resize({
            width: 800, 
            fit: 'contain',
            background: '#00000000'    
        })
        .sharpen()
        .grayscale()
        .commit()
    ))
    .pipe(gulp.dest('dst/')); 
};

API

The only argument is a pipeline in Array design, and there're 2 basic functions:

  • resize(widith?: number, height?: number, opts?: {[k: string]: any}) - now a direct mapping to Sharp's resize function
    • Where width and height are size to resize to; when any parameter is ommitted, its value will be determined by fit option. Please refer to resizeOptsHelper object of this package to learn how to make up a correct opts object.
  • toFormat(fmt: string, opts?: {[k: string]: any})
    • Where fmt is the format to convert to (right now supports jpeg, png, tiff and webp). There are quite a few option choices for each format, please find more details from sharp official document

And 3 overlaying related featured functions inspired by my past experiences:

  • cutin/cutout/watermark(src: Buffer | string, opts?: {[k: string]: any}) - an encapsulation of Sharp's composite function
    • Where src is either the svg/png file name (in string) or the data (in Buffer) to overlay upon the original image, and you can learn how to construct the basic opts argument with the help of compositeOptsHelper, or read sharp official document to comprehensively understand the exact meaning of each option.

To construct this pipeline array, you can use chained method calling started by begin() and ended by commit().

Moreover, almost all other transformation related functions of sharp are supported with the same function prototype, please feel free to use like what I did in the test gulpfile.js file:

  • extend, extract, trim
  • rotate, flip, flop
  • sharpen, median, blur
  • flatten, gamma, negate, linear, normalize, convolve, threshould, recomb, modulate
  • tint, grayscale, toColorspace
  • removeAlpha, ensureAlpha, extractChannel, joinChannel, bandbool
  • composite, boolean

Thanks

Special gratitude to sharp and other dependencies

Author

tibetty [email protected]