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-scale-images

v3.0.3

Published

Gulp plugin to resize each image into multiple smaller variants.

Downloads

291

Readme

gulp-scale-images

Gulp plugin to make each image smaller. Combined with flat-map, you can create multiple variantes per image, which is useful for responsive images.

npm version build status ISC-licensed support me via GitHub Sponsors chat with me on Twitter

Installing

npm install gulp-scale-images --save-dev

Usage

gulp-scale-images expects the instructions for each file to be in file.scale. They may look like this:

{
	maxWidth: 300, // optional maximum width
	maxHeight: 400, // optional maximum height
	format: 'jpeg', // optional, one of ('jpeg', 'png', 'webp')
	withoutEnlargement: false, // optional, default is true
	fit: 'inside', // optional, default is 'cover', one of ('cover', 'contain', 'fill', 'inside', 'outside')
	rotate: true, // optional
	metadata: false, // copy metadata over?
	formatOptions: {} // optional, additional format options for sharp engine
}

Note: You must specify at least one of maxWidth and maxHeight.

You can pass additional format options to Sharp engine using formatOptions parameter. Docs can be found at Sharp API.

An example, we're going to generate two smaller variants for each input file. We're going to use flat-map for this:

const gulp = require('gulp')
const flatMap = require('flat-map').default
const scaleImages = require('gulp-scale-images')

const twoVariantsPerFile = (file, cb) => {
	const pngFile = file.clone()
	pngFile.scale = {maxWidth: 500, maxHeight: 500, format: 'png'}
	const jpegFile = file.clone()
	jpegFile.scale = {maxWidth: 700, format: 'jpeg'}
	cb(null, [pngFile, jpegFile])
}

gulp.src('src/*.{jpeg,jpg,png,gif}')
.pipe(flatMap(twoVariantsPerFile))
.pipe(scaleImages())
.pipe(gulp.dest(…))

Note: Unlike sharp, gulp-scale-image is not designed to process untrusted user input. For example, it turns off sharp's input pixel limit altogether.

Definining scale instructions based on metadata

You can let gulp-scale-images read the image metadata first, to device what to do with the file:

const readMetadata = require('gulp-scale-images/read-metadata')
const through = require('through2')
const scaleImages = require('gulp-scale-images')

const computeScaleInstructions = (file, _, cb) => {
	readMetadata(file, (err, meta) => {
		if (err) return cb(err)
		file = file.clone()
		file.scale = {
			maxWidth: Math.floor(meta.width / 2),
			maxHeight: Math.floor(meta.height / 2)
		}
		cb(null, file)
	})
}

gulp.src(…)
.pipe(through.obj(computeScaleInstructions))
.pipe(scaleImages())
.pipe(gulp.dest(…))

Custom output file names

By default, gulp-scale-images will use {basename}.{maxWidth}w-{maxHeight}h.{format} (e.g. foo.500w-300h.jpeg). You can define a custom logic though:

const path = require('path')
const scaleImages = require('gulp-scale-images')

const computeFileName = (output, scale, cb) => {
	const fileName = [
		path.basename(output.path, output.extname), // strip extension
		scale.maxWidth + 'w',
		scale.format || output.extname
	].join('.')
	cb(null, fileName)
}

gulp.src(…)
.pipe(through.obj(computeScaleInstructions))
.pipe(scaleImages(computeFileName)) // not that we pass computeFileName here
.pipe(gulp.dest(…))

gulp-scale-images works well with

  • flat-map – A flat map implementation for node streams. (One chunk in, n chunks out.)
  • replace-ext – Replaces a file extension with another one.

Similar libraries

Some similar libraries and why I think this one is better.

  • gulp-image-resize
    • uses gm instead of sharp, requires gm to be installed
    • supports only one scale instruction
  • gulp-sharp
    • is not being maintained
    • has no tests
    • supports only one scale instruction
  • gulp-retinize
    • doesn't seem to be maintained
    • uses gm instead of sharp, requires gm to be installed
    • only works for files on disk
    • supports only one scale instruction
  • gulp-imgconv
    • has no tests
    • supports only one scale instruction
  • gulp-inline-resize
    • doesn't do one thing
    • uses gm instead of sharp, requires gm to be installed
  • gulp-unretina
    • less flexible
    • uses gm instead of sharp, requires gm to be installed
  • gulp-gm-limit
    • doesn't seem to be maintained
    • supports only one scale instruction
  • gulp-imgresize
    • no documentation
    • is not being maintained
    • has no tests

Contributing

If you have a question or have difficulties using gulp-scale-images, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.