@trojs/logger 0.4.2 → 0.4.3

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@trojs/logger",
     "description": "Winston logger for TroJS",
-    "version": "0.4.2",
+    "version": "0.4.3",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://trojs.org/"
@@ -31,17 +31,22 @@
     ],
     "main": "src/logger.js",
     "devDependencies": {
-        "@trojs/error": "^3.0.0",
         "@hckrnews/eslint-config": "^3.0.0",
-        "c8": "^9.0.0",
+        "@trojs/error": "^3.0.0",
+        "c8": "^10.0.0",
         "eslint": "^8.23.0",
-        "eslint-config-standard": "^17.1.0",
-        "eslint-plugin-import": "^2.26.0",
-        "eslint-plugin-jsdoc": "^48.0.6",
-        "eslint-plugin-n": "^16.6.2",
-        "eslint-plugin-promise": "^6.0.1",
-        "eslint-plugin-sonarjs": "^0.25.0",
-        "jscpd": "^4.0.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": "^48.8.3",
+        "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",
+        "jscpd": "^4.0.0",
+        "prettier": "^3.3.3"
     },
     "repository": {
         "type": "git",
@@ -57,12 +62,12 @@
         "error"
     ],
     "dependencies": {
-        "@trojs/enum": "^3.0.0",
-        "@trojs/mutator": "^0.4.0",
-        "@trojs/objects": "^8.0.0",
         "@sentry/integrations": "^7.117.0",
         "@sentry/node": "^7.117.0",
         "@sentry/tracing": "^7.117.0",
+        "@trojs/enum": "^3.0.0",
+        "@trojs/mutator": "^0.4.0",
+        "@trojs/objects": "^8.0.0",
         "compression": "^1.7.4",
         "cors": "^2.8.5",
         "dotenv": "^16.0.3",

package/src/helpers/stackdriver.js

@@ -1,30 +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) => ({
-  ...info,
-  severity: levelToSeverity[level] || levelToSeverity[defaultLevel],
-  level: levels[level] || levels[defaultLevel],
-  time: Date.now(),
-  pid: process.pid,
-  hostname: os.hostname()
-})
+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(),
+    });
 
-export default stackdriver
+export default stackdriver;

package/src/logger.js

@@ -1,20 +1,20 @@
-import winston from 'winston'
-import makeLoggers from './loggers/index.js'
+import winston from 'winston';
+import makeLoggers from './loggers/index.js';
 
 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
@@ -25,13 +25,13 @@ 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,
-    format: winston.format.json(),
-    defaultMeta: meta,
-    transports: winstonLoggers
-  })
-}
+    return winston.createLogger({
+        level,
+        levels,
+        format: winston.format.json(),
+        defaultMeta: meta,
+        transports: winstonLoggers,
+    });
+};

package/src/loggers/combined-file.js

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

package/src/loggers/console.js

@@ -1,13 +1,15 @@
-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: winston.format.combine(
-      winston.format(stackDriver({ level: logger?.level, defaultLevel }))(),
-      winston.format.json()
-    )
-  })
-}
+    return new winston.transports.Console({
+        level: logger?.level || defaultLevel,
+        format: winston.format.combine(
+            winston.format(
+                stackDriver({ level: logger?.level, defaultLevel })
+            )(),
+            winston.format.json()
+        ),
+    });
+};

package/src/loggers/error-file.js

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

package/src/loggers/index.js

@@ -1,29 +1,30 @@
-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,
+};
 
-const makeLoggers = ({ winston, loggers }) => Logger.createAll(loggers).map(logger => {
-  const loggerFn = winstonLoggers[logger.type]
-  if (!loggerFn) {
-    throw new Error(`Unknown logger type: ${logger.type}`)
-  }
+const makeLoggers = ({ winston, loggers }) =>
+    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,4 @@
-import { Enum } from '@trojs/enum'
+import { Enum } from '@trojs/enum';
 
 /**
  * @typedef LevelType
@@ -17,10 +17,15 @@ import { Enum } from '@trojs/enum'
  * @enum { LevelType }
  */
 export default class Level extends Enum {
-  static info = 'info'
-  static fatal = 'fatal'
-  static error = 'error'
-  static warn = 'warn'
-  static debug = 'debug'
-  static trace = 'trace'
+    static info = 'info';
+
+    static fatal = 'fatal';
+
+    static error = 'error';
+
+    static warn = 'warn';
+
+    static debug = 'debug';
+
+    static trace = 'trace';
 }

package/src/models/logger.js

@@ -1,6 +1,6 @@
-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
@@ -9,29 +9,29 @@ import LoggerMutator from './mutators/logger.js'
 /**
  * @type {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
@@ -21,15 +21,15 @@ 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
-}
+    type: String,
+    'location?': String,
+    'level?': Level,
+    'key?': String,
+    'credentials?': Object,
+    'environment?': String,
+    'serverName?': String,
+    'release?': String,
+    'debug?': Boolean,
+    'sampleRate?': Number,
+    'tracesSampleRate?': Number,
+};