Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traviswimer/grunt-resize-crop
Grunt Plugin --- Make images a specific size without distorting the aspect ratio. Resizes as close as possible and crops the rest.
https://github.com/traviswimer/grunt-resize-crop
Last synced: about 2 months ago
JSON representation
Grunt Plugin --- Make images a specific size without distorting the aspect ratio. Resizes as close as possible and crops the rest.
- Host: GitHub
- URL: https://github.com/traviswimer/grunt-resize-crop
- Owner: traviswimer
- License: mit
- Created: 2014-03-20T05:28:57.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-21T06:37:28.000Z (almost 9 years ago)
- Last Synced: 2024-04-25T13:00:56.148Z (8 months ago)
- Language: JavaScript
- Size: 125 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-resize-crop [](https://travis-ci.org/traviswimer/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](https://github.com/traviswimer/resize-crop.js)_
## Getting Started
This plugin requires [Grunt](http://gruntjs.com/) `~0.4.4` -- [Learn to use Grunt](http://gruntjs.com/getting-started)
Install the plugin with this command:
```shell
npm install grunt-resize-crop --save-dev
```
Enable in your Gruntfile with:
```js
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()`.
```js
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](https://github.com/rsms/node-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:
```javascript
{
"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](http://gruntjs.com/).