grunt-resize-crop

grunt-resize-crop

Make images a specific size without distorting the aspect ratio. Resizes as close as possible and crops the rest.

This plugin is a wrapper for resize-crop

Getting Started

This plugin requires Grunt ~0.4.4 -- Learn to use Grunt

Install the plugin with this command:

npm install grunt-resize-crop --save-dev

Enable in your Gruntfile with:

grunt.loadNpmTasks('grunt-resize-crop');

The "resize_crop" task

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

grunt.initConfig({
  resize_crop: {
    image_group: {
      options: {
        format: "jpg",
        gravity: "center",
        height: 200,
        width: 200
      },
      files: {
        'your/destination/directory': [
          'your/source/images/kittens.png',
          'your/source/images/puppies.jpg'
        ],
      },
    },
    other_images: {
      options: {
        height: 400,
        width: 400
      },
      files: {
        'your/other/destination/directory': [
          'your/source/images/image.png'
        ],
      },
    },
  },
});

Options

options.height

• REQUIRED OPTION
• Type: integer
• Description: Sets the height in pixels to be used for the output image.

options.width

• REQUIRED OPTION
• Type: integer
• Description: Sets the width in pixels to be used for the output image.

options.format

• Type: String
• Default: "png"
• Description: Sets the image type to output. Supporst any image format supported by imagemagick

options.gravity

• Type: string
• Description: Determines the part of the image that will be removed during cropping. For example, "center" will try to keep the centermost part of the image and only remove the furthest edges.

Files

Follows the format of:

{
  "an output directory": ['image1', 'image2', 'image3']
}

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.