@trojs/logger 0.6.1 → 1.0.0

package/package.json

@@ -1,16 +1,16 @@
 {
     "name": "@trojs/logger",
     "description": "Winston logger for TroJS",
-    "version": "0.6.1",
+    "version": "1.0.0",
     "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",
+        "lint": "eslint",
+        "lint:report": "eslint src/*.js -f json -o report.json",
+        "lint:fix": "eslint --fix",
         "test": "c8 node --test",
         "cpd": "node_modules/jscpd/bin/jscpd src",
         "vulnerabilities": "npm audit --omit=dev"
@@ -31,20 +31,20 @@
     ],
     "main": "src/logger.js",
     "devDependencies": {
-        "@hckrnews/eslint-config": "^3.0.0",
-        "@trojs/error": "^3.0.0",
+        "@eslint/js": "^9.15.0",
+        "@stylistic/eslint-plugin": "^2.11.0",
+        "@stylistic/eslint-plugin-js": "^2.11.0",
+        "@trojs/error": "^4.0.0",
         "c8": "^10.0.0",
-        "eslint": "^8.23.0",
-        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint": "^9.15.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-import": "^2.31.0",
+        "eslint-plugin-jsdoc": "^50.5.0",
+        "eslint-plugin-n": "^17.14.0",
         "eslint-plugin-prettier": "^5.2.1",
-        "eslint-plugin-promise": "^7.0.0",
-        "eslint-plugin-sonarjs": "^0.25.1",
+        "eslint-plugin-promise": "^7.1.0",
+        "eslint-plugin-sonarjs": "^2.0.4",
+        "globals": "^15.12.0",
         "jscpd": "^4.0.0",
         "prettier": "^3.3.3"
     },
@@ -53,7 +53,7 @@
         "url": "https://github.com/trojs/logger"
     },
     "engines": {
-        "node": ">= 18.13"
+        "node": ">= 20"
     },
     "keywords": [
         "javascript",
@@ -63,9 +63,9 @@
     ],
     "dependencies": {
         "@sentry/node": "^8.0.0",
-        "@trojs/enum": "^3.0.0",
-        "@trojs/mutator": "^0.4.0",
-        "@trojs/objects": "^8.0.0",
+        "@trojs/enum": "^4.0.0",
+        "@trojs/mutator": "^1.0.0",
+        "@trojs/objects": "^9.0.1",
         "compression": "^1.7.4",
         "cors": "^2.8.5",
         "dotenv": "^16.0.3",
@@ -76,5 +76,14 @@
     "funding": {
         "type": "github",
         "url": "https://github.com/sponsors/w3nl"
+    },
+    "overrides": {
+        "eslint-plugin-sonarjs": {
+            "eslint": "^9.15.0",
+            "@typescript-eslint/eslint-plugin": "^8.0.0",
+            "@typescript-eslint/utils": "^8.0.0",
+            "eslint-plugin-import": "^2.31.0",
+            "eslint-plugin-react-hooks": "^5.0.0"
+        }
     }
 }

package/src/helpers/stackdriver.js

@@ -1,4 +1,4 @@
-import os from 'node:os';
+import os from 'node:os'
 
 const levelToSeverity = {
     trace: 'DEBUG',
@@ -6,8 +6,8 @@ const levelToSeverity = {
     info: 'INFO',
     warn: 'WARNING',
     error: 'ERROR',
-    fatal: 'CRITICAL',
-};
+    fatal: 'CRITICAL'
+}
 
 const levels = {
     trace: 10,
@@ -15,18 +15,18 @@ const levels = {
     info: 30,
     warn: 40,
     error: 50,
-    fatal: 60,
-};
+    fatal: 60
+}
 
 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(),
-    });
+        (info) => ({
+            ...info,
+            severity: levelToSeverity[level] || levelToSeverity[defaultLevel],
+            level: levels[level] || levels[defaultLevel],
+            time: Date.now(),
+            pid: process.pid,
+            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
@@ -9,9 +9,9 @@ import makeLoggers from './loggers/index.js';
 /** @type {LoggerType[]} */
 const defaultLoggers = [
     {
-        type: 'console',
-    },
-];
+        type: 'console'
+    }
+]
 
 const levels = {
     fatal: 0,
@@ -19,8 +19,8 @@ const levels = {
     warn: 2,
     info: 3,
     debug: 4,
-    trace: 5,
-};
+    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,
-    });
-};
+        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',
-    });
+        filename: logger?.location || 'combined.log'
+    })

package/src/loggers/console.js

@@ -1,22 +1,22 @@
-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:
             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.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()
-                  ),
-    });
-};
+                    winston.format.errors({ stack: logger?.debug ?? false }),
+                    winston.format.simple()
+                )
+    })
+}

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',
-    });
+        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,
-};
+    console: makeConsoleLogger
+}
 
 /**
  * @typedef {import('../models/schemas/logger.js').Logger} LoggerType
@@ -26,17 +26,17 @@ const winstonLoggers = {
  */
 const makeLoggers = ({ winston, loggers }) =>
     Logger.createAll(loggers).map((logger) => {
-        const loggerFn = winstonLoggers[logger.type];
+        const loggerFn = winstonLoggers[logger.type]
         if (!loggerFn) {
-            throw new Error(`Unknown logger type: ${logger.type}`);
+            throw new Error(`Unknown logger type: ${logger.type}`)
         }
 
         const opts = {
             logger,
-            winston,
-        };
+            winston
+        }
 
-        return loggerFn(opts);
-    });
+        return loggerFn(opts)
+    })
 
-export default makeLoggers;
+export default makeLoggers

package/src/loggers/sentry.js

@@ -1,6 +1,6 @@
-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 = {
@@ -11,10 +11,10 @@ export default ({ logger }) => {
             release: logger?.release || 'unknown',
             debug: logger?.debug || false,
             sampleRate: logger?.sampleRate || 1,
-            tracesSampleRate: logger?.tracesSampleRate || 1,
+            tracesSampleRate: logger?.tracesSampleRate || 1
         },
-        level: logger?.level || 'info',
-    };
+        level: logger?.level || 'info'
+    }
 
-    return new Sentry(options);
-};
+    return new Sentry(options)
+}

package/src/models/enums/level.js

@@ -1,4 +1,6 @@
-import { Enum } from '@trojs/enum';
+import { Enum } from '@trojs/enum'
+
+/* eslint-disable sonarjs/public-static-readonly */
 
 /**
  * @typedef LevelType
@@ -16,16 +18,18 @@ import { Enum } from '@trojs/enum';
  * @readonly
  * @enum { LevelType }
  */
-export default class Level extends Enum {
-    static info = 'info';
+class Level extends Enum {
+    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'
 }
+
+export default Level

package/src/models/logger.js

@@ -1,12 +1,12 @@
-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 {
     /**
@@ -15,8 +15,8 @@ export default class Logger {
      * @returns {LoggerType}
      */
     static create(data) {
-        const logger = LoggerMutator.create(data);
-        return LoggerObject.create(logger);
+        const logger = LoggerMutator.create(data)
+        return LoggerObject.create(logger)
     }
 
     /**
@@ -26,9 +26,9 @@ export default class Logger {
      */
     static createAll(data) {
         if (!data || data.length === 0) {
-            return [];
+            return []
         }
 
-        return data.map((loggerData) => Logger.create(loggerData));
+        return data.map((loggerData) => Logger.create(loggerData))
     }
 }

package/src/models/mutators/logger.js

@@ -1,5 +1,5 @@
-import DefaultMutator from '@trojs/mutator';
-import LevelEnum from '../enums/level.js';
+import DefaultMutator from '@trojs/mutator'
+import LevelEnum from '../enums/level.js'
 
 /**
  * Logger mutator
@@ -7,8 +7,8 @@ import LevelEnum from '../enums/level.js';
  */
 class Logger extends DefaultMutator {
     setLevelAttribute(level) {
-        return LevelEnum.fromKey(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
@@ -33,5 +33,5 @@ export default {
     'debug?': Boolean,
     'sampleRate?': Number,
     'tracesSampleRate?': Number,
-    'format?': String,
-};
+    'format?': String
+}