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-retinate

v1.0.0

Published

Automated retina down-scaling from @2x and @4x

Downloads

3

Readme

gulp-retinate

npm version build status

Gulp plugin to automate scaling of images to target lower resolution or non-retina screens.

This project is based on gulp-retinize. Main changes include the use of the Sharp image library instead of GM to resize images, reducing dependencies.

Installation

npm install gulp gulp-retinate

Usage

const gulp = require('gulp');
const retinate = require('gulp-retinate');

/* Default options */
const OPTIONS = {
  inputFlags: { 1: '@1x', 2: '@2x', 4: '@4x' },
  inputPlace: 'endsWith',
  outputFlags: { 1: '', 2: '@2x', 4: '@4x' },
  outputPlace: 'append',
  rounding: 'ceil',
  scaleUp: false
};

gulp.task('default', function () {
  return gulp.src('./src/**/*.{png,jpg,jpeg}')
    .pipe(retinate(OPTIONS))
    .on('error', e => console.log(e.message))
    .pipe(gulp.dest('./dest/'));
});

Options

inputFlags

The flags the plugin will use to detect which source images should be resized. Key is output resolution, value is flag.

  • Since: 1.0.0
  • Property is Optional
  • Default value is: { 1: '@1x', 2: '@2x', 4: '@4x' }
  • Validation rules:
    • Must be a hash Object

 

inputPlace

Whether to look for the flags at the beginning of the source image filename:

  • Since: 1.0.0
  • Property is Optional
  • Default value is: endsWith
  • Validation rules:
    • Must be either startsWith (e.g.: @2ximage) or endsWith (e.g.: image@2x)

 

outputFlags

The flags the plugin will append (or prepend) to the destination image files. Key is output resolution, value is flag.

  • Since: 1.0.0
  • Property is Optional
  • Default value is: { 1: '', 2: '@2x', 4: '@4x' }
  • Validation rules:
    • Must be a hash Object

 

outputPlace

Whether to output the flags at the beginning of the destination image filename:

  • Since: 1.0.0
  • Property is Optional
  • Default value is: append
  • Validation rules:
    • Must be either prepend (e.g.: @2ximage) or append (e.g.: image@2x)

 

rounding

Math function to round partial resolutions up (ceil) or down (floor). For example, an @2x source image with dimensions of 35x35 will be scaled to 18x18 by default.

  • Since: 1.0.0
  • Property is Optional
  • Default value is: ceil
  • Validation rules:
    • Must be either ceil (to round up) or floor (to round down)

 

scaleUp

Whether to scale images up if they are only included at a lower resolution in their source files.

If true, an images directory that includes only [email protected] will output destination files [email protected] (scaled up), [email protected] and image.png.

The output resolutions depend on the value of outputFlags.

  • Since: 1.0.0
  • Property is Optional
  • Default value is: value
  • Validation rules:
    • Must be a valid Boolean