@emartech/json-logger 7.0.3 → 7.2.0

package/.github/workflows/_init.yml

@@ -0,0 +1,55 @@
+name: Initialize build
+
+on:
+  workflow_call:
+
+    outputs:
+      NODE_VERSION:
+        value: ${{ jobs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY:
+        value: ${{ jobs.init.outputs.NODE_CACHE_KEY }}
+
+jobs:
+  init:
+    name: Initialize build
+    runs-on: ubuntu-latest
+
+    outputs:
+      NODE_VERSION: ${{ steps.node-version.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ steps.node-cache-key.outputs.NODE_CACHE_KEY }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get node version
+        id: node-version
+        run: echo ::set-output name=NODE_VERSION::$(cat .nvmrc)
+
+      - name: Get node cache key
+        id: node-cache-key
+        run: echo ::set-output name=NODE_CACHE_KEY::npm-${{ steps.node-version.outputs.NODE_VERSION }}-${{ hashFiles('**/package.json') }}
+
+      - name: Cache dependencies
+        id: cache-node-modules
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ steps.node-cache-key.outputs.NODE_CACHE_KEY }}
+
+      - name: Setup node
+        if: steps.cache-node-modules.outputs.cache-hit != 'true'
+        uses: actions/setup-node@v3
+        with:
+          node-version: '${{ steps.node-version.outputs.NODE_VERSION }}'
+
+      - name: Install dependencies
+        if: steps.cache-node-modules.outputs.cache-hit != 'true'
+        run: npm install
+
+      - name: Log results
+        run: |
+          echo "NODE_VERSION:      ${{ steps.node-version.outputs.NODE_VERSION }}"
+          echo "NODE_CACHE_KEY:    ${{ steps.node-cache-key.outputs.NODE_CACHE_KEY }}"

package/.github/workflows/_release.yml

@@ -0,0 +1,46 @@
+name: Release package
+
+on:
+  workflow_call:
+    inputs:
+      NODE_VERSION:
+        type: string
+        required: true
+      NODE_CACHE_KEY:
+        type: string
+        required: true
+
+    secrets:
+      SEMANTIC_RELEASE_NPM_TOKEN:
+        required: true
+      SEMANTIC_RELEASE_GH_TOKEN:
+        required: true
+
+jobs:
+  test:
+    name: Release package
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Load dependencies from cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ inputs.NODE_CACHE_KEY }}
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '${{ inputs.NODE_VERSION }}'
+
+      - name: Run build
+        run: npm run build
+
+      - name: Run release
+        run: npm run release
+        env:
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+          GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}

package/.github/workflows/_test.yml

@@ -0,0 +1,39 @@
+name: Run tests
+
+on:
+  workflow_call:
+    inputs:
+      NODE_VERSION:
+        type: string
+        required: true
+      NODE_CACHE_KEY:
+        type: string
+        required: true
+
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        test: [lint, test]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Load dependencies from cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ inputs.NODE_CACHE_KEY }}
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '${{ inputs.NODE_VERSION }}'
+
+      - name: Run ${{ matrix.test }} test
+        run: npm run ${{ matrix.test }}

package/.github/workflows/dev.yml

@@ -0,0 +1,20 @@
+name: Development
+
+on:
+  push:
+    branches: [ '*', '*/*', '**', '!master', '!main' ]
+  pull_request:
+    branches: [ master, main ]
+
+jobs:
+  init:
+    name: Init
+    uses: ./.github/workflows/_init.yml
+
+  test:
+    name: Test
+    uses: ./.github/workflows/_test.yml
+    needs: [ init ]
+    with:
+      NODE_VERSION: ${{ needs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ needs.init.outputs.NODE_CACHE_KEY }}

package/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    branches: [ master, main ]
+
+jobs:
+  init:
+    name: Init
+    uses: ./.github/workflows/_init.yml
+
+  test:
+    name: Test
+    uses: ./.github/workflows/_test.yml
+    needs: [ init ]
+    with:
+      NODE_VERSION: ${{ needs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ needs.init.outputs.NODE_CACHE_KEY }}
+
+  release:
+    name: Release
+    uses: ./.github/workflows/_release.yml
+    needs: [ init, test ]
+    with:
+      NODE_VERSION: ${{ needs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ needs.init.outputs.NODE_CACHE_KEY }}
+    secrets:
+      SEMANTIC_RELEASE_NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+      SEMANTIC_RELEASE_GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}

package/README.md

@@ -9,6 +9,8 @@ It has the same namespace based enabling/disabling mechanism as [debug].
 npm install @emartech/json-logger
 ```
 
+
+
 ### Usage
 
 #### Script

package/dist/enabled/enabled.d.ts

@@ -1 +1 @@
-export declare function isNamespaceEnabled(availableNamespace: string, namespace: string): boolean;
+export declare const isNamespaceEnabled: (availableNamespace: string, namespace: string) => boolean;

package/dist/enabled/enabled.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isNamespaceEnabled = void 0;
-function isNamespaceEnabled(availableNamespace, namespace) {
+const isNamespaceEnabled = (availableNamespace, namespace) => {
     const availableNamespaces = availableNamespace.split(/[\s,]+/);
     let enabled = false;
     const adds = [];
     const skips = [];
-    availableNamespaces.forEach(function (name) {
+    availableNamespaces.forEach((name) => {
         if (!name) {
             return;
         }
@@ -18,16 +18,16 @@ function isNamespaceEnabled(availableNamespace, namespace) {
             adds.push(new RegExp('^' + name + '$'));
         }
     });
-    adds.forEach(function (addRegexp) {
+    adds.forEach((addRegexp) => {
         if (addRegexp.test(namespace)) {
             enabled = true;
         }
     });
-    skips.forEach(function (addRegexp) {
+    skips.forEach((addRegexp) => {
         if (addRegexp.test(namespace)) {
             enabled = false;
         }
     });
     return enabled;
-}
+};
 exports.isNamespaceEnabled = isNamespaceEnabled;

package/dist/formatter/index.d.ts

@@ -1,6 +1,4 @@
-import { jsonFormatter } from './json';
-import { logentriesFormatter } from './logentries';
 export declare const formatter: {
-    json: typeof jsonFormatter;
-    logentries: typeof logentriesFormatter;
+    json: (log: unknown) => string;
+    logentries: (data: Record<string, unknown>) => string;
 };

package/dist/formatter/index.js

@@ -5,5 +5,5 @@ const json_1 = require("./json");
 const logentries_1 = require("./logentries");
 exports.formatter = {
     json: json_1.jsonFormatter,
-    logentries: logentries_1.logentriesFormatter
+    logentries: logentries_1.logentriesFormatter,
 };

package/dist/formatter/json.d.ts

@@ -1 +1 @@
-export declare function jsonFormatter(log: unknown): string;
+export declare const jsonFormatter: (log: unknown) => string;

package/dist/formatter/json.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jsonFormatter = void 0;
-function jsonFormatter(log) {
+const jsonFormatter = (log) => {
     return JSON.stringify(log);
-}
+};
 exports.jsonFormatter = jsonFormatter;

package/dist/formatter/logentries.d.ts

@@ -1 +1 @@
-export declare function logentriesFormatter(data: Record<string, unknown>): string;
+export declare const logentriesFormatter: (data: Record<string, unknown>) => string;

package/dist/formatter/logentries.js

@@ -15,10 +15,9 @@ const convertToTag = (value, key) => {
     }
     return key + '=' + value;
 };
-function logentriesFormatter(data) {
-    return Object
-        .keys(data)
-        .map(key => convertToTag(data[key], key))
+const logentriesFormatter = (data) => {
+    return Object.keys(data)
+        .map((key) => convertToTag(data[key], key))
         .join(' ');
-}
+};
 exports.logentriesFormatter = logentriesFormatter;

package/dist/index.d.ts

@@ -6,7 +6,7 @@ export declare namespace createLogger {
     var getNamespaces: () => string;
     var configure: (options: LoggerConfig) => void;
     var formatter: {
-        json: typeof import("./formatter/json").jsonFormatter;
-        logentries: typeof import("./formatter/logentries").logentriesFormatter;
+        json: (log: unknown) => string;
+        logentries: (data: Record<string, unknown>) => string;
     };
 }

package/dist/logger/logger.d.ts

@@ -20,8 +20,8 @@ export declare class Logger {
     _namespace: string;
     _enabled: boolean;
     constructor(namespace: string, enabled: boolean);
-    static configure(options: LoggerConfig): void;
-    static _validate(options: LoggerConfig): void;
+    static configure(options: Partial<LoggerConfig>): void;
+    static _validate(options: Partial<LoggerConfig>): void;
     static config: LoggerConfig;
     isEnabled(): boolean;
     trace(action: string, data?: unknown): void;

package/dist/logger/logger.js

@@ -18,7 +18,7 @@ class Logger {
         Object.assign(Logger.config, options);
     }
     static _validate(options) {
-        Object.keys(options).forEach(key => {
+        Object.keys(options).forEach((key) => {
             if (!allowedKeys.includes(key)) {
                 throw new Error('Only the following keys are allowed: formatter, output');
             }
@@ -53,7 +53,7 @@ class Logger {
             name: this._namespace,
             action: action,
             level: config_1.config.levels[level].number,
-            time: new Date().toISOString()
+            time: new Date().toISOString(),
         }, data);
         Logger.config.transformers.forEach((transform) => {
             dataToLog = transform(dataToLog);
@@ -76,18 +76,14 @@ class Logger {
         if (!stack) {
             return;
         }
-        return stack.length > STACK_TRACE_LIMIT ?
-            stack.substring(0, STACK_TRACE_LIMIT) + ' ...' :
-            stack;
+        return stack.length > STACK_TRACE_LIMIT ? stack.substring(0, STACK_TRACE_LIMIT) + ' ...' : stack;
     }
     _shortenData(data) {
         if (typeof data === 'undefined') {
             return;
         }
         const stringifiedData = typeof data === 'object' ? JSON.stringify(data) : data;
-        return stringifiedData.length > DATA_LIMIT ?
-            stringifiedData.substring(0, DATA_LIMIT) + ' ...' :
-            stringifiedData;
+        return stringifiedData.length > DATA_LIMIT ? stringifiedData.substring(0, DATA_LIMIT) + ' ...' : stringifiedData;
     }
     _getErrorDetails(error) {
         if (!(error instanceof Object)) {
@@ -97,7 +93,7 @@ class Logger {
             error_name: error.name,
             error_stack: this._shortenStackTrace(error.stack || ''),
             error_message: error.message,
-            error_data: this._shortenData(error.data)
+            error_data: this._shortenData(error.data),
         };
         return Object.assign(baseDetails, this._getAxiosErrorDetails(error));
     }
@@ -110,7 +106,7 @@ class Logger {
             request_url: error.config.url,
             response_status: error.response ? error.response.status : undefined,
             response_status_text: error.response ? error.response.statusText : undefined,
-            response_data: error.response ? this._shortenData(error.response.data) : undefined
+            response_data: error.response ? this._shortenData(error.response.data) : undefined,
         };
     }
 }
@@ -118,5 +114,5 @@ exports.Logger = Logger;
 Logger.config = {
     formatter: json_1.jsonFormatter,
     output: console_1.consoleOutput,
-    transformers: []
+    transformers: [],
 };

package/dist/output/console.d.ts

@@ -1 +1 @@
-export declare function consoleOutput(formattedLog: unknown): void;
+export declare const consoleOutput: (formattedLog: unknown) => void;

package/dist/output/console.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.consoleOutput = void 0;
-function consoleOutput(formattedLog) {
+const consoleOutput = (formattedLog) => {
     console.log(formattedLog);
-}
+};
 exports.consoleOutput = consoleOutput;

package/main.yml

@@ -0,0 +1,30 @@
+name: Test and Release
+
+on:
+  push:
+    branches: [ master, main ]
+
+env:
+  NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
+  GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}
+
+jobs:
+  init:
+    name: Init
+    uses: ./.github/workflows/_init.yml
+
+  test:
+    name: Test
+    uses: ./.github/workflows/_test.yml
+    needs: [ init ]
+    with:
+      NODE_VERSION: ${{ needs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ needs.init.outputs.NODE_CACHE_KEY }}
+
+  deploy:
+    name: Test
+    uses: ./.github/workflows/_deploy.yml
+    needs: [ init, test ]
+    with:
+      NODE_VERSION: ${{ needs.init.outputs.NODE_VERSION }}
+      NODE_CACHE_KEY: ${{ needs.init.outputs.NODE_CACHE_KEY }}

package/package.json

@@ -3,15 +3,14 @@
   "description": "Tiny and fast json logger with namespace support",
   "main": "dist/index.js",
   "scripts": {
-    "test": "mocha --require ts-node/register ./src --recursive",
-    "test:watch": "mocha --require ts-node/register ./src --recursive --watch",
-    "lint": "eslint ./src/**/*.{ts,js}",
+    "test": "mocha --require ts-node/register --extension ts ./src --recursive",
+    "test:watch": "mocha --require ts-node/register --extension ts ./src --recursive --watch",
+    "lint": "eslint ./src/**/*.ts",
+    "lint:fix": "eslint ./src/**/*.ts --fix",
     "build": "rm -rf dist && tsc --project ./tsconfig.json",
-    "semantic-release": "CI=true semantic-release",
+    "release": "CI=true semantic-release",
     "example-js": "DEBUG=* node examples/index-js.js",
-    "example-ts": "DEBUG=* ts-node examples/index-ts.ts",
-    "koa-example": "DEBUG=* node examples/koa.js",
-    "express-example": "DEBUG=* node examples/express.js"
+    "example-ts": "DEBUG=* ts-node examples/index-ts.ts"
   },
   "publishConfig": {
     "access": "public"
@@ -27,21 +26,31 @@
     "debug",
     "json"
   ],
-  "dependencies": {},
   "devDependencies": {
-    "@types/node": "18.7.14",
-    "@typescript-eslint/parser": "5.36.1",
+    "@types/chai": "4.3.3",
+    "@types/mocha": "10.0.0",
+    "@types/node": "18.7.23",
+    "@types/sinon": "10.0.13",
+    "@types/sinon-chai": "3.2.8",
+    "@typescript-eslint/eslint-plugin": "5.38.1",
+    "@typescript-eslint/parser": "5.38.1",
+    "axios": "0.27.2",
     "chai": "4.3.6",
-    "eslint": "8.23.0",
+    "eslint": "8.24.0",
     "eslint-config-emarsys": "5.1.0",
+    "eslint-config-prettier": "8.5.0",
     "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-security": "1.5.0",
+    "install": "0.13.0",
     "mocha": "10.0.0",
+    "npm": "8.19.2",
+    "prettier": "2.7.1",
     "semantic-release": "19.0.5",
     "sinon": "14.0.0",
     "sinon-chai": "3.7.0",
     "ts-node": "10.9.1",
-    "typescript": "4.8.2"
+    "typescript": "4.8.4"
   },
   "repository": {
     "type": "git",
@@ -51,5 +60,5 @@
     "url": "https://github.com/emartech/json-logger-js/issues"
   },
   "homepage": "https://github.com/emartech/json-logger-js#readme",
-  "version": "7.0.3"
+  "version": "7.2.0"
 }

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
-  "exclude": ["dist", "node_modules", "src/**/*.js"],
-  "include": ["src/**/*.ts", "src/**/*.js"],
+  "exclude": ["dist", "node_modules"],
+  "include": ["src/**/*.ts"],
   "compilerOptions": {
     /* Visit https://aka.ms/tsconfig to read more about this file */
 
@@ -41,7 +41,7 @@
     // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
 
     /* JavaScript Support */
-    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "allowJs": false,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
     // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 

package/.eslintrc

@@ -1,25 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "mocha": true,
-    "es6": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaFeatures": {
-      "impliedStrict": true
-    }
-  },
-  "globals": {
-    "expect": true
-  },
-  "rules": {
-    "security/detect-object-injection": 0,
-    "security/detect-non-literal-regexp": 0,
-    "no-unused-expressions": 0,
-    "func-style": 0
-  },
-  "extends": [
-    "emarsys"
-  ]
-}

package/.github/workflows/main.yml

@@ -1,33 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ master, main ]
-
-env:
-  NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
-  GH_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Node version
-        id: engines
-        run: echo "##[set-output name=NODE_VERSION;]$(cat .nvmrc)"
-      - name: Use Node.js ${{ steps.engines.outputs.NODE_VERSION }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ steps.engines.outputs.NODE_VERSION }}
-      - name: Install
-        run: npm install
-      - name: Lint
-        run: npm run lint
-      - name: Test
-        run: npm run test
-      - name: Build
-        run: npm run build
-      - name: Release
-        run: npm run semantic-release