@unchainedshop/logger 1.1.3 → 1.2.0

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@unchainedshop/logger",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "main": "lib/logger-index.js",
+  "exports": {
+    ".": "./lib/logger-index.js",
+    "./*": "./lib/*"
+  },
   "types": "lib/logger-index.d.ts",
   "type": "module",
   "scripts": {
+    "prepublishOnly": "npm install && npm run build || :",
     "clean": "rm -rf lib",
-    "build": "npm run clean && tsc -p tsconfig.build.json",
-    "watch": "tsc --watch",
-    "link:core": "npm link @unchainedshop/types",
+    "build": "npm run clean && tsc",
+    "watch": "tsc -w",
     "test": "jest --watch"
   },
   "repository": {
@@ -28,24 +32,16 @@
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
     "safe-stable-stringify": "^2.3.1",
-    "winston": "^3.7.2",
+    "winston": "^3.8.0",
     "winston-transport": "^4.5.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.5",
-    "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
-    "@types/chai": "^4.3.1",
-    "@types/jest": "^28.1.1",
-    "@types/mocha": "^9.1.1",
+    "@types/jest": "^28.1.3",
+    "@types/node": "^16.11.44",
     "@types/winston": "^2.4.4",
-    "@unchainedshop/types": "latest",
-    "babel-jest": "^28.1.1",
-    "chai": "^4.3.6",
-    "cross-env": "^7.0.3",
+    "@unchainedshop/types": "^1.1.9",
     "jest": "^28.1.1",
     "ts-jest": "^28.0.5",
-    "ts-node": "^10.8.1",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   }
 }

package/src/createLogger.ts

@@ -0,0 +1,60 @@
+import { createLogger as createWinstonLogger, format, transports } from 'winston';
+import stringify from 'safe-stable-stringify';
+import TransportStream from 'winston-transport';
+import { LogLevel } from './logger.types';
+
+const { DEBUG = '', LOG_LEVEL = LogLevel.Info, UNCHAINED_LOG_FORMAT = 'unchained' } = process.env;
+
+const { combine, label, timestamp, colorize, printf, json } = format;
+
+const debugStringContainsModule = (debugString: string, moduleName: string) => {
+  if (!debugString) return false;
+  const loggingMatched = debugString.split(',').reduce((accumulator: any, name: string) => {
+    if (accumulator === false) return accumulator;
+    const nameRegex = name.replace(/-/i, '\\-?').replace(/:\*/i, '\\:?*').replace(/\*/i, '.*');
+    const regExp = new RegExp(`^${nameRegex}$`, 'm');
+    if (regExp.test(moduleName)) {
+      if (name.slice(0, 1) === '-') {
+        // explicitly disable
+        return false;
+      }
+      return true;
+    }
+    return accumulator;
+  }, undefined);
+  return loggingMatched || false;
+};
+
+const myFormat = printf(({ level, message, label: _label, timestamp: _timestamp, ...rest }) => { //eslint-disable-line
+  const otherPropsString = stringify(rest);
+  return `[${_label}] ${level}: ${message} ${otherPropsString}`;
+});
+
+const UnchainedLogFormats = {
+  unchained: (moduleName: string) =>
+    combine(timestamp(), label({ label: moduleName }), colorize(), myFormat),
+  json,
+};
+
+if (!UnchainedLogFormats[UNCHAINED_LOG_FORMAT.toLowerCase()]) {
+  throw new Error(
+    `UNCHAINED_LOG_FORMAT is invalid, use one of ${Object.keys(UnchainedLogFormats).join(',')}`,
+  );
+}
+
+export { transports, format };
+
+export const createLogger = (moduleName: string, moreTransports: Array<TransportStream> = []) => {
+  const loggingMatched = debugStringContainsModule(DEBUG, moduleName);
+  return createWinstonLogger({
+    transports: [
+      new transports.Console({
+        format: UnchainedLogFormats[UNCHAINED_LOG_FORMAT](moduleName),
+        stderrLevels: [LogLevel.Error],
+        consoleWarnLevels: [LogLevel.Warning],
+        level: loggingMatched ? LogLevel.Debug : LOG_LEVEL,
+      }),
+      ...moreTransports,
+    ],
+  });
+};

package/src/log.ts

@@ -0,0 +1,10 @@
+import winston from 'winston';
+import { LogLevel, LogOptions } from './logger.types';
+import { createLogger } from './createLogger';
+
+const logger = createLogger('unchained');
+
+export const log = (message: string, options?: LogOptions): winston.Logger => {
+  const { level = LogLevel.Info, ...meta } = options || {};
+  return logger.log(level, message, meta);
+};

package/src/logger-index.ts

@@ -0,0 +1,5 @@
+import { createLogger, format, transports } from './createLogger';
+import { LogLevel } from './logger.types';
+import { log } from './log';
+
+export { log, createLogger, format, transports, LogLevel };

package/src/logger.types.ts

@@ -0,0 +1,14 @@
+import { LoggerOptions } from 'winston';
+
+export enum LogLevel {
+  Verbose = 'verbose',
+  Info = 'info',
+  Debug = 'debug',
+  Error = 'error',
+  Warning = 'warn',
+}
+
+export interface LogOptions extends LoggerOptions {
+  level: LogLevel;
+  [x: string]: any;
+}

package/tests/logger-index.test.ts

@@ -0,0 +1,23 @@
+import { assert } from 'chai';
+
+import {
+  log,
+  createLogger,
+  transports,
+  format,
+  LogLevel,
+} from '../src/logger-index';
+
+describe('Test exports', () => {
+  it('log', () => {
+    assert.isFunction(log);
+    log('Test', { level: LogLevel.Warning });
+  });
+  it('createLogger', () => {
+    assert.isFunction(createLogger);
+    assert.isFunction(format);
+    assert.isObject(transports);
+    const logger = createLogger('unchained:test');
+    logger.info('Test Logger', 'With additional info');
+  });
+});

package/{tsconfig.build.json → tsconfig.json}

@@ -6,7 +6,9 @@
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["esnext"],
+    "lib": [
+      "esnext"
+    ],
     "module": "esnext",
     "moduleResolution": "node",
     "noImplicitReturns": true,
@@ -16,8 +18,12 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "target": "esnext",
-    "types": ["node"]
+    "types": [
+      "node",
+      "jest"
+    ]
   },
-  "include": ["src"]
-}
-
+  "include": [
+    "src"
+  ]
+}

package/babel.config.js

@@ -1,3 +0,0 @@
-export default {
-  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
-};

package/package.js

@@ -1,21 +0,0 @@
-Package.describe({
-  name: 'unchained:logger',
-  version: '1.1.3',
-  summary: 'Unchained Engine: Logger',
-  git: 'https://github.com/unchainedshop/unchained',
-  documentation: 'README.md',
-});
-
-Npm.depends({
-  'safe-stable-stringify': '2.3.1',
-  winston: '3.7.2',
-  'winston-transport': '4.5.0',
-});
-
-Package.onUse((api) => {
-  api.versionsFrom('2.7.3');
-  api.use('ecmascript');
-  api.use('typescript');
-
-  api.mainModule('src/logger-index.ts', 'server');
-});