<commit_before># Rump Images
[![NPM](http://img.shields.io/npm/v/rump-images.svg?style=flat-square)](https://www.npmjs.org/package/rump-images)
![License](http://img.shields.io/npm/l/rump-images.svg?style=flat-square)
[![Dependencies](http://img.shields.io/david/rumps/rump-images.svg?style=flat-square)](https://david-dm.org/rumps/rump-images)
[![Peer Dependencies](http://img.shields.io/david/peer/rumps/rump-images.svg?style=flat-square)](https://david-dm.org/rumps/rump-images#info=peerDependencies)


## About
Rump Images is a Rump module that handles images with support for image
optimizations via [imagemin](https://github.com/imagemin/imagemin) and high
density "retina" images. (retina support requires
[GraphicsMagick](http://www.graphicsmagick.org/)) For more information, visit
the [Rump repository](https://github.com/rumps/rump).


## API
The following is appended to the core Rump API:

### `rump.addGulpTasks()`
This module adds the following tasks:
- `rump:build:images` will process and copy images from source to destination.
  This task is also added to the `rump:build` task. Images that end with `@2x`
  (`logo@2x.png`) will have copies made without the `@2x` (`logo.png`) and at
  half the resolution of the original. If this is run under the production
  environment, images will be minified for optimal size. For more information
  on source and destination paths see `rump.configure()` below.
- `rump:watch:images` will run `rump:build:static`, then monitor for changes
  and process updated files as needed. This task is also added to the
  `rump:watch` task.
- `rump:info:images` will display information on what this specific module
  does, specifically the source and destination paths as well as what files
  would get processed as well as those that would get retina copies.

### `rump.configure(options)`<commit_msg>More detail to documentation<commit_after># Rump Images
[![NPM](http://img.shields.io/npm/v/rump-images.svg?style=flat-square)](https://www.npmjs.org/package/rump-images)
![License](http://img.shields.io/npm/l/rump-images.svg?style=flat-square)
[![Dependencies](http://img.shields.io/david/rumps/rump-images.svg?style=flat-square)](https://david-dm.org/rumps/rump-images)
[![Peer Dependencies](http://img.shields.io/david/peer/rumps/rump-images.svg?style=flat-square)](https://david-dm.org/rumps/rump-images#info=peerDependencies)


## About
Rump Images is a Rump module that handles images with support for image
optimizations via [imagemin](https://github.com/imagemin/imagemin) and high
density "retina" images. (retina support requires
[GraphicsMagick](http://www.graphicsmagick.org/)) For more information, visit
the [Rump repository](https://github.com/rumps/rump).


## API
The following is appended to the core Rump API:

### `rump.addGulpTasks()`
This module adds the following tasks:
- `rump:build:images` will process and copy images from source to destination.
  This task is also added to the `rump:build` task. Images that end with `@2x`
  (`logo@2x.png`) will have copies made without the `@2x` (`logo.png`) and at
  half the resolution of the original. For more information on source and
  destination paths see `rump.configure()` below. This task is also added to
  the `rump:build` task.
- `rump:watch:images` will run `rump:build:static`, then monitor for changes
  and process updated files as needed. This task is also added to the
  `rump:watch` task.
- `rump:info:images` will display information on what this specific module
  does, specifically the source and destination paths as well as what files
  would get processed as well as those that would get retina copies. This task
  is also added to the `rump:info` task.

### `rump.configure(options)`
{'fraction_non_alphanumeric': 0.1261744966442953, 'fraction_numerical': 0.001610738255033557, 'mean_word_length': 4.971153846153846, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6657272', 'n_tokens_mistral': 1192, 'n_tokens_neox': 1141, 'n_words': 369}