‼️ BREAKING:[#10]Create log files feature (v2.0.0)

Author: 0necontroller

CHANGELOG.md

@@ -6,4 +6,8 @@
 
 ## 1.0.1 /2023-02/28
     - Added new color
-    - Updated Documentation
+    - Updated Documentation
+
+## 2.0.0 /2023-03-08
+    - Added log file capabilities
+    - Removed unnecessary express dependency

README.md

@@ -221,6 +221,37 @@ app.listen('3001', () => {
 
 <br>
 
+# Save my logs🚀
+Using this feature you can store you apps log in a file.\
+This feature is useful for debugging and for production.
+
+<br>
+
+## 📑Borgen logs 🐾
+**logs** argument allows you to specify a  path where your log file will be located.
+```js
+app.use(
+    Borgen({
+        logs: '../logs/borgen.log'
+    })
+);
+```
+## 📑Logger logs 🐾
+To save your logs you need to add the **logs** parameter as an argument.
+
+```js
+ Logger.info({ logs: '../logs/info.log' });
+ Logger.warn({ logs: '../logs/warnings.log' });
+ Logger.error({ logs: '../logs/error.log' });
+```
+
+> \
+> **Note:** The 🔖log file name can be any custom name. ' ./custom_name.log '
+> ___
+
+<br>
+<br>
+
 ## 💪🏽 Thanks to all the awesome Contributors
 
 Thanks a lot for spending your time helping Borgen grow. Thanks a lot! Keep rocking🍻

example.js

@@ -1,5 +1,4 @@
 const express = require('express');
-
 const { Logger, Borgen } = require('borgen');
 
 const app = express();
@@ -15,20 +14,21 @@ app.use(
         routeColor: 'gray',
         statusColor: 'cyan',
         resTimeColor: 'gray',
-        statusCodesCl: { serverErr: 'red', clientErr: 'yellow', redirects: 'cyan', success: 'greenBright' }
+        statusCodesCl: { serverErr: 'red', clientErr: 'yellow', redirects: 'cyan', success: 'greenBright' },
+        logs: './logs/borgen.log'
     })
 );
 
 app.get('/test', (req, res) => {
-    Logger.warn({ message: 'This is an warning', infoColor: 'yellow', messageColor: 'yellowBright' });
+    Logger.warn({ message: 'This is an warning', infoColor: 'yellow', messageColor: 'yellowBright', logs: './logs/warnings.log' });
     res.send('Hello world').end();
 });
 
 app.get('*', (req, res) => {
-    Logger.error({ message: 'This route does not exist', infoColor: 'red', messageColor: 'redBright' });
+    Logger.error({ message: 'This route does not exist', infoColor: 'red', messageColor: 'redBright', logs: './logs/error.log' });
     res.send('404 not found');
 });
 
 app.listen('3001', () => {
-    Logger.info({ message: 'The server is running on port ' });
+    Logger.info({ message: 'The server is running on port ', logs: './logs/info.log' });
 });

example.ts

@@ -1,33 +1,34 @@
-import express from 'express'
-import { Logger,Borgen } from 'borgen';
+import express from 'express';
+import { Logger, Borgen } from './src/index';
 
 const app = express();
 app.use(
     Borgen({
-        methodColor:{
-        GET:'greenBright',
-        POST:'yellow',
-        PUT:'gray',
-        PATCH:'gray',
-        DELETE:'redBright'
+        methodColor: {
+            GET: 'greenBright',
+            POST: 'yellow',
+            PUT: 'gray',
+            PATCH: 'gray',
+            DELETE: 'redBright'
         },
-        routeColor:'gray',
-        statusColor:'cyan',
-        resTimeColor:'gray',
-        statusCodesCl:{serverErr:'red', clientErr:'yellow', redirects:'cyan',success:'greenBright'
-        }})
+        routeColor: 'gray',
+        statusColor: 'cyan',
+        resTimeColor: 'gray',
+        statusCodesCl: { serverErr: 'red', clientErr: 'yellow', redirects: 'cyan', success: 'greenBright' },
+        logs: '../logs/borgen.log'
+    })
 );
 
 app.get('/test', (req, res) => {
-    Logger.warn({ message: 'This is an warning', infoColor: 'yellow', messageColor: 'yellowBright' });
+    Logger.warn({ message: 'This is an warning', infoColor: 'yellow', messageColor: 'yellowBright', logs: '../logs/warnings.log' });
     res.send('Hello world').end();
 });
 
 app.get('*', (req, res) => {
-    Logger.error({ message: 'This route does not exist', infoColor: 'red', messageColor: 'redBright' });
+    Logger.error({ message: 'This route does not exist', infoColor: 'red', messageColor: 'redBright', logs: '../logs/error.log' });
     res.send('404 not found');
 });
 
 app.listen('3001', () => {
-    Logger.info({ message: 'The server is running on port '});
+    Logger.info({ message: 'The server is running on port ', logs: '../logs/info.log' });
 });

logs/borgen.log

@@ -0,0 +1,2 @@
+[3/8/2023, 2:59:32 PM] GET Request path: /test - Status:304 in 7 ms
+[3/8/2023, 3:00:06 PM] GET Request path: /test - Status:304 in 1 ms

logs/info.log

@@ -0,0 +1 @@
+[3/8/2023, 2:59:13 PM] [INFO] The server is running on port 

logs/warnings.log

@@ -0,0 +1,2 @@
+[3/8/2023, 2:59:32 PM] [INFO] This is an warning
+[3/8/2023, 3:00:06 PM] [INFO] This is an warning

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "borgen",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "contributors": [
     "Abel Misiocha <abel@abeldev.site>"
   ],
@@ -40,12 +40,9 @@
   },
   "homepage": "https://codedwells.github.io/Borgen",
   "devDependencies": {
-    "@types/express": "^4.17.17",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "borgen": "^1.0.1",
-    "chalk": "^4.1.2",
-    "express": "^4.18.2"
+    "chalk": "^4.1.2"
   }
 }

package.json

@@ -6,8 +6,8 @@
  * MIT Licensed
  */
 
-import { Request, Response, NextFunction } from 'express';
 import chalk from 'chalk';
+import fs from 'fs';
 
 type colorTypes =
     | 'black'
@@ -33,6 +33,7 @@ type loggerParams = {
     message: string;
     infoColor?: colorTypes;
     messageColor?: colorTypes;
+    logs?: string;
 };
 
 type statusCodeType = {
@@ -56,6 +57,7 @@ type BorgenParams = {
     statusColor?: colorTypes;
     resTimeColor?: colorTypes;
     statusCodesCl?: statusCodeType;
+    logs?: string;
 };
 
 export class Logger {
@@ -66,15 +68,21 @@ export class Logger {
      * @param message The message you want logged `This is an informational message`
      * @example
      * ```js
-     * Logger.error({message:'This is an info message',infoColor:'blue',messageColor:'cyan'});
+     * Logger.error({message:'This is an info message',infoColor:'blue',messageColor:'cyan',logs:'../logs/info.log'});
      *
      * [2/27/2023, 3:57:45 PM] [INFO] Server is listening on port:3001
      * ```
      */
-    public static info = ({ message, infoColor, messageColor }: loggerParams) => {
+    public static info = ({ message, infoColor, messageColor, logs }: loggerParams) => {
         const infoCl = infoColor || 'blue';
         const messageCl = messageColor || 'blueBright';
 
+        if (logs) {
+            const output = fs.createWriteStream(logs, { encoding: 'utf8', flags: 'a' });
+
+            output.write(`[${new Date().toLocaleString()}] [INFO] ${message || 'Default info message'}\n`);
+        }
+
         console.log(chalk[infoCl](`[${new Date().toLocaleString()}] [INFO]`), chalk[messageCl](message || 'Default info message'));
     };
 
@@ -85,16 +93,22 @@ export class Logger {
      * @param message The message you want logged `This is a warning`
      * @example
      * ```js
-     * Logger.warn({message:'This is an warning',infoColor:'yellow',messageColor:'yellowBright'});
+     * Logger.warn({message:'This is an warning',infoColor:'yellow',messageColor:'yellowBright',logs:'../logs/warns.log'});
      *
      *  [2/27/2023, 3:57:48 PM] [ERROR] This is a warning
      * ```
      */
-    public static warn = ({ message, infoColor, messageColor }: loggerParams) => {
+    public static warn = ({ message, infoColor, messageColor, logs }: loggerParams) => {
         const infoCl = infoColor || 'yellow';
         const messageCl = messageColor || 'yellowBright';
 
-        console.log(chalk[infoCl].bold(`[${new Date().toLocaleString()}] [WARN]`), chalk[messageCl](message));
+        if (logs) {
+            const output = fs.createWriteStream(logs, { encoding: 'utf8', flags: 'a' });
+
+            output.write(`[${new Date().toLocaleString()}] [INFO] ${message || 'Default  warn message'}\n`);
+        }
+
+        console.log(chalk[infoCl].bold(`[${new Date().toLocaleString()}] [WARN]`), chalk[messageCl](message || 'Default warn message'));
     };
 
     /**
@@ -104,16 +118,22 @@ export class Logger {
      * @param message The message you want logged  `This is an error message`
      * @example
      * ```js
-     * Logger.error({message:'This is an error message',infoColor:'red',messageColor:'redBright'});
+     * Logger.error({message:'This is an error message',infoColor:'red',messageColor:'redBright',logs:'../logs/error.log'});
      *
      * [2/27/2023, 3:57:48 PM] [ERROR] This is route does not exist
      * ```
      */
-    public static error = ({ message, infoColor, messageColor }: loggerParams) => {
+    public static error = ({ message, infoColor, messageColor, logs }: loggerParams) => {
         const infoCl = infoColor || 'red';
         const messageCl = messageColor || 'redBright';
 
-        console.log(chalk[infoCl].bold(`[${new Date().toLocaleString()}] [ERROR]`), chalk[messageCl](message));
+        if (logs) {
+            const output = fs.createWriteStream(logs, { encoding: 'utf8', flags: 'a' });
+
+            output.write(`[${new Date().toLocaleString()}] [INFO] ${message || 'Default error message'}\n`);
+        }
+
+        console.log(chalk[infoCl].bold(`[${new Date().toLocaleString()}] [ERROR]`), chalk[messageCl](message || 'Default error message'));
     };
 }
 
@@ -137,15 +157,16 @@ export class Logger {
  * routeColor:'gray',
  * statusColor:'cyan',
  * resTimeColor:'gray',
- * statusCodesCl:{serverErr:'red', clientErr:'yellow', redirects:'cyan',success:'greenBright'
- * }})
+ * statusCodesCl:{serverErr:'red', clientErr:'yellow', redirects:'cyan',success:'greenBright'},
+ * logs:'../logs/borgen.log',
+ * })
  * ```
  * @example
  *  ```js
  *  [POST] Request path: /api/v1/users/new - Status:200 in 5 ms
  * ```
  */
-export const Borgen = ({ methodColor, routeColor, statusColor, resTimeColor, statusCodesCl }: BorgenParams) => {
+export const Borgen = ({ methodColor, routeColor, statusColor, resTimeColor, statusCodesCl, logs }: BorgenParams) => {
     const { serverErr, clientErr, redirects, success } = {
         serverErr: statusCodesCl?.serverErr || 'red',
         clientErr: statusCodesCl?.clientErr || 'yellow',
@@ -164,10 +185,18 @@ export const Borgen = ({ methodColor, routeColor, statusColor, resTimeColor, sta
     const statusCl = statusColor || 'cyan';
     const resTimeCl = resTimeColor || 'gray';
 
-    return (req: Request, res: Response, next: NextFunction) => {
+    //@ts-ignore
+    return (req, res, next) => {
         const start = Date.now();
-        const reqColor = res.on('finish', () => {
+        res.on('finish', () => {
             const elapsed = Date.now() - start;
+
+            if (logs) {
+                const output = fs.createWriteStream(logs, { encoding: 'utf8', flags: 'a' });
+
+                output.write(`[${new Date().toLocaleString()}] ${req.method} Request path: ${req.path} - Status:${res.statusCode} in ${elapsed} ms\n`);
+            }
+
             console.log(
                 chalk[req.method === 'GET' ? GET : req.method === 'POST' ? POST : req.method === 'PUT' ? PUT : req.method === 'PATCH' ? PATCH : req.method === 'DELETE' ? DELETE : 'greenBright'](
                     `[${req.method}] Request`
@@ -186,7 +215,6 @@ export const Borgen = ({ methodColor, routeColor, statusColor, resTimeColor, sta
                 chalk[resTimeCl].bold(`in ${elapsed} ms`)
             );
         });
-
         next();
     };
 };