# customize-watch

> A file watcher for customize

Latest version **3.0.0** (published 2019-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install customize-watch
pnpm add customize-watch
yarn add customize-watch
bun add customize-watch
```

## 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 | 3.0.0 |
| Published | 2019-12-28 |
| First published | 2015-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nils Knappmeier |
| Maintainers | knappi |

## Links

- npm: https://www.npmjs.com/package/customize-watch
- Repository: https://github.com/bootprint/customize-watch
- Homepage: https://github.com/bootprint/customize-watch#readme
- Issues: https://github.com/bootprint/customize-watch/issues
- npm.io page: https://npm.io/package/customize-watch

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [chokidar](https://npm.io/package/chokidar.md) ^3.3.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [customize](https://npm.io/package/customize.md) ^3.0.2
- [deep-aplus](https://npm.io/package/deep-aplus.md) ^1.0.4
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8
- [lodash.mergewith](https://npm.io/package/lodash.mergewith.md) ^4.6.2

## Recent versions

- 3.0.0 (latest) — 2019-12-28
- 1.0.1 — 2019-11-07
- 1.0.0 — 2016-12-20
- 0.5.4 — 2016-03-15
- 0.5.3 — 2016-03-15
- 0.5.2 — 2016-03-15
- 0.5.1 — 2016-03-15
- 0.5.0 — 2015-12-21
- 0.4.2 — 2015-11-08
- 0.4.1 — 2015-10-18
- 0.4.0 — 2015-10-18
- 0.3.0 — 2015-10-14
- 0.2.2 — 2015-10-05
- 0.2.1 — 2015-10-05
- 0.2.0 — 2015-10-05
- … 1 more at https://npm.io/package/customize-watch/versions

## README

# customize-watch 

[![NPM version](https://img.shields.io/npm/v/customize-watch.svg)](https://npmjs.com/package/customize-watch)
[![Travis Build Status](https://travis-ci.org/bootprint/customize-watch.svg?branch=master)](https://travis-ci.org/bootprint/customize-watch)
[![Coverage Status](https://img.shields.io/coveralls/bootprint/customize-watch.svg)](https://coveralls.io/r/bootprint/customize-watch)

> A file watcher for customize

`customize-watch` is a file watcher for [customize](https://github.com/nknapp/customize)
It attaches watchers (using [chokidar](https://github.com/paulmillr/chokidar)) to 
the files and directories that are relevant for computing a result with `customize`.

If files are added, removed or changed the result will be recomputed.

# Installation

```
npm install customize-watch
```

## Usage

The following example is almost identical to the
["merging another configuration"-example of the `customize`-module](https://github.com/nknapp/customize#merging-another-configuration).

```js
const customize = require('customize-watch')

// Load files from one directory and merge with second
customize()
  .registerEngine('files', require('./engine-concat-files'))
  .merge({
    files: 'dir1'
  })
  .merge({
    files: 'dir2'
  })
  .watch()
  .on('update', function(result) {
    console.log('result', result.files)
  })
```

It will generate the same output, but every time the files in `dir1` and `dir2` are changed, 
removed or added, the output will be recomputed. The `update`-event will be sent with the result
as argument, every time the computation has finished.












# License

`customize-watch` is published under the MIT-license.

See [LICENSE.md](LICENSE.md) for details.


# Release-Notes
 
For release notes, see [CHANGELOG.md](CHANGELOG.md)
 
# Contributing guidelines

See [CONTRIBUTING.md](CONTRIBUTING.md).

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