grunt-cropthumb

Crops and scales down image to create thumbnails.

This plugin was built quickly for personal use and has had very little testing. Because of this, this plugin is not published to the npm registry.

Getting Started

This plugin requires Grunt ~0.4.1

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 git+http://github.com/jbakse/grunt-cropthumb.git --save-dev

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

grunt.loadNpmTasks('grunt-cropthumb');

The "cropthumb" task

Overview

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

grunt.initConfig({
  cropthumb: {

    options: {
      width: 200,
      height: 200,
      overwrite: false
    },
    files: [{
      expand: true,
      dot: true,
      cwd: 'source/',
      dest: 'dest/',
      src: [
          'image.png'
      ]
    }]
  },
})

Options

options.width

Type: Integer Default value: 200

With of the resulting thumbnail.

options.height

Type: Integer Default value: 200

Height of the resulting thumbnail.

options.quality

Type: Integer Default value: 100

options.overwrite

Type: boolean Default value: false

Set to true to overwrite existing files with the same name as the new cropthumb.

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

(Nothing yet)