# gulp-cordova-icon

> Generate all the icons for your Cordova build automatically

Latest version **0.7.2** (published 2018-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-cordova-icon
pnpm add gulp-cordova-icon
yarn add gulp-cordova-icon
bun add gulp-cordova-icon
```

## 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.7.2 |
| Published | 2018-08-01 |
| First published | 2015-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 12 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 (+8 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sam Verschueren |
| Maintainers | samverschueren |
| Keywords | gulp, gulpjs, cordova, icon, gulp-cordova |

## Links

- npm: https://www.npmjs.com/package/gulp-cordova-icon
- Repository: https://github.com/SamVerschueren/gulp-cordova-icon
- Homepage: https://github.com/SamVerschueren/gulp-cordova-icon#readme
- Issues: https://github.com/SamVerschueren/gulp-cordova-icon/issues
- npm.io page: https://npm.io/package/gulp-cordova-icon

## Dependencies (12)

- [npmi](https://npm.io/package/npmi.md) ^2.0.1-alpha
- [pify](https://npm.io/package/pify.md) ^2.3.0
- [lodash](https://npm.io/package/lodash.md) ^3.8.0
- [mem-fs](https://npm.io/package/mem-fs.md) ^1.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.26.2
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.4
- [image-size](https://npm.io/package/image-size.md) ^0.3.5
- [mime-types](https://npm.io/package/mime-types.md) ^2.0.11
- [mem-fs-editor](https://npm.io/package/mem-fs-editor.md) ^2.0.4
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^2.0.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.7.2 (latest) — 2018-08-01
- 0.7.1 — 2018-07-17
- 0.7.0 — 2017-05-02
- 0.6.0 — 2016-07-14
- 0.5.0 — 2016-06-02
- 0.4.0 — 2016-03-17
- 0.3.0 — 2015-11-25
- 0.2.0 — 2015-09-23
- 0.1.1 — 2015-08-27
- 0.1.0 — 2015-08-27
- 0.0.4 — 2015-06-21
- 0.0.3 — 2015-06-20
- 0.0.2 — 2015-06-20
- 0.0.1 — 2015-05-11

## README

# gulp-cordova-icon

> Generate all the icons for your Cordova build automatically


## Installation

```
$ npm install --save-dev gulp-cordova-icon
```

This library depends on [GraphicsMagick](http://www.graphicsmagick.org/) or [ImageMagick](http://www.imagemagick.org/), so be sure to install
one of those.


## Usage

```js
const create = require('gulp-cordova-create'),
const icon = require('gulp-cordova-icon'),
const android = require('gulp-cordova-android');

gulp.task('build', () => {
    return gulp.src('dist')
        .pipe(create())
        .pipe(icon('res/my-icon.png'))
        .pipe(android())
        .pipe(gulp.dest('build'));
});
```

When the project is build for a platform, the icon provided will be used as application icon. It will generate all the different sizes of the icon and puts them in the correct location.


## API

### icon(file [, options])

#### file

Type: `string`

The path to the `png` or `svg` icon that will be used as application icon.

#### options

Type: `object`

##### errorHandlingStrategy

Type: `string`<br>
Default: `lenient`

The error handling strategy of the process. This field has 3 possible values:
* `lenient` (default): any encountered error is silently discarded and the build continues
* `warn`: any encountered error is logged as a warning on the console
* `throw`: any encountered error is thrown and interrupts the Gulp stream

##### imageMagick

Type: `boolean`<br>
Default: `false`

Use ImageMagick instead of GraphicsMagick.


## Related

See [`gulp-cordova`](https://github.com/SamVerschueren/gulp-cordova) for the full list of available packages.


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)

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