2.0.8

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -39,6 +40,7 @@ snyk:
 testLEGACY:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install legacy
   - npmci npm install
   - npmci npm test
@@ -51,6 +53,7 @@ testLEGACY:
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +65,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +121,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g 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
@@ -128,3 +134,14 @@ pages:
     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

npmextra.json

@@ -1,8 +1,6 @@
 {
   "npmci": {
-    "npmGlobalTools": [
+    "npmGlobalTools": [],
-      "npmts"
-    ],
     "npmAccessLevel": "public"
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "smartlog",
+  "name": "@pushrocks/smartlog",
-  "version": "1.0.4",
+  "version": "2.0.8",
   "private": false,
   "description": "winston based logger for large scale projects",
   "main": "dist/index.js",
@@ -8,16 +8,20 @@
   "author": "Lossless GmbH",
   "license": "UNLICENSED",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
+    "test": "(tstest test/)",
-    "build": "echo \"Not needed for now\"",
+    "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.0.4",
+    "@gitzone/tsbuild": "^2.0.22",
-    "cz-conventional-changelog": "^2.1.0",
+    "@gitzone/tsrun": "^1.1.13",
-    "tapbundle": "^1.0.13"
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.12.2",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "smartlog-interfaces": "^1.0.4"
+    "@pushrocks/smartlog-interfaces": "^2.0.2"
   }
 }

test/test.ts

@@ -1,10 +1,10 @@
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartlog from '../ts/index';
 
 let defaultLogger: smartlog.Smartlog;
 
 tap.test('should produce instance of Smartlog', async () => {
-  defaultLogger = smartlog.getDefaultLogger();
+  defaultLogger = smartlog.defaultLogger;
   expect(defaultLogger).to.be.instanceOf(smartlog.Smartlog);
 });
 

ts/index.ts

@@ -1,13 +1,14 @@
 import * as plugins from './smartlog.plugins';
 import { Smartlog } from './smartlog.classes.smartlog';
-
+const defaultLogger: Smartlog = new Smartlog({
-export { Smartlog };
+  logContext: {
-
+    company: 'undefined',
-let defaultLogger: Smartlog;
+    companyunit: 'undefefined',
-
+    containerName: 'undefined',
-export const getDefaultLogger = () => {
+    environment: 'local',
-  if (!defaultLogger) {
+    runtime: 'node',
-    defaultLogger = new Smartlog();
+    zone: 'undefined'
   }
-  return defaultLogger;
+});
-};
+
+export { Smartlog, defaultLogger };

ts/smartlog.classes.logrouter.ts

@@ -1,10 +1,23 @@
 import * as plugins from './smartlog.plugins';
 
-import { ILogDestination } from 'smartlog-interfaces';
+import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
 
 export class LogRouter {
-  logDestinations: ILogDestination[] = [];
+  /**
+   * all log destinations
+   */
+  private logDestinations: ILogDestination[] = [];
+
   constructor() {}
 
-  addLogDestination;
+  public addLogDestination(logDestination: ILogDestination) {
+    this.logDestinations.push(logDestination);
+  }
+
+  // routes the log according to added logDestinations
+  routeLog(logPackageArg: ILogPackage) {
+    for (const logDestination of this.logDestinations) {
+      logDestination.handleLog(logPackageArg);
+    }
+  }
 }

ts/smartlog.classes.smartlog.ts

@@ -1,13 +1,33 @@
 import * as plugins from './smartlog.plugins';
 
 // interfaces
-import { TEnvironment, ILogContext, TLogLevel, TRuntime } from 'smartlog-interfaces';
+import { TLogType, TEnvironment, ILogContext, TLogLevel, TRuntime, ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
+
+import { LogRouter } from './smartlog.classes.logrouter';
+
+export interface ISmartlogContructorOptions {
+  logContext: ILogContext;
+  minimumLogLevel?: TLogLevel;
+}
 
 export class Smartlog {
   private logContext: ILogContext;
+  private minimumLogLevel: TLogLevel;
+  
   private consoleEnabled: boolean;
-  private minimumLevel: TLogLevel;
+  
-  private runtime: TRuntime;
+  private logRouter = new LogRouter();
+
+  public addLogDestination (logDestinationArg: ILogDestination) {
+    this.logRouter.addLogDestination(logDestinationArg);
+  }
+
+  constructor(optionsArg: ISmartlogContructorOptions) {
+    this.logContext = optionsArg.logContext;
+    this.minimumLogLevel = optionsArg.minimumLogLevel;
+  }
+
+
   // ============
   // Logger Setup
   // ============
@@ -19,39 +39,42 @@ export class Smartlog {
     this.consoleEnabled = true;
   }
 
-  /**
-   * set a minimum serverity level to log
-   * @param levelArg
-   */
-  level(levelArg: TLogLevel) {}
-
   // =============
   // log functions
   // =============
   /**
-   * log stuff
+   * main log method
-   * @param logLevelArg
+   * @param logLevelArg - the log level
-   * @param logMessageArg
+   * @param logMessageArg - the log message
+   * @param logDataArg - any additional log data
    */
-  log(logLevelArg: TLogLevel, logMessageArg: string) {}
+  public log(logLevelArg: TLogLevel, logMessageArg: string, logDataArg?: any) {
-
+    if (this.consoleEnabled) {
-  silly(logMessageArg: string) {
+      console.log(`LOG: ${logLevelArg}: ${logMessageArg}`);
-    this.log('silly', logMessageArg);
+    }
+    const logPackage: ILogPackage = {
+      timestamp: Date.now(),
+      type: 'log',
+      context: this.logContext,
+      level: logLevelArg,
+      message: logMessageArg
+    };
+    if(logDataArg) {
+      logPackage.data = logDataArg;
+    }
+    this.logRouter.routeLog(logPackage);
   }
 
-  debug(logMessageArg) {
+  public increment(logLevelArg: TLogLevel, logMessageArg) {
-    this.log('debug', logMessageArg);
+    if (this.consoleEnabled) {
+      console.log(`INCREMENT: ${logLevelArg}: ${logMessageArg}`);
     }
-
+    this.logRouter.routeLog({
-  info(logMessageArg: string) {
+      timestamp: Date.now(),
-    this.log('info', logMessageArg);
+      type: 'increment',
-  }
+      context: this.logContext,
-
+      level: logLevelArg,
-  warn(logMessageArg) {
+      message: logMessageArg
-    this.log('warn', logMessageArg);
+    });
-  }
-
-  error(logMessageArg) {
-    this.log('error', logMessageArg);
   }
 }

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"
 }