logxpert 1.0.0 → 1.0.2

package/PATCHNOTE.fr.md

@@ -1,6 +1,16 @@
 # Notes de Version
 
-## v1.0.0 LTS
+## v1.0.2
+
+- **Préservation de la Décoration dans l'Horodatage Personnalisé :** Ajout d'une fonction d'assistance dans le module de log qui permet de conserver les caractères de décoration (tels que [], (), {}) dans le `timestampFormat` tel que défini par l'utilisateur. Cette amélioration permet d'utiliser des formats comme `"Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "` ou `"date: YYYY-MM-DD heure: HH:mm:ss - "` sans que Moment.js n'échappe automatiquement les crochets.
+- **Autres Améliorations et Corrections de Bugs :** Toutes les améliorations et fonctionnalités précédentes de la v1.0.1 LTS restent intactes.
+
+
+## v1.0.1
+
+- Amélioration de la prise en charge des formats d'horodatage personnalisés en console via Moment.js. Les utilisateurs peuvent désormais fournir des formats entièrement personnalisés (ex. : "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - " ou "date: YYYY-MM-DD heure: HH:mm:ss - ") qui rendent correctement les dates dynamiques et le texte littéral.
+
+## v1.0.0
 
 - **Stabilité & Support:** Cette version est désormais la version LTS, offrant une API stable pour une utilisation en production sur le long terme.
 - **Configuration Améliorée:** Ajout d'options avancées pour personnaliser l'horodatage en console, incluant le format, le préfixe et le suffixe personnalisables.
@@ -8,8 +18,6 @@
 - **Documentation:** Mise à jour du README et de la référence API pour plus de clarté et de complétude.
 - **Compatibilité Rétroactive:** Conservation de toutes les fonctionnalités des versions précédentes, incluant les méthodes pour la journalisation générale, d'erreur, d'avertissement, d'information et de débogage.
 
-## Versions Précédentes
-
 ### v0.3.2
 - Modification du motif par défaut de `filesName` passant de `'YYYY-MM-DD_HH:mm:ss'` à `'YYYY-MM-DD'`.
 

package/PATCHNOTE.md

@@ -1,6 +1,16 @@
 # Patch Notes
 
-## v1.0.0 LTS
+## v1.0.2 
+
+- **Custom Timestamp Decoration Preservation:** Introduced a helper function in the logging module to allow any decoration characters (such as [], (), {}) in the `timestampFormat` to be preserved as supplied by the user. This improvement lets you use formats like `"This is the date: [YYYY-MM-DD HH:mm:ss] - "` or `"date: YYYY-MM-DD heure: HH:mm:ss - "` without Moment.js automatically escaping the brackets.
+- **Other Enhancements and Bug Fixes:** All previous improvements and features from v1.0.1 LTS remain intact.
+
+
+## v1.0.1
+
+- Improved support for fully custom console timestamp formats using Moment.js. Users can now supply completely custom formats (e.g., "This is the time: [YYYY-MM-DD HH:mm:ss] - " or "date: YYYY-MM-DD heure: HH:mm:ss - ") that correctly render dynamic dates and literal text.
+
+## v1.0.0
 
 - **Stability & Support:** This release is now the LTS version, providing a stable API for long-term production use.
 - **Enhanced Configuration:** Added advanced configuration for console timestamps, including customizable format, prefix, and suffix.
@@ -8,8 +18,6 @@
 - **Documentation:** Updated README and API references for clarity and completeness.
 - **Backward Compatibility:** Retained all features from previous versions, including methods for general, error, warning, info, and debug logging.
 
-## Previous Versions
-
 ### v0.3.2
 - Changed the default `filesName` pattern from `'YYYY-MM-DD_HH:mm:ss'` to `'YYYY-MM-DD'`.
 

package/README.fr.md

@@ -1,6 +1,6 @@
-# LogXpert v1.0.0 LTS
+# LogXpert
 
-LogXpert est une bibliothèque de logs puissante pour Node.js qui offre des méthodes de log simples à utiliser avec une sortie colorée et, en option, l'enregistrement dans un fichier. Cette version est la version LTS (Long Term Support) avec une API stable et des options de configuration améliorées.
+LogXpert est une bibliothèque de logs puissante pour Node.js qui offre des méthodes de log simples à utiliser avec une sortie colorée et, en option, l'enregistrement dans un fichier. 
 
 ## Table des Matières
 - [Installation](#installation)
@@ -46,7 +46,7 @@ log.debug("Ceci est un message de debug.");
 
 ### Journalisation avancée : Fichiers de logs & Personnalisation de l'horodatage en console
 
-LogXpert supporte la journalisation dans des fichiers via [winston](https://github.com/winstonjs/winston) et [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file). Vous pouvez configurer l'enregistrement dans un fichier ainsi que personnaliser l'horodatage en console grâce à `log.settings()`.
+LogXpert supporte la journalisation dans des fichiers via [winston](https://github.com/winstonjs/winston) et [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file).
 
 Exemple de configuration :
 
@@ -56,9 +56,10 @@ const log = require('logxpert');
 log.settings({ 
     console: { 
         enableTimestamp: true,
-        timestampFormat: 'YYYY-MM-DD HH:mm:ss',
-        timestampPrefix: '[START] ',
-        timestampSuffix: ' [END]'
+        // Vous pouvez inclure des caractères de décoration, par exemple :
+        timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - ",
+        timestampPrefix: '',
+        timestampSuffix: ''
     },
     files: { 
         folder: 'logs', 
@@ -89,14 +90,14 @@ log.settings({
 
 - **log.settings(options: object):**  
   Configure les options d'enregistrement dans un fichier et de personnalisation de la sortie console.  
-  **Options Console:**
+  **Options Console :**
   - `enableTimestamp` (boolean) : Active/désactive l'horodatage (par défaut : `true`).
-  - `timestampFormat` (string) : Format de l'horodatage (par défaut : `'YYYY-MM-DD HH:mm:ss'`).
+  - `timestampFormat` (string) : Format de l'horodatage incluant tout texte littéral ou décoration (par défaut : `'YYYY-MM-DD HH:mm:ss'`).
   - `timestampPrefix` (string) : Préfixe de l'horodatage.
   - `timestampSuffix` (string) : Suffixe de l'horodatage.
   
-  **Options Fichiers:**
-  - `folder` (string) : Répertoire où les fichiers de logs seront stockés (par défaut : `'logs'`).
+  **Options Fichiers :**
+  - `folder` (string) : Répertoire où seront stockés les fichiers de logs (par défaut : `'logs'`).
   - `filesName` (string) : Motif de date pour le nom des fichiers de logs (par défaut : `'YYYY-MM-DD'`).
   - `maxFile` (string) : Durée maximale de rétention des fichiers (par défaut : `'14d'`).
   - `maxSize` (string) : Taille maximale par fichier de log (par défaut : `'20m'`).

package/README.md

@@ -1,6 +1,6 @@
-# LogXpert v1.0.0 LTS
+# LogXpert
 
-LogXpert is a powerful logging library for Node.js that provides easy-to-use logging methods with colorful formatted output and optional file logging support. This release marks our Long Term Support (LTS) version with a stable API and enhanced configuration options.
+LogXpert is a powerful logging library for Node.js that provides easy-to-use logging methods with colorful formatted output and optional file logging support
 
 ## Table of Contents
 - [Installation](#installation)
@@ -46,9 +46,9 @@ log.debug('This is a debug message.');
 
 ### Advanced Logging: File Output & Custom Console Timestamp
 
-LogXpert supports file logging using [winston](https://github.com/winstonjs/winston) and [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file). You can configure file logging and customize console timestamps via `log.settings()`.
+LogXpert supports file logging using [winston](https://github.com/winstonjs/winston) and [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file).
 
-Example configuration to enable file logging and customize console timestamp:
+Example configuration:
 
 ```js
 const log = require('logxpert');
@@ -56,9 +56,10 @@ const log = require('logxpert');
 log.settings({ 
     console: { 
         enableTimestamp: true,
-        timestampFormat: 'YYYY-MM-DD HH:mm:ss',
-        timestampPrefix: '[START] ',
-        timestampSuffix: ' [END]'
+        // You can now include decoration characters as desired:
+        timestampFormat: "This is the date: [YYYY-MM-DD HH:mm:ss] - ",
+        timestampPrefix: '',
+        timestampSuffix: ''
     },
     files: { 
         folder: 'logs', 
@@ -91,7 +92,7 @@ log.settings({
   Configures file logging and console output options.  
   **Console Options:**
   - `enableTimestamp` (boolean): Enable/disable timestamp (default: `true`).
-  - `timestampFormat` (string): Format for the timestamp (default: `'YYYY-MM-DD HH:mm:ss'`).
+  - `timestampFormat` (string): Format for the timestamp including any desired literal text or decoration (default: `'YYYY-MM-DD HH:mm:ss'`).
   - `timestampPrefix` (string): Prefix for the timestamp.
   - `timestampSuffix` (string): Suffix for the timestamp.
   

package/main.js

@@ -1,13 +1,37 @@
 const fs = require('fs');
+const moment = require('moment'); // Add moment as a dependency: npm install moment
 const { createLogger, format, transports } = require('winston');
 require('winston-daily-rotate-file');
 
+/**
+ * Helper function to format the timestamp while preserving bracket characters.
+ * This function replaces all occurrences of '[' and ']' with temporary placeholders
+ * so that Moment.js does not treat them as escapes. After formatting, it restores them.
+ *
+ * @param {string} fmt - The user-defined format string.
+ * @returns {string} - The formatted timestamp with any decoration brackets preserved.
+ *
+ * Example:
+ *   Input: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
+ *   Might output: "Voici la date et l'heure: [2025-03-21 15:30:45] - "
+ */
+function formatCustomTimestamp(fmt) {
+    // Replace square brackets with placeholders
+    const temp = fmt.replace(/\[/g, '__LB__').replace(/\]/g, '__RB__');
+    // Let moment replace tokens in the modified string
+    const formatted = moment().format(temp);
+    // Restore the original bracket characters
+    return formatted.replace(/__LB__/g, '[').replace(/__RB__/g, ']');
+}
+
 /**
  * @typedef {Object} ConsoleOptions
  * @property {boolean} [enableTimestamp=true] - Enable or disable timestamp in console logs.
- * @property {string} [timestampFormat='YYYY-MM-DD HH:mm:ss'] - Format for the timestamp.
- * @property {string} [timestampPrefix=''] - String to prefix the timestamp.
- * @property {string} [timestampSuffix=''] - String to suffix the timestamp.
+ * @property {string} [timestampFormat='YYYY-MM-DD HH:mm:ss'] - Custom format for the timestamp.
+ *   You can include any decoration characters ([], (), {}) without interference.
+ *   For example:
+ *     - "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
+ *     - "date: YYYY-MM-DD heure: HH:mm:ss - "
  */
 
 /**
@@ -25,16 +49,21 @@ require('winston-daily-rotate-file');
  * @property {FilesOptions} [files] - Options for configuring file logging.
  */
 
-// Custom format for logger (handles the timestamp if present)
+// Custom format for logger output
 const customFormat = format.printf(({ timestamp, level, message }) => {
     return timestamp ? `${timestamp} [${level}]: ${message}` : `[${level}]: ${message}`;
 });
 
-// Create a default console transport with timestamp enabled by default
+// Default console timestamp format
+const defaultConsoleFormat = 'YYYY-MM-DD HH:mm:ss';
+
+// Create a default console transport with timestamp enabled using the default format
 let consoleTransport = new transports.Console({
     format: format.combine(
         format.colorize(),
-        format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+        format.timestamp({
+            format: () => moment().format(defaultConsoleFormat)
+        }),
         customFormat
     )
 });
@@ -43,7 +72,9 @@ let consoleTransport = new transports.Console({
 const logger = createLogger({
     level: 'debug',
     format: format.combine(
-        format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+        format.timestamp({
+            format: () => moment().format(defaultConsoleFormat)
+        }),
         customFormat
     ),
     transports: [consoleTransport]
@@ -54,16 +85,16 @@ let fileTransport;
 
 /**
  * Configures logging settings for both console and file transports.
- * 
- * @param {LogSettingsOptions} options - The settings for console and file logging.
+ *
+ * @param {LogSettingsOptions} options - The settings for both console and file logging.
  * @example
- * // Customize console timestamp and enable file logging
+ * // Example: Fully custom console timestamp that preserves decoration,
+ * // and enabling file logging.
  * log.settings({ 
  *   console: { 
  *     enableTimestamp: true,
- *     timestampFormat: 'YYYY-MM-DD HH:mm:ss',
- *     timestampPrefix: '[START] ',
- *     timestampSuffix: ' [END]'
+ *     // You can now include brackets or parentheses as decoration:
+ *     timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
  *   },
  *   files: { 
  *     folder: 'logs', 
@@ -78,26 +109,20 @@ function applySettings(options = {}) {
     // Update console transport if configuration is provided
     if (options.console) {
         const enableTimestamp = options.console.enableTimestamp !== undefined ? options.console.enableTimestamp : true;
-        const timestampFormat = options.console.timestampFormat || 'YYYY-MM-DD HH:mm:ss';
-        const timestampPrefix = options.console.timestampPrefix || '';
-        const timestampSuffix = options.console.timestampSuffix || '';
+        const timestampFormat = options.console.timestampFormat || defaultConsoleFormat;
 
         // Remove the current console transport
         logger.remove(consoleTransport);
 
-        // Create new console transport based on the provided options
+        // Create new console transport based on the provided options.
+        // Here, we use our helper function to let tokens be replaced while preserving any decoration.
         consoleTransport = new transports.Console({
             format: enableTimestamp
                 ? format.combine(
                     format.colorize(),
-                    format.timestamp({ format: timestampFormat }),
-                    // Append prefix and suffix to the timestamp value
-                    format((info) => {
-                        if (info.timestamp) {
-                            info.timestamp = timestampPrefix + info.timestamp + timestampSuffix;
-                        }
-                        return info;
-                    })(),
+                    format.timestamp({
+                        format: () => formatCustomTimestamp(timestampFormat)
+                    }),
                     customFormat
                 )
                 : format.combine(
@@ -126,7 +151,7 @@ function applySettings(options = {}) {
             logger.remove(fileTransport);
         }
 
-        // Create a new daily rotate file transport with provided/default settings
+        // Create a new daily-rotate file transport with provided/default settings
         fileTransport = new transports.DailyRotateFile({
             filename: `${folder}/application-%DATE%.log`,
             datePattern,
@@ -134,15 +159,14 @@ function applySettings(options = {}) {
             maxSize,
             maxFiles
         });
-
         logger.add(fileTransport);
     }
 }
 
 /**
  * Logs a general message using the info level.
- * 
- * @param {string} message - Message to be logged.
+ *
+ * @param {string} message - The message to be logged.
  */
 function log(message) {
     logger.info(message);
@@ -150,7 +174,7 @@ function log(message) {
 
 /**
  * Logs an error message.
- * @param {string} message - Error message.
+ * @param {string} message - The error message.
  */
 log.error = function (message) {
     logger.error(message);
@@ -158,7 +182,7 @@ log.error = function (message) {
 
 /**
  * Logs a warning message.
- * @param {string} message - Warning message.
+ * @param {string} message - The warning message.
  */
 log.warn = function (message) {
     logger.warn(message);
@@ -166,7 +190,7 @@ log.warn = function (message) {
 
 /**
  * Logs an informational message.
- * @param {string} message - Informational message.
+ * @param {string} message - The informational message.
  */
 log.info = function (message) {
     logger.info(message);
@@ -174,13 +198,13 @@ log.info = function (message) {
 
 /**
  * Logs a debug message.
- * @param {string} message - Debug message.
+ * @param {string} message - The debug message.
  */
 log.debug = function (message) {
     logger.debug(message);
 };
 
-// Expose the settings function for configuring file logging and console output customization
+// Expose the settings function for configuring both file logging and console output
 log.settings = applySettings;
 
 module.exports = log;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logxpert",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A powerful logging library for Node.js",
   "main": "main.js",
   "repository": {
@@ -10,6 +10,7 @@
   "author": "https://github.com/lighscent",
   "license": "MIT",
   "dependencies": {
+    "moment": "^2.30.1",
     "winston": "^3.17.0",
     "winston-daily-rotate-file": "^5.0.0"
   }