@mks2508/better-logger 0.0.2-alpha.2 → 0.3.0

package/docs/PACKAGES.md

@@ -0,0 +1,244 @@
+---
+layout: default
+title: Sub-Packages Guide  
+permalink: /packages/
+---
+
+# 📦 Sub-Packages Guide
+
+Better Logger provides modular architecture with independent packages for specific functionality.
+
+## Package Overview
+
+| Package | Description | Size | Dependencies |
+|---------|-------------|------|--------------|
+| `@mks2508/better-logger` | **Main package** - Full functionality | ~45KB | None |
+| `@mks2508/better-logger-core` | **Core logging** - Essential features only | ~15KB | None |
+| `@mks2508/better-logger-styling` | **Styling system** - CSS themes & visuals | ~12KB | core |
+| `@mks2508/better-logger-exports` | **Export handlers** - File, remote, analytics | ~18KB | core |
+
+---
+
+## 🚀 Installation Options
+
+### Full Package (Recommended)
+```bash
+npm install @mks2508/better-logger
+```
+
+### Modular Installation
+```bash
+# Core functionality only
+npm install @mks2508/better-logger-core
+
+# Add styling capabilities  
+npm install @mks2508/better-logger-styling
+
+# Add export functionality
+npm install @mks2508/better-logger-exports
+```
+
+---
+
+## 📋 Package Details
+
+### Core Package (`@mks2508/better-logger-core`)
+
+**What it includes:**
+- ✅ Basic logging methods (debug, info, warn, error, critical)
+- ✅ Log level filtering and verbosity
+- ✅ Performance timing (time/timeEnd)
+- ✅ Stack trace capture
+- ✅ Scoped loggers with prefixes
+- ✅ Basic console grouping
+
+**What it excludes:**
+- ❌ Advanced CSS styling and themes
+- ❌ Export handlers (file, remote, analytics)
+- ❌ CLI interface
+- ❌ SVG banners and animations
+
+```typescript
+// Core-only usage
+import { Logger } from '@mks2508/better-logger-core';
+
+const logger = new Logger();
+logger.info('Basic logging works!');
+logger.time('operation');
+// ... do work
+logger.timeEnd('operation');
+```
+
+### Styling Package (`@mks2508/better-logger-styling`)
+
+**What it adds:**
+- ✅ Advanced CSS gradients and themes
+- ✅ Pre-built theme variants (matrix, cyberpunk, etc.)
+- ✅ Custom style builder with fluent API
+- ✅ SVG banner support
+- ✅ Animation effects for console output
+
+```typescript
+// With styling capabilities
+import { Logger } from '@mks2508/better-logger-core';
+import { applyTheme, StyleBuilder } from '@mks2508/better-logger-styling';
+
+const logger = new Logger();
+applyTheme(logger, 'matrix');
+
+// Custom styling
+const style = new StyleBuilder()
+    .backgroundColor('#1a1a2e')
+    .color('#eee')
+    .fontSize('14px')
+    .build();
+
+logger.info('Styled message', { style });
+```
+
+### Exports Package (`@mks2508/better-logger-exports`)
+
+**What it adds:**
+- ✅ File export handlers (CSV, JSON, XML)
+- ✅ Remote logging to external services
+- ✅ Analytics integration handlers
+- ✅ Custom export format support
+- ✅ Batch processing and buffering
+
+```typescript
+// With export capabilities
+import { Logger } from '@mks2508/better-logger-core';
+import { FileLogHandler, RemoteLogHandler } from '@mks2508/better-logger-exports';
+
+const logger = new Logger();
+
+// Add file export
+logger.addHandler(new FileLogHandler({
+    filename: 'app.log',
+    format: 'json',
+    maxSize: '10MB'
+}));
+
+// Add remote logging
+logger.addHandler(new RemoteLogHandler({
+    endpoint: 'https://api.example.com/logs',
+    apiKey: 'your-key',
+    batchSize: 100
+}));
+```
+
+---
+
+## 🔧 Build Your Own Stack
+
+### Minimal Setup (Core Only)
+Perfect for lightweight applications or libraries.
+
+```typescript
+import { Logger } from '@mks2508/better-logger-core';
+
+const logger = new Logger({ 
+    prefix: '[MyApp]',
+    level: 'info'
+});
+
+export default logger;
+```
+**Bundle size:** ~15KB
+
+### Visual Setup (Core + Styling)
+For applications that need visual appeal in dev tools.
+
+```typescript
+import { Logger } from '@mks2508/better-logger-core';
+import { applyTheme } from '@mks2508/better-logger-styling';
+
+const logger = new Logger();
+applyTheme(logger, 'cyberpunk');
+
+export default logger;
+```
+**Bundle size:** ~27KB
+
+### Full-Featured Setup (All Packages)
+Complete logging solution with all capabilities.
+
+```typescript
+import { Logger } from '@mks2508/better-logger-core';
+import { applyTheme } from '@mks2508/better-logger-styling';
+import { FileLogHandler } from '@mks2508/better-logger-exports';
+
+const logger = new Logger();
+applyTheme(logger, 'matrix');
+logger.addHandler(new FileLogHandler({ filename: 'app.log' }));
+
+export default logger;
+```
+**Bundle size:** ~45KB
+
+---
+
+## 📊 Performance Comparison
+
+| Setup | Bundle Size | Load Time | Memory Usage | Features |
+|-------|-------------|-----------|--------------|----------|
+| Core Only | 15KB | <10ms | <2MB | Basic logging |
+| Core + Styling | 27KB | <15ms | <3MB | Styled output |
+| Core + Exports | 33KB | <20ms | <4MB | With file/remote |
+| Full Package | 45KB | <25ms | <5MB | All features |
+
+---
+
+## 🔄 Migration Guide
+
+### From Full to Modular
+If you want to reduce bundle size:
+
+```typescript
+// Before: Full package
+import { Logger } from '@mks2508/better-logger';
+
+// After: Modular approach
+import { Logger } from '@mks2508/better-logger-core';
+import { applyTheme } from '@mks2508/better-logger-styling'; // Only if needed
+```
+
+### From v0.8.x to v0.1.0-rc.1
+The package structure changed in v0.1.0-rc.1:
+
+```bash
+# Update all packages
+npm update @mks2508/better-logger@0.1.0-rc.1
+npm update @mks2508/better-logger-core@0.1.0-rc.1  
+npm update @mks2508/better-logger-styling@0.1.0-rc.1
+npm update @mks2508/better-logger-exports@0.1.0-rc.1
+```
+
+---
+
+## 🎯 Recommendations
+
+### For Libraries
+Use **core-only** to minimize dependencies:
+```bash
+npm install @mks2508/better-logger-core
+```
+
+### For Applications  
+Use **full package** for complete features:
+```bash
+npm install @mks2508/better-logger
+```
+
+### For Production APIs
+Use **core + exports** for logging + file/remote:
+```bash
+npm install @mks2508/better-logger-core @mks2508/better-logger-exports
+```
+
+### For Development
+Use **full package** with enhanced CLI:
+```bash  
+npm install @mks2508/better-logger
+# Includes interactive CLI, history, plugins, etc.
+```

package/docs/_config.yml

@@ -0,0 +1,36 @@
+title: "Better Logger Documentation"
+description: "State-of-the-art console logger with advanced CSS styling, SVG support, animations, and CLI interface"
+theme: minima
+url: "https://mks2508.github.io"
+baseurl: "/advanced-logger/docs"
+
+markdown: kramdown
+highlighter: rouge
+kramdown:
+  syntax_highlighter: rouge
+
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+  - jekyll-seo-tag
+
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/
+
+header_pages:
+  - API.md
+  - DEVELOPMENT.md
+
+navigation:
+  - title: API Reference
+    url: /advanced-logger/docs/API
+  - title: Development Guide
+    url: /advanced-logger/docs/DEVELOPMENT
+  - title: Live Demo
+    url: /advanced-logger/

package/docs/index.md

@@ -0,0 +1,179 @@
+---
+layout: default
+title: Better Logger Documentation
+---
+
+# 🚀 Better Logger
+
+**State-of-the-art console logger with advanced CSS styling, SVG support, animations, and CLI interface**
+
+[![NPM Version](https://img.shields.io/npm/v/@mks2508/better-logger)](https://www.npmjs.com/package/@mks2508/better-logger)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/@mks2508/better-logger)](https://bundlephobia.com/package/@mks2508/better-logger)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/npm/l/@mks2508/better-logger)](https://github.com/MKS2508/advanced-logger/blob/main/LICENSE)
+
+Transform your console logging experience with beautiful styling, professional themes, and advanced features that make debugging and monitoring a visual delight.
+
+## ✨ Features
+
+- 🎨 **Advanced CSS Styling** - Beautiful gradients, shadows, and animations
+- 🌈 **5 Professional Themes** - Default, Dark, Neon, Cyberpunk, Retro  
+- 🖼️ **SVG Background Support** - Custom graphics in console output
+- ⚡ **Performance Monitoring** - Built-in timing and benchmarking
+- 📊 **Data Export** - CSV, JSON, XML export with filtering
+- 📡 **Remote Logging** - Send logs to external services
+- 💻 **Interactive CLI** - Built-in command interface
+- 🔧 **Modular Architecture** - Import only what you need
+- 📱 **Universal Compatibility** - Browser & Node.js with graceful fallbacks
+- 🎯 **TypeScript First** - Complete type safety and IntelliSense
+
+## 📦 Installation
+
+```bash
+npm install @mks2508/better-logger
+```
+
+## 🚀 Quick Start
+
+```typescript
+import { Logger } from '@mks2508/better-logger';
+
+const logger = new Logger({ prefix: 'APP' });
+
+// Beautiful styled logging
+logger.info('Application started', { version: '1.0.0' });
+logger.success('Database connected successfully');
+logger.warn('Memory usage high', { usage: '85%' });
+logger.error('API request failed', { status: 500 });
+
+// Performance timing
+logger.time('operation');
+await performOperation();
+logger.timeEnd('operation'); // Shows duration with beautiful styling
+```
+
+## 🔧 Modular Usage
+
+Import only what you need for optimal bundle sizes:
+
+```typescript
+// Core logging only (6KB) - Essential features
+import { Logger } from '@mks2508/better-logger/core';
+
+// Styling features (26KB) - Themes, SVG, animations
+import { setTheme, logAnimated } from '@mks2508/better-logger/styling';
+
+// Export capabilities (12KB) - Data export, remote logging
+import { ExportLogger } from '@mks2508/better-logger/exports';
+```
+
+## 📊 Bundle Analysis
+
+| Module | Size | Gzipped | Best For |
+|--------|------|---------|----------|
+| **Core** | 6KB | 2KB | Essential logging, Node.js apps |
+| **Styling** | 26KB | 5KB | Frontend apps, visual debugging |
+| **Exports** | 12KB | 3KB | Production logging, analytics |
+| **Full** | 64KB | 13KB | Complete feature set |
+
+## 📚 Documentation
+
+### 🎮 Interactive Demo
+- **[🌟 Live Demo](https://mks2508.github.io/advanced-logger/)** - Try all features in your browser
+
+### 📖 Complete Documentation
+- **[📋 API Reference](API)** - Complete method documentation
+- **[🛠️ Development Guide](DEVELOPMENT)** - Use cases and development workflow
+
+### 🏃 Examples
+```bash
+# Clone and try examples
+git clone https://github.com/MKS2508/advanced-logger.git
+cd advanced-logger/examples && npm install
+
+npm run basic        # Learn fundamentals
+npm run performance  # Master timing operations
+npm run styling      # Explore visual features
+npm run export       # Data management
+```
+
+## 🎨 Visual Showcase
+
+### Professional Themes
+```typescript
+import { setTheme } from '@mks2508/better-logger/styling';
+
+setTheme('cyberpunk');  // Purple/pink futuristic
+setTheme('neon');       // Bright electric colors
+setTheme('dark');       // Dark mode optimized
+```
+
+### Custom Styling
+```typescript
+import { createStyle } from '@mks2508/better-logger/styling';
+
+const customStyle = createStyle()
+  .bg('linear-gradient(45deg, #667eea, #764ba2)')
+  .color('white')
+  .padding('12px 24px')
+  .rounded('8px')
+  .shadow('0 4px 15px rgba(102, 126, 234, 0.4)')
+  .build();
+
+console.log('%c🚀 Beautiful Custom Style!', customStyle);
+```
+
+## ⚡ Advanced Features
+
+### CLI Interface
+```typescript
+import { initializeCLI } from '@mks2508/better-logger/cli';
+initializeCLI(logger);
+
+// Available in browser console:
+// /help /theme /export /clear /status
+```
+
+### Performance Monitoring
+```typescript
+logger.time('api-request');
+const result = await fetch('/api/data');
+logger.timeEnd('api-request'); // Automatic duration display
+```
+
+### Data Export
+```typescript
+import { ExportLogger } from '@mks2508/better-logger/exports';
+
+const logger = new ExportLogger();
+const csvData = await logger.exportLogs('csv', {
+  filter: { level: 'error' },
+  limit: 100
+});
+```
+
+## 🌐 Compatibility
+
+- ✅ **All Modern Browsers** - Full feature support
+- ✅ **Node.js** - Core features with graceful fallbacks  
+- ✅ **TypeScript** - Complete type definitions
+- ✅ **ESM & CommonJS** - Both module systems supported
+
+## 🔗 Resources
+
+- 📦 **[NPM Package](https://www.npmjs.com/package/@mks2508/better-logger)**
+- 📚 **[GitHub Repository](https://github.com/MKS2508/advanced-logger)**
+- 🧩 **[Examples](https://github.com/MKS2508/advanced-logger/tree/main/examples)**
+- 🐛 **[Issues & Support](https://github.com/MKS2508/advanced-logger/issues)**
+
+## 🤝 Contributing
+
+Contributions welcome! See our [Contributing Guide](https://github.com/MKS2508/advanced-logger/blob/main/CONTRIBUTING.md) for details.
+
+## 📄 License
+
+MIT License - see [LICENSE](https://github.com/MKS2508/advanced-logger/blob/main/LICENSE) for details.
+
+---
+
+**Made with ❤️ by [MKS2508](https://github.com/MKS2508)**

package/examples/README.md

@@ -0,0 +1,208 @@
+# 📚 Better Logger Examples
+
+This directory contains practical examples demonstrating various features of Better Logger.
+
+## 🚀 Quick Start
+
+```bash
+# Install dependencies
+cd examples
+npm install
+
+# Run all examples
+npm run all
+
+# Or run individual examples
+npm run basic        # Basic logging features
+npm run performance  # Performance timing
+npm run styling      # Themes and visual styling  
+npm run export       # Data export and remote logging
+```
+
+## 📋 Available Examples
+
+### 1. 🔤 Basic Logging (`basic-logging.js`)
+
+Learn the fundamentals of logging with Better Logger:
+
+- **Log Levels**: debug, info, warn, error, critical, success
+- **Data Types**: Strings, numbers, booleans, arrays, objects, errors
+- **Message Formatting**: Multiple arguments and structured data
+- **Practical Usage**: Real-world logging scenarios
+
+**Key Features Demonstrated:**
+```javascript
+logger.info('User login', { userId: 123, method: 'oauth' });
+logger.error('Connection failed', error);
+logger.success('Operation completed', { duration: '2.5s' });
+```
+
+**Run:** `npm run basic`
+
+---
+
+### 2. ⏱️ Performance Timing (`performance-timing.js`)
+
+Master performance monitoring and timing operations:
+
+- **Basic Timing**: `time()` and `timeEnd()` operations
+- **Intermediate Timing**: `timeLog()` for step-by-step tracking
+- **Concurrent Operations**: Multiple timers running simultaneously
+- **Nested Timing**: Parent and child operation tracking
+- **Performance Comparison**: Benchmarking different approaches
+
+**Key Features Demonstrated:**
+```javascript
+logger.time('database-query');
+const result = await executeQuery();
+logger.timeLog('database-query', 'Query executed');
+logger.timeEnd('database-query');
+```
+
+**Run:** `npm run performance`
+
+---
+
+### 3. 🎨 Styling & Themes (`styling-themes.js`)
+
+Explore visual customization and theming capabilities:
+
+- **Theme System**: 5 built-in themes (default, dark, neon, cyberpunk, retro)
+- **Banner Types**: ASCII, Unicode, SVG, and animated banners
+- **Custom Styles**: StyleBuilder API for creating unique appearances
+- **Style Presets**: Ready-to-use styles for common scenarios
+- **SVG Integration**: Custom graphics in console output (browser)
+
+**Key Features Demonstrated:**
+```javascript
+setTheme('cyberpunk');
+const customStyle = createStyle()
+  .bg('linear-gradient(45deg, #ff6b6b, #feca57)')
+  .color('white')
+  .padding('12px 24px')
+  .rounded('8px')
+  .build();
+```
+
+**Run:** `npm run styling`
+
+**Note:** Best viewed in browser console for full visual effects.
+
+---
+
+### 4. 📤 Data Export & Remote (`data-export.js`)
+
+Learn data management, export, and remote logging:
+
+- **Log Buffering**: Circular buffer management with configurable size
+- **Export Formats**: CSV, JSON, XML with filtering options
+- **Remote Logging**: HTTP and WebSocket endpoint simulation
+- **Analytics**: Log statistics and performance metrics
+- **Filtering**: Advanced search and filtering capabilities
+
+**Key Features Demonstrated:**
+```javascript
+const csvData = await logger.exportLogs('csv', {
+  filter: { level: 'error', from: yesterday },
+  limit: 100
+});
+
+logger.addRemoteHandler('https://api.logs.com', {
+  apiKey: 'secret-key',
+  batchSize: 10
+});
+```
+
+**Run:** `npm run export`
+
+**Output:** Creates `exports/` directory with sample export files.
+
+---
+
+## 🎯 Learning Path
+
+### Beginner (Start Here)
+1. **Basic Logging** - Learn core logging methods
+2. **Performance Timing** - Add timing to your applications
+
+### Intermediate  
+3. **Styling & Themes** - Customize visual appearance
+4. **Data Export** - Implement log management
+
+### Advanced
+- Combine examples to create comprehensive logging solutions
+- Explore the full [API Reference](../docs/API.md)
+- Check out the [Interactive Demo](https://mks2508.github.io/advanced-logger/)
+
+## 💡 Tips for Running Examples
+
+### Node.js Environment
+All examples work in Node.js, but some visual features are optimized for browsers:
+
+```bash
+# Works everywhere
+npm run basic
+npm run performance
+npm run export
+
+# Limited visual effects in Node.js
+npm run styling
+```
+
+### Browser Environment
+For full visual experience with styling and animations:
+
+1. Import Better Logger in your browser console:
+   ```javascript
+   // Using CDN
+   import('https://unpkg.com/@mks2508/better-logger@latest')
+   ```
+
+2. Copy and paste example code from `styling-themes.js`
+
+### File Outputs
+The `data-export.js` example creates files in the `exports/` directory:
+
+```
+exports/
+├── logs-all.csv        # All logs in CSV format
+├── logs-errors.json    # Error logs in JSON format  
+├── logs-recent.xml     # Recent logs in XML format
+└── logs-24h.json       # Last 24 hours in JSON format
+```
+
+## 🔗 Related Resources
+
+- 📚 [API Reference](../docs/API.md) - Complete method documentation
+- 🎮 [Interactive Demo](https://mks2508.github.io/advanced-logger/) - Try features live
+- 📦 [NPM Package](https://www.npmjs.com/package/@mks2508/better-logger) - Installation guide
+- 🐛 [Issues & Support](https://github.com/MKS2508/advanced-logger/issues) - Get help
+
+## 🤝 Contributing Examples
+
+Have a useful logging pattern or use case? We'd love to see your examples!
+
+1. Create a new `.js` file following the existing pattern
+2. Add a script to `package.json`
+3. Update this README with documentation
+4. Submit a pull request
+
+**Example Template:**
+```javascript
+/**
+ * [Feature Name] Example
+ * 
+ * Demonstrates [specific capabilities] including:
+ * - Feature 1
+ * - Feature 2
+ * - Feature 3
+ * 
+ * Run: node examples/your-example.js
+ */
+
+// Your example code here
+```
+
+---
+
+Happy logging! 🎉