feat Examples

- Advanced Example
- Custom Colors
- Log to File and Suppress Console
- Terminate on Fatal

Author: samestrin

README.md

@@ -163,8 +163,10 @@ logger.dir(sampleObject);
 
 ## Examples
 
+- [Advanced Example](/examples/advanced-example.js)
 - [Custom Colors](/examples/custom-colors.js)
 - [Log to File and Suppress Console](/examples/log-to-file-and-suppress-console.js)
+- [Terminate on Fatal](/examples/terminate-on-fatal.js)
 
 ## Contribute
 

examples/README.md

@@ -2,5 +2,7 @@
 
 ## Examples
 
+- [Advanced Example](advanced-example.js)
 - [Custom Colors](custom-colors.js)
 - [Log to File and Suppress Console](log-to-file-and-suppress-console.js)
+- [Terminate on Fatal](terminate-on-fatal.js)

examples/advanced-example.js

@@ -0,0 +1,30 @@
+const ACL = require("../index");
+
+// Create a logger instance with custom color configuration
+const logger = new ACL({
+	includeTimestamps: true, // Include timestamps in all log messages.
+	includeMemoryUsage: true, // Track and display memory usage information in the logs.
+	memoryDisplayMode: 2, // Memory display mode: (1 = MB, 2 = %, 3 = both MB and %).
+	generateReport: true, // Generate a report at the end of the logging session showing log method usage statistics.
+
+	// Caller Information Settings
+	includeCallerInfo: 1, // Enable the inclusion of caller information (file, line, and column) in log messages.
+	callerInfoLevel: 3, // Minimum log level to include caller information (0 = debug, 1 = log, 2 = info, 3 = warn, etc.).
+	callerInfoDisplayMode: 2, // Format for caller information display:
+	// 1 = Multi-line format (shows file, function, line, and column separately).
+	// 2 = Inline format (compact single line: file:line:column).
+
+	// Inline Caller Information Settings
+	includeInlineCallerInfo: 1, // Display inline caller information within the log message (quick debugging reference).
+	inlineCallerInfoLevel: 3, // Minimum log level to include inline caller information (similar to `callerInfoLevel`).
+
+	terminateOnFatal: true, // Terminate the application on a `fatal` log message.
+});
+
+// Logging with different levels to demonstrate color differences
+logger.debug("This is a debug message.");
+logger.log("This is a regular log message.");
+logger.info("This is an informational message.");
+logger.warn("This is a warning message, it will include caller information.");
+logger.error("This is an error message, it will include caller information.");
+logger.fatal("This is a fatal message, terminating the process.");

examples/custom-colors.js

@@ -2,8 +2,6 @@ const ACL = require("../index");
 
 // Create a logger instance with custom color configuration
 const logger = new ACL({
-	logLevel: 1, // Show all log levels
-	terminateOnFatal: true, // Terminate on fatal error message
 	color: {
 		debug: "\x1b[36m", // Cyan
 		log: "\x1b[32m", // Green
@@ -23,6 +21,3 @@ logger.info("This is an informational message.");
 logger.warn("This is a warning message.");
 logger.error("This is an error message.");
 logger.fatal("This is a fatal message, terminating the process.");
-logger.error(
-	"This is an error message that isn't displayed because the process ended."
-);

examples/log-to-file-and-suppress-console.js

@@ -5,9 +5,6 @@ const logger = new ACL({
 	logLevel: 0, // Suppress console logs
 	outputFilename: "app.log", // Specify the file to save logs
 	outputFilenameLogLevel: 1, // Log all levels to file
-	includeTimestamps: true, // Include timestamps in the logs
-	includeCallerInfo: false, // Optional: disable caller info if not needed
-	includeMemoryUsage: false, // Optional: disable memory usage if not needed
 });
 
 // Use the logger as usual

examples/terminate-on-fatal.js

@@ -0,0 +1,17 @@
+const ACL = require("../index");
+
+// Create a logger instance with custom color configuration
+const logger = new ACL({
+	terminateOnFatal: true, // Terminate on fatal error message
+});
+
+// Logging with different levels to demonstrate color differences
+logger.debug("This is a debug message.");
+logger.log("This is a regular log message.");
+logger.info("This is an informational message.");
+logger.warn("This is a warning message.");
+logger.error("This is an error message.");
+logger.fatal("This is a fatal message, terminating the process.");
+logger.error(
+	"This is an error message that isn't displayed because the process ended."
+);