Feature Logger for easier way to track and debug (#17)

Feature `Logger` for easier way to track and debug

Author: EmptyWork

clean.js

@@ -1,9 +1,10 @@
 import { existsSync, rmSync } from 'fs'
+import { Logger, LoggerType } from "./src/lib/utilities.class.js"
 
 const cleanDirectory = () => {
-    if (!existsSync('./out/')) return console.error(`failed: dir out not exist`)
+    if (!existsSync('./out/')) return Logger(`\`./out\` not exist`, LoggerType.warning)
     rmSync('./out/', { recursive: true })
-    console.log(`complete: dir out has been deleted`)
+    Logger(`\`./out\` has been deleted`, LoggerType.info)
 }
 
 cleanDirectory()

src/lib/application.class.js

@@ -2,6 +2,7 @@ import { series } from "async"
 import { exec } from 'child_process'
 import { readFileSync, writeFileSync, existsSync, mkdirSync } from 'fs'
 import { getCategoriesFlags, getCategoriesFromCategoriesFlags, getCurrentCategories } from "./categoriesHandlers.class.js"
+import { Logger, LoggerType } from "./utilities.class.js"
 import Command from "./commandHandlers.class.js"
 
 export default class ThesisLighthouse {
@@ -20,9 +21,10 @@ export default class ThesisLighthouse {
         this.#currentCategories = getCurrentCategories(categories)
     }
 
-    testURL = (urlToCheck, options = {}) => {
+    testURL = (urlToCheck, options = {}, currentIndex) => {
         const { commandToRun } = Command.make(urlToCheck, options)
-        if (options?.consoleLog ?? true) console.log(`Running Test on ${urlToCheck}`)
+
+        Logger(`Running Test on ${urlToCheck}`, LoggerType.info, options.consoleLog)
 
         series([
             () => exec(commandToRun, this.execOptions, this.execResult.bind(this))
@@ -36,7 +38,7 @@ export default class ThesisLighthouse {
         )
 
         const data = JSON.parse(out)
-        if (this.options?.consoleLog) console.log(`Stopped Test on ${data?.requestedUrl}`)
+        Logger(`Stopped Test on ${data?.requestedUrl}`, LoggerType.info, this.options?.consoleLog)
 
         const newAccessibilityJSON = this.#produceNewJSON(data, accessibilityScores)
 
@@ -80,19 +82,24 @@ export default class ThesisLighthouse {
     }
 
     #checkDir = () => {
-        if (!existsSync(`${this.#outputDir}`)) mkdirSync(`${this.#outputDir}`)
-        if (!existsSync(`${this.#outputDir}logs`)) mkdirSync(`${this.#outputDir}logs`)
+        this.#makeDirIfNotExists(`${this.#outputDir}`)
+        this.#makeDirIfNotExists(`${this.#outputDir}logs`)
+    }
+
+    #makeDirIfNotExists = (location) => {
+        if (!existsSync(location)) mkdirSync(location)
     }
 
     start = () => {
-        if (this.options?.consoleLog) console.log(this.options)
 
         const isOptionsCategories = getCategoriesFlags(this.options?.categories)
         const currentFlags = `${isOptionsCategories}\n\t--output json \n\t--disable-full-page-screenshot \n\t--chrome-flags="\n\t\t--no-sandbox \n\t\t--headless \n\t\t--disable-gpu"`
 
-        console.log(`ThesisLighthouse ${process.env.npm_package_version} - Thesis Example Code`)
-        console.log(`Running with these flags: ${currentFlags}\n`)
+        Logger(`Copyright (c) 2023 Stevarth`)
+        Logger(`ThesisLighthouse ${process.env.npm_package_version} - Thesis Example Code`)
+        Logger(this.options, LoggerType.info, this.options?.consoleLog)
+        Logger(`Running with these flags: ${currentFlags}\n`)
 
-        this.urlList.forEach((url, index) => { this.testURL(url, this.options) })
+        this.urlList.forEach((url, index) => { this.testURL(url, this.options, index) })
     }
 }

src/lib/utilities.class.js

@@ -1,4 +1,11 @@
 class Utility {
+    LoggerType = {
+        'info': "Info",
+        'warning': "Warning",
+        'error': "Error",
+        'empty': ""
+    }
+
     isEmpty = data => {
         switch (typeof data) {
             case "array":
@@ -10,6 +17,11 @@ class Utility {
         }
     }
 
+    Logger = (text, type = LoggerType.empty, condition = true) => {
+        const typeFormatted = (type === LoggerType.empty) ? `${type}` : `${type}:`
+        if (condition) console.log(`${typeFormatted}`, text)
+    }
+
     #isArrayEmpty = (data = []) => {
         return (data === undefined || data.length === 0) ? false : true
     }
@@ -21,4 +33,5 @@ class Utility {
     }
 }
 
-export default new Utility()
+export default new Utility()
+export const { Logger, LoggerType } = new Utility()

test/lib/utilites.class.test.js

@@ -1,4 +1,4 @@
-import Utility from "../../src/lib/utilities.class.js"
+import Utility, { LoggerType } from "../../src/lib/utilities.class.js"
 
 test('isEmpty of an empty Array', () => {
     expect(
@@ -49,3 +49,34 @@ test('Not isEmpty of not an empty Object', () => {
     ).toBe(true);
 });
 
+test('Logger test', () => {
+    const spyOn = jest.spyOn(console, 'log')
+    Utility.Logger("Running Test on localhost", "Info", false)
+    expect(
+        spyOn
+    ).not.toHaveBeenCalled()
+})
+
+test('Logger test', () => {
+    const spyOn = jest.spyOn(console, 'log')
+    Utility.Logger("Running Test on localhost", "Info")
+    expect(
+        spyOn
+    ).toHaveBeenCalledWith("Info:", "Running Test on localhost")
+})
+
+test('LoggerType.empty', () => {
+    expect(LoggerType.empty).toStrictEqual("")
+})
+
+test('LoggerType.info', () => {
+    expect(LoggerType.info).toStrictEqual("Info")
+})
+
+test('LoggerType.warning', () => {
+    expect(LoggerType.warning).toStrictEqual("Warning")
+})
+
+test('LoggerType.error', () => {
+    expect(LoggerType.error).toStrictEqual("Error")
+})