customize-watch
Advanced tools
Comparing version 1.0.0 to 1.0.1
@@ -6,2 +6,9 @@ # Change Log | ||
<a name="current-release"></a> | ||
# Version 1.0.1 (Thu, 07 Nov 2019 20:54:07 GMT) | ||
* [3ccab07](https://github.com/bootprint/customize-watch/commit/3ccab07) fix styling (standard-js) - Nils Knappmeier | ||
* [61135b5](https://github.com/bootprint/customize-watch/commit/61135b5) Tests for the file-watcher (#2) - Nils Knappmeier | ||
# Version 1.0.0 (Tue, 20 Dec 2016 15:27:42 GMT) | ||
@@ -8,0 +15,0 @@ |
@@ -16,8 +16,5 @@ /*! | ||
var key | ||
for (key in customize) { | ||
if (customize.hasOwnProperty(key)) { | ||
module.exports[key] = customize[key] | ||
} | ||
} | ||
Object.keys(customize).forEach(key => { | ||
module.exports[key] = customize[key] | ||
}) | ||
@@ -24,0 +21,0 @@ module.exports.Customize = Recustomize |
{ | ||
"name": "customize-watch", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "A file watcher for customize", | ||
@@ -36,3 +36,3 @@ "repository": { | ||
"lodash": "^3.10.1", | ||
"m-io": "^0.3.1", | ||
"m-io": "^0.5.0", | ||
"q": "^1.4.1" | ||
@@ -39,0 +39,0 @@ }, |
119
README.md
# customize-watch | ||
[![NPM version](https://badge.fury.io/js/customize-watch.svg)](http://badge.fury.io/js/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 | ||
@@ -58,123 +57,17 @@ | ||
## API-reference | ||
<a name="Recustomize"></a> | ||
## Recustomize | ||
**Kind**: global class | ||
# License | ||
* [Recustomize](#Recustomize) | ||
* [new Recustomize(builder)](#new_Recustomize_new) | ||
* _instance_ | ||
* [.merge](#Recustomize+merge) | ||
* [.registerEngine](#Recustomize+registerEngine) | ||
* [.load](#Recustomize+load) | ||
* [.configSchema()](#Recustomize+configSchema) : <code>function</code> | ||
* [.buildConfig()](#Recustomize+buildConfig) ⇒ <code>Promise.<object></code> | ||
* [.watched()](#Recustomize+watched) ⇒ <code>Promise.<object.<Array.<string>>></code> | ||
* [.watch()](#Recustomize+watch) ⇒ <code>EventEmitter</code> | ||
* [.run()](#Recustomize+run) ⇒ <code>object</code> | ||
* _inner_ | ||
* [~wrap(fnName)](#Recustomize..wrap) ⇒ <code>function</code> | ||
`customize-watch` is published under the MIT-license. | ||
<a name="new_Recustomize_new"></a> | ||
See [LICENSE.md](LICENSE.md) for details. | ||
### new Recustomize(builder) | ||
Recustomize has the same interface as Customize, but instead of storing | ||
the current configuration-state, it stores a function that computes the state. | ||
The only difference is the [watch()](#Recustomize+watch)-method. It can be | ||
used to emit an event every time one of the input files is added, removed or changed. | ||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| builder | <code>function</code> | a builder function for a Customize object | | ||
<a name="Recustomize+merge"></a> | ||
### recustomize.merge | ||
Wrapped function. See [customize](https://github.com/nknapp/customize) for details | ||
**Kind**: instance property of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
<a name="Recustomize+registerEngine"></a> | ||
### recustomize.registerEngine | ||
Wrapped function. See [customize](https://github.com/nknapp/customize) for details | ||
**Kind**: instance property of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
<a name="Recustomize+load"></a> | ||
### recustomize.load | ||
Wrapped function. See [customize](https://github.com/nknapp/customize) for details | ||
**Kind**: instance property of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
<a name="Recustomize+configSchema"></a> | ||
### recustomize.configSchema() : <code>function</code> | ||
Wrapped function. See [customize](https://github.com/nknapp/customize) for details | ||
**Kind**: instance method of <code>[Recustomize](#Recustomize)</code> | ||
<a name="Recustomize+buildConfig"></a> | ||
### recustomize.buildConfig() ⇒ <code>Promise.<object></code> | ||
Return the configuation object | ||
**Kind**: instance method of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
<a name="Recustomize+watched"></a> | ||
### recustomize.watched() ⇒ <code>Promise.<object.<Array.<string>>></code> | ||
Return a list of files and directories that need to be watched | ||
in watch-mode. | ||
**Kind**: instance method of <code>[Recustomize](#Recustomize)</code> | ||
**Returns**: <code>Promise.<object.<Array.<string>>></code> - a list of paths to files or directories for each engine | ||
**Api**: private | ||
<a name="Recustomize+watch"></a> | ||
### recustomize.watch() ⇒ <code>EventEmitter</code> | ||
Register file-watchers for all relevant files. | ||
Rebuild the config and run the appropriate engine, whenever | ||
a file has changed. | ||
**Kind**: instance method of <code>[Recustomize](#Recustomize)</code> | ||
<a name="Recustomize+run"></a> | ||
### recustomize.run() ⇒ <code>object</code> | ||
Wraps the run(...)-method of the customize object, rebuilding the whole configuration | ||
before running. | ||
**Kind**: instance method of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
<a name="Recustomize..wrap"></a> | ||
### Recustomize~wrap(fnName) ⇒ <code>function</code> | ||
Wrap the method of a Customize object such that | ||
instead of the new Customize object, new Recustomize object | ||
with the appropriate builder-function is returned | ||
**Kind**: inner method of <code>[Recustomize](#Recustomize)</code> | ||
**Api**: private | ||
| Param | | ||
| --- | | ||
| fnName | | ||
## License | ||
`customize-watch` is published under the MIT-license. | ||
See [LICENSE.md](LICENSE.md) for details. | ||
## Release-Notes | ||
# Release-Notes | ||
For release notes, see [CHANGELOG.md](CHANGELOG.md) | ||
## Contributing guidelines | ||
# Contributing guidelines | ||
See [CONTRIBUTING.md](CONTRIBUTING.md). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
12866
192
72
- Removedfs.realpath@1.0.0(transitive)
- Removedglob@7.2.3(transitive)
- Removedinflight@1.0.6(transitive)
- Removedm-io@0.3.1(transitive)
- Removedminimist@1.2.8(transitive)
- Removedmkdirp@0.5.6(transitive)
- Removedonce@1.4.0(transitive)
- Removedrimraf@2.7.1(transitive)
- Removedwrappy@1.0.2(transitive)
Updatedm-io@^0.5.0