logxpert 1.0.1 → 1.0.2

package/PATCHNOTE.fr.md

@@ -1,5 +1,11 @@
 # Notes de Version
 
+## 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.
@@ -12,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,5 +1,11 @@
 # Patch Notes
 
+## 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.
@@ -12,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.1 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. Dans cette version LTS v1.0.1, nous avons amélioré la personnalisation de l'horodatage en console et apporté plusieurs améliorations.
+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 pleinement 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,10 +56,8 @@ const log = require('logxpert');
 log.settings({ 
     console: { 
         enableTimestamp: true,
-        // Exemple 1 : Inclure du texte littéral avec des tokens
+        // Vous pouvez inclure des caractères de décoration, par exemple :
         timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - ",
-        // Exemple 2 : Séparer les tokens pour la date et l'heure
-        // timestampFormat: "date: YYYY-MM-DD heure: HH:mm:ss - "
         timestampPrefix: '',
         timestampSuffix: ''
     },
@@ -94,12 +92,12 @@ log.settings({
   Configure les options d'enregistrement dans un fichier et de personnalisation de la sortie 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'`). Vous pouvez inclure du texte littéral si nécessaire.
+  - `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'`).
+  - `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.1 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. In this LTS release, v1.0.1, we have enhanced custom console timestamp formatting and made several improvements.
+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,7 +46,7 @@ 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 fully 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:
 
@@ -56,10 +56,8 @@ const log = require('logxpert');
 log.settings({ 
     console: { 
         enableTimestamp: true,
-        // Example 1: Including literal text with tokens
-        timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - ",
-        // Example 2: Separating date and time tokens:
-        // timestampFormat: "date: YYYY-MM-DD heure: HH:mm:ss - "
+        // You can now include decoration characters as desired:
+        timestampFormat: "This is the date: [YYYY-MM-DD HH:mm:ss] - ",
         timestampPrefix: '',
         timestampSuffix: ''
     },
@@ -94,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 including literal text if desired (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

@@ -3,11 +3,33 @@ const moment = require('moment'); // Add moment as a dependency: npm install mom
 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'] - Moment.js format for the timestamp.
- *   You can include literal text as needed. For example:
+ * @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 - "
  */
@@ -35,7 +57,7 @@ const customFormat = format.printf(({ timestamp, level, message }) => {
 // Default console timestamp format
 const defaultConsoleFormat = 'YYYY-MM-DD HH:mm:ss';
 
-// Create a default console transport with timestamp enabled using Moment.js
+// Create a default console transport with timestamp enabled using the default format
 let consoleTransport = new transports.Console({
     format: format.combine(
         format.colorize(),
@@ -66,11 +88,12 @@ let fileTransport;
  *
  * @param {LogSettingsOptions} options - The settings for both console and file logging.
  * @example
- * // Example: Fully custom console timestamp using a custom format string,
+ * // Example: Fully custom console timestamp that preserves decoration,
  * // and enabling file logging.
  * log.settings({ 
  *   console: { 
  *     enableTimestamp: true,
+ *     // You can now include brackets or parentheses as decoration:
  *     timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
  *   },
  *   files: { 
@@ -92,13 +115,13 @@ function applySettings(options = {}) {
         logger.remove(consoleTransport);
 
         // Create new console transport based on the provided options.
-        // The provided timestampFormat is passed directly to moment().
+        // 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: () => moment().format(timestampFormat)
+                        format: () => formatCustomTimestamp(timestampFormat)
                     }),
                     customFormat
                 )
@@ -136,7 +159,6 @@ function applySettings(options = {}) {
             maxSize,
             maxFiles
         });
-
         logger.add(fileTransport);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logxpert",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A powerful logging library for Node.js",
   "main": "main.js",
   "repository": {