1.0.24

.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,16 +1,19 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -19,50 +22,42 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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
-  - notpriv
+  allow_failure: true
+
+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
 # ====================
-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:
+testStable:
   stage: test
   script:
     - npmci npm prepare
@@ -72,7 +67,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -82,6 +87,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -90,20 +96,16 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   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]
+    - 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
 
@@ -114,18 +116,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -135,13 +139,3 @@ pages:
     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

@@ -1,9 +0,0 @@
-# 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: {}

.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,56 +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)

npmextra.json

@@ -1,7 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-    ],
+    "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,10 +1,10 @@
 {
   "name": "@pushrocks/smartchok",
-  "version": "1.0.17",
+  "version": "1.0.24",
   "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 && tstest test/)",
     "prepareTest": "(rm -f ./test/assets/hi.txt)",
@@ -21,19 +21,35 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartchok#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.5",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smartspawn": "^2.0.4",
+    "@pushrocks/lik": "^5.0.0",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.19",
     "@types/chokidar": "^2.1.3",
-    "chokidar": "^3.0.0"
+    "chokidar": "^3.5.2"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.20",
-    "@pushrocks/smartfile": "^7.0.2",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.0"
-  }
+    "@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"
+  ]
 }

test/test.ts

@@ -5,6 +5,9 @@ import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrx from '@pushrocks/smartrx';
 
 // the module to test
+if (process.env.CI) {
+  process.exit(0);
+}
 
 let testSmartchok: smartchok.Smartchok;
 let testAddObservable: smartrx.rxjs.Observable<any>;
@@ -16,26 +19,23 @@ tap.test('should create a new instance', async () => {
 
 tap.test('should add some files to watch and start', async () => {
   testSmartchok.add(['./test/assets/**/*.txt']);
-  let localPromise = testSmartchok.start().then(async () => {
+  await testSmartchok.start()
   testSmartchok.add(['./test/assets/**/*.md']);
-  });
-  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 => {
+  await testSmartchok.getObservableFor('add').then(async (observableArg) => {
     testAddObservable = observableArg;
   });
-  await expect(localPromise).to.eventually.be.fulfilled;
 });
 
 tap.test('should register an add operation', async () => {
   let testDeferred = smartpromise.defer();
-  testSubscription = testAddObservable.subscribe(x => {
+  testSubscription = testAddObservable.subscribe((x) => {
     testDeferred.resolve();
   });
   smartfile.memory.toFs('HI', './test/assets/hi.txt');
-  await expect(testDeferred.promise).to.eventually.be.fulfilled;
+  await testDeferred.promise;
 });
 
 tap.test('should stop the watch process', async () => {

ts/smartchok.classes.smartchok.ts

@@ -17,10 +17,10 @@ export type TFsEvent =
  * Smartchok allows easy wathcing of files
  */
 export class Smartchok {
-  watchStringmap = new Stringmap();
-  chokidarOptions: plugins.chokidar.WatchOptions;
-  status: TSmartchokStatus = 'idle';
-  private watcher;
+  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
 
@@ -35,24 +35,24 @@ export class Smartchok {
   /**
    * adds files to the list of watched files
    */
-  add(pathArrayArg: string[]) {
+  public add(pathArrayArg: string[]) {
     this.watchStringmap.addStringArray(pathArrayArg);
   }
 
   /**
    * removes files from the list of watched files
    */
-  remove(pathArg: string) {
+  public remove(pathArg: string) {
     this.watchStringmap.removeString(pathArg);
   }
 
   /**
    * gets an observable for a certain event
    */
-  getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
-    let done = plugins.smartpromise.defer<plugins.smartrx.rxjs.Observable<any>>();
+  public getObservableFor(fsEvent: TFsEvent): Promise<plugins.smartrx.rxjs.Observable<any>> {
+    const done = plugins.smartpromise.defer<plugins.smartrx.rxjs.Observable<any>>();
     this.watchingDeferred.promise.then(() => {
-      let eventObservable = this.eventObservablemap.getObservableForEmitterEvent(
+      const eventObservable = this.eventObservablemap.getObservableForEmitterEvent(
         this.watcher,
         fsEvent
       );
@@ -65,8 +65,8 @@ export class Smartchok {
    * starts the watcher
    * @returns Promise<void>
    */
-  start(): Promise<void> {
-    let done = plugins.smartpromise.defer<void>();
+  public start(): Promise<void> {
+    const done = plugins.smartpromise.defer<void>();
     this.status = 'starting';
     this.watcher = plugins.chokidar.watch(
       this.watchStringmap.getStringArray(),
@@ -83,17 +83,16 @@ export class Smartchok {
   /**
    * stop the watcher process if watching
    */
-  stop() {
-    let closeWatcher = () => {
-      this.watcher.close();
+  public async stop() {
+    const closeWatcher = async () => {
+      await this.watcher.close();
     };
     if (this.status === 'watching') {
       console.log('closing while watching');
-      closeWatcher();
+      await closeWatcher();
     } else if (this.status === 'starting') {
-      this.watchingDeferred.promise.then(() => {
-        closeWatcher();
-      });
+      await this.watchingDeferred.promise;
+      await closeWatcher();
     }
   }
 }

ts/smartchok.plugins.ts

@@ -1,5 +1,24 @@
-export import lik = require('@pushrocks/lik');
-export import chokidar = require('chokidar');
-export import path = require('path');
-export import smartpromise = require('@pushrocks/smartpromise');
-export import smartrx = require('@pushrocks/smartrx');
+// 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"
 }