update ci
This commit is contained in:
parent
9e06369139
commit
cb6c8f3c8e
@ -7,15 +7,36 @@ cache:
|
|||||||
key: "$CI_BUILD_STAGE"
|
key: "$CI_BUILD_STAGE"
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
|
- mirror
|
||||||
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- trigger
|
- trigger
|
||||||
- pages
|
- pages
|
||||||
|
|
||||||
|
mirror:
|
||||||
|
stage: mirror
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
security:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci command yarn global add snyk
|
||||||
|
- npmci command yarn install --ignore-scripts
|
||||||
|
- npmci command snyk test
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
testLEGACY:
|
testLEGACY:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test legacy
|
- npmci node install legacy
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -24,7 +45,9 @@ testLEGACY:
|
|||||||
testLTS:
|
testLTS:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test lts
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -32,7 +55,9 @@ testLTS:
|
|||||||
testSTABLE:
|
testSTABLE:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test stable
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -40,7 +65,8 @@ testSTABLE:
|
|||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci publish
|
- npmci npm prepare
|
||||||
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
@ -60,7 +86,7 @@ pages:
|
|||||||
stage: pages
|
stage: pages
|
||||||
script:
|
script:
|
||||||
- npmci command yarn global add npmpage
|
- npmci command yarn global add npmpage
|
||||||
- npmci command npmpage --publish gitlab
|
- npmci command npmpage
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
only:
|
only:
|
||||||
|
24
README.md
24
README.md
@ -1,13 +1,16 @@
|
|||||||
# smartchok
|
# smartchok
|
||||||
|
|
||||||
smart wrapper for chokidar
|
smart wrapper for chokidar
|
||||||
|
|
||||||
## Availabililty
|
## Availabililty
|
||||||
|
|
||||||
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartchok)
|
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartchok)
|
||||||
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartchok)
|
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartchok)
|
||||||
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartchok)
|
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartchok)
|
||||||
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartchok/)
|
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartchok/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
|
|
||||||
[![build status](https://GitLab.com/pushrocks/smartchok/badges/master/build.svg)](https://GitLab.com/pushrocks/smartchok/commits/master)
|
[![build status](https://GitLab.com/pushrocks/smartchok/badges/master/build.svg)](https://GitLab.com/pushrocks/smartchok/commits/master)
|
||||||
[![coverage report](https://GitLab.com/pushrocks/smartchok/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartchok/commits/master)
|
[![coverage report](https://GitLab.com/pushrocks/smartchok/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartchok/commits/master)
|
||||||
[![npm downloads per month](https://img.shields.io/npm/dm/smartchok.svg)](https://www.npmjs.com/package/smartchok)
|
[![npm downloads per month](https://img.shields.io/npm/dm/smartchok.svg)](https://www.npmjs.com/package/smartchok)
|
||||||
@ -19,34 +22,35 @@ smart wrapper for chokidar
|
|||||||
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
|
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import { Smartchok } from 'smartchok'
|
import { Smartchok } from 'smartchok';
|
||||||
|
|
||||||
let mySmartChok = new Smartchok(['some/path/**/*.any','/absolute/*.js'], chokidarOptions)
|
let mySmartChok = new Smartchok(['some/path/**/*.any', '/absolute/*.js'], chokidarOptions);
|
||||||
|
|
||||||
mySmartChok.add(['/some/**/*.any']) // add files
|
mySmartChok.add(['/some/**/*.any']); // add files
|
||||||
|
|
||||||
mySmartChok.remove('some/**/*.js')
|
mySmartChok.remove('some/**/*.js');
|
||||||
|
|
||||||
mySmartChok.start() // starts the watch process
|
mySmartChok.start(); // starts the watch process
|
||||||
|
|
||||||
mySmartChok.getObservableFor('change').then((observableArg) => {
|
mySmartChok.getObservableFor('change').then(observableArg => {
|
||||||
observableArg.subscribe(x => {
|
observableArg.subscribe(x => {
|
||||||
// do something here when a change is detected
|
// do something here when a change is detected
|
||||||
// possible events are 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw'
|
// possible events are 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw'
|
||||||
// note that the observable is only created once you call .start() on the Smartchok instance
|
// note that the observable is only created once you call .start() on the Smartchok instance
|
||||||
// hence the promise construction
|
// hence the promise construction
|
||||||
})
|
});
|
||||||
})
|
});
|
||||||
|
|
||||||
mySmartChok.stop()
|
mySmartChok.stop();
|
||||||
```
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
For further information read the linked docs at the top of this README.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||||
|
|
||||||
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
|
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
|
||||||
|
2
dist/index.js
vendored
2
dist/index.js
vendored
@ -4,4 +4,4 @@ function __export(m) {
|
|||||||
}
|
}
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
__export(require("./smartchok.classes.smartchok"));
|
__export(require("./smartchok.classes.smartchok"));
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE2QyJ9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE4QyJ9
|
0
dist/smartchok.child.d.ts
vendored
0
dist/smartchok.child.d.ts
vendored
3
dist/smartchok.child.js
vendored
3
dist/smartchok.child.js
vendored
@ -1,3 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLmNoaWxkLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRjaG9rLmNoaWxkLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==
|
|
5
dist/smartchok.classes.smartchok.d.ts
vendored
5
dist/smartchok.classes.smartchok.d.ts
vendored
@ -1,12 +1,11 @@
|
|||||||
import * as plugins from './smartchok.plugins';
|
import * as plugins from './smartchok.plugins';
|
||||||
import { Stringmap } from 'lik';
|
|
||||||
export declare type TSmartchokStatus = 'idle' | 'starting' | 'watching';
|
export declare type TSmartchokStatus = 'idle' | 'starting' | 'watching';
|
||||||
export declare type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw';
|
export declare type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw';
|
||||||
/**
|
/**
|
||||||
* Smartchok allows easy wathcing of files
|
* Smartchok allows easy wathcing of files
|
||||||
*/
|
*/
|
||||||
export declare class Smartchok {
|
export declare class Smartchok {
|
||||||
watchStringmap: Stringmap;
|
watchStringmap: plugins.lik.Stringmap;
|
||||||
chokidarOptions: plugins.chokidar.WatchOptions;
|
chokidarOptions: plugins.chokidar.WatchOptions;
|
||||||
status: TSmartchokStatus;
|
status: TSmartchokStatus;
|
||||||
private watcher;
|
private watcher;
|
||||||
@ -27,7 +26,7 @@ export declare class Smartchok {
|
|||||||
/**
|
/**
|
||||||
* gets an observable for a certain event
|
* gets an observable for a certain event
|
||||||
*/
|
*/
|
||||||
getObservableFor(fsEvent: TFsEvent): Promise<plugins.rx.Observable<any>>;
|
getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>>;
|
||||||
/**
|
/**
|
||||||
* starts the watcher
|
* starts the watcher
|
||||||
* @returns Promise<void>
|
* @returns Promise<void>
|
||||||
|
8
dist/smartchok.classes.smartchok.js
vendored
8
dist/smartchok.classes.smartchok.js
vendored
@ -13,7 +13,7 @@ class Smartchok {
|
|||||||
this.watchStringmap = new lik_1.Stringmap();
|
this.watchStringmap = new lik_1.Stringmap();
|
||||||
this.status = 'idle';
|
this.status = 'idle';
|
||||||
this.watchingDeferred = plugins.smartq.defer(); // used to run things when watcher is initialized
|
this.watchingDeferred = plugins.smartq.defer(); // used to run things when watcher is initialized
|
||||||
this.eventObservablemap = new plugins.lik.Observablemap(); // register one observable per event
|
this.eventObservablemap = new plugins.smartrx.Observablemap(); // register one observable per event
|
||||||
this.watchStringmap.addStringArray(watchArrayArg);
|
this.watchStringmap.addStringArray(watchArrayArg);
|
||||||
this.chokidarOptions = optionsArg;
|
this.chokidarOptions = optionsArg;
|
||||||
}
|
}
|
||||||
@ -67,9 +67,11 @@ class Smartchok {
|
|||||||
closeWatcher();
|
closeWatcher();
|
||||||
}
|
}
|
||||||
else if (this.status === 'starting') {
|
else if (this.status === 'starting') {
|
||||||
this.watchingDeferred.promise.then(() => { closeWatcher(); });
|
this.watchingDeferred.promise.then(() => {
|
||||||
|
closeWatcher();
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
exports.Smartchok = Smartchok;
|
exports.Smartchok = Smartchok;
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQThDO0FBQzlDLDZCQUErQjtBQUsvQjs7R0FFRztBQUNIO0lBUUU7O09BRUc7SUFDSCxZQUFhLGFBQXVCLEVBQUUsYUFBNEMsRUFBRTtRQVZwRixtQkFBYyxHQUFHLElBQUksZUFBUyxFQUFFLENBQUE7UUFFaEMsV0FBTSxHQUFxQixNQUFNLENBQUE7UUFFekIscUJBQWdCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQVEsQ0FBQSxDQUFDLGlEQUFpRDtRQUNqRyx1QkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsYUFBYSxFQUFFLENBQUEsQ0FBQyxvQ0FBb0M7UUFNL0YsSUFBSSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUE7UUFDakQsSUFBSSxDQUFDLGVBQWUsR0FBRyxVQUFVLENBQUE7SUFDbkMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsR0FBRyxDQUFDLFlBQXNCO1FBQ3hCLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQ2xELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU0sQ0FBRSxPQUFlO1FBQ3JCLElBQUksQ0FBQyxjQUFjLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQzNDLENBQUM7SUFFRDs7T0FFRztJQUNILGdCQUFnQixDQUFFLE9BQWlCO1FBQ2pDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUE4QixDQUFBO1FBQzdELElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQ2pDLElBQUksZUFBZSxHQUFHLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyw0QkFBNEIsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFBO1lBQ2pHLElBQUksQ0FBQyxPQUFPLENBQUMsZUFBZSxDQUFDLENBQUE7UUFDL0IsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsS0FBSztRQUNILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDdkMsSUFBSSxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUE7UUFDeEIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLGNBQWMsRUFBRSxFQUFFLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNqRyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUU7WUFDdkIsSUFBSSxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUE7WUFDeEIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sRUFBRSxDQUFBO1lBQy9CLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNoQixDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3JCLENBQUM7SUFFRDs7T0FFRztJQUNILElBQUk7UUFDRixJQUFJLFlBQVksR0FBRztZQUNqQixJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQ3RCLENBQUMsQ0FBQTtRQUNELEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUMvQixPQUFPLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUE7WUFDckMsWUFBWSxFQUFFLENBQUE7UUFDaEIsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLFVBQVUsQ0FBQyxDQUFDLENBQUM7WUFDdEMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxZQUFZLEVBQUUsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQzlELENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUF4RUQsOEJBd0VDIn0=
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQStDO0FBQy9DLDZCQUFnQztBQWNoQzs7R0FFRztBQUNIO0lBUUU7O09BRUc7SUFDSCxZQUFZLGFBQXVCLEVBQUUsYUFBNEMsRUFBRTtRQVZuRixtQkFBYyxHQUFHLElBQUksZUFBUyxFQUFFLENBQUM7UUFFakMsV0FBTSxHQUFxQixNQUFNLENBQUM7UUFFMUIscUJBQWdCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQVEsQ0FBQyxDQUFDLGlEQUFpRDtRQUNsRyx1QkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsYUFBYSxFQUFFLENBQUMsQ0FBQyxvQ0FBb0M7UUFNcEcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbEQsSUFBSSxDQUFDLGVBQWUsR0FBRyxVQUFVLENBQUM7SUFDcEMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsR0FBRyxDQUFDLFlBQXNCO1FBQ3hCLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ25ELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU0sQ0FBQyxPQUFlO1FBQ3BCLElBQUksQ0FBQyxjQUFjLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7T0FFRztJQUNILGdCQUFnQixDQUFDLE9BQWlCO1FBQ2hDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUF3QyxDQUFDO1FBQ3hFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtZQUN0QyxJQUFJLGVBQWUsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsNEJBQTRCLENBQ3hFLElBQUksQ0FBQyxPQUFPLEVBQ1osT0FBTyxDQUNSLENBQUM7WUFDRixJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ2hDLENBQUMsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7SUFDdEIsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUs7UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBUSxDQUFDO1FBQ3hDLElBQUksQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQ25DLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxFQUFFLEVBQ3BDLElBQUksQ0FBQyxlQUFlLENBQ3JCLENBQUM7UUFDRixJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFO1lBQzVCLElBQUksQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDO1lBQ3pCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNoQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDakIsQ0FBQyxDQUFDLENBQUM7UUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN0QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJO1FBQ0YsSUFBSSxZQUFZLEdBQUcsR0FBRyxFQUFFO1lBQ3RCLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDdkIsQ0FBQyxDQUFDO1FBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQy9CLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztZQUN0QyxZQUFZLEVBQUUsQ0FBQztRQUNqQixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUN0QyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7Z0JBQ3RDLFlBQVksRUFBRSxDQUFDO1lBQ2pCLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7Q0FDRjtBQWhGRCw4QkFnRkMifQ==
|
0
dist/smartchok.classes.watcher.d.ts
vendored
0
dist/smartchok.classes.watcher.d.ts
vendored
3
dist/smartchok.classes.watcher.js
vendored
3
dist/smartchok.classes.watcher.js
vendored
@ -1,3 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLmNsYXNzZXMud2F0Y2hlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2hvay5jbGFzc2VzLndhdGNoZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
|
|
10
dist/smartchok.plugins.d.ts
vendored
10
dist/smartchok.plugins.d.ts
vendored
@ -1,13 +1,5 @@
|
|||||||
import 'typings-global';
|
|
||||||
export import lik = require('lik');
|
export import lik = require('lik');
|
||||||
export import chokidar = require('chokidar');
|
export import chokidar = require('chokidar');
|
||||||
export import path = require('path');
|
export import path = require('path');
|
||||||
export import smartq = require('smartq');
|
export import smartq = require('smartq');
|
||||||
export import rx = require('rxjs/Rx');
|
export import smartrx = require('smartrx');
|
||||||
import { Operator } from 'rxjs/Operator';
|
|
||||||
import { Observable } from 'rxjs/Observable';
|
|
||||||
declare module 'rxjs/Subject' {
|
|
||||||
interface Subject<T> {
|
|
||||||
lift<R>(operator: Operator<T, R>): Observable<R>;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
5
dist/smartchok.plugins.js
vendored
5
dist/smartchok.plugins.js
vendored
@ -1,9 +1,8 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
require("typings-global");
|
|
||||||
exports.lik = require("lik");
|
exports.lik = require("lik");
|
||||||
exports.chokidar = require("chokidar");
|
exports.chokidar = require("chokidar");
|
||||||
exports.path = require("path");
|
exports.path = require("path");
|
||||||
exports.smartq = require("smartq");
|
exports.smartq = require("smartq");
|
||||||
exports.rx = require("rxjs/Rx");
|
exports.smartrx = require("smartrx");
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGNob2sucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2Qiw2QkFBa0M7QUFDbEMsdUNBQTRDO0FBQzVDLCtCQUFvQztBQUNwQyxtQ0FBd0M7QUFDeEMsZ0NBQXFDIn0=
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGNob2sucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDZCQUFtQztBQUNuQyx1Q0FBNkM7QUFDN0MsK0JBQXFDO0FBQ3JDLG1DQUF5QztBQUN6QyxxQ0FBMkMifQ==
|
18
package.json
18
package.json
@ -19,16 +19,16 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/smartchok#README",
|
"homepage": "https://gitlab.com/pushrocks/smartchok#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/chokidar": "^1.7.0",
|
"@types/chokidar": "^1.7.5",
|
||||||
"chokidar": "^1.7.0",
|
"chokidar": "^2.0.2",
|
||||||
"lik": "^1.0.32",
|
"lik": "^2.0.5",
|
||||||
"rxjs": "^5.4.1",
|
"smartipc": "^1.0.11",
|
||||||
"smartipc": "^1.0.9",
|
"smartq": "^1.1.6",
|
||||||
"smartq": "^1.1.1",
|
"smartrx": "^1.0.5"
|
||||||
"typings-global": "^1.0.19"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"smartfile": "^4.2.17",
|
"@types/node": "^9.4.6",
|
||||||
"tapbundle": "^1.0.14"
|
"smartfile": "^4.2.28",
|
||||||
|
"tapbundle": "^2.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
20
test/test.ts
20
test/test.ts
@ -1,5 +1,5 @@
|
|||||||
import { tap, expect } from 'tapbundle'
|
import { tap, expect } from 'tapbundle'
|
||||||
import * as smartchok from '../dist/index'
|
import * as smartchok from '../ts/index'
|
||||||
import * as smartfile from 'smartfile'
|
import * as smartfile from 'smartfile'
|
||||||
import * as smartq from 'smartq'
|
import * as smartq from 'smartq'
|
||||||
import * as rx from 'rxjs/Rx'
|
import * as rx from 'rxjs/Rx'
|
||||||
@ -11,23 +11,23 @@ let testAddObservable: rx.Observable<any>
|
|||||||
let testSubscription: rx.Subscription
|
let testSubscription: rx.Subscription
|
||||||
tap.test('should create a new instance', async () => {
|
tap.test('should create a new instance', async () => {
|
||||||
testSmartchok = new smartchok.Smartchok([])
|
testSmartchok = new smartchok.Smartchok([])
|
||||||
return expect(testSmartchok).to.be.instanceof(smartchok.Smartchok)
|
expect(testSmartchok).to.be.instanceof(smartchok.Smartchok)
|
||||||
}).catch(tap.threw)
|
})
|
||||||
|
|
||||||
tap.test('should add some files to watch and start', async () => {
|
tap.test('should add some files to watch and start', async () => {
|
||||||
testSmartchok.add([ './test/assets/**/*.txt' ])
|
testSmartchok.add([ './test/assets/**/*.txt' ])
|
||||||
let localPromise = testSmartchok.start().then(async () => {
|
let localPromise = testSmartchok.start().then(async () => {
|
||||||
testSmartchok.add([ './test/assets/**/*.md' ])
|
testSmartchok.add([ './test/assets/**/*.md' ])
|
||||||
})
|
})
|
||||||
return await expect(localPromise).to.eventually.be.fulfilled
|
await expect(localPromise).to.eventually.be.fulfilled
|
||||||
}).catch(tap.threw)
|
})
|
||||||
|
|
||||||
tap.test('should get an observable for a certain event', async () => {
|
tap.test('should get an observable for a certain event', async () => {
|
||||||
let localPromise = testSmartchok.getObservableFor('add').then(async (observableArg) => {
|
let localPromise = testSmartchok.getObservableFor('add').then(async (observableArg) => {
|
||||||
testAddObservable = observableArg
|
testAddObservable = observableArg
|
||||||
})
|
})
|
||||||
return await expect(localPromise).to.eventually.be.fulfilled
|
await expect(localPromise).to.eventually.be.fulfilled
|
||||||
}).catch(tap.threw)
|
})
|
||||||
|
|
||||||
tap.test('should register an add operation', async () => {
|
tap.test('should register an add operation', async () => {
|
||||||
let testDeferred = smartq.defer()
|
let testDeferred = smartq.defer()
|
||||||
@ -35,11 +35,11 @@ tap.test('should register an add operation', async () => {
|
|||||||
testDeferred.resolve()
|
testDeferred.resolve()
|
||||||
})
|
})
|
||||||
smartfile.memory.toFs('HI', './test/assets/hi.txt')
|
smartfile.memory.toFs('HI', './test/assets/hi.txt')
|
||||||
return await expect(testDeferred.promise).to.eventually.be.fulfilled
|
await expect(testDeferred.promise).to.eventually.be.fulfilled
|
||||||
}).catch(tap.threw)
|
})
|
||||||
|
|
||||||
tap.test('should stop the watch process', async () => {
|
tap.test('should stop the watch process', async () => {
|
||||||
testSmartchok.stop()
|
testSmartchok.stop()
|
||||||
}).catch(tap.threw)
|
})
|
||||||
|
|
||||||
tap.start()
|
tap.start()
|
||||||
|
@ -1 +1 @@
|
|||||||
export * from './smartchok.classes.smartchok'
|
export * from './smartchok.classes.smartchok';
|
||||||
|
@ -1 +0,0 @@
|
|||||||
import chokidar = require('chokidar')
|
|
@ -1,52 +1,64 @@
|
|||||||
import * as plugins from './smartchok.plugins'
|
import * as plugins from './smartchok.plugins';
|
||||||
import { Stringmap } from 'lik'
|
import { Stringmap } from 'lik';
|
||||||
|
import { Observablemap } from 'smartrx';
|
||||||
|
|
||||||
export type TSmartchokStatus = 'idle' | 'starting' | 'watching'
|
export type TSmartchokStatus = 'idle' | 'starting' | 'watching';
|
||||||
export type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw'
|
export type TFsEvent =
|
||||||
|
| 'add'
|
||||||
|
| 'addDir'
|
||||||
|
| 'change'
|
||||||
|
| 'error'
|
||||||
|
| 'unlink'
|
||||||
|
| 'unlinkDir'
|
||||||
|
| 'ready'
|
||||||
|
| 'raw';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Smartchok allows easy wathcing of files
|
* Smartchok allows easy wathcing of files
|
||||||
*/
|
*/
|
||||||
export class Smartchok {
|
export class Smartchok {
|
||||||
watchStringmap = new Stringmap()
|
watchStringmap = new Stringmap();
|
||||||
chokidarOptions: plugins.chokidar.WatchOptions
|
chokidarOptions: plugins.chokidar.WatchOptions;
|
||||||
status: TSmartchokStatus = 'idle'
|
status: TSmartchokStatus = 'idle';
|
||||||
private watcher
|
private watcher;
|
||||||
private watchingDeferred = plugins.smartq.defer<void>() // used to run things when watcher is initialized
|
private watchingDeferred = plugins.smartq.defer<void>(); // used to run things when watcher is initialized
|
||||||
private eventObservablemap = new plugins.lik.Observablemap() // register one observable per event
|
private eventObservablemap = new plugins.smartrx.Observablemap(); // register one observable per event
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constructor of class smartchok
|
* constructor of class smartchok
|
||||||
*/
|
*/
|
||||||
constructor(watchArrayArg: string[], optionsArg: plugins.chokidar.WatchOptions = {}) {
|
constructor(watchArrayArg: string[], optionsArg: plugins.chokidar.WatchOptions = {}) {
|
||||||
this.watchStringmap.addStringArray(watchArrayArg)
|
this.watchStringmap.addStringArray(watchArrayArg);
|
||||||
this.chokidarOptions = optionsArg
|
this.chokidarOptions = optionsArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* adds files to the list of watched files
|
* adds files to the list of watched files
|
||||||
*/
|
*/
|
||||||
add(pathArrayArg: string[]) {
|
add(pathArrayArg: string[]) {
|
||||||
this.watchStringmap.addStringArray(pathArrayArg)
|
this.watchStringmap.addStringArray(pathArrayArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* removes files from the list of watched files
|
* removes files from the list of watched files
|
||||||
*/
|
*/
|
||||||
remove(pathArg: string) {
|
remove(pathArg: string) {
|
||||||
this.watchStringmap.removeString(pathArg)
|
this.watchStringmap.removeString(pathArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gets an observable for a certain event
|
* gets an observable for a certain event
|
||||||
*/
|
*/
|
||||||
getObservableFor (fsEvent: TFsEvent): Promise<plugins.rx.Observable<any>> {
|
getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
|
||||||
let done = plugins.smartq.defer<plugins.rx.Observable<any>>()
|
let done = plugins.smartq.defer<plugins.smartrx.rxjs.Observable<any>>();
|
||||||
this.watchingDeferred.promise.then(() => {
|
this.watchingDeferred.promise.then(() => {
|
||||||
let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(this.watcher, fsEvent)
|
let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(
|
||||||
done.resolve(eventObservable)
|
this.watcher,
|
||||||
})
|
fsEvent
|
||||||
return done.promise
|
);
|
||||||
|
done.resolve(eventObservable);
|
||||||
|
});
|
||||||
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -54,15 +66,18 @@ export class Smartchok {
|
|||||||
* @returns Promise<void>
|
* @returns Promise<void>
|
||||||
*/
|
*/
|
||||||
start(): Promise<void> {
|
start(): Promise<void> {
|
||||||
let done = plugins.smartq.defer<void>()
|
let done = plugins.smartq.defer<void>();
|
||||||
this.status = 'starting'
|
this.status = 'starting';
|
||||||
this.watcher = plugins.chokidar.watch(this.watchStringmap.getStringArray(), this.chokidarOptions)
|
this.watcher = plugins.chokidar.watch(
|
||||||
|
this.watchStringmap.getStringArray(),
|
||||||
|
this.chokidarOptions
|
||||||
|
);
|
||||||
this.watcher.on('ready', () => {
|
this.watcher.on('ready', () => {
|
||||||
this.status = 'watching'
|
this.status = 'watching';
|
||||||
this.watchingDeferred.resolve()
|
this.watchingDeferred.resolve();
|
||||||
done.resolve()
|
done.resolve();
|
||||||
})
|
});
|
||||||
return done.promise
|
return done.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -70,13 +85,15 @@ export class Smartchok {
|
|||||||
*/
|
*/
|
||||||
stop() {
|
stop() {
|
||||||
let closeWatcher = () => {
|
let closeWatcher = () => {
|
||||||
this.watcher.close()
|
this.watcher.close();
|
||||||
}
|
};
|
||||||
if (this.status === 'watching') {
|
if (this.status === 'watching') {
|
||||||
console.log('closing while watching')
|
console.log('closing while watching');
|
||||||
closeWatcher()
|
closeWatcher();
|
||||||
} else if (this.status === 'starting') {
|
} else if (this.status === 'starting') {
|
||||||
this.watchingDeferred.promise.then(() => { closeWatcher() })
|
this.watchingDeferred.promise.then(() => {
|
||||||
|
closeWatcher();
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,2 +0,0 @@
|
|||||||
import * as plugins from './smartchok.plugins'
|
|
||||||
|
|
@ -1,15 +1,5 @@
|
|||||||
import 'typings-global'
|
export import lik = require('lik');
|
||||||
export import lik = require('lik')
|
export import chokidar = require('chokidar');
|
||||||
export import chokidar = require('chokidar')
|
export import path = require('path');
|
||||||
export import path = require('path')
|
export import smartq = require('smartq');
|
||||||
export import smartq = require('smartq')
|
export import smartrx = require('smartrx');
|
||||||
export import rx = require('rxjs/Rx')
|
|
||||||
|
|
||||||
// workaround
|
|
||||||
import {Operator} from 'rxjs/Operator'
|
|
||||||
import {Observable} from 'rxjs/Observable'
|
|
||||||
declare module 'rxjs/Subject' {
|
|
||||||
interface Subject<T> {
|
|
||||||
lift<R>(operator: Operator<T, R>): Observable<R>
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
Loading…
Reference in New Issue
Block a user