@cley_faye/boilerplate 3.4.1 → 3.5.1

package/lib/express/logger.js

@@ -33,38 +33,6 @@ exports.registerErrorLogger = exports.registerRouteLogger = void 0;
 const winston_1 = __importDefault(require("winston"));
 const express_winston_1 = __importDefault(require("express-winston"));
 const winston_js_1 = require("../winston.js");
-// High value because of colorize()
-const LOG_LEVEL_PADDING_SIZE = 19;
-/**
- * Collapse all lines containing /node_modules/ into an ellipsis
- */
-const filterNodeModules = function* (message) {
-    let inNodeModules = false;
-    const lines = message.split("\n");
-    for (const line of lines) {
-        if (/\/node_modules\//u.exec(line)) {
-            if (!inNodeModules) {
-                inNodeModules = true;
-                yield "[...]";
-            }
-        }
-        else {
-            inNodeModules = false;
-            yield line;
-        }
-    }
-};
-/**
- * Prefix all lines with the level and the timestamp if needed
- */
-const prefixOutput = (level, message, timestamp) => {
-    const timestampPrefix = timestamp
-        ? `${new Date().toISOString()} `
-        : "";
-    const levelPrefix = `${level.toString().padStart(LOG_LEVEL_PADDING_SIZE)}: `;
-    return message.split("\n").map(line => `${timestampPrefix}${levelPrefix}${line}`)
-        .join("\n");
-};
 const customRouteFormat = (outputTimestamp) => winston_1.default.format.printf((info) => {
     const meta = info.meta;
     // Clean the meta object from stuff displayed in the regular message
@@ -86,7 +54,7 @@ const customRouteFormat = (outputTimestamp) => winston_1.default.format.printf((
     }
     const metaString = JSON.stringify(info.meta);
     const finalMessage = `${info.message} ${metaString === "{}" ? "" : metaString}`;
-    return prefixOutput(info.level, finalMessage, outputTimestamp);
+    return (0, winston_js_1.prefixOutput)(info.level, finalMessage, outputTimestamp);
 });
 const registerRouteLogger = (app, logOptions) => {
     const { route, logger, timestamp } = logOptions ?? {};
@@ -131,9 +99,9 @@ const customErrorFormat = (outputTimestamp, config) => {
     return winston_1.default.format.printf((info) => {
         const meta = info.meta;
         const finalMessage = collapseNodeModules
-            ? [...filterNodeModules(meta.message)].join("\n")
+            ? [...(0, winston_js_1.filterNodeModules)(meta.message)].join("\n")
             : meta.message;
-        return prefixOutput(info.level, finalMessage, outputTimestamp);
+        return (0, winston_js_1.prefixOutput)(info.level, finalMessage, outputTimestamp);
     });
 };
 const registerErrorLogger = (app, logOptions) => {

package/lib/express/pipelinebuilder.js

@@ -30,6 +30,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const express_1 = __importDefault(require("express"));
+const winston_js_1 = require("../winston.js");
 const logger_js_1 = require("./logger.js");
 const defaultErrorHandler = (err, req, res, next) => {
     if (!res.headersSent && err.statusCode) {
@@ -88,6 +89,15 @@ class PipelineBuilder {
     createPipeline({ topLevels, routes, statics, postStatics, errorHandlers, options, }) {
         const { middleware, log, defaultErrorHandler: useDefaultErrorHandler } = options ?? {};
         this.internalLog("createPipeline()");
+        if (log) {
+            const errorConfig = typeof log.error === "boolean"
+                ? {}
+                : log.error ?? {};
+            (0, winston_js_1.setConfig)({
+                timestamp: log.timestamp ?? false,
+                collapseNodeModules: errorConfig.collapseNodeModules ?? true,
+            });
+        }
         const router = express_1.default.Router();
         this.internalLog("setGenericMiddlewares()");
         this._setGenericMiddlewares(router, middleware);

package/lib/express.d.ts

@@ -23,6 +23,9 @@ import { PipelineSettings, LogFunction } from "./express/pipelinebuilder.js";
  * If the request accepts json, a json object with the error is returned.
  * Otherwise text is returned.
  *
+ * For convenience, providing timestamp and collapseNodeModules here will automatically
+ * update the basic consoleLogger configuration.
+ *
  * @param settings
  *
  * @param [settings.topLevels]

package/lib/express.js

@@ -51,6 +51,9 @@ const pipelinebuilder_js_1 = __importDefault(require("./express/pipelinebuilder.
  * If the request accepts json, a json object with the error is returned.
  * Otherwise text is returned.
  *
+ * For convenience, providing timestamp and collapseNodeModules here will automatically
+ * update the basic consoleLogger configuration.
+ *
  * @param settings
  *
  * @param [settings.topLevels]

package/lib/winston.d.ts

@@ -1,3 +1,17 @@
 import winston from "winston";
+/**
+ * Collapse all lines containing /node_modules/ into an ellipsis
+ */
+export declare const filterNodeModules: (message: string) => Generator<string>;
+/**
+ * Prefix all lines with the level and the timestamp if needed
+ */
+export declare const prefixOutput: (level: string, message: string, timestamp: boolean | undefined) => string;
+export interface LogConfig {
+    timestamp: boolean;
+    collapseNodeModules: boolean;
+}
+/** Edit the configuration applied to consoleLogger */
+export declare const setConfig: (config: LogConfig) => void;
 export declare const transports: winston.transports.ConsoleTransportInstance[];
 export declare const consoleLogger: winston.Logger;

package/lib/winston.js

@@ -29,11 +29,61 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.consoleLogger = exports.transports = void 0;
+exports.consoleLogger = exports.transports = exports.setConfig = exports.prefixOutput = exports.filterNodeModules = void 0;
 const winston_1 = __importDefault(require("winston"));
+// High value because of colorize()
+const LOG_LEVEL_PADDING_SIZE = 19;
+/**
+ * Collapse all lines containing /node_modules/ into an ellipsis
+ */
+const filterNodeModules = function* (message) {
+    let inNodeModules = false;
+    const lines = message.split("\n");
+    for (const line of lines) {
+        if (/\/node_modules\//u.exec(line)) {
+            if (!inNodeModules) {
+                inNodeModules = true;
+                yield "[...]";
+            }
+        }
+        else {
+            inNodeModules = false;
+            yield line;
+        }
+    }
+};
+exports.filterNodeModules = filterNodeModules;
+/**
+ * Prefix all lines with the level and the timestamp if needed
+ */
+const prefixOutput = (level, message, timestamp) => {
+    const timestampPrefix = timestamp
+        ? `${new Date().toISOString()} `
+        : "";
+    const levelPrefix = `${level.toString().padStart(LOG_LEVEL_PADDING_SIZE)}: `;
+    return message.split("\n").map(line => `${timestampPrefix}${levelPrefix}${line}`)
+        .join("\n");
+};
+exports.prefixOutput = prefixOutput;
+const logConfig = {
+    timestamp: true,
+    collapseNodeModules: true,
+};
+const customFormat = winston_1.default.format.printf((info) => {
+    const message = ("stack" in info) ? info.stack : info.message;
+    const filteredMessage = logConfig.collapseNodeModules
+        ? [...(0, exports.filterNodeModules)(message)].join("\n")
+        : message;
+    return (0, exports.prefixOutput)(info.level, filteredMessage, logConfig.timestamp);
+});
+/** Edit the configuration applied to consoleLogger */
+const setConfig = (config) => {
+    Object.assign(logConfig, config);
+};
+exports.setConfig = setConfig;
 exports.transports = [new winston_1.default.transports.Console()];
 exports.consoleLogger = winston_1.default.createLogger({
     level: "info",
-    format: winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.simple()),
+    format: winston_1.default.format.combine(winston_1.default.format.colorize(), customFormat),
     transports: exports.transports,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.4.1",
+  "version": "3.5.1",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",
@@ -17,13 +17,13 @@
   },
   "homepage": "https://github.com/CleyFaye/boilerplate#readme",
   "devDependencies": {
-    "@keeex/eslint-config": "^1.7.0",
+    "@keeex/eslint-config": "^1.7.1",
     "@types/express": "^4.17.11",
     "@types/grunt": "^0.4.25",
     "@types/http-errors": "^1.8.0",
     "@types/node": "^16.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.3.1",
-    "@typescript-eslint/parser": "^5.3.1",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
     "eslint": "^8.7.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-promise": "^6.0.0",