# grunt-image-sequencer

> Integrates Image Sequencer Library into Grunt

Latest version **0.2.0** (published 2018-06-24) · 0 weekly downloads

## Install

```sh
npm install grunt-image-sequencer
pnpm add grunt-image-sequencer
yarn add grunt-image-sequencer
bun add grunt-image-sequencer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-06-24 |
| First published | 2018-06-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | tech4GT |
| Maintainers | tech4gt |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-image-sequencer
- Repository: https://github.com/tech4GT/grunt-image-sequencer
- Issues: https://github.com/tech4GT/grunt-image-sequencer/issues
- npm.io page: https://npm.io/package/grunt-image-sequencer

## Dependencies (1)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.2

## Recent versions

- 0.2.0 (latest) — 2018-06-24
- 0.1.0 — 2018-06-24

## README

# grunt-image-sequencer

> Grunt Integration for Image Sequencer Library. See https://github.com/image-sequencer

## Getting Started
This plugin requires Grunt `~0.4.5`
You should also have image-sequencer installed
```shell
npm install -g image-sequencer
```

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-image-sequencer --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-image-sequencer');
```

## The "image_sequencer" task

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

```js
grunt.initConfig({
  image_sequencer: {
    options: {
      steps: /*A string containing space separated steps*/,
      config: /*Inputs for steps(optional)*/
    },
    files: [
      {
        src: [/*Array of source files you wish to include*/],
        dest: /*Destination path for the exported images*/
      }
    ]
  },
});
```

### Options

#### options.steps
Type: `String`
Default value: `""`

A string which defines the sequence that should be applied to images
Example:
```js
"invert brightness ndvi"
```
###options.config
Type: 'Object'
Default value: `{}`

An object which contains the inputs for steps, if some are missing they can be entered at runtime

### Usage Examples

```js
grunt.initConfig({
  image_sequencer: {
        options: {
          steps: 'invert'
        },
        files: [
          {dest: 'dist',src: ['src/*.png','src/*.jpg']}
        ]
    }
});
```

## 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/).

## Release History
_(Nothing yet)_

---
_Source: https://npm.io/package/grunt-image-sequencer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._