Merge the "release/v1.1.0" branch to the "main" branch

feat: Implement enhanced logging and Dockerignore improvements

This change integrates features from the release/v1.1.0 branch. A new modular logging system is introduced using a logDebug function for structured, type-based console output To support this, the project now utilizes ES modules. The .dockerignore file has also been refined to optimize Docker image builds by excluding unnecessary files and removing duplicate entries, which contributes to a smaller image size and faster build times.

Author: Amnoor

.dockerignore

@@ -1,7 +1,6 @@
 # Docker
 .dockerignore
 Dockerfile
-Dockerfile
 
 # Git
 .git/
@@ -11,6 +10,9 @@ Dockerfile
 # License
 LICENSE
 
+# README
+README.md
+
 # Gemini
 .gemini/
 GEMINI.md

index.html

@@ -26,6 +26,6 @@
             <h1 id="clock" aria-live="polite"></h1>
         </div>
         <!-- Linking the JavaScript file -->
-        <script src="index.js" defer></script>
+        <script type="module" src="index.js" defer></script>
     </body>
 </html>

index.js

@@ -2,6 +2,9 @@
 
 // index.js
 
+// Import the logDebug function from the logs module
+import { logDebug } from "./modules/logs/index.js";
+
 /**
  * Starts the digital clock with the specified interval.
  * If no interval is specified, it defaults to 1000 milliseconds (1 second).
@@ -31,23 +34,29 @@ function startClock(interval = 1000) {
         // Determine AM or PM
         const ampm = hours24 >= 12 ? "PM" : "AM";
 
+        // Log the updated time
+        logDebug("log", `Updating clock: ${hours12}:${minutes}:${seconds} ${ampm}`);
+        
         // Update the clock element's text content
         clock.textContent = `${hours12}:${minutes}:${seconds} ${ampm}`;
     }
 
-    // If the clock element is not found, return an error
+    // If the clock element is not found, log an error
     if(!clock){
-        return console.error("Clock element not found in the DOM.");
+        logDebug("error", "Clock element not found in the DOM.");
+        return;
     }
-    // else if the interval is less than or equal to 0, return an error
+    // else if the interval is less than or equal to 0, log an error
     else if(interval <= 0){
-        return console.error("Interval must be greater than 0.");
+        logDebug("error", "Interval must be greater than 0.");
+        return;
     }
     // else start the clock and update it at the specified interval
     else{
-        // Log success messages
-        console.log("Clock element found.");
-        console.log(`Starting clock with an interval of ${interval} milliseconds.`);
+        // Log success message
+        logDebug("log", "Clock element found.");
+        // Log starting message
+        logDebug("log", `Starting clock with an interval of ${interval} milliseconds.`);
         // Initial
         update();
         // Set interval to update the clock every specified milliseconds
@@ -56,6 +65,6 @@ function startClock(interval = 1000) {
 }
 
 // Log initialization message
-console.log("Digital Clock Program Initialized.");
+logDebug("log", "Initializing Digital Clock Program...");
 // Start the clock with default interval
 const intervalId = startClock();

modules/logs/index.js

@@ -0,0 +1,47 @@
+// Digital Clock Program
+
+// modules/logs/index.js
+
+// Debugging flag
+const DEBUG = false;
+
+/**
+ * Logs a message to the console with a timestamp based on the type.
+ * If type is "error", logs an error to the console.
+ * If type is "warn", logs a warning to the console.
+ * If type is "log" and DEBUG is true, logs to the console.
+ * If type is invalid and DEBUG is true, logs a warning about invalid type.
+ * If type is unhandled, logs an error to the console.
+ * @param {string} type - The type of log message to log (error, warn, log).
+ * @param {string} message - The message to log.
+ */
+export function logDebug(type, message){
+    // Get the current timestamp for logging
+    const timestamp = new Date().toISOString();
+
+    // Log the message based on the type
+    // if type is "error", log an error, even if DEBUG is false
+    if(type === "error"){
+        console.error(`${timestamp} - ${message}`);
+    }
+    // else if type is "warn", log a warning, even if DEBUG is false
+    else if(type === "warn"){
+        console.warn(`${timestamp} - ${message}`);
+    }
+    // else if DEBUG is false, return nothing and do not log
+    else if(!DEBUG){
+        return;
+    }
+    // else if type is "log" and DEBUG is true, log to the console
+    else if(type === "log" && DEBUG){
+        console.log(`${timestamp} - ${message}`);
+    }
+    // else if type is invalid and DEBUG is true, log a warning about invalid type
+    else if(type !== "log" && type !== "error" && type !== "warn" && DEBUG){
+        console.warn(`${timestamp} - Invalid log type specified: ${type}`);
+    }
+    // else log an error for unhandled log types
+    else{
+        console.warn(`${timestamp} - Unhandled log type: ${type} with message: ${message}`);
+    }
+}