gu

grunt-unretina

Scales @2x images down to standard resolution

Showing:

Popularity

Downloads/wk

7

GitHub Stars

0

Maintenance

Last Commit

5yrs ago

Contributors

2

Package

Dependencies

3

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

unretina

Scales @2x images down to standard resolution

Getting Started

This plugin requires Grunt ~0.4.4 and GraphicsMagick.

Grunt

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-unretina --save-dev

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-unretina');

GraphicsMagick

Make sure GraphicsMagick is installed on your system and properly set up in your PATH.

Ubuntu:

$ apt-get install graphicsmagick

Mac OS X (using Homebrew):

$ brew install graphicsmagick

Windows & others:

ftp://ftp.graphicsmagick.org/pub/GraphicsMagick/windows/

Confirm that GraphicsMagick is properly set up by executing gm convert -help in a terminal.

The "unretina" task

Overview

In your project's Gruntfile, add a section named unretina to the data object passed into grunt.initConfig().

grunt.initConfig({
  unretina: {
    options: {
      overwrite: true
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.overwrite

Type: Boolean Default value: true

Determines whether file that already exist under this destination will be overwritten.

options.suffixes

Type: Array Default value: ["@2x", "-hd"]

List of suffixes that are stripped out of the dest file when using multiple files with expand option on.

options.concurrency

Type: Number Default value: Number of CPUs

Determines how many resize operations are executed in parallel.

options.quality

Type: Number Default value: 1

Determines the output quality of the resized image. Ranges from 0 (really bad) to 1 (almost lossless). Only applies to jpg images.

Usage Examples

Default Options

In this example, the default options are used to resize an image to 100px width. So if the test/fixtures/wikipedia.png file has a width of 500px, the generated result would be a 100px wide tmp/wikipedia.png.

grunt.initConfig({
  unretina: {
    resize: {
      files: [
        { src: "**/*@2x.png", dest: "tmp/", expand: true, cwd: "test/fixtures/" }
      ]
    }
  }
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • 2014-03-26   v0.1.0   Initial release.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100