logxpert 0.3.2 → 1.0.1

package/PATCHNOTE.fr.md

@@ -1,22 +1,26 @@
 # Notes de Version
 
-## v0.3.2
+## v1.0.1
 
-- Modification du motif par défaut de `filesName` passant de `'YYYY-MM-DD_HH:mm:ss'` à `'YYYY-MM-DD'` afin que le nom des fichiers de logs n'inclue pas les heures, minutes ou secondes.
+- 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.
 
-## v0.3.1
+## v1.0.0
 
-- Ajout de la création automatique du dossier de logs s'il n'existe pas afin d'éviter l'erreur `ENOENT`.
+- **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.
+- **Amélioration de la Journalisation dans les Fichiers:** Mise à jour des réglages pour l'enregistrement dans les fichiers et création automatique du dossier de logs s'il n'existe pas.
+- **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.0
+### v0.3.2
+- Modification du motif par défaut de `filesName` passant de `'YYYY-MM-DD_HH:mm:ss'` à `'YYYY-MM-DD'`.
+
+### v0.3.1
+- Ajout de la création automatique du dossier de logs s'il n'existe pas afin d'éviter l'erreur `ENOENT`.
 
-- Ajout du support de l'enregistrement dans des fichiers via [winston](https://github.com/winstonjs/winston) et [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file).
+### v0.3.0
+- Ajout du support de l'enregistrement dans des fichiers via winston et winston-daily-rotate-file.
 - Introduction de la méthode `log.settings()` pour configurer l'enregistrement dans les fichiers.
-- Mise à jour des options de configuration pour utiliser `filesName` à la place de l'ancienne propriété.
-- Réglages par défaut :
-  - Dossier : `logs`
-  - Motif de date (`filesName`) : `YYYY-MM-DD_HH:mm:ss`
-  - Rétention maximale des fichiers : `14d`
-  - Taille maximale par fichier : `20m`
-  - `zippedArchive` : par défaut `false` à moins qu'une autre valeur soit fournie.
-- La journalisation dans la console conserve une sortie colorée et formatée.
+- Mise à jour des options de configuration pour utiliser `filesName` à la place de l'ancienne propriété.

package/PATCHNOTE.md

@@ -1,22 +1,26 @@
 # Patch Notes
 
-## v0.3.2
+## v1.0.1
 
-- Changed the default `filesName` pattern from `'YYYY-MM-DD_HH:mm:ss'` to `'YYYY-MM-DD'` so that log filenames do not include hours, minutes, or seconds.
+- 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.
 
-## v0.3.1
+## v1.0.0
 
-- Ensure the log folder is created if it does not exist to prevent `ENOENT` errors.
+- **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.
+- **File Logging Improvements:** Updated file logging settings and ensured the log folder is automatically created if it doesn't exist.
+- **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.
 
-## v0.3.0
+## Previous Versions
 
+### v0.3.2
+- Changed the default `filesName` pattern from `'YYYY-MM-DD_HH:mm:ss'` to `'YYYY-MM-DD'`.
+
+### v0.3.1
+- Ensured the log folder is created if it does not exist to prevent `ENOENT` errors.
+
+### v0.3.0
 - Added file logging support using winston and winston-daily-rotate-file.
 - Introduced `log.settings()` to configure file logging.
-- Updated configuration options to use `filesName` instead of the previous property name.
-- Default settings:
-  - Folder: `logs`
-  - Date pattern (`filesName`): `YYYY-MM-DD_HH:mm:ss`
-  - Maximum file retention: `14d`
-  - Maximum file size: `20m`
-  - `zippedArchive`: default is `false` unless provided.
-- Console logging remains with colorful formatted output.
+- Updated configuration options to use `filesName` instead of the previous property name.

package/README.fr.md

@@ -1,12 +1,12 @@
-# LogXpert
+# LogXpert v1.0.1 LTS
 
-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 documentation explique l'installation et l'utilisation du module.
+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.
 
 ## Table des Matières
 - [Installation](#installation)
 - [Utilisation](#utilisation)
   - [Journalisation de base](#journalisation-de-base)
-  - [Journalisation avancée : Fichiers de logs](#journalisation-avancee-fichiers-de-logs)
+  - [Journalisation avancée : Fichiers de logs & Personnalisation de l'horodatage en console](#journalisation-avancee-fichiers-de-logs--personnalisation-de-lhorodatage-en-console)
 - [Référence API](#référence-api)
 - [Informations Supplémentaires](#informations-supplémentaires)
 - [Licence](#licence)
@@ -44,22 +44,31 @@ log.info("Ceci est un message d'information.");
 log.debug("Ceci est un message de debug.");
 ```
 
-### Journalisation avancée : Fichiers de logs
+### Journalisation avancée : Fichiers de logs & Personnalisation de l'horodatage en console
 
-LogXpert supporte l'enregistrement des logs dans des fichiers à l'aide de [winston](https://github.com/winstonjs/winston) et [winston-daily-rotate-file](https://github.com/winstonjs/winston-daily-rotate-file). Pour activer l'enregistrement dans un fichier, configurez les paramètres via la méthode `log.settings()`. Si non configuré, seule la journalisation dans la console est active.
+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()`.
 
-Exemple de configuration pour activer l'enregistrement dans un fichier :
+Exemple de configuration :
 
 ```js
 const log = require('logxpert');
 
 log.settings({ 
+    console: { 
+        enableTimestamp: true,
+        // Exemple 1 : Inclure du texte littéral avec des tokens
+        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: ''
+    },
     files: { 
         folder: 'logs', 
         filesName: 'YYYY-MM-DD', 
         maxFile: '14d', 
         maxSize: '20m', 
-        zippedArchive: false 
+        zippedArchive: false
     }
 });
 ```
@@ -81,12 +90,18 @@ log.settings({
 - **log.debug(message: string):**  
   Enregistre un message de debug.
 
-- **log.settings(options: Object):**  
-  Configure les options d'enregistrement des logs dans un fichier. L'objet doit contenir la propriété `files` avec les options suivantes :
-
+- **log.settings(options: object):**  
+  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.
+  - `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'`).
-  - `filesName` (string) : Motif de date utilisé dans le nom des fichiers de log (par défaut : `'YYYY-MM-DD_HH:mm:ss'`).
-  - `maxFile` (string) : Durée de rétention maximale des fichiers (par défaut : `'14d'`).
+  - `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'`).
   - `zippedArchive` (boolean) : Archive les logs au format zip (par défaut : `false`).
 

package/README.md

@@ -1,12 +1,12 @@
-# LogXpert
+# LogXpert v1.0.1 LTS
 
-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 documentation explains the installation and usage of the module.
+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.
 
 ## Table of Contents
 - [Installation](#installation)
 - [Usage](#usage)
   - [Basic Logging](#basic-logging)
-  - [Advanced Logging: File Output](#advanced-logging-file-output)
+  - [Advanced Logging: File Output & Custom Console Timestamp](#advanced-logging-file-output--custom-console-timestamp)
 - [API Reference](#api-reference)
 - [Additional Information](#additional-information)
 - [License](#license)
@@ -44,16 +44,25 @@ log.info('This is an informational message.');
 log.debug('This is a debug message.');
 ```
 
-### Advanced Logging: File Output
+### 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). To enable file logging, you can configure it with custom settings via the `log.settings()` method. If not configured, only console logging is active.
+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()`.
 
-Example configuration to enable file logging:
+Example configuration:
 
 ```js
 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 - "
+        timestampPrefix: '',
+        timestampSuffix: ''
+    },
     files: { 
         folder: 'logs', 
         filesName: 'YYYY-MM-DD', 
@@ -64,7 +73,7 @@ log.settings({
 });
 ```
 
-### API Reference
+## API Reference
 
 - **log(message: string):**  
   Logs a general message using the `info` level.
@@ -81,15 +90,20 @@ log.settings({
 - **log.debug(message: string):**  
   Logs a debug message.
 
-- **log.settings(options: Object):**  
-  Configures the file logging options. Accepts an object with a `files` property.  
-  **Options**:
+- **log.settings(options: object):**  
+  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'`).
+  - `timestampPrefix` (string): Prefix for the timestamp.
+  - `timestampSuffix` (string): Suffix for the timestamp.
   
+  **Files Options:**
   - `folder` (string): Directory where log files will be stored (default: `'logs'`).
-  - `filesName` (string): Date pattern used in the log file name (default: `'YYYY-MM-DD_HH:mm:ss'`).
+  - `filesName` (string): Date pattern for the log file name (default: `'YYYY-MM-DD'`).
   - `maxFile` (string): Maximum file retention (default: `'14d'`).
   - `maxSize` (string): Maximum size per log file (default: `'20m'`).
-  - `zippedArchive` (boolean): Whether to archive the logs in zipped format (default: `false`).
+  - `zippedArchive` (boolean): Archive logs in zip format (default: `false`).
 
 ## Additional Information
 

package/main.js

@@ -1,39 +1,117 @@
 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');
 
-// Custom format for logger
+/**
+ * @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:
+ *     - "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
+ *     - "date: YYYY-MM-DD heure: HH:mm:ss - "
+ */
+
+/**
+ * @typedef {Object} FilesOptions
+ * @property {string} [folder='logs'] - Directory where log files will be stored.
+ * @property {string} [filesName='YYYY-MM-DD'] - Date pattern used in the log file name.
+ * @property {string} [maxFile='14d'] - Maximum file retention time.
+ * @property {string} [maxSize='20m'] - Maximum file size per log file.
+ * @property {boolean} [zippedArchive=false] - Whether to archive logs as zip.
+ */
+
+/**
+ * @typedef {Object} LogSettingsOptions
+ * @property {ConsoleOptions} [console] - Options for customizing console output.
+ * @property {FilesOptions} [files] - Options for configuring file logging.
+ */
+
+// Custom format for logger output
 const customFormat = format.printf(({ timestamp, level, message }) => {
-    return `${timestamp} [${level}]: ${message}`;
+    return timestamp ? `${timestamp} [${level}]: ${message}` : `[${level}]: ${message}`;
 });
 
-// Create a logger with console transport only
+// Default console timestamp format
+const defaultConsoleFormat = 'YYYY-MM-DD HH:mm:ss';
+
+// Create a default console transport with timestamp enabled using Moment.js
+let consoleTransport = new transports.Console({
+    format: format.combine(
+        format.colorize(),
+        format.timestamp({
+            format: () => moment().format(defaultConsoleFormat)
+        }),
+        customFormat
+    )
+});
+
+// Create a logger with the default console transport
 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: [
-        new transports.Console({
-            format: format.combine(
-                format.colorize(),
-                format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
-                customFormat
-            )
-        })
-    ]
+    transports: [consoleTransport]
 });
 
 // Reference to file transport (added via settings)
 let fileTransport;
 
-// Settings function to enable file logging
-// Example usage:
-// log.settings({ files: { folder: 'logs', filesName: 'YYYY-MM-DD', maxFile: '14d', maxSize: '20m', zippedArchive: false }})
+/**
+ * Configures logging settings for both console and file transports.
+ *
+ * @param {LogSettingsOptions} options - The settings for both console and file logging.
+ * @example
+ * // Example: Fully custom console timestamp using a custom format string,
+ * // and enabling file logging.
+ * log.settings({ 
+ *   console: { 
+ *     enableTimestamp: true,
+ *     timestampFormat: "Voici la date et l'heure: [YYYY-MM-DD HH:mm:ss] - "
+ *   },
+ *   files: { 
+ *     folder: 'logs', 
+ *     filesName: 'YYYY-MM-DD', 
+ *     maxFile: '14d', 
+ *     maxSize: '20m', 
+ *     zippedArchive: false 
+ *   }
+ * });
+ */
 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 || defaultConsoleFormat;
+
+        // Remove the current console transport
+        logger.remove(consoleTransport);
+
+        // Create new console transport based on the provided options.
+        // The provided timestampFormat is passed directly to moment().
+        consoleTransport = new transports.Console({
+            format: enableTimestamp
+                ? format.combine(
+                    format.colorize(),
+                    format.timestamp({
+                        format: () => moment().format(timestampFormat)
+                    }),
+                    customFormat
+                )
+                : format.combine(
+                    format.colorize(),
+                    customFormat
+                )
+        });
+        logger.add(consoleTransport);
+    }
+
+    // Enable file logging if options.files is provided
     if (options.files) {
-        // Set defaults if not provided
         const folder = options.files.folder || 'logs';
         const datePattern = options.files.filesName || 'YYYY-MM-DD';
         const maxFiles = options.files.maxFile || '14d';
@@ -50,7 +128,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,
@@ -63,28 +141,48 @@ function applySettings(options = {}) {
     }
 }
 
-// Create a simplified logging interface
+/**
+ * Logs a general message using the info level.
+ *
+ * @param {string} message - The message to be logged.
+ */
 function log(message) {
     logger.info(message);
 }
 
+/**
+ * Logs an error message.
+ * @param {string} message - The error message.
+ */
 log.error = function (message) {
     logger.error(message);
 };
 
+/**
+ * Logs a warning message.
+ * @param {string} message - The warning message.
+ */
 log.warn = function (message) {
     logger.warn(message);
 };
 
+/**
+ * Logs an informational message.
+ * @param {string} message - The informational message.
+ */
 log.info = function (message) {
     logger.info(message);
 };
 
+/**
+ * Logs a debug message.
+ * @param {string} message - The debug message.
+ */
 log.debug = function (message) {
     logger.debug(message);
 };
 
-// Expose the settings function for configuring file logging
+// 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": "0.3.2",
+  "version": "1.0.1",
   "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"
   }