grunt-images

A grunt plugin for processing images. As of v0.1.16 the supported libraries are compiled on the target machine on installation.

How to use

• Install with: npm install grunt-images.

• Call grunt.loadNpmTasks('grunt-images') in grunt.js

• In your grunt.js config:

  images: {
    taskOne: {
      imageDirectory: '/path/to/images/',
      files: [
        '/path/to/images/foo-*.png',
      ],
      tasks: {
        convert: {
          resizeDimension: '66%'
        },
        pngquant: {
        }
      }
    },
    taskTwo: {
      imageDirectory: '/path/to/images/',
      files: [
        '/path/to/images/foo/*.png',
        '/path/to/images/bar/*.png',
        '/path/to/images/baz/*.png'
      ],
      destination: IMAGES + '/optimized',
      keepDirectoryStructure: true,
      tasks: {
        pngquant: {
        }
      }
    }
  }

Settings

imageDirectory required : Used to determine relative filepaths, in case you want to preserve the directory structure in the output folder. Files that aren't within this folder will be rejected.

files required : Array of files / wildcards for images to iterate through.

destination optional : If provided, copies files to the destination directory after optimizations are complete. If omitted, replaces original with optimized file.

outputSuffix optional : Use to add a suffix onto output filenames (someimage.jpg -> someimage_foo.jpg). Requires destination.

keepDirectoryStructure optional : If omitted or set to false, the destination folder will be flat. If set to true, destination folder will contain the original files' folder structure relative to imageDirectory.

crusherTasks required : Configure each bin. (TODO: Add config options in supported libraries section once available).

Supported Libraries

pngquant

convert

Changelog

Current: v0.1.16

Major Changes:

• v0.1.16 Make convert (imagemagick) and pngquant compile on install, rather than requiring a bin location. Remove pngout since it can't be compiled / is close-sourced.
• v0.1.15 Upgrade for Grunt 0.4 compatibility.
• v0.1.12 Added outputSuffix.
• v0.1.10 Added experimental support for convert, initially for resize.
• v0.1.9 Added tests, some refactoring on logging.
• v0.1.6 Add imageDirectory and keepDirectoryStructure settings.
• v0.1.4 Make it so that you have to define the bin locations as part of the task; making it platform independant was too tricky here. dest -> destination in task settings.
• v0.1.2 Adding pngout, start working on how different bins will operate together.
• v0.1.1 Add optional destination/export directory.
• v0.1.0 Initial release.

License

Copyright (c) 2012 George Pantazis Licensed under the MIT license.