# directory-colorfy

> Color up those SVGs

Latest version **2.2.1** (published 2017-07-11) · 0 weekly downloads

## Install

```sh
npm install directory-colorfy
pnpm add directory-colorfy
yarn add directory-colorfy
bun add directory-colorfy
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2017-07-11 |
| First published | 2013-12-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Jeffrey Lembeck & Filament Group |
| Maintainers | jlembeck, scottjehl, maggiewachs, zachleat, johnmbender, filamentgroup-admin |

## Links

- npm: https://www.npmjs.com/package/directory-colorfy
- Repository: https://github.com/filamentgroup/directory-colorfy
- Issues: https://github.com/filamentgroup/directory-colorfy/issues
- npm.io page: https://npm.io/package/directory-colorfy

## Dependencies (4)

- [rsvp](https://npm.io/package/rsvp.md) 3.0.15
- [fs-extra](https://npm.io/package/fs-extra.md) 0.6.3
- [phantomjs-prebuilt](https://npm.io/package/phantomjs-prebuilt.md) ^2.1.7
- [@filamentgroup/worker-farm](https://npm.io/package/@filamentgroup/worker-farm.md) 1.3.2

## Recent versions

- 2.2.1 (latest) — 2017-07-11
- 2.2.0 — 2016-08-02
- 2.1.0 — 2016-07-26
- 2.0.5 — 2015-06-10
- 2.0.4 — 2015-06-10
- 2.0.3 — 2015-03-06
- 2.0.2 — 2015-03-06
- 2.0.1 — 2015-02-06
- 2.0.0 — 2015-02-02
- 1.1.0 — 2014-12-29
- 1.0.0 — 2014-12-17
- 0.5.1 — 2014-07-23
- 0.5.0 — 2014-07-19
- 0.4.3 — 2014-05-21
- 0.4.1 — 2014-05-21
- … 3 more at https://npm.io/package/directory-colorfy/versions

## README

# directory-colorfy [![Build Status](https://secure.travis-ci.org/filamentgroup/directory-colorfy.png?branch=master)](http://travis-ci.org/filamentgroup/directory-colorfy)

[![Filament Group](http://filamentgroup.com/images/fg-logo-positive-sm-crop.png) ](http://www.filamentgroup.com/)

Color up those SVGs

## Getting Started
Install the module with: `npm install directory-colorfy`

```javascript
var DirectoryColorfy = require('directory-colorfy');
var dc = new DirectoryColorfy( input, output, options );
dc.convert()
.then(function(){
// Next
});
```

## Documentation

### Required Params

#### Input
Type: `String`

Input folder of SVGs

#### Output
Type: `String`

Output folder


### Optional Params

#### options.colors
Type: `Object`
Default value: `{}`

A hash of colors to pass in with names.

Example:
```
{ "primary": "#ff0000" }
```

#### options.dynamicColorOnly
Type: `Boolean`
Default value: `false`

Allows you to tell directory-colorfy to ignore the original file when using colors.

For example, if given a file named like so: 

```
bear.colors-white.svg
```

And `dynamicColorOnly` is set to `true`:

```
{
	dynamicColorOnly: true
}
```

Only a single file will be generated:

```
bear-white.svg
```

## Examples

If the input directory has this file in it:

```
bear.colors-primary-blue-red.svg
```

And the color hash that is passed through is:

```
{ "primary": "green" }
```

The output folder should end up with:

```
bear-green.svg
bear-blue.svg
bear-red.svg
```

Which will all be completely filled in with their specific color.


## 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
* 1.0.0 Make `convert` return a promise. Also, change from putting stylesheet in to just changing the `fill` and `stroke` attributes
* 0.4.0 Make sure custom color words override actual color words (e.g.
	red)
* 0.3.0 Make sure custom color words (e.g. primary, secondary) are
	acknowledged
* 0.2.0 No longer needs a dir as an input, can also take an array of files
* 0.1.0 First release

## License
Copyright (c) 2013 Jeffrey Lembeck & Filament Group  
Licensed under the MIT license.

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