vite-svg-sprite-generator-plugin 1.1.6 → 1.3.0

package/CHANGELOG.md

@@ -1,332 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## [1.1.6] - 2025-01-28
-
-### 🐛 Bug Fix - Preview Mode Detection
-
-- **FIXED:** Preview mode detection now works correctly
-- **ISSUE:** Plugin was showing validation messages during `vite preview`
-- **ROOT CAUSE:** Vite runs preview as `command="serve"` + `mode="production"`
-- **SOLUTION:** Added smart detection: `serve + production + !SSR = preview`
-
-### 🔍 Changes
-
-```javascript
-// Now correctly detects preview mode
-isLikelyPreview = 
-  isPreview || 
-  resolvedConfig.mode === 'preview' ||
-  (command === 'serve' && mode === 'production' && !build?.ssr);
-```
-
-### ✅ Result
-
-- Preview mode now correctly skips validation ✅
-- Preview mode skips sprite generation ✅
-- Preview runs instantly (0ms) ✅
-- Debug logging shows mode detection ✅
-
-### 📊 Testing
-
-**Before (v1.1.4):**
-```
-vite preview → "Validated icons folder" ❌
-```
-
-**After (v1.1.6):**
-```
-vite preview → "Preview mode detected: skipping" ✅
-```
-
----
-
-## [1.1.4] - 2025-01-21
-
-### ⚡ Performance - Smart Launch Mode
-
-- **NEW:** Intelligent mode detection for preview command
-- **IMPROVED:** Preview mode now skips unnecessary operations  
-- **ADDED:** Automatic command detection (serve/build/preview)
-- **OPTIMIZED:** Preview runs instantly (0ms instead of 583ms)
-- **NEW:** Skipping path validation in preview mode
-- **NEW:** Skipping sprite generation in preview mode
-- **ADDED:** Debug logging to understand Vite mode detection
-- **IMPROVED:** Additional check for `resolvedConfig.mode === 'preview'`
-
-### 🔍 Preview Mode Detection (Fixed)
-
-**Issue:** The plugin was showing validation messages during `vite preview` because Vite runs preview as `command="serve"` + `mode="production"`.
-
-**Fix:** Added smart detection logic:
-- Detects `isPreview` flag
-- Detects `mode === 'preview'`
-- Detects `serve` + `production` combination (typical for preview)
-- Excludes SSR builds from this check
-
-Now the plugin correctly skips validation and sprite generation in preview mode.
-
-Enable `verbose: true` to see debug information: `command`, `isPreview`, `mode`.
-
-### 🎯 Optimization Details
-
-**Before optimization:**
-```javascript
-// Preview mode executed all operations unnecessarily
-npm run preview  // 583ms
-```
-
-**After optimization:**
-```javascript
-// Preview mode intelligently skips work
-npm run preview  // 0ms ⚡
-```
-
-**Performance improvements:**
-- Preview: **-100% time** (0ms vs 583ms)
-- Dev: unchanged (full functionality)
-- Build: unchanged (full functionality)
-
-### 🔧 Internal Changes
-
-- **ADDED:** `command` variable to track Vite command mode
-- **ADDED:** Early return in `configResolved` for preview mode
-- **ADDED:** Early return in `buildStart` for preview mode
-- **IMPROVED:** Better mode detection logic
-- **IMPROVED:** Cleaner logs in preview mode
-
-### 📝 Why These Changes?
-
-In preview mode, the project is already built and the sprite is already in the HTML. There's no need to:
-- Validate paths (project is already built)
-- Scan for icons (no `src/` folder in `dist/`)
-- Generate sprite (already embedded)
-
-### 🎯 Impact
-
-- ✅ Preview mode is now **instant**
-- ✅ Cleaner console output in preview
-- ✅ No breaking changes
-- ✅ Full backward compatibility
-
----
-
-## [1.1.1] - 2025-10-26
-
-### 🔧 Improvements
-
-- **IMPROVED:** Using `vite.normalizePath` utility instead of manual path normalization
-  - Better cross-platform compatibility (handles UNC paths, network drives)
-  - Consistency with Vite ecosystem
-  - Future-proof for Vite API changes
-
-### 📝 Internal Changes
-
-- **REFACTOR:** `validateIconsPath()` now uses `normalizePath(absolutePath)`
-- **REFACTOR:** `handleFileEvent()` in configureServer uses `normalizePath(file)`
-- **ADDED:** Import `{ normalizePath }` from 'vite'
-
-### 📊 Impact
-
-- No breaking changes
-- Better Windows/Unix path handling
-- Improved edge case support (network paths, etc.)
-
----
-
-## [1.1.0] - 2025-10-25
-
-### 🔒 Security
-
-- **NEW:** Path traversal protection via `validateIconsPath()` function
-- **NEW:** `configResolved()` hook for early path validation
-- **IMPROVED:** Precompiled RegExp patterns for SVG sanitization (performance + security)
-- **ADDED:** Detailed error messages with valid/invalid path examples
-- **ADDED:** Protection against reading files outside project root
-
-### ⚡ Performance
-
-- **BREAKING:** Removed all synchronous FS operations (`existsSync`, `statSync`)
-- **NEW:** All FS operations are now fully async (using `access`, `stat` from `fs/promises`)
-- **IMPROVED:** ~20% faster sanitization with precompiled RegExp patterns
-- **IMPROVED:** No event loop blocking - better performance for large projects
-- **IMPROVED:** ~12-18% faster build times for projects with 100+ icons
-
-### 📝 Documentation
-
-- **ADDED:** Comprehensive JSDoc comments with `@security` tags
-- **ADDED:** Examples for safe and unsafe paths in error messages
-- **ADDED:** Performance optimization notes in function documentation
-- **IMPROVED:** Enhanced error messages with helpful tips
-
-### 🔧 Internal Changes
-
-- **REFACTOR:** `findSVGFiles()` now accepts `options` parameter for verbose logging
-- **REFACTOR:** `generateHashFromMtime()` now accepts `pluginState` for cache cleanup
-- **NEW:** `validateIconsPath()` function with comprehensive security checks
-- **NEW:** Variables `viteRoot` and `validatedIconsFolder` for secure path handling
-- **IMPROVED:** Better error handling with detailed context
-
-### 🧪 Testing
-
-- **ADDED:** Comprehensive test suite
-- **ADDED:** Security tests (path traversal, XSS, RegExp patterns)
-- **ADDED:** Performance benchmarks
-- **ADDED:** Architecture validation tests
-- **ADDED:** User case scenarios
-- **ADDED:** Developer experience tests
-
-### 📊 Metrics
-
-| Improvement | Before | After | Change |
-|-------------|--------|-------|--------|
-| Build time (100 SVG) | 250ms | 220ms | **-12%** |
-| Build time (500 SVG) | 1200ms | 980ms | **-18%** |
-| Sanitization (100 files) | 10ms | 8ms | **-20%** |
-| Event loop blocks | Yes | No | **-100%** |
-| Path traversal protection | No | Yes | **+100%** |
-
-### 🚨 Breaking Changes
-
-**NONE** - Fully backward compatible with v1.0.0
-
-### 🔄 Migration Guide
-
-No changes required for existing users. All improvements are transparent.
-
-**Optional recommendations:**
-- Enable verbose mode to see validated paths: `verbose: true`
-- Ensure `iconsFolder` points inside project root (now enforced)
-
----
-
-## [1.0.1] - 2025-10-24
-
-### 🎨 Documentation & Improvements
-
-- **IMPROVED:** Updated README with inline SVG behavior documentation
-- **ADDED:** Clarification that sprite is injected into page DOM
-- **ADDED:** "How It Works" section in README
-- **ADDED:** "Why Inline SVG?" section explaining benefits
-- **IMPROVED:** Better documentation of sprite injection behavior
-
----
-
-## [1.0.0] - 2025-10-23
-
-### 🎉 Initial Release
-
-Production-ready Vite plugin for automatic SVG sprite generation with comprehensive feature set.
-
-### ✨ Features
-
-- 🚀 **SVGO Optimization** - Automatic SVG optimization in production (40-60% size reduction)
-- ⚡ **Hot Module Replacement** - Instant updates without page reload in development
-- 🔒 **Security First** - Built-in XSS protection and path traversal prevention
-- 💾 **Smart Caching** - Efficient LRU-like cache with mtime validation
-- 🎯 **Auto-Injection** - Automatic sprite injection into HTML
-- 🔧 **Fully Configurable** - Extensive customization options
-- 📦 **Zero Config** - Works out of the box with sensible defaults
-- 🌳 **Tree-Shakeable** - Modern ES modules with proper exports
-- 🎨 **TypeScript Support** - Full TypeScript definitions included
-- 📁 **Nested Folders** - Automatic recursive folder scanning
-
-### 🔒 Security
-
-- XSS protection (script tags, event handlers, javascript: URLs)
-- Path traversal prevention with safe path validation
-- File size limits (5MB max) to prevent DoS
-- SVG content sanitization
-- Duplicate symbol ID detection
-
-### ⚡ Performance
-
-- mtime-based hash generation (faster than content hashing)
-- Efficient file caching with automatic invalidation
-- Debounced file watching (configurable delay)
-- Minimal build time impact (~50ms for 100 icons)
-- Memory leak prevention with proper cleanup
-
-### 🎯 Configuration Options
-
-```javascript
-svgSpritePlugin({
-  iconsFolder: 'src/icons',        // Icons directory
-  spriteId: 'icon-sprite',         // Sprite element ID
-  spriteClass: 'svg-sprite',       // Sprite CSS class
-  idPrefix: '',                    // Symbol ID prefix (empty by default)
-  optimize: true,                  // Enable optimization
-  watch: true,                     // Watch for changes in dev
-  debounceDelay: 100,             // HMR debounce delay (ms)
-  verbose: false,                  // Verbose logging
-  svgoOptimize: true,             // SVGO optimization in production
-  svgoConfig: {                    // Custom SVGO configuration
-    // ... custom plugins
-  }
-})
-```
-
-### 📦 Installation
-
-```bash
-# Basic (without SVGO)
-npm install -D vite-svg-sprite-generator-plugin
-
-# Recommended (with SVGO for optimization)
-npm install -D vite-svg-sprite-generator-plugin svgo
-```
-
-**Note:** SVGO is optional! The plugin works without it, but you'll get 40-60% smaller sprites with SVGO installed.
-
-### 🚀 Quick Start
-
-```javascript
-// vite.config.js
-import { defineConfig } from 'vite';
-import svgSpritePlugin from 'vite-svg-sprite-generator-plugin';
-
-export default defineConfig({
-  plugins: [
-    svgSpritePlugin({
-      iconsFolder: 'src/icons'
-    })
-  ]
-});
-```
-
-```html
-<!-- Use in HTML -->
-<svg class="icon">
-  <use href="#home"></use>
-</svg>
-```
-
-### 📚 Documentation
-
-See [README.md](README.md) for comprehensive documentation, examples, and best practices.
-
----
-
-## Legend
-
-- ✨ New features
-- 🔄 Changes
-- 🐛 Bug fixes
-- 🔒 Security
-- ⚡ Performance
-- 📚 Documentation
-- 💾 Caching
-- 🧪 Tests
-- 📦 Dependencies
-- 🎯 Improvements
-- ❌ Removals
-- 🔧 Configuration
-
-## Links
-
-- [NPM Package](https://www.npmjs.com/package/vite-svg-sprite-generator-plugin)
-- [GitHub Repository](https://github.com/german-schneck/vite-svg-sprite-generator-plugin)
-- [Documentation](https://github.com/german-schneck/vite-svg-sprite-generator-plugin#readme)
-- [Issues](https://github.com/german-schneck/vite-svg-sprite-generator-plugin/issues)
-