logxpert 0.2.0 → 0.3.1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+augustin.pro.prs@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 lighscent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/PATCHNOTE.fr.md

@@ -0,0 +1,18 @@
+# Notes de Version
+
+## v0.3.1
+
+- Ajout de la création automatique du dossier de logs s'il n'existe pas afin d'éviter l'erreur `ENOENT`.
+
+## v0.3.0
+
+- 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).
+- 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.

package/PATCHNOTE.md

@@ -0,0 +1,18 @@
+# Patch Notes
+
+## v0.3.1
+
+- Ensure 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.

package/README.fr.md

@@ -1,6 +1,15 @@
 # LogXpert
 
-LogXpert est une bibliothèque de log puissante pour Node.js qui offre des méthodes de log simples à utiliser avec un affichage coloré et formaté.
+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.
+
+## 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)
+- [Référence API](#référence-api)
+- [Informations Supplémentaires](#informations-supplémentaires)
+- [Licence](#licence)
 
 ## Installation
 
@@ -12,31 +21,79 @@ npm install logxpert
 
 ## Utilisation
 
-Importez LogXpert dans votre projet :
+### Journalisation de base
+
+Importez LogXpert dans votre projet et utilisez-le pour enregistrer des messages :
 
 ```js
 const log = require('logxpert');
 
-// Log global
+// Journalisation d'un message général
 log('Ceci est un message de log général.');
 
-// Log d'erreur
+// Journalisation d'un message d'erreur
 log.error("Ceci est un message d'erreur.");
 
-// Log d'avertissement
+// Journalisation d'un message d'avertissement
 log.warn("Ceci est un message d'avertissement.");
 
-// Log d'info
+// Journalisation d'un message d'information
 log.info("Ceci est un message d'information.");
 
-// Log de debug
+// Journalisation d'un message de debug
 log.debug("Ceci est un message de debug.");
 ```
 
-## Structure du Projet
+### Journalisation avancée : Fichiers de logs
+
+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.
+
+Exemple de configuration pour activer l'enregistrement dans un fichier :
+
+```js
+const log = require('logxpert');
+
+log.settings({ 
+    files: { 
+        folder: 'logs', 
+        filesName: 'YYYY-MM-DD_HH:mm:ss', 
+        maxFile: '14d', 
+        maxSize: '20m', 
+        zippedArchive: true 
+    }
+});
+```
+
+## Référence API
+
+- **log(message: string):**  
+  Enregistre un message général avec le niveau `info`.
+
+- **log.error(message: string):**  
+  Enregistre un message d'erreur.
+
+- **log.warn(message: string):**  
+  Enregistre un message d'avertissement.
+
+- **log.info(message: string):**  
+  Enregistre un message d'information.
+
+- **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 :
+
+  - `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'`).
+  - `maxSize` (string) : Taille maximale par fichier de log (par défaut : `'20m'`).
+  - `zippedArchive` (boolean) : Archive les logs au format zip (par défaut : `false`).
+
+## Informations Supplémentaires
 
-- [main.js](c:\Users\x\Desktop\powerlogs\main.js) - Point d'entrée avec la fonctionnalité de log.
-- [package.json](c:\Users\x\Desktop\powerlogs\package.json) - Configuration du package.
+- [Version Anglaise](./README.md)
+- [Notes de Version](./PATCHNOTE.fr.md)
 
 ## Licence
 

package/README.md

@@ -1,6 +1,101 @@
 # LogXpert
 
-Please choose your language:
+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.
 
-- [English Version](./README.en.md)
-- [Version Française](./README.fr.md)
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Logging](#basic-logging)
+  - [Advanced Logging: File Output](#advanced-logging-file-output)
+- [API Reference](#api-reference)
+- [Additional Information](#additional-information)
+- [License](#license)
+
+## Installation
+
+You can install LogXpert using npm:
+
+```sh
+npm install logxpert
+```
+
+## Usage
+
+### Basic Logging
+
+Import LogXpert in your project and use it to log messages:
+
+```js
+const log = require('logxpert');
+
+// Log a general message
+log('This is a general log message.');
+
+// Log an error message
+log.error('This is an error message.');
+
+// Log a warning message
+log.warn('This is a warning message.');
+
+// Log an informational message
+log.info('This is an informational message.');
+
+// Log a debug message
+log.debug('This is a debug message.');
+```
+
+### Advanced Logging: File Output
+
+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.
+
+Example configuration to enable file logging:
+
+```js
+const log = require('logxpert');
+
+log.settings({ 
+    files: { 
+        folder: 'logs', 
+        filesName: 'YYYY-MM-DD_HH:mm:ss', 
+        maxFile: '14d', 
+        maxSize: '20m', 
+        zippedArchive: true 
+    }
+});
+```
+
+### API Reference
+
+- **log(message: string):**  
+  Logs a general message using the `info` level.
+
+- **log.error(message: string):**  
+  Logs an error message.
+
+- **log.warn(message: string):**  
+  Logs a warning message.
+
+- **log.info(message: string):**  
+  Logs an informational message.
+
+- **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**:
+  
+  - `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'`).
+  - `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`).
+
+## Additional Information
+
+- [French Version](./README.fr.md)
+- [Patch Notes](./PATCHNOTE.md)
+
+## License
+
+This project is licensed under the MIT License.

package/main.js

@@ -1,34 +1,90 @@
-const colors = {
-    reset: "\x1b[0m",
-    red: "\x1b[31m",
-    yellow: "\x1b[33m",
-    cyan: "\x1b[36m",
-    magenta: "\x1b[35m",
-    white: "\x1b[37m"
-};
+const fs = require('fs');
+const { createLogger, format, transports } = require('winston');
+require('winston-daily-rotate-file');
+
+// Custom format for logger
+const customFormat = format.printf(({ timestamp, level, message }) => {
+    return `${timestamp} [${level}]: ${message}`;
+});
+
+// Create a logger with console transport only
+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
+            )
+        })
+    ]
+});
+
+// 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 }})
+function applySettings(options = {}) {
+    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 maxFiles = options.files.maxFile || '14d';
+        const maxSize = options.files.maxSize || '20m';
+        const zippedArchive = options.files.zippedArchive !== undefined ? options.files.zippedArchive : false;
 
-function colorText(text, color) {
-    return `${color}${text}${colors.reset}`;
+        // Ensure the log folder exists
+        if (!fs.existsSync(folder)) {
+            fs.mkdirSync(folder, { recursive: true });
+        }
+
+        // Remove existing file transport if it exists
+        if (fileTransport) {
+            logger.remove(fileTransport);
+        }
+
+        // Create a new daily rotate file transport with provided/default settings
+        fileTransport = new transports.DailyRotateFile({
+            filename: `${folder}/application-%DATE%.log`,
+            datePattern,
+            zippedArchive,
+            maxSize,
+            maxFiles
+        });
+
+        logger.add(fileTransport);
+    }
 }
 
+// Create a simplified logging interface
 function log(message) {
-    console.log(colorText(message, colors.white));
+    logger.info(message);
 }
 
 log.error = function (message) {
-    console.error(colorText(`Error: ${message}`, colors.red));
+    logger.error(message);
 };
 
 log.warn = function (message) {
-    console.warn(colorText(`Warn: ${message}`, colors.yellow));
+    logger.warn(message);
 };
 
 log.info = function (message) {
-    console.info(colorText(`Info: ${message}`, colors.cyan));
+    logger.info(message);
 };
 
 log.debug = function (message) {
-    console.debug(colorText(`Debug: ${message}`, colors.magenta));
+    logger.debug(message);
 };
 
+// Expose the settings function for configuring file logging
+log.settings = applySettings;
+
 module.exports = log;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logxpert",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "A powerful logging library for Node.js",
   "main": "main.js",
   "repository": {
@@ -8,5 +8,9 @@
     "url": "git+https://github.com/lighscent/LogXpert.git"
   },
   "author": "https://github.com/lighscent",
-  "license": "MIT"
+  "license": "MIT",
+  "dependencies": {
+    "winston": "^3.17.0",
+    "winston-daily-rotate-file": "^5.0.0"
+  }
 }

package/README.en.md

@@ -1,43 +0,0 @@
-# LogXpert
-
-LogXpert is a powerful logging library for Node.js that provides easy-to-use logging methods with colorful formatted output.
-
-## Installation
-
-Install LogXpert using npm:
-
-```sh
-npm install logxpert
-```
-
-## Usage
-
-Import LogXpert in your project:
-
-```js
-const log = require('logxpert');
-
-// Global log
-log('This is a general log message.');
-
-// Error log
-log.error('This is an error message.');
-
-// Warning log
-log.warn('This is a warning message.');
-
-// Info log
-log.info('This is an informational message.');
-
-// Debug log
-log.debug('This is a debug message.');
-```
-
-## Project Structure
-
-- [main.js](c:\Users\x\Desktop\powerlogs\main.js) - Entry point with the logging functionality.
-- [package.json](c:\Users\x\Desktop\powerlogs\package.json) - Package configuration.
-
-## License
-
-This project is licensed under the MIT License.