@trojs/logger 0.5.2 → 0.5.4

package/package.json

@@ -1,17 +1,19 @@
 {
     "name": "@trojs/logger",
     "description": "Winston logger for TroJS",
-    "version": "0.5.2",
+    "version": "0.5.4",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
     },
     "license": "MIT",
     "scripts": {
-        "lint": "eslint src/*.js --config .eslintrc",
-        "lint:report": "eslint src/*.js --config .eslintrc -f json -o report.json",
-        "lint:fix": "eslint src/ --config .eslintrc --fix",
-        "test": "c8 node --test",
+        "lint": "eslint",
+        "lint:report": "eslint src/*.js -f json -o report.json",
+        "lint:fix": "eslint --fix",
+        "lint:rules": "eslint --print-config file.js > eslintconfig.json",
+        "test": "node --test --experimental-test-coverage --test-reporter=spec --test-reporter=lcov --test-reporter-destination=stdout --test-reporter-destination=./coverage/lcov.info",
+        "test:watch": "node --watch --test --experimental-test-coverage --test-reporter=spec --test-reporter=lcov --test-reporter-destination=stdout --test-reporter-destination=./coverage/lcov.info",
         "cpd": "node_modules/jscpd/bin/jscpd src",
         "vulnerabilities": "npm audit --omit=dev"
     },
@@ -31,20 +33,10 @@
     ],
     "main": "src/logger.js",
     "devDependencies": {
-        "@hckrnews/eslint-config": "^3.0.0",
         "@trojs/error": "^4.0.0",
-        "c8": "^10.0.0",
-        "eslint": "^8.23.0",
-        "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-html": "^8.1.1",
-        "eslint-plugin-import": "^2.29.1",
-        "eslint-plugin-jsdoc": "^50.0.0",
-        "eslint-plugin-jsx-a11y": "^6.9.0",
-        "eslint-plugin-n": "^17.9.0",
-        "eslint-plugin-prettier": "^5.2.1",
-        "eslint-plugin-promise": "^7.0.0",
-        "eslint-plugin-sonarjs": "^0.25.1",
+        "@trojs/lint": "^0.2.13",
+        "eslint": "^9.24.0",
+        "globals": "^16.0.0",
         "jscpd": "^4.0.0",
         "prettier": "^3.3.3"
     },
@@ -53,7 +45,7 @@
         "url": "https://github.com/trojs/logger"
     },
     "engines": {
-        "node": ">= 18.13"
+        "node": ">= 20"
     },
     "keywords": [
         "javascript",

package/src/helpers/stackdriver.js

@@ -1,32 +1,32 @@
-import os from 'node:os';
+import os from 'node:os'
 
 const levelToSeverity = {
-    trace: 'DEBUG',
-    debug: 'DEBUG',
-    info: 'INFO',
-    warn: 'WARNING',
-    error: 'ERROR',
-    fatal: 'CRITICAL',
-};
+  trace: 'DEBUG',
+  debug: 'DEBUG',
+  info: 'INFO',
+  warn: 'WARNING',
+  error: 'ERROR',
+  fatal: 'CRITICAL'
+}
 
 const levels = {
-    trace: 10,
-    debug: 20,
-    info: 30,
-    warn: 40,
-    error: 50,
-    fatal: 60,
-};
+  trace: 10,
+  debug: 20,
+  info: 30,
+  warn: 40,
+  error: 50,
+  fatal: 60
+}
 
-const stackdriver =
-    ({ level, defaultLevel }) =>
-    (info) => ({
+const stackdriver
+    = ({ level, defaultLevel }) =>
+      (info) => ({
         ...info,
         severity: levelToSeverity[level] || levelToSeverity[defaultLevel],
         level: levels[level] || levels[defaultLevel],
         time: Date.now(),
         pid: process.pid,
-        hostname: os.hostname(),
-    });
+        hostname: os.hostname()
+      })
 
-export default stackdriver;
+export default stackdriver

package/src/logger.js

@@ -1,5 +1,5 @@
-import winston from 'winston';
-import makeLoggers from './loggers/index.js';
+import winston from 'winston'
+import makeLoggers from './loggers/index.js'
 
 /**
  * @typedef {import('./models/schemas/logger.js').Logger} LoggerType
@@ -8,19 +8,19 @@ import makeLoggers from './loggers/index.js';
 
 /** @type {LoggerType[]} */
 const defaultLoggers = [
-    {
-        type: 'console',
-    },
-];
+  {
+    type: 'console'
+  }
+]
 
 const levels = {
-    fatal: 0,
-    error: 1,
-    warn: 2,
-    info: 3,
-    debug: 4,
-    trace: 5,
-};
+  fatal: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+  debug: 4,
+  trace: 5
+}
 
 /**
  * Create the logger
@@ -31,12 +31,12 @@ const levels = {
  * @returns {winston.Logger}
  */
 export default ({ loggers = defaultLoggers, level = 'info', meta = {} }) => {
-    const winstonLoggers = makeLoggers({ winston, loggers });
+  const winstonLoggers = makeLoggers({ winston, loggers })
 
-    return winston.createLogger({
-        level,
-        levels,
-        defaultMeta: meta,
-        transports: winstonLoggers,
-    });
-};
+  return winston.createLogger({
+    level,
+    levels,
+    defaultMeta: meta,
+    transports: winstonLoggers
+  })
+}

package/src/loggers/combined-file.js

@@ -1,4 +1,4 @@
 export default ({ winston, logger }) =>
-    new winston.transports.File({
-        filename: logger?.location || 'combined.log',
-    });
+  new winston.transports.File({
+    filename: logger?.location || 'combined.log'
+  })

package/src/loggers/console.js

@@ -1,22 +1,25 @@
-import stackDriver from '../helpers/stackdriver.js';
+import stackDriver from '../helpers/stackdriver.js'
 
 export default ({ winston, logger }) => {
-    const defaultLevel = 'trace';
+  const defaultLevel = 'trace'
 
-    return new winston.transports.Console({
-        level: logger?.level || defaultLevel,
-        format:
+  const jsonFormatter = winston.format.combine(
+    winston.format.errors({ stack: logger?.debug ?? false }),
+    winston.format(
+      stackDriver({ level: logger?.level, defaultLevel })
+    )(),
+    winston.format.json()
+  )
+
+  const defaultFormatter = winston.format.combine(
+    winston.format.errors({ stack: logger?.debug ?? false }),
+    winston.format.simple()
+  )
+  return new winston.transports.Console({
+    level: logger?.level || defaultLevel,
+    format:
             logger.format === 'json'
-                ? winston.format.combine(
-                      winston.format.errors({ stack: logger?.debug ?? false }),
-                      winston.format(
-                          stackDriver({ level: logger?.level, defaultLevel })
-                      )(),
-                      winston.format.json()
-                  )
-                : winston.format.combine(
-                      winston.format.errors({ stack: logger?.debug ?? false }),
-                      winston.format.simple()
-                  ),
-    });
-};
+              ? jsonFormatter
+              : defaultFormatter
+  })
+}

package/src/loggers/error-file.js

@@ -1,5 +1,5 @@
 export default ({ winston, logger }) =>
-    new winston.transports.File({
-        filename: logger?.location || 'error.log',
-        level: logger?.level || 'error',
-    });
+  new winston.transports.File({
+    filename: logger?.location || 'error.log',
+    level: logger?.level || 'error'
+  })

package/src/loggers/index.js

@@ -1,16 +1,16 @@
-import makeErrorFileLogger from './error-file.js';
-import makeCombinedFileLogger from './combined-file.js';
-import makeSentryLogger from './sentry.js';
-import makeConsoleLogger from './console.js';
+import makeErrorFileLogger from './error-file.js'
+import makeCombinedFileLogger from './combined-file.js'
+import makeSentryLogger from './sentry.js'
+import makeConsoleLogger from './console.js'
 
-import Logger from '../models/logger.js';
+import Logger from '../models/logger.js'
 
 const winstonLoggers = {
-    sentry: makeSentryLogger,
-    errorFile: makeErrorFileLogger,
-    combinedFile: makeCombinedFileLogger,
-    console: makeConsoleLogger,
-};
+  sentry: makeSentryLogger,
+  errorFile: makeErrorFileLogger,
+  combinedFile: makeCombinedFileLogger,
+  console: makeConsoleLogger
+}
 
 /**
  * @typedef {import('../models/schemas/logger.js').Logger} LoggerType
@@ -25,18 +25,18 @@ const winstonLoggers = {
  * @returns {TransportStream[]}
  */
 const makeLoggers = ({ winston, loggers }) =>
-    Logger.createAll(loggers).map((logger) => {
-        const loggerFn = winstonLoggers[logger.type];
-        if (!loggerFn) {
-            throw new Error(`Unknown logger type: ${logger.type}`);
-        }
+  Logger.createAll(loggers).map((logger) => {
+    const loggerFn = winstonLoggers[logger.type]
+    if (!loggerFn) {
+      throw new Error(`Unknown logger type: ${logger.type}`)
+    }
 
-        const opts = {
-            logger,
-            winston,
-        };
+    const opts = {
+      logger,
+      winston
+    }
 
-        return loggerFn(opts);
-    });
+    return loggerFn(opts)
+  })
 
-export default makeLoggers;
+export default makeLoggers

package/src/loggers/sentry.js

@@ -1,20 +1,20 @@
-import SentryPackage from 'winston-transport-sentry-node';
+import SentryPackage from 'winston-transport-sentry-node'
 
-const Sentry = SentryPackage?.default || SentryPackage;
+const Sentry = SentryPackage?.default || SentryPackage
 
 export default ({ logger }) => {
-    const options = {
-        sentry: {
-            dsn: logger?.location,
-            environment: logger?.environment || 'production',
-            serverName: logger?.serverName || 'localhost',
-            release: logger?.release || 'unknown',
-            debug: logger?.debug || false,
-            sampleRate: logger?.sampleRate || 1,
-            tracesSampleRate: logger?.tracesSampleRate || 1,
-        },
-        level: logger?.level || 'info',
-    };
+  const options = {
+    sentry: {
+      dsn: logger?.location,
+      environment: logger?.environment || 'production',
+      serverName: logger?.serverName || 'localhost',
+      release: logger?.release || 'unknown',
+      debug: logger?.debug || false,
+      sampleRate: logger?.sampleRate || 1,
+      tracesSampleRate: logger?.tracesSampleRate || 1
+    },
+    level: logger?.level || 'info'
+  }
 
-    return new Sentry(options);
-};
+  return new Sentry(options)
+}

package/src/models/enums/level.js

@@ -1,4 +1,5 @@
-import { Enum } from '@trojs/enum';
+/* eslint-disable sonarjs/public-static-readonly */
+import { Enum } from '@trojs/enum'
 
 /**
  * @typedef LevelType
@@ -17,15 +18,15 @@ import { Enum } from '@trojs/enum';
  * @enum { LevelType }
  */
 export default class Level extends Enum {
-    static info = 'info';
+  static info = 'info'
 
-    static fatal = 'fatal';
+  static fatal = 'fatal'
 
-    static error = 'error';
+  static error = 'error'
 
-    static warn = 'warn';
+  static warn = 'warn'
 
-    static debug = 'debug';
+  static debug = 'debug'
 
-    static trace = 'trace';
+  static trace = 'trace'
 }

package/src/models/logger.js

@@ -1,34 +1,34 @@
-import { Obj } from '@trojs/objects';
-import loggerSchema from './schemas/logger.js';
-import LoggerMutator from './mutators/logger.js';
+import { Obj } from '@trojs/objects'
+import loggerSchema from './schemas/logger.js'
+import LoggerMutator from './mutators/logger.js'
 
 /**
  * @typedef {import('./schemas/logger.js').Logger} LoggerType
  */
 
-const LoggerObject = Obj({ schema: loggerSchema });
+const LoggerObject = Obj({ schema: loggerSchema })
 
 export default class Logger {
-    /**
-     * Create a logger object
-     * @param {LoggerType} data
-     * @returns {LoggerType}
-     */
-    static create(data) {
-        const logger = LoggerMutator.create(data);
-        return LoggerObject.create(logger);
-    }
-
-    /**
-     * Create logger objects
-     * @param {LoggerType[]} data
-     * @returns {LoggerType[]}
-     */
-    static createAll(data) {
-        if (!data || data.length === 0) {
-            return [];
-        }
+  /**
+   * Create a logger object
+   * @param {LoggerType} data
+   * @returns {LoggerType}
+   */
+  static create (data) {
+    const logger = LoggerMutator.create(data)
+    return LoggerObject.create(logger)
+  }
 
-        return data.map((loggerData) => Logger.create(loggerData));
+  /**
+   * Create logger objects
+   * @param {LoggerType[]} data
+   * @returns {LoggerType[]}
+   */
+  static createAll (data) {
+    if (!data || data.length === 0) {
+      return []
     }
+
+    return data.map((loggerData) => Logger.create(loggerData))
+  }
 }

package/src/models/mutators/logger.js

@@ -1,14 +1,14 @@
-import DefaultMutator from '@trojs/mutator';
-import LevelEnum from '../enums/level.js';
+import DefaultMutator from '@trojs/mutator'
+import LevelEnum from '../enums/level.js'
 
 /**
  * Logger mutator
  * @augments DefaultMutator
  */
 class Logger extends DefaultMutator {
-    setLevelAttribute(level) {
-        return LevelEnum.fromKey(level);
-    }
+  setLevelAttribute (level) {
+    return LevelEnum.fromKey(level)
+  }
 }
 
-export default Logger;
+export default Logger

package/src/models/schemas/logger.js

@@ -1,4 +1,4 @@
-import Level from '../enums/level.js';
+import Level from '../enums/level.js'
 
 /**
  * @typedef {import('../enums/level.js').LevelType} LevelType
@@ -22,16 +22,16 @@ import Level from '../enums/level.js';
  */
 
 export default {
-    type: String,
-    'location?': String,
-    'level?': Level,
-    'key?': String,
-    'credentials?': Object,
-    'environment?': String,
-    'serverName?': String,
-    'release?': String,
-    'debug?': Boolean,
-    'sampleRate?': Number,
-    'tracesSampleRate?': Number,
-    'format?': String,
-};
+  type: String,
+  'location?': String,
+  'level?': Level,
+  'key?': String,
+  'credentials?': Object,
+  'environment?': String,
+  'serverName?': String,
+  'release?': String,
+  'debug?': Boolean,
+  'sampleRate?': Number,
+  'tracesSampleRate?': Number,
+  'format?': String
+}