chromalogger 1.1.1 → 1.1.2

package/CHROMA.md

@@ -0,0 +1,253 @@
+# Chroma Utility
+
+[🇬🇧 English](#chroma-utility) | [🇫🇷 Français](#utilitaire-chroma)
+
+## Chroma Utility
+
+Chroma is a simple utility function for styling console text output in Node.js applications. It's part of the ChromaLogger package and provides a convenient way to apply ANSI color and style codes to your console output.
+
+## 🔧 Installation
+
+Chroma is included with ChromaLogger. No additional installation is needed if you already have ChromaLogger installed.
+
+```bash
+# If you need to install ChromaLogger
+npm install chromalogger
+# or
+yarn add chromalogger
+```
+
+## 🚀 Quick Start
+
+```javascript
+import chroma from 'chromalogger/utils/chroma.js';
+
+// Basic usage
+chroma('This text is red and bold', 'red', 'bright');
+
+// Multiple styles
+chroma('Blue text on white background', 'blue', 'bgWhite');
+
+// Using with template literals
+const name = 'Alice';
+chroma(`Hello, ${name}!`, 'green', 'underline');
+```
+
+## 📚 API Reference
+
+### `chroma(text, ...styleNames)`
+
+Applies the specified styles to the text and logs it to the console.
+
+**Parameters:**
+- `text` (string): The text to style and log
+- `...styleNames` (string): One or more style names to apply
+
+**Returns:** `undefined`
+
+## 🎨 Available Styles
+
+### Text Colors
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`
+
+### Background Colors
+- `bgBlack`
+- `bgRed`
+- `bgGreen`
+- `bgYellow`
+- `bgBlue`
+- `bgMagenta`
+- `bgCyan`
+- `bgWhite`
+
+### Text Styles
+- `bright` (bold)
+- `dim`
+- `italic`
+- `underline`
+- `blink`
+- `reverse` (swap foreground and background)
+- `hidden`
+- `strikethrough`
+
+## 📝 Examples
+
+### Basic Usage
+
+```javascript
+import chroma from 'chromalogger/utils/chroma.js';
+
+// Simple colored text
+chroma('Error: Something went wrong!', 'red');
+
+// Multiple styles
+chroma('Warning: This is important!', 'yellow', 'bright', 'underline');
+
+// Background color
+chroma('Success!', 'green', 'bgBlack');
+```
+
+### Advanced Usage
+
+```javascript
+// Create reusable styled log functions
+const success = (text) => chroma(text, 'green', 'bright');
+const error = (text) => chroma(text, 'red', 'bright');
+const warning = (text) => chroma(text, 'yellow', 'bright');
+
+// Use them throughout your application
+success('Operation completed successfully!');
+error('Failed to connect to the server');
+warning('This feature is deprecated');
+
+// Conditional styling
+const status = 'success';
+chroma(
+  `Status: ${status}`, 
+  status === 'success' ? 'green' : 'red',
+  'bright'
+);
+```
+
+## ⚠️ Notes
+
+- Chroma is designed for Node.js environments with console support
+- Colors may not display correctly in all terminals
+- For more complex logging needs, consider using the full ChromaLogger package
+
+## 📄 License
+
+MIT - See [LICENSE](LICENSE) for more information.
+
+---
+
+## Utilitaire Chroma
+
+[🇬🇧 English](#chroma-utility) | [🇫🇷 Français](#utilitaire-chroma)
+
+## 📦 Installation
+
+Chroma est inclus avec ChromaLogger. Aucune installation supplémentaire n'est nécessaire si vous avez déjà installé ChromaLogger.
+
+```bash
+# Si vous devez installer ChromaLogger
+npm install chromalogger
+# ou
+yarn add chromalogger
+```
+
+## 🚀 Démarrage Rapide
+
+```javascript
+import chroma from 'chromalogger/utils/chroma.js';
+
+// Utilisation de base
+chroma('Ce texte est en rouge et en gras', 'red', 'bright');
+
+// Styles multiples
+chroma('Texte bleu sur fond blanc', 'blue', 'bgWhite');
+
+// Avec des littéraux de gabarit
+const nom = 'Alice';
+chroma(`Bonjour, ${nom} !`, 'green', 'underline');
+```
+
+## 📚 Référence de l'API
+
+### `chroma(texte, ...nomsStyles)`
+
+Applique les styles spécifiés au texte et l'affiche dans la console.
+
+**Paramètres :**
+- `texte` (string) : Le texte à styliser et à afficher
+- `...nomsStyles` (string) : Un ou plusieurs noms de styles à appliquer
+
+**Retourne :** `undefined`
+
+## 🎨 Styles Disponibles
+
+### Couleurs de texte
+- `black` (noir)
+- `red` (rouge)
+- `green` (vert)
+- `yellow` (jaune)
+- `blue` (bleu)
+- `magenta` (magenta)
+- `cyan` (cyan)
+- `white` (blanc)
+
+### Couleurs d'arrière-plan
+- `bgBlack` (fond noir)
+- `bgRed` (fond rouge)
+- `bgGreen` (fond vert)
+- `bgYellow` (fond jaune)
+- `bgBlue` (fond bleu)
+- `bgMagenta` (fond magenta)
+- `bgCyan` (fond cyan)
+- `bgWhite` (fond blanc)
+
+### Styles de texte
+- `bright` (gras)
+- `dim` (atténué)
+- `italic` (italique)
+- `underline` (souligné)
+- `blink` (clignotant)
+- `reverse` (inverse les couleurs)
+- `hidden` (caché)
+- `strikethrough` (barré)
+
+## 📝 Exemples
+
+### Utilisation de Base
+
+```javascript
+import chroma from 'chromalogger/utils/chroma.js';
+
+// Texte coloré simple
+chroma('Erreur : Quelque chose a mal tourné !', 'red');
+
+// Styles multiples
+chroma('Attention : Ceci est important !', 'yellow', 'bright', 'underline');
+
+// Couleur d'arrière-plan
+chroma('Succès !', 'green', 'bgBlack');
+```
+
+### Utilisation Avancée
+
+```javascript
+// Créer des fonctions de log réutilisables
+const succes = (texte) => chroma(texte, 'green', 'bright');
+const erreur = (texte) => chroma(texte, 'red', 'bright');
+const avertissement = (texte) => chroma(texte, 'yellow', 'bright');
+
+// Les utiliser dans votre application
+succes('Opération réussie !');
+erreur('Échec de la connexion au serveur');
+avertissement('Cette fonctionnalité est obsolète');
+
+// Style conditionnel
+const statut = 'succes';
+chroma(
+  `Statut : ${statut}`, 
+  statut === 'succes' ? 'green' : 'red',
+  'bright'
+);
+```
+
+## ⚠️ Notes
+
+- Chroma est conçu pour les environnements Node.js avec support de la console
+- Les couleurs peuvent ne pas s'afficher correctement dans tous les terminaux
+- Pour des besoins de journalisation plus complexes, envisagez d'utiliser le module ChromaLogger complet
+
+## 📄 Licence
+
+MIT - Voir [LICENCE](LICENSE) pour plus d'informations.

package/INFO.md

@@ -0,0 +1,128 @@
+# Guide d'utilisation des niveaux de log
+
+Ce document explique comment utiliser efficacement les différents niveaux de log dans la bibliothèque ChromaLogger.
+
+## Table des matières
+
+- [Introduction aux niveaux de log](#introduction-aux-niveaux-de-log)
+- [Les différents niveaux disponibles](#les-différents-niveaux-disponibles)
+- [Comment définir le niveau de log](#comment-définir-le-niveau-de-log)
+- [Exemples d'utilisation](#exemples-dutilisation)
+- [Bonnes pratiques](#bonnes-pratiques)
+- [Dépannage](#dépannage)
+
+## Introduction aux niveaux de log
+
+Les niveaux de log vous permettent de contrôler la quantité d'informations affichées dans vos journaux. Cela est particulièrement utile pour :
+
+- Déboguer des problèmes en production
+- Réduire le bruit dans les logs en production
+- Activer/désactiver des logs détaillés selon l'environnement
+
+## Les différents niveaux disponibles
+
+La bibliothèque supporte 5 niveaux de log, du plus bas au plus élevé :
+
+| Niveau  | Valeur | Description                                              |
+| ------- | ------ | -------------------------------------------------------- |
+| `DEBUG` | 0      | Niveau le plus détaillé, utilisé pour le débogage        |
+| `INFO`  | 1      | Informations générales sur le déroulement du programme   |
+| `WARN`  | 2      | Situations potentiellement problématiques                |
+| `ERROR` | 3      | Erreurs qui n'empêchent pas l'application de fonctionner |
+| `NONE`  | 4      | Aucun log ne sera affiché                                |
+
+## Comment définir le niveau de log
+
+Utilisez la fonction `setLogLevel()` pour définir le niveau de log :
+
+```javascript
+import { setLogLevel, LOG_LEVELS } from './index.js';
+
+// Méthode 1 : Utiliser le nom du niveau
+setLogLevel('DEBUG'); // Affiche tous les messages
+setLogLevel('INFO'); // Affiche INFO, WARN et ERROR
+setLogLevel('WARN'); // Affiche WARN et ERROR
+setLogLevel('ERROR'); // Affiche uniquement les erreurs
+setLogLevel('NONE'); // Désactive tous les logs
+
+// Méthode 2 : Utiliser la constante LOG_LEVELS
+setLogLevel(LOG_LEVELS.DEBUG);
+```
+
+## Exemples d'utilisation
+
+### Configuration de base
+
+```javascript
+import { setLogLevel, log, debug, info, warn, error } from './index.js';
+
+// Définir le niveau de log (par défaut: INFO)
+setLogLevel('DEBUG');
+
+// Ces logs s'afficheront selon le niveau défini
+debug('Message de débogage'); // Niveau DEBUG (0)
+log('Message standard'); // Niveau INFO (1)
+info('Information'); // Niveau INFO (1)
+warn('Avertissement'); // Niveau WARN (2)
+error('Erreur'); // Niveau ERROR (3)
+```
+
+### Utilisation dans différents environnements
+
+```javascript
+// Dans votre configuration d'environnement
+const environment = process.env.NODE_ENV || 'development';
+
+// Définir le niveau de log selon l'environnement
+if (environment === 'production') {
+  setLogLevel('WARN'); // En production, on ne veut que les avertissements et erreurs
+} else {
+  setLogLevel('DEBUG'); // En développement, on veut tout voir
+}
+```
+
+## Bonnes pratiques
+
+1. **Environnement de développement** : Utilisez `DEBUG` ou `INFO` pour avoir un maximum d'informations
+2. **Environnement de test** : Utilisez `INFO` pour suivre l'exécution des tests
+3. **Environnement de production** : Utilisez `WARN` ou `ERROR` pour éviter la surcharge de logs
+4. **Pour le débogage** : Passez temporairement en `DEBUG` pour résoudre des problèmes spécifiques
+5. **Évitez les logs inutiles** : Ne laissez pas de logs de débogage en production
+
+## Dépannage
+
+### Problème : Mes logs ne s'affichent pas
+
+1. Vérifiez que le niveau de log est correctement défini :
+
+   ```javascript
+   import { setLogLevel } from './index.js';
+   setLogLevel('DEBUG'); // Pour voir tous les logs
+   ```
+
+2. Vérifiez que vous utilisez la bonne fonction de log :
+   - `log()` et `info()` : Niveau INFO (1)
+   - `debug()` : Niveau DEBUG (0)
+   - `warn()` : Niveau WARN (2)
+   - `error()` : Niveau ERROR (3)
+
+### Problème : Trop de logs en production
+
+Augmentez le niveau de log pour réduire le bruit :
+
+```javascript
+// En production
+setLogLevel('WARN'); // N'affiche que les avertissements et erreurs
+```
+
+### Problème : Les logs sont désactivés
+
+Vérifiez que le niveau n'est pas défini sur `NONE` :
+
+```javascript
+setLogLevel('INFO'); // Réactive les logs d'information et supérieurs
+```
+
+## Conclusion
+
+La gestion des niveaux de log est un outil puissant pour maintenir et déboguer vos applications. En utilisant correctement les différents niveaux, vous pouvez garder une trace utile de ce qui se passe dans votre application sans être submergé par trop d'informations.