1.0.21

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -37,32 +37,8 @@ snyk:
 # ====================
 # 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:
+testStable:
-  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
@@ -72,6 +48,18 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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
   - notpriv
 
 release:
@@ -90,19 +78,12 @@ release:
 # ====================
 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
@@ -118,13 +99,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - 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:
     - docker
     - notpriv
@@ -135,13 +118,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

npmextra.json

@@ -2,5 +2,15 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "gitzone",
+      "gitrepo": "tswatch",
+      "shortDescription": "watch typescript projects during development",
+      "npmPackagename": "@gitzone/tswatch",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,30 +1,50 @@
 {
   "name": "@gitzone/tswatch",
-  "version": "1.0.2",
+  "version": "1.0.21",
   "private": false,
   "description": "watch typescript projects during development",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
+  "bin": {
+    "tswatch": "cli.js"
+  },
   "scripts": {
-    "test": "node ./cli.ts.js test",
+    "test": "(tstest test/)",
-    "test2": "(tstest test/)",
+    "build": "(tsbuild)"
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^10.11.7",
+    "@types/node": "^12.7.12",
-    "tslint": "^5.11.0",
+    "tslint": "^5.20.0",
-    "tslint-config-prettier": "^1.15.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@gitzone/tsrun": "^1.1.13",
+    "@gitzone/tsbundle": "^1.0.47",
-    "@pushrocks/smartcli": "^3.0.6",
+    "@gitzone/tsrun": "^1.2.8",
-    "@pushrocks/smartshell": "^2.0.6",
+    "@pushrocks/early": "^3.0.3",
-    "filewatcher": "^3.0.1"
+    "@pushrocks/lik": "^3.0.11",
-  }
+    "@pushrocks/smartchok": "^1.0.23",
+    "@pushrocks/smartcli": "^3.0.7",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartlog-destination-local": "^8.0.2",
+    "@pushrocks/smartserve": "^1.1.37",
+    "@pushrocks/smartshell": "^2.0.25",
+    "@pushrocks/taskbuffer": "^2.0.15"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,26 @@
+# @gitzone/tswatch
+watch typescript projects during development
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tswatch)
+* [gitlab.com (source)](https://gitlab.com/gitzone/tswatch)
+* [github.com (source mirror)](https://github.com/gitzone/tswatch)
+* [docs (typedoc)](https://gitzone.gitlab.io/tswatch/)
+
+## Status for master
+[![build status](https://gitlab.com/gitzone/tswatch/badges/master/build.svg)](https://gitlab.com/gitzone/tswatch/commits/master)
+[![coverage report](https://gitlab.com/gitzone/tswatch/badges/master/coverage.svg)](https://gitlab.com/gitzone/tswatch/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tswatch.svg)](https://www.npmjs.com/package/@gitzone/tswatch)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tswatch/badge.svg)](https://snyk.io/test/npm/@gitzone/tswatch)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+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.ts

@@ -1,21 +1,20 @@
+// tslint:disable-next-line: no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as tswatch from '../ts/index';
 
 let testTsWatchInstance: tswatch.TsWatch;
 
 tap.test('should create a valid TsWatch instance', async () => {
-  testTsWatchInstance = new tswatch.TsWatch({
+  testTsWatchInstance = new tswatch.TsWatch('echoSomething');
-    filePathToWatch: process.cwd(),
-    commandToExecute: 'npm -v'
-  });
 });
 
 tap.test('should start the tswatch instance', async () => {
-  console.log('test executed');
+  await testTsWatchInstance.start();
 });
 
-tap.test('should run abitrary commands', async () => {
+tap.test('should stop the instance', async tools => {
-  
+  tools.delayFor(2000);
+  testTsWatchInstance.stop();
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1,5 @@
+import * as early from '@pushrocks/early';
+early.start('tswatch');
 export * from './tswatch.classes.tswatch';
-
+import './tswatch.cli';
-import './tswatch.cli';
+early.stop();

ts/interfaces/index.ts

@@ -0,0 +1 @@
+export * from './interfaces.watchmodes';

ts/interfaces/interfaces.watchmodes.ts

@@ -0,0 +1,7 @@
+export type TWatchModes =
+  | 'test'
+  | 'gitzone_npm'
+  | 'gitzone_service'
+  | 'gitzone_element'
+  | 'gitzone_website'
+  | 'echoSomething';

ts/tswatch.classes.tswatch.ts

@@ -1,70 +1,94 @@
 import * as plugins from './tswatch.plugins';
+import * as paths from './tswatch.paths';
+import * as interfaces from './interfaces';
+
+import { Watcher } from './tswatch.classes.watcher';
 
-/**
- * handles the management of watching for foes
- */
 export class TsWatch {
-  private smartshellInstance = new plugins.smartshell.Smartshell({
+  public watchmode: interfaces.TWatchModes;
-    executor: 'bash'
+  public watcherMap = new plugins.lik.Objectmap<Watcher>();
-  });
-  private currentExecution: plugins.smartshell.IExecResultStreaming;
-  private watcher = plugins.fileWatcher();
-  private filePathToWatch: string;
-  private commandToExecute: string;
 
-  constructor(optionsArg: {
+  constructor(watchmodeArg: interfaces.TWatchModes) {
-    filePathToWatch: string,
+    this.watchmode = watchmodeArg;
-    commandToExecute: string
-  }) {
-    this.filePathToWatch = optionsArg.filePathToWatch;
-    this.commandToExecute = optionsArg.commandToExecute;
   }
 
   /**
-   * start the file
+   * starts the TsWatch instance
    */
   public async start() {
-    this.setupCleanup();
+    switch (this.watchmode) {
-    console.log(`Looking at ${this.filePathToWatch} for changes`);
+      case 'test':
-    this.watcher.add(this.filePathToWatch); // __dirname refers to the directory of this very file
+        this.watcherMap.add(
-    this.watcher.on('change', async (file, stat) => {
+          new Watcher({
-      console.log('Noticed change!');
+            filePathToWatch: paths.cwd,
-      if (!stat) {
+            commandToExecute: 'npm run test2',
-        console.log('deleted');
+            timeout: null
-      }
+          })
-      this.updateCurrentExecution();
+        );
-    });
+        break;
-    this.updateCurrentExecution();
+      case 'gitzone_npm':
-  }
+        this.watcherMap.add(
+          new Watcher({
+            filePathToWatch: paths.cwd,
+            commandToExecute: 'npm run test',
+            timeout: null
+          })
+        );
+        break;
+      case 'gitzone_element':
+        this.watcherMap.add(
+          new Watcher({
+            filePathToWatch: plugins.path.join(paths.cwd, './ts_web/'),
+            commandToExecute: async () => {
+              const tsbundle = new plugins.tsbundle.TsBundle();
+              const htmlHandler = new plugins.tsbundle.HtmlHandler();
+              await tsbundle.buildProduction('./ts_web', 'dist_web');
+              await htmlHandler.copyHtml();
+            },
+            timeout: null
+          })
+        );
+        break;
+      case 'gitzone_website':
+        this.watcherMap.add(
+          new Watcher({
+            filePathToWatch: plugins.path.join(paths.cwd, './ts/'),
+            commandToExecute: 'npm run startTs',
+            timeout: null
+          })
+        );
 
-  private async updateCurrentExecution() {
+        // client directory
-    if (this.currentExecution) {
+        this.watcherMap.add(
-      process.kill(-this.currentExecution.childProcess.pid);
+          new Watcher({
+            filePathToWatch: plugins.path.join(paths.cwd, './ts_web/'),
+            commandToExecute: 'npm run build',
+            timeout: null
+          })
+        );
+        break;
+      case 'echoSomething':
+        const tsWatchInstanceEchoSomething = new Watcher({
+          filePathToWatch: paths.cwd,
+          commandToExecute: 'npm -v',
+          timeout: null
+        });
+        this.watcherMap.add(tsWatchInstanceEchoSomething);
+        break;
+      default:
+        break;
     }
-    this.currentExecution = await this.smartshellInstance.execStreaming(this.commandToExecute);
+    this.watcherMap.forEach(async watcher => {
-    this.currentExecution = null;
+      await watcher.start();
+    });
   }
 
   /**
-   * this method sets up a clean exit strategy
+   * stops the execution of any active Watchers
    */
-  private setupCleanup() {
+  public async stop() {
-    const cleanup = () => {
+    this.watcherMap.forEach(async watcher => {
-      if (this.currentExecution) {
+      await watcher.stop();
-        process.kill(-this.currentExecution.childProcess.pid);
-      }
-    };
-    process.on('exit', () => {
-      console.log('');
-      console.log('now exiting!');
-      cleanup();
-      process.exit(0);
-    });
-    process.on('SIGINT', () => {
-      console.log('');
-      console.log('ok! got SIGINT We are exiting! Just cleaning up to exit neatly :)');
-      cleanup();
-      process.exit(0);
     });
   }
 }

ts/tswatch.classes.watcher.ts

@@ -0,0 +1,122 @@
+import * as plugins from './tswatch.plugins';
+import { logger } from './tswatch.logging';
+
+export type TCommandFunction = () => Promise<void>;
+
+export interface IWatcherConstructorOptions {
+  filePathToWatch: string;
+  commandToExecute: string | TCommandFunction;
+  timeout?: number;
+}
+
+/**
+ * A watcher keeps track of one child execution
+ */
+export class Watcher {
+  /**
+   * used to execute shell commands
+   */
+  private smartshellInstance = new plugins.smartshell.Smartshell({
+    executor: 'bash'
+  });
+
+  /**
+   * used to execute 
+   */
+  private executionTask: plugins.taskbuffer.Task = new plugins.taskbuffer.Task({
+    name: 'watcherCommandFunctionTask',
+    taskFunction: async () => {
+      if (typeof this.options.commandToExecute === 'string') {
+        throw new Error('cannot execute string as task');
+      }
+      await this.options.commandToExecute();
+    },
+    buffered: true,
+    bufferMax: 1
+  });
+
+  private currentExecution: plugins.smartshell.IExecResultStreaming;
+  private smartchokWatcher = new plugins.smartchok.Smartchok([], {});
+  private options: IWatcherConstructorOptions;
+
+  constructor(optionsArg: IWatcherConstructorOptions) {
+    this.options = optionsArg;
+  }
+
+  /**
+   * start the file
+   */
+  public async start() {
+    await this.setupCleanup();
+    console.log(`Looking at ${this.options.filePathToWatch} for changes`);
+    this.smartchokWatcher.add([this.options.filePathToWatch]); // __dirname refers to the directory of this very file
+    await this.smartchokWatcher.start();
+    const changeObservable = await this.smartchokWatcher.getObservableFor('change');
+    changeObservable.subscribe(() => {
+      this.updateCurrentExecution();
+    });
+    this.updateCurrentExecution();
+  }
+
+  /**
+   * updates the current execution
+   */
+  private async updateCurrentExecution() {
+    if (typeof this.options.commandToExecute === 'string') {
+      if (this.currentExecution) {
+        logger.log('ok', `reexecuting ${this.options.commandToExecute}`);
+        process.kill(-this.currentExecution.childProcess.pid);
+      } else {
+        logger.log('ok', `executing ${this.options.commandToExecute} for the first time`);
+      }
+      this.currentExecution = await this.smartshellInstance.execStreaming(
+        this.options.commandToExecute
+      );
+      this.currentExecution = null;
+    } else {
+      await this.executionTask.trigger();
+    }
+  }
+
+  /**
+   * this method sets up a clean exit strategy
+   */
+  private async setupCleanup() {
+    const cleanup = () => {
+      if (this.currentExecution) {
+        process.kill(-this.currentExecution.childProcess.pid);
+      }
+    };
+    process.on('exit', () => {
+      console.log('');
+      console.log('now exiting!');
+      cleanup();
+      process.exit(0);
+    });
+    process.on('SIGINT', () => {
+      console.log('');
+      console.log('ok! got SIGINT We are exiting! Just cleaning up to exit neatly :)');
+      cleanup();
+      process.exit(0);
+    });
+
+    // handle timeout
+    if (this.options.timeout) {
+      plugins.smartdelay.delayFor(this.options.timeout).then(() => {
+        console.log(`timed out afer ${this.options.timeout} milliseconds! exiting!`);
+        cleanup();
+        process.exit(0);
+      });
+    }
+  }
+
+  /**
+   * stops the watcher
+   */
+  public async stop() {
+    await this.smartchokWatcher.stop();
+    if (this.currentExecution && !this.currentExecution.childProcess.killed) {
+      process.kill(-this.currentExecution.childProcess.pid);
+    }
+  }
+}

ts/tswatch.cli.ts

@@ -1,16 +1,29 @@
 import * as plugins from './tswatch.plugins';
 import * as paths from './tswatch.paths';
+import { logger } from './tswatch.logging';
 
 import { TsWatch } from './tswatch.classes.tswatch';
 
 const tswatchCli = new plugins.smartcli.Smartcli();
 
-tswatchCli.addCommand('test').subscribe(argvArg => {
+// standard behaviour will assume gitzone setup
-  const tsWatch = new TsWatch({
+
-    filePathToWatch: paths.cwd,
+tswatchCli.addCommand('test').subscribe(async argvArg => {
-    commandToExecute: 'npm run test2'
+  logger.log('info', `running test task`);
-  });
+  const tsWatch = new TsWatch('test');
-  tsWatch.start();
+  await tsWatch.start();
+});
+
+tswatchCli.addCommand('website').subscribe(async argvArg => {
+  logger.log('info', `running watch task for a gitzone website project`);
+  const tsWatch = new TsWatch('gitzone_website');
+  await tsWatch.start();
+});
+
+tswatchCli.addCommand('element').subscribe(async argvArg => {
+  logger.log('info', `running watch task for a gitzone element project`);
+  const tsWatch = new TsWatch('gitzone_element');
+  await tsWatch.start();
 });
 
 tswatchCli.startParse();

ts/tswatch.logging.ts

@@ -0,0 +1,15 @@
+import * as plugins from './tswatch.plugins';
+
+export const logger = new plugins.smartlog.Smartlog({
+  logContext: {
+    company: 'Some Company',
+    companyunit: 'Some CompanyUnit',
+    containerName: 'Some Containername',
+    environment: 'local',
+    runtime: 'node',
+    zone: 'gitzone'
+  },
+  minimumLogLevel: 'silly'
+});
+
+logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

ts/tswatch.plugins.ts

@@ -1,13 +1,21 @@
 import * as path from 'path';
 export { path };
 
+// @gitzone scope
+import * as tsbundle from '@gitzone/tsbundle';
+
+export {
+  tsbundle
+};
+
 // @pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smartchok from '@pushrocks/smartchok';
 import * as smartcli from '@pushrocks/smartcli';
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartlog from '@pushrocks/smartlog';
+import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
 import * as smartshell from '@pushrocks/smartshell';
+import * as taskbuffer from '@pushrocks/taskbuffer';
 
-export { smartshell, smartcli };
+export { lik, smartchok, smartcli, smartdelay, smartlog, smartlogDestinationLocal, smartshell, taskbuffer };
-
-// Third Pary
-import * as fileWatcher from 'filewatcher';
-
-export { fileWatcher };

tslint.json

@@ -4,7 +4,14 @@
     "semicolon": [true, "always"],
     "no-console": false,
     "ordered-imports": false,
-    "object-literal-sort-keys": false
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
   },
   "defaultSeverity": "warning"
 }