1.0.26

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
-pages/
-public/
+.nogit/
+
+# artifacts
 coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,38 +1,80 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
-- release
-- trigger
-- pages
+  - security
+  - test
+  - release
+  - metadata
 
-testLEGACY:
-  stage: test
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
-  coverage: /\d+.?\d+?\%\s*coverage/
+    - npmci git mirror
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
   allow_failure: true
 
-testLTS:
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-    - npmci test stable
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -40,32 +82,60 @@ testSTABLE:
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
-    - npmci command npmpage --publish gitlab
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
       - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,52 +0,0 @@
-# smartchok
-smart wrapper for chokidar
-
-## Availabililty
-[![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-mirror.svg)](https://github.com/pushrocks/smartchok)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartchok/)
-
-## Status for 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)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartchok.svg)](https://www.npmjs.com/package/smartchok)
-[![Dependency Status](https://david-dm.org/pushrocks/smartchok.svg)](https://david-dm.org/pushrocks/smartchok)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartchok/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartchok/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartchok/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartchok)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-Use TypeScript for best in class instellisense.
-
-```javascript
-import { Smartchok } from 'smartchok'
-
-let mySmartChok = new Smartchok(['some/path/**/*.any','/absolute/*.js'], chokidarOptions)
-
-mySmartChok.add(['/some/**/*.any']) // add files
-
-mySmartChok.remove('some/**/*.js')
-
-mySmartChok.start() // starts the watch process
-
-mySmartChok.getObservableFor('change').then((observableArg) => {
-    observableArg.subscribe(x => {
-        // do something here when a change is detected
-        // 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
-        // hence the promise construction
-    })
-})
-
-mySmartChok.stop()
-```
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| 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)

dist/index.d.ts

@@ -1,41 +0,0 @@
-/// <reference types="q" />
-import * as plugins from './smartchok.plugins';
-import { Stringmap } from 'lik';
-export declare type TSmartchokStatus = 'idle' | 'starting' | 'watching';
-export declare type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw';
-/**
- * Smartchok allows easy wathcing of files
- */
-export declare class Smartchok {
-    watchStringmap: Stringmap;
-    chokidarOptions: plugins.chokidar.WatchOptions;
-    status: TSmartchokStatus;
-    private watcher;
-    private watchingDeferred;
-    private eventObservablemap;
-    /**
-     * constructor of class smartchok
-     */
-    constructor(watchArrayArg: string[], optionsArg?: plugins.chokidar.WatchOptions);
-    /**
-     * adds files to the list of watched files
-     */
-    add(pathArrayArg: string[]): void;
-    /**
-     * removes files from the list of watched files
-     */
-    remove(pathArg: string): void;
-    /**
-     * gets an observable for a certain event
-     */
-    getObservableFor(fsEvent: TFsEvent): plugins.q.Promise<plugins.rx.Observable<any>>;
-    /**
-     * starts the watcher
-     * @returns Promise<void>
-     */
-    start(): plugins.q.Promise<void>;
-    /**
-     * stop the watcher process if watching
-     */
-    stop(): void;
-}

dist/index.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartchok.plugins");
-const lik_1 = require("lik");
-/**
- * Smartchok allows easy wathcing of files
- */
-class Smartchok {
-    /**
-     * constructor of class smartchok
-     */
-    constructor(watchArrayArg, optionsArg = {}) {
-        this.watchStringmap = new lik_1.Stringmap();
-        this.status = 'idle';
-        this.watchingDeferred = plugins.q.defer(); // used to run things when watcher is initialized
-        this.eventObservablemap = new plugins.lik.Observablemap(); // register one observable per event
-        this.watchStringmap.addStringArray(watchArrayArg);
-        this.chokidarOptions = optionsArg;
-    }
-    /**
-     * adds files to the list of watched files
-     */
-    add(pathArrayArg) {
-        this.watchStringmap.addStringArray(pathArrayArg);
-        if (this.status !== 'idle') {
-            this.watchingDeferred.promise.then(() => {
-                this.watcher.add(pathArrayArg);
-            });
-        }
-    }
-    /**
-     * removes files from the list of watched files
-     */
-    remove(pathArg) {
-        this.watchStringmap.removeString(''); // TODO
-        this.watchingDeferred.promise.then(() => {
-            this.watcher.unwatch(pathArg);
-        });
-    }
-    /**
-     * gets an observable for a certain event
-     */
-    getObservableFor(fsEvent) {
-        let done = plugins.q.defer();
-        this.watchingDeferred.promise.then(() => {
-            let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(this.watcher, fsEvent);
-            done.resolve(eventObservable);
-        });
-        return done.promise;
-    }
-    /**
-     * starts the watcher
-     * @returns Promise<void>
-     */
-    start() {
-        let done = plugins.q.defer();
-        this.status = 'starting';
-        this.watcher = plugins.chokidar.watch(this.watchStringmap.getStringArray(), this.chokidarOptions);
-        this.watcher.on('ready', () => {
-            this.status = 'watching';
-            this.watchingDeferred.resolve();
-            done.resolve();
-        });
-        return done.promise;
-    }
-    /**
-     * stop the watcher process if watching
-     */
-    stop() {
-        let closeWatcher = () => {
-            this.watcher.close();
-        };
-        if (this.status === 'watching') {
-            console.log('closing while watching');
-            closeWatcher();
-        }
-        else if (this.status === 'starting') {
-            this.watchingDeferred.promise.then(() => { closeWatcher(); });
-        }
-    }
-}
-exports.Smartchok = Smartchok;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLCtDQUE4QztBQUM5Qyw2QkFBK0I7QUFLL0I7O0dBRUc7QUFDSDtJQVFFOztPQUVHO0lBQ0gsWUFBWSxhQUF1QixFQUFFLGFBQTRDLEVBQUU7UUFWbkYsbUJBQWMsR0FBRyxJQUFJLGVBQVMsRUFBRSxDQUFBO1FBRWhDLFdBQU0sR0FBcUIsTUFBTSxDQUFBO1FBRXpCLHFCQUFnQixHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFRLENBQUEsQ0FBQyxpREFBaUQ7UUFDNUYsdUJBQWtCLEdBQUcsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLGFBQWEsRUFBRSxDQUFBLENBQUMsb0NBQW9DO1FBTS9GLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxDQUFBO1FBQ2pELElBQUksQ0FBQyxlQUFlLEdBQUcsVUFBVSxDQUFBO0lBQ25DLENBQUM7SUFFRDs7T0FFRztJQUNILEdBQUcsQ0FBQyxZQUFzQjtRQUN4QixJQUFJLENBQUMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUNoRCxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDM0IsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUM7Z0JBQ2pDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFBO1lBQ2hDLENBQUMsQ0FBQyxDQUFBO1FBQ0osQ0FBQztJQUVILENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU0sQ0FBQyxPQUFlO1FBQ3BCLElBQUksQ0FBQyxjQUFjLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQyxDQUFBLENBQUMsT0FBTztRQUM1QyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztZQUNqQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQTtRQUMvQixDQUFDLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFFRDs7T0FFRztJQUNILGdCQUFnQixDQUFDLE9BQWlCO1FBQ2hDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUE4QixDQUFBO1FBQ3hELElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQ2pDLElBQUksZUFBZSxHQUFHLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyw0QkFBNEIsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFBO1lBQ2pHLElBQUksQ0FBQyxPQUFPLENBQUMsZUFBZSxDQUFDLENBQUE7UUFDL0IsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsS0FBSztRQUNILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDbEMsSUFBSSxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUE7UUFDeEIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLGNBQWMsRUFBRSxFQUFFLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNqRyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUU7WUFDdkIsSUFBSSxDQUFDLE1BQU0sR0FBRyxVQUFVLENBQUE7WUFDeEIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sRUFBRSxDQUFBO1lBQy9CLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNoQixDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3JCLENBQUM7SUFFRDs7T0FFRztJQUNILElBQUk7UUFDRixJQUFJLFlBQVksR0FBRztZQUNqQixJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQ3RCLENBQUMsQ0FBQTtRQUNELEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUMvQixPQUFPLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUE7WUFDckMsWUFBWSxFQUFFLENBQUE7UUFDaEIsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLFVBQVUsQ0FBQyxDQUFDLENBQUM7WUFDdEMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxZQUFZLEVBQUUsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQzlELENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFqRkQsOEJBaUZDIn0=

dist/smartchok.plugins.d.ts

@@ -1,6 +0,0 @@
-import 'typings-global';
-export import chokidar = require('chokidar');
-export import lik = require('lik');
-export import path = require('path');
-export import q = require('q');
-export import rx = require('rxjs/Rx');

dist/smartchok.plugins.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("typings-global");
-exports.chokidar = require("chokidar");
-exports.lik = require("lik");
-exports.path = require("path");
-exports.q = require("q");
-exports.rx = require("rxjs/Rx");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGNob2sucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2Qix1Q0FBNEM7QUFDNUMsNkJBQWtDO0FBQ2xDLCtCQUFvQztBQUNwQyx5QkFBOEI7QUFDOUIsZ0NBQXFDIn0=

npmextra.json

@@ -1,10 +1,17 @@
 {
-    "npmts": {
-        "mode": "default"
-    },
   "npmci": {
-        "globalNpmTools": [
-            "npmts"
-        ]
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartchok",
+      "shortDescription": "smart wrapper for chokidar",
+      "npmPackagename": "@pushrocks/smartchokidar",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,12 +1,14 @@
 {
-  "name": "smartchok",
-  "version": "1.0.8",
+  "name": "@pushrocks/smartchok",
+  "version": "1.0.26",
+  "private": false,
   "description": "smart wrapper for chokidar",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npm run prepareTest && npmts)",
-    "prepareTest": "(rm -f ./test/assets/hi.txt)"
+    "test": "(npm run prepareTest && tstest test/)",
+    "prepareTest": "(rm -f ./test/assets/hi.txt)",
+    "build": "tsbuild"
   },
   "repository": {
     "type": "git",
@@ -19,17 +21,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartchok#README",
   "dependencies": {
-    "@types/chokidar": "^1.6.0",
-    "@types/q": "x.x.x",
-    "chokidar": "^1.6.1",
-    "lik": "^1.0.30",
-    "q": "^1.5.0",
-    "rxjs": "^5.3.0",
-    "smartipc": "^1.0.9",
-    "typings-global": "^1.0.14"
+    "@pushrocks/lik": "^5.0.0",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.19",
+    "chokidar": "^3.5.2"
   },
   "devDependencies": {
-    "smartfile": "^4.1.9",
-    "tapbundle": "^1.0.5"
-  }
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsrun": "^1.2.18",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/smartfile": "^8.0.10",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.11.10",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,63 @@
+# @pushrocks/smartchok
+smart wrapper for chokidar
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartchokidar)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartchok)
+* [github.com (source mirror)](https://github.com/pushrocks/smartchok)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartchok/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartchok/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartchok/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartchokidar)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartchok)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartchokidar)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartchokidar)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartchokidar)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+```javascript
+import { Smartchok } from 'smartchok';
+
+const mySmartChok = new Smartchok(['some/path/**/*.any', '/absolute/*.js'], chokidarOptions);
+
+mySmartChok.add(['/some/**/*.any']); // add files
+
+mySmartChok.remove('some/**/*.js');
+
+mySmartChok.start(); // starts the watch process
+
+mySmartChok.getObservableFor('change').then((observableArg) => {
+  observableArg.subscribe((x) => {
+    // do something here when a change is detected
+    // 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
+    // hence the promise construction
+  });
+});
+
+mySmartChok.stop();
+```
+
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.js

@@ -1,38 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const smartfile = require("smartfile");
-const smartchok = require("../dist/index");
-describe('smartchok', function () {
-    let testSmartchok;
-    let testAddObservable;
-    let testSubscription;
-    it('should create a new instance', function () {
-        testSmartchok = new smartchok.Smartchok([]);
-        should(testSmartchok).be.instanceof(smartchok.Smartchok);
-    });
-    it('should add some files to watch and start', function (done) {
-        testSmartchok.add(['./test/assets/**/*.txt']);
-        testSmartchok.start().then(() => {
-            testSmartchok.add(['./test/assets/**/*.md']);
-            done();
-        }).catch(err => { console.log(err); });
-    });
-    it('should get an observable for a certain event', function (done) {
-        testSmartchok.getObservableFor('add').then((observableArg) => {
-            testAddObservable = observableArg;
-            done();
-        }).catch(err => { console.log(err); });
-    });
-    it('should register an add operation', function (done) {
-        this.timeout(5000);
-        testSubscription = testAddObservable.subscribe(x => {
-            done();
-        });
-        smartfile.memory.toFs('HI', './test/assets/hi.txt');
-    });
-    it('should stop the watch process', function () {
-        testSmartchok.stop();
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFDaEMsdUNBQXNDO0FBRXRDLDJDQUEwQztBQUUxQyxRQUFRLENBQUMsV0FBVyxFQUFDO0lBQ2pCLElBQUksYUFBa0MsQ0FBQTtJQUN0QyxJQUFJLGlCQUFxQyxDQUFBO0lBQ3pDLElBQUksZ0JBQWlDLENBQUE7SUFDckMsRUFBRSxDQUFDLDhCQUE4QixFQUFDO1FBQzlCLGFBQWEsR0FBRyxJQUFJLFNBQVMsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLENBQUE7UUFDM0MsTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzVELENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDBDQUEwQyxFQUFDLFVBQVMsSUFBSTtRQUN2RCxhQUFhLENBQUMsR0FBRyxDQUFDLENBQUMsd0JBQXdCLENBQUMsQ0FBQyxDQUFBO1FBQzdDLGFBQWEsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxJQUFJLENBQUM7WUFDdkIsYUFBYSxDQUFDLEdBQUcsQ0FBQyxDQUFDLHVCQUF1QixDQUFDLENBQUMsQ0FBQTtZQUM1QyxJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQ3pDLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDhDQUE4QyxFQUFDLFVBQVMsSUFBSTtRQUMzRCxhQUFhLENBQUMsZ0JBQWdCLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsYUFBYTtZQUNyRCxpQkFBaUIsR0FBRyxhQUFhLENBQUE7WUFDakMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsR0FBRyxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN6QyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxrQ0FBa0MsRUFBQyxVQUFTLElBQUk7UUFDL0MsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUNsQixnQkFBZ0IsR0FBRyxpQkFBaUIsQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUM1QyxJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsU0FBUyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFDLHNCQUFzQixDQUFDLENBQUE7SUFDdEQsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsK0JBQStCLEVBQUM7UUFDL0IsYUFBYSxDQUFDLElBQUksRUFBRSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -1,43 +1,45 @@
-import { tap, expect } from 'tapbundle'
-import * as smartfile from 'smartfile'
-import * as smartq from 'smartq'
-import * as rx from 'rxjs/Rx'
+import { tap, expect } from '@pushrocks/tapbundle';
+import * as smartchok from '../ts/index';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 
 // the module to test
-import * as smartchok from '../dist/index'
+if (process.env.CI) {
+  process.exit(0);
+}
 
-let testSmartchok: smartchok.Smartchok
-let testAddObservable: rx.Observable<any>
-let testSubscription: rx.Subscription
+let testSmartchok: smartchok.Smartchok;
+let testAddObservable: smartrx.rxjs.Observable<any>;
+let testSubscription: smartrx.rxjs.Subscription;
 tap.test('should create a new instance', async () => {
-  testSmartchok = new smartchok.Smartchok([])
-  return expect(testSmartchok).to.be.instanceof(smartchok.Smartchok)
-}).catch(tap.threw)
+  testSmartchok = new smartchok.Smartchok([]);
+  expect(testSmartchok).to.be.instanceof(smartchok.Smartchok);
+});
 
 tap.test('should add some files to watch and start', async () => {
-  testSmartchok.add([ './test/assets/**/*.txt' ])
-  let localPromise = testSmartchok.start().then(async () => {
-    testSmartchok.add([ './test/assets/**/*.md' ])
-  })
-  return await expect(localPromise).to.eventually.be.fulfilled
-}).catch(tap.threw)
+  testSmartchok.add(['./test/assets/**/*.txt']);
+  await testSmartchok.start()
+  testSmartchok.add(['./test/assets/**/*.md']);
+});
 
 tap.test('should get an observable for a certain event', async () => {
-  let localPromise = testSmartchok.getObservableFor('add').then(async (observableArg) => {
-    testAddObservable = observableArg
-  })
-  return await expect(localPromise).to.eventually.be.fulfilled
-}).catch(tap.threw)
+  await testSmartchok.getObservableFor('add').then(async (observableArg) => {
+    testAddObservable = observableArg;
+  });
+});
 
 tap.test('should register an add operation', async () => {
-  let testDeferred = smartq.defer()
-  testSubscription = testAddObservable.subscribe(x => {
-    testDeferred.resolve()
-  })
-  smartfile.memory.toFs('HI', './test/assets/hi.txt')
-  return await expect(testDeferred.promise).to.eventually.be.fulfilled
-}).catch(tap.threw)
+  let testDeferred = smartpromise.defer();
+  testSubscription = testAddObservable.subscribe((x) => {
+    testDeferred.resolve();
+  });
+  smartfile.memory.toFs('HI', './test/assets/hi.txt');
+  await testDeferred.promise;
+});
 
 tap.test('should stop the watch process', async () => {
-  testSmartchok.stop()
-}).catch(tap.threw)
+  testSmartchok.stop();
+});
+
+tap.start();

ts/index.ts

@@ -1,91 +1 @@
-import * as plugins from './smartchok.plugins'
-import { Stringmap } from 'lik'
-
-export type TSmartchokStatus = 'idle' | 'starting' | 'watching'
-export type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw'
-
-/**
- * Smartchok allows easy wathcing of files
- */
-export class Smartchok {
-  watchStringmap = new Stringmap()
-  chokidarOptions: plugins.chokidar.WatchOptions
-  status: TSmartchokStatus = 'idle'
-  private watcher
-  private watchingDeferred = plugins.q.defer<void>() // used to run things when watcher is initialized
-  private eventObservablemap = new plugins.lik.Observablemap() // register one observable per event
-
-  /**
-   * constructor of class smartchok
-   */
-  constructor(watchArrayArg: string[], optionsArg: plugins.chokidar.WatchOptions = {}) {
-    this.watchStringmap.addStringArray(watchArrayArg)
-    this.chokidarOptions = optionsArg
-  }
-
-  /**
-   * adds files to the list of watched files
-   */
-  add(pathArrayArg: string[]) {
-    this.watchStringmap.addStringArray(pathArrayArg)
-    if (this.status !== 'idle') {
-      this.watchingDeferred.promise.then(() => {
-        this.watcher.add(pathArrayArg)
-      })
-    }
-
-  }
-
-  /**
-   * removes files from the list of watched files
-   */
-  remove(pathArg: string) {
-    this.watchStringmap.removeString('') // TODO
-    this.watchingDeferred.promise.then(() => {
-      this.watcher.unwatch(pathArg)
-    })
-  }
-
-  /**
-   * gets an observable for a certain event
-   */
-  getObservableFor(fsEvent: TFsEvent): plugins.q.Promise<plugins.rx.Observable<any>> {
-    let done = plugins.q.defer<plugins.rx.Observable<any>>()
-    this.watchingDeferred.promise.then(() => {
-      let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(this.watcher, fsEvent)
-      done.resolve(eventObservable)
-    })
-    return done.promise
-  }
-
-  /**
-   * starts the watcher
-   * @returns Promise<void>
-   */
-  start(): plugins.q.Promise<void> {
-    let done = plugins.q.defer<void>()
-    this.status = 'starting'
-    this.watcher = plugins.chokidar.watch(this.watchStringmap.getStringArray(), this.chokidarOptions)
-    this.watcher.on('ready', () => {
-      this.status = 'watching'
-      this.watchingDeferred.resolve()
-      done.resolve()
-    })
-    return done.promise
-  }
-
-  /**
-   * stop the watcher process if watching
-   */
-  stop() {
-    let closeWatcher = () => {
-      this.watcher.close()
-    }
-    if (this.status === 'watching') {
-      console.log('closing while watching')
-      closeWatcher()
-    } else if (this.status === 'starting') {
-      this.watchingDeferred.promise.then(() => { closeWatcher() })
-    }
-  }
-}
+export * from './smartchok.classes.smartchok';

ts/smartchok.classes.smartchok.ts

@@ -0,0 +1,98 @@
+import * as plugins from './smartchok.plugins';
+import { Stringmap } from '@pushrocks/lik';
+import { Observablemap } from '@pushrocks/smartrx';
+
+export type TSmartchokStatus = 'idle' | 'starting' | 'watching';
+export type TFsEvent =
+  | 'add'
+  | 'addDir'
+  | 'change'
+  | 'error'
+  | 'unlink'
+  | 'unlinkDir'
+  | 'ready'
+  | 'raw';
+
+/**
+ * Smartchok allows easy wathcing of files
+ */
+export class Smartchok {
+  public watchStringmap = new Stringmap();
+  public chokidarOptions: plugins.chokidar.WatchOptions;
+  public status: TSmartchokStatus = 'idle';
+  private watcher: plugins.chokidar.FSWatcher;
+  private watchingDeferred = plugins.smartpromise.defer<void>(); // used to run things when watcher is initialized
+  private eventObservablemap = new plugins.smartrx.Observablemap(); // register one observable per event
+
+  /**
+   * constructor of class smartchok
+   */
+  constructor(watchArrayArg: string[], optionsArg: plugins.chokidar.WatchOptions = {}) {
+    this.watchStringmap.addStringArray(watchArrayArg);
+    this.chokidarOptions = optionsArg;
+  }
+
+  /**
+   * adds files to the list of watched files
+   */
+  public add(pathArrayArg: string[]) {
+    this.watchStringmap.addStringArray(pathArrayArg);
+  }
+
+  /**
+   * removes files from the list of watched files
+   */
+  public remove(pathArg: string) {
+    this.watchStringmap.removeString(pathArg);
+  }
+
+  /**
+   * gets an observable for a certain event
+   */
+  public getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
+    const done = plugins.smartpromise.defer<plugins.smartrx.rxjs.Observable<any>>();
+    this.watchingDeferred.promise.then(() => {
+      const eventObservable = this.eventObservablemap.getObservableForEmitterEvent(
+        this.watcher,
+        fsEvent
+      );
+      done.resolve(eventObservable);
+    });
+    return done.promise;
+  }
+
+  /**
+   * starts the watcher
+   * @returns Promise<void>
+   */
+  public start(): Promise<void> {
+    const done = plugins.smartpromise.defer<void>();
+    this.status = 'starting';
+    this.watcher = plugins.chokidar.watch(
+      this.watchStringmap.getStringArray(),
+      this.chokidarOptions
+    );
+    this.watcher.on('ready', () => {
+      this.status = 'watching';
+      this.watchingDeferred.resolve();
+      done.resolve();
+    });
+    return done.promise;
+  }
+
+  /**
+   * stop the watcher process if watching
+   */
+  public async stop() {
+    const closeWatcher = async () => {
+      await this.watcher.close();
+    };
+    if (this.status === 'watching') {
+      console.log('closing while watching');
+      await closeWatcher();
+    } else if (this.status === 'starting') {
+      await this.watchingDeferred.promise;
+      await closeWatcher();
+    }
+  }
+}

ts/smartchok.plugins.ts

@@ -1,6 +1,24 @@
-import 'typings-global'
-export import chokidar = require('chokidar')
-export import lik = require('lik')
-export import path = require('path')
-export import q = require('q')
-export import rx = require('rxjs/Rx')
+// node native
+import * as path from 'path';
+
+export {
+  path
+}
+
+// @pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
+
+export {
+  lik,
+  smartpromise,
+  smartrx
+}
+
+// thirdparty scope
+import * as chokidar from 'chokidar';
+
+export {
+  chokidar
+}

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }