1.0.16

.gitlab-ci.yml

@@ -3,95 +3,145 @@ image: hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
-- mirror
 - security
 - test
 - release
-- trigger
+- metadata
-- pages
 
+# ====================
+# security stage
+# ====================
 mirror:
-  stage: mirror
+  stage: security
   script:
   - npmci git mirror
   tags:
   - docker
+  - notpriv
 
-security:
+snyk:
   stage: security
   script:
-    - npmci command yarn global add snyk
+    - npmci npm prepare
-    - npmci command yarn install --ignore-scripts
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
   - docker
-  allow_failure: true
+  - notpriv
 
+# ====================
+# test stage
+# ====================
 testLEGACY:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install legacy
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
   allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
   script:
-  - npmci npm prepare
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
   image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
+    - npmci command npm install -g typedoc typescript
-    - npmci command npmpage
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true
+
+windowsCompatibility:
+  image: stefanscherer/node-windows:10-build-tools
+  stage: metadata
+  script:
+  - npm install & npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - windows
+  allow_failure: true

.snyk

@@ -0,0 +1,9 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.12.0
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  'npm:chownr:20180731':
+    - chokidar > fsevents > node-pre-gyp > tar > chownr:
+        reason: None given
+        expires: '2018-11-09T15:06:03.003Z'
+patch: {}

dist/index.d.ts

@@ -1 +0,0 @@
-export * from './smartchok.classes.smartchok';

dist/index.js

@@ -1,7 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./smartchok.classes.smartchok"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE4QyJ9

dist/smartchok.classes.smartchok.d.ts

@@ -1,39 +0,0 @@
-import * as plugins from './smartchok.plugins';
-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: plugins.lik.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): Promise<plugins.smartrx.rxjs.Observable<any>>;
-    /**
-     * starts the watcher
-     * @returns Promise<void>
-     */
-    start(): Promise<void>;
-    /**
-     * stop the watcher process if watching
-     */
-    stop(): void;
-}

dist/smartchok.classes.smartchok.js

@@ -1,77 +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.smartq.defer(); // used to run things when watcher is initialized
-        this.eventObservablemap = new plugins.smartrx.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);
-    }
-    /**
-     * removes files from the list of watched files
-     */
-    remove(pathArg) {
-        this.watchStringmap.removeString(pathArg);
-    }
-    /**
-     * gets an observable for a certain event
-     */
-    getObservableFor(fsEvent) {
-        let done = plugins.smartq.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.smartq.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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRjaG9rLmNsYXNzZXMuc21hcnRjaG9rLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0NBQStDO0FBQy9DLDZCQUFnQztBQWNoQzs7R0FFRztBQUNIO0lBUUU7O09BRUc7SUFDSCxZQUFZLGFBQXVCLEVBQUUsYUFBNEMsRUFBRTtRQVZuRixtQkFBYyxHQUFHLElBQUksZUFBUyxFQUFFLENBQUM7UUFFakMsV0FBTSxHQUFxQixNQUFNLENBQUM7UUFFMUIscUJBQWdCLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQVEsQ0FBQyxDQUFDLGlEQUFpRDtRQUNsRyx1QkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsYUFBYSxFQUFFLENBQUMsQ0FBQyxvQ0FBb0M7UUFNcEcsSUFBSSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDbEQsSUFBSSxDQUFDLGVBQWUsR0FBRyxVQUFVLENBQUM7SUFDcEMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsR0FBRyxDQUFDLFlBQXNCO1FBQ3hCLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ25ELENBQUM7SUFFRDs7T0FFRztJQUNILE1BQU0sQ0FBQyxPQUFlO1FBQ3BCLElBQUksQ0FBQyxjQUFjLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7T0FFRztJQUNILGdCQUFnQixDQUFDLE9BQWlCO1FBQ2hDLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUF3QyxDQUFDO1FBQ3hFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtZQUN0QyxJQUFJLGVBQWUsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsNEJBQTRCLENBQ3hFLElBQUksQ0FBQyxPQUFPLEVBQ1osT0FBTyxDQUNSLENBQUM7WUFDRixJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ2hDLENBQUMsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7SUFDdEIsQ0FBQztJQUVEOzs7T0FHRztJQUNILEtBQUs7UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBUSxDQUFDO1FBQ3hDLElBQUksQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQ25DLElBQUksQ0FBQyxjQUFjLENBQUMsY0FBYyxFQUFFLEVBQ3BDLElBQUksQ0FBQyxlQUFlLENBQ3JCLENBQUM7UUFDRixJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFO1lBQzVCLElBQUksQ0FBQyxNQUFNLEdBQUcsVUFBVSxDQUFDO1lBQ3pCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNoQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDakIsQ0FBQyxDQUFDLENBQUM7UUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN0QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFJO1FBQ0YsSUFBSSxZQUFZLEdBQUcsR0FBRyxFQUFFO1lBQ3RCLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDdkIsQ0FBQyxDQUFDO1FBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQy9CLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztZQUN0QyxZQUFZLEVBQUUsQ0FBQztRQUNqQixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUN0QyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7Z0JBQ3RDLFlBQVksRUFBRSxDQUFDO1lBQ2pCLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7Q0FDRjtBQWhGRCw4QkFnRkMifQ==

dist/smartchok.plugins.d.ts

@@ -1,5 +0,0 @@
-export import lik = require('lik');
-export import chokidar = require('chokidar');
-export import path = require('path');
-export import smartq = require('smartq');
-export import smartrx = require('smartrx');

dist/smartchok.plugins.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lik = require("lik");
-exports.chokidar = require("chokidar");
-exports.path = require("path");
-exports.smartq = require("smartq");
-exports.smartrx = require("smartrx");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjaG9rLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGNob2sucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDZCQUFtQztBQUNuQyx1Q0FBNkM7QUFDN0MsK0JBQXFDO0FBQ3JDLG1DQUF5QztBQUN6QyxxQ0FBMkMifQ==

npmextra.json

@@ -1,10 +1,7 @@
 {
-    "npmts": {
+  "npmci": {
-        "mode": "default"
+    "npmGlobalTools": [
-    },
+    ],
-    "npmci": {
+    "npmAccessLevel": "public"
-        "globalNpmTools": [
+  }
-            "npmts"
-        ]
-    }
 }

package.json

@@ -1,12 +1,14 @@
 {
-  "name": "smartchok",
+  "name": "@pushrocks/smartchok",
-  "version": "1.0.12",
+  "version": "1.0.16",
+  "private": false,
   "description": "smart wrapper for chokidar",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(yarn run prepareTest && npmts)",
+    "test": "(npm run prepareTest && tstest test/)",
-    "prepareTest": "(rm -f ./test/assets/hi.txt)"
+    "prepareTest": "(rm -f ./test/assets/hi.txt)",
+    "build": "tsbuild"
   },
   "repository": {
     "type": "git",
@@ -19,16 +21,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartchok#README",
   "dependencies": {
+    "@pushrocks/lik": "^3.0.1",
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartrx": "^2.0.1",
+    "@pushrocks/smartspawn": "^2.0.2",
     "@types/chokidar": "^1.7.5",
-    "chokidar": "^2.0.2",
+    "chokidar": "^2.0.4"
-    "lik": "^2.0.5",
-    "smartipc": "^1.0.11",
-    "smartq": "^1.1.6",
-    "smartrx": "^1.0.5"
   },
   "devDependencies": {
-    "@types/node": "^9.4.6",
+    "@gitzone/tsbuild": "^2.0.22",
-    "smartfile": "^4.2.28",
+    "@gitzone/tsrun": "^1.1.12",
-    "tapbundle": "^2.0.0"
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/smartfile": "^6.0.8",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.11.6"
   }
 }

test/test.ts

@@ -1,45 +1,45 @@
-import { tap, expect } from 'tapbundle'
+import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartchok from '../ts/index'
+import * as smartchok from '../ts/index';
-import * as smartfile from 'smartfile'
+import * as smartfile from '@pushrocks/smartfile';
-import * as smartq from 'smartq'
+import * as smartpromise from '@pushrocks/smartpromise';
-import * as rx from 'rxjs/Rx'
+import * as smartrx from '@pushrocks/smartrx';
 
 // the module to test
 
-let testSmartchok: smartchok.Smartchok
+let testSmartchok: smartchok.Smartchok;
-let testAddObservable: rx.Observable<any>
+let testAddObservable: smartrx.rxjs.Observable<any>;
-let testSubscription: rx.Subscription
+let testSubscription: smartrx.rxjs.Subscription;
 tap.test('should create a new instance', async () => {
-  testSmartchok = new smartchok.Smartchok([])
+  testSmartchok = new smartchok.Smartchok([]);
-  expect(testSmartchok).to.be.instanceof(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' ])
+  testSmartchok.add(['./test/assets/**/*.txt']);
   let localPromise = testSmartchok.start().then(async () => {
-    testSmartchok.add([ './test/assets/**/*.md' ])
+    testSmartchok.add(['./test/assets/**/*.md']);
-  })
+  });
-  await expect(localPromise).to.eventually.be.fulfilled
+  await expect(localPromise).to.eventually.be.fulfilled;
-})
+});
 
 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;
-  })
+  });
-  await expect(localPromise).to.eventually.be.fulfilled
+  await expect(localPromise).to.eventually.be.fulfilled;
-})
+});
 
 tap.test('should register an add operation', async () => {
-  let testDeferred = smartq.defer()
+  let testDeferred = smartpromise.defer();
   testSubscription = testAddObservable.subscribe(x => {
-    testDeferred.resolve()
+    testDeferred.resolve();
-  })
+  });
-  smartfile.memory.toFs('HI', './test/assets/hi.txt')
+  smartfile.memory.toFs('HI', './test/assets/hi.txt');
-  await expect(testDeferred.promise).to.eventually.be.fulfilled
+  await expect(testDeferred.promise).to.eventually.be.fulfilled;
-})
+});
 
 tap.test('should stop the watch process', async () => {
-  testSmartchok.stop()
+  testSmartchok.stop();
-})
+});
 
-tap.start()
+tap.start();

ts/smartchok.classes.smartchok.ts

@@ -1,6 +1,6 @@
 import * as plugins from './smartchok.plugins';
-import { Stringmap } from 'lik';
+import { Stringmap } from '@pushrocks/lik';
-import { Observablemap } from 'smartrx';
+import { Observablemap } from '@pushrocks/smartrx';
 
 export type TSmartchokStatus = 'idle' | 'starting' | 'watching';
 export type TFsEvent =
@@ -21,7 +21,7 @@ export class Smartchok {
   chokidarOptions: plugins.chokidar.WatchOptions;
   status: TSmartchokStatus = 'idle';
   private watcher;
-  private watchingDeferred = plugins.smartq.defer<void>(); // used to run things when watcher is initialized
+  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
 
   /**
@@ -50,7 +50,7 @@ export class Smartchok {
    * gets an observable for a certain event
    */
   getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
-    let done = plugins.smartq.defer<plugins.smartrx.rxjs.Observable<any>>();
+    let done = plugins.smartpromise.defer<plugins.smartrx.rxjs.Observable<any>>();
     this.watchingDeferred.promise.then(() => {
       let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(
         this.watcher,
@@ -66,7 +66,7 @@ export class Smartchok {
    * @returns Promise<void>
    */
   start(): Promise<void> {
-    let done = plugins.smartq.defer<void>();
+    let done = plugins.smartpromise.defer<void>();
     this.status = 'starting';
     this.watcher = plugins.chokidar.watch(
       this.watchStringmap.getStringArray(),

ts/smartchok.plugins.ts

@@ -1,5 +1,5 @@
-export import lik = require('lik');
+export import lik = require('@pushrocks/lik');
 export import chokidar = require('chokidar');
 export import path = require('path');
-export import smartq = require('smartq');
+export import smartpromise = require('@pushrocks/smartpromise');
-export import smartrx = require('smartrx');
+export import smartrx = require('@pushrocks/smartrx');