logxpert 0.3.1 → 1.0.0

package/PATCHNOTE.fr.md

@@ -1,18 +1,22 @@
 # Notes de Version
 
-## v0.3.1
+## v1.0.0 LTS
 
-- 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,18 +1,22 @@
 # Patch Notes
 
-## v0.3.1
+## v1.0.0 LTS
 
-- 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.0 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. Cette version est la version LTS (Long Term Support) avec une API stable et des options de configuration améliorées.
 
 ## 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,28 @@ 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 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,
+        timestampFormat: 'YYYY-MM-DD HH:mm:ss',
+        timestampPrefix: '[START] ',
+        timestampSuffix: ' [END]'
+    },
     files: { 
         folder: 'logs', 
-        filesName: 'YYYY-MM-DD_HH:mm:ss', 
+        filesName: 'YYYY-MM-DD', 
         maxFile: '14d', 
         maxSize: '20m', 
-        zippedArchive: true 
+        zippedArchive: false
     }
 });
 ```
@@ -81,12 +87,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'`).
+  - `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.0 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. This release marks our Long Term Support (LTS) version with a stable API and enhanced configuration options.
 
 ## 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,27 +44,33 @@ 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 customize console timestamps via `log.settings()`.
 
-Example configuration to enable file logging:
+Example configuration to enable file logging and customize console timestamp:
 
 ```js
 const log = require('logxpert');
 
 log.settings({ 
+    console: { 
+        enableTimestamp: true,
+        timestampFormat: 'YYYY-MM-DD HH:mm:ss',
+        timestampPrefix: '[START] ',
+        timestampSuffix: ' [END]'
+    },
     files: { 
         folder: 'logs', 
-        filesName: 'YYYY-MM-DD_HH:mm:ss', 
+        filesName: 'YYYY-MM-DD', 
         maxFile: '14d', 
         maxSize: '20m', 
-        zippedArchive: true 
+        zippedArchive: false
     }
 });
 ```
 
-### API Reference
+## API Reference
 
 - **log(message: string):**  
   Logs a general message using the `info` level.
@@ -81,15 +87,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 (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

@@ -2,40 +2,116 @@ const fs = require('fs');
 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'] - Format for the timestamp.
+ * @property {string} [timestampPrefix=''] - String to prefix the timestamp.
+ * @property {string} [timestampSuffix=''] - String to suffix the timestamp.
+ */
+
+/**
+ * @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 (handles the timestamp if present)
 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
+// Create a default console transport with timestamp enabled by default
+let consoleTransport = new transports.Console({
+    format: format.combine(
+        format.colorize(),
+        format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+        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' }),
         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_HH:mm:ss', maxFile: '14d', maxSize: '20m', zippedArchive: false }})
+/**
+ * Configures logging settings for both console and file transports.
+ * 
+ * @param {LogSettingsOptions} options - The settings for console and file logging.
+ * @example
+ * // Customize console timestamp and enable file logging
+ * log.settings({ 
+ *   console: { 
+ *     enableTimestamp: true,
+ *     timestampFormat: 'YYYY-MM-DD HH:mm:ss',
+ *     timestampPrefix: '[START] ',
+ *     timestampSuffix: ' [END]'
+ *   },
+ *   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 || 'YYYY-MM-DD HH:mm:ss';
+        const timestampPrefix = options.console.timestampPrefix || '';
+        const timestampSuffix = options.console.timestampSuffix || '';
+
+        // Remove the current console transport
+        logger.remove(consoleTransport);
+
+        // Create new console transport based on the provided options
+        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;
+                    })(),
+                    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_HH:mm:ss';
+        const datePattern = options.files.filesName || 'YYYY-MM-DD';
         const maxFiles = options.files.maxFile || '14d';
         const maxSize = options.files.maxSize || '20m';
         const zippedArchive = options.files.zippedArchive !== undefined ? options.files.zippedArchive : false;
@@ -63,28 +139,48 @@ function applySettings(options = {}) {
     }
 }
 
-// Create a simplified logging interface
+/**
+ * Logs a general message using the info level.
+ * 
+ * @param {string} message - Message to be logged.
+ */
 function log(message) {
     logger.info(message);
 }
 
+/**
+ * Logs an error message.
+ * @param {string} message - Error message.
+ */
 log.error = function (message) {
     logger.error(message);
 };
 
+/**
+ * Logs a warning message.
+ * @param {string} message - Warning message.
+ */
 log.warn = function (message) {
     logger.warn(message);
 };
 
+/**
+ * Logs an informational message.
+ * @param {string} message - Informational message.
+ */
 log.info = function (message) {
     logger.info(message);
 };
 
+/**
+ * Logs a debug message.
+ * @param {string} message - Debug message.
+ */
 log.debug = function (message) {
     logger.debug(message);
 };
 
-// Expose the settings function for configuring file logging
+// Expose the settings function for configuring file logging and console output customization
 log.settings = applySettings;
 
 module.exports = log;

package/package.json

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