svger-cli 2.0.8 → 3.1.0

package/CHANGELOG.md

@@ -5,6 +5,327 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.0] - 2025-12-04
+
+### 🚀 Major Improvements - Testing & DevOps
+
+This release brings comprehensive testing infrastructure and production-grade CI/CD pipelines, significantly improving project reliability and developer experience.
+
+### Added - Testing Infrastructure
+
+#### **Comprehensive Test Suite** 📋
+- ✅ **114 automated tests** covering unit, integration, and E2E scenarios
+- ✅ **Jest integration** with TypeScript support and ESM modules
+- ✅ **82.5% initial pass rate** with well-structured test cases
+- ✅ **7 test suites**:
+  - `builder.test.ts` - Build orchestration and parallel processing (7 tests)
+  - `cli.test.ts` - CLI command parsing and execution (13 tests)
+  - `config-service.test.ts` - Configuration validation and loading (17 tests)
+  - `integration.test.ts` - End-to-end workflow testing (19 tests)
+  - `svg-processor.test.ts` - SVG parsing and optimization (11 tests)
+  - `templates.test.ts` - Framework template generation (22 tests)
+  - `utils.test.ts` - Utility functions and FileSystem operations (26 tests)
+- ✅ **Test fixtures** with 11 SVG variations (simple, complex, nested, gradients, accessibility, animated)
+- ✅ **Code coverage** configured with 70% threshold across branches, functions, lines, statements
+- ✅ **Coverage reporters**: text, text-summary, lcov, html, json, clover
+- ✅ **Test documentation** in `src/__tests__/README.md` with best practices and debugging guides
+
+#### **New Test Scripts** 🧪
+- `npm run test:jest` - Run all Jest tests
+- `npm run test:unit` - Run unit tests only
+- `npm run test:watch` - Watch mode for development
+- `npm run test:coverage` - Generate coverage reports
+- `npm test` - Run complete test suite (Jest + framework + config + E2E + integrations)
+
+### Added - CI/CD Infrastructure
+
+#### **GitHub Actions Workflows** 🔄
+- ✅ **Release workflow** (`.github/workflows/release.yml`):
+  - Automated version bumping and changelog generation
+  - Multi-platform Docker builds (linux/amd64, linux/arm64)
+  - NPM package publishing with provenance
+  - Documentation deployment to GitHub Pages
+  - Codecov integration for coverage tracking
+  - Snyk security scanning
+  - Slack notifications for releases
+  - GitHub Release creation with assets
+- ✅ **CI workflow** enhancements for automated testing
+
+#### **Jenkins Pipeline** 🏗️
+- ✅ **Complete Jenkinsfile** with 11 stages:
+  1. Checkout - Git repository cloning
+  2. Setup - Node.js environment configuration
+  3. Install - Dependency installation with caching
+  4. Lint - Code quality checks
+  5. Build - TypeScript compilation
+  6. Test - Parallel test execution (unit, integration, E2E)
+  7. Security - Dependency vulnerability scanning
+  8. Package - NPM package creation
+  9. Docker - Multi-architecture image builds
+  10. Release - Version management and publishing
+  11. Push - Docker registry updates
+- ✅ **Build parameters** for version bumping and branch selection
+- ✅ **Parallel execution** for faster builds
+- ✅ **Artifact preservation** and workspace cleanup
+- ✅ **Email notifications** for build status
+
+#### **Docker Support** 🐳
+- ✅ **Multi-stage Dockerfile**:
+  - Alpine-based production image
+  - Non-root user for security
+  - Health checks configured
+  - Multi-architecture support (amd64, arm64)
+  - Optimized layer caching
+- ✅ **docker-compose.yml** with 6 profiles:
+  - `dev` - Development environment with volume mounts
+  - `prod` - Production deployment
+  - `test` - Test execution environment
+  - `watch` - File watching for auto-rebuild
+  - `ci` - CI/CD pipeline execution
+  - `docs` - Documentation server (nginx)
+- ✅ **Docker optimization**:
+  - `.dockerignore` for efficient builds
+  - Volume mounts for workspace persistence
+  - Environment variable configuration
+  - Network isolation
+
+#### **Validation & Documentation** 📚
+- ✅ **CI/CD validation script** (`scripts/validate-cicd.sh`):
+  - Project structure verification
+  - NPM scripts validation
+  - Dependencies check
+  - TypeScript configuration
+  - Build verification
+  - YAML syntax validation
+  - Docker and Jenkinsfile validation
+  - Security and documentation checks
+- ✅ **Comprehensive documentation**:
+  - `CICD.md` - Complete CI/CD setup guide
+  - `CICD-QUICKREF.md` - Quick reference for developers
+  - `CICD-SETUP-CHECKLIST.md` - Step-by-step setup instructions
+  - `CI-CD-IMPLEMENTATION-REPORT.md` - Implementation summary
+  - `TEST-SUITE-SUMMARY.md` - Test suite documentation
+
+### Changed - Configuration
+
+#### **Jest Configuration**
+- 🔧 Renamed `jest.config.js` → `jest.config.cjs` for ES module compatibility
+- 🔧 Renamed `jest.setup.js` → `jest.setup.cjs`
+- 🔧 Updated module name mapper for `.js` extension handling
+- 🔧 Added test path ignoring for build artifacts and temporary files
+- 🔧 Configured parallel execution with 50% max workers
+- 🔧 Added fixtures exclusion from test runs
+
+#### **Package.json**
+- 🔧 Updated test scripts to include Jest integration
+- 🔧 Added new npm scripts for granular test execution
+- 🔧 Main test script now runs comprehensive suite
+
+### Improved - Developer Experience
+
+#### **Documentation**
+- 📖 **README.md** enhanced with:
+  - Complete project structure tree
+  - NPM download and version badges
+  - Test suite information
+  - CI/CD pipeline documentation links
+- 📖 **Test documentation** with:
+  - Writing tests best practices
+  - Debugging guides
+  - CI/CD integration instructions
+  - Troubleshooting section
+  - Coverage information
+
+#### **Code Quality**
+- ✨ Structured test organization following industry standards
+- ✨ AAA pattern (Arrange, Act, Assert) in test cases
+- ✨ Proper cleanup with beforeEach/afterEach hooks
+- ✨ Comprehensive edge case coverage
+- ✨ Reusable test fixtures and utilities
+
+### Fixed
+
+- 🐛 Jest configuration compatibility with ES modules
+- 🐛 TypeScript compilation in test environment
+- 🐛 Module resolution for test imports
+- 🐛 Docker permission handling in validation scripts
+
+### Security
+
+- 🔒 Snyk integration for vulnerability scanning
+- 🔒 Automated dependency auditing in CI/CD
+- 🔒 Non-root Docker user for container security
+- 🔒 NPM provenance for package authenticity
+
+### Performance
+
+- ⚡ Parallel test execution for faster validation
+- ⚡ Docker layer caching optimization
+- ⚡ Multi-stage builds for smaller images
+- ⚡ Jest worker optimization (50% CPU allocation)
+
+### Testing Coverage
+
+- 🎯 **94/114 tests passing** (82.5% success rate)
+- 🎯 **4/7 test suites** fully passing
+- 🎯 Coverage targets: 70% for branches, functions, lines, statements
+- 🎯 Multiple coverage formats: text, lcov, html, json, clover
+
+### CI/CD Metrics
+
+- 📊 **11-stage Jenkins pipeline** for complete automation
+- 📊 **6 Docker Compose profiles** for different environments
+- 📊 **Multi-architecture builds** (linux/amd64, linux/arm64)
+- 📊 **Automated release workflow** with GitHub Actions
+- 📊 **Comprehensive validation** with 10+ checks
+
+---
+
+## [3.0.0] - 2025-11-26
+
+### 🎉 Major Release - Official Build Tool Integrations
+
+This major release introduces **official build tool integrations**, making SVGER-CLI the most
+comprehensive SVG-to-component solution with first-class support for all major build tools and
+frameworks.
+
+### Added - Build Tool Integrations
+
+#### **Webpack Integration** (`svger-cli/webpack`)
+
+- ✅ Full webpack plugin with HMR (Hot Module Replacement) support
+- ✅ Webpack loader for inline SVG transformation
+- ✅ Watch mode with intelligent debouncing
+- ✅ Asset emission directly to webpack compilation
+- ✅ TypeScript support with full type definitions
+- ✅ Multi-framework support (React, Vue, Angular, etc.)
+
+#### **Vite Plugin** (`svger-cli/vite`)
+
+- ✅ Native Vite plugin with lightning-fast HMR
+- ✅ Virtual module support for dynamic imports
+- ✅ Dev server integration with instant updates
+- ✅ Build optimization and tree-shaking
+- ✅ Named and default export options
+- ✅ Source map generation
+
+#### **Rollup Plugin** (`svger-cli/rollup`)
+
+- ✅ Full Rollup plugin with tree-shaking support
+- ✅ Load and transform hooks for SVG files
+- ✅ Source map generation for debugging
+- ✅ Bundle optimization for production
+- ✅ Library-friendly named exports
+- ✅ Zero runtime overhead
+
+#### **Babel Plugin** (`svger-cli/babel`)
+
+- ✅ Complete Babel plugin with visitor pattern
+- ✅ Automatic import transformation (SVG → Component)
+- ✅ Dynamic import support (`import('./icon.svg')`)
+- ✅ Pre-build SVG processing
+- ✅ Works with Create React App, Gatsby, Vue CLI
+- ✅ Framework-agnostic with full TypeScript support
+
+#### **Next.js Integration** (`svger-cli/nextjs`)
+
+- ✅ `withSvger` wrapper for seamless Next.js integration
+- ✅ Server-Side Rendering (SSR) support
+- ✅ App Router and Pages Router compatibility
+- ✅ Webpack configuration extension
+- ✅ Hot Module Replacement for development
+- ✅ TypeScript support out of the box
+
+#### **Jest Preset** (`svger-cli/jest`)
+
+- ✅ Complete Jest transformer for SVG files
+- ✅ Jest preset configuration
+- ✅ Custom transformer factory
+- ✅ Mock mode for faster test execution
+- ✅ CommonJS and ES module support
+- ✅ Multi-framework compatibility
+
+### Added - Package Infrastructure
+
+- **11 New Export Paths**: Added dedicated exports for all integrations
+  - `./webpack`, `./webpack-loader`
+  - `./vite`
+  - `./rollup`
+  - `./babel`, `./babel-plugin`
+  - `./nextjs`
+  - `./jest`, `./jest-transformer`, `./jest-preset`
+
+- **Comprehensive Documentation**:
+  - New `docs/INTEGRATIONS.md` - Complete integration guide (500+ lines)
+  - New `docs/INTEGRATION-IMPLEMENTATION-SUMMARY.md` - Implementation overview
+  - 6 example configuration files in `examples/` directory
+  - Updated API documentation with integration examples
+
+- **Enhanced Testing**:
+  - New integration verification test suite
+  - 100% integration test coverage (7/7 passing)
+  - Automated testing for all build tool integrations
+  - New `test:integrations` npm script
+
+- **Updated Keywords**: Added 18+ new npm keywords:
+  - Build tools: `webpack`, `webpack-plugin`, `webpack-loader`
+  - Bundlers: `vite`, `vite-plugin`, `rollup`, `rollup-plugin`
+  - Transpilers: `babel`, `babel-plugin`, `babel-transform`
+  - Frameworks: `nextjs`, `next-js`
+  - Testing: `jest`, `jest-preset`, `jest-transformer`
+  - General: `build-tools`, `bundler`, `hmr`, `hot-module-replacement`
+
+### Changed
+
+- **Package Description**: Updated to highlight official build tool integrations
+- **Main Index**: Reorganized exports to include all integration plugins
+- **Type Definitions**: Enhanced TypeScript types for all integrations
+- **Documentation Structure**: Improved organization with dedicated integration docs
+
+### Features Comparison
+
+| Feature            | Webpack | Vite | Rollup | Babel | Next.js | Jest |
+| ------------------ | ------- | ---- | ------ | ----- | ------- | ---- |
+| HMR Support        | ✅      | ✅   | ❌     | ❌    | ✅      | N/A  |
+| Source Maps        | ✅      | ✅   | ✅     | ❌    | ✅      | ❌   |
+| SSR Support        | ❌      | ✅   | ❌     | ❌    | ✅      | N/A  |
+| Virtual Modules    | ❌      | ✅   | ❌     | ❌    | ❌      | N/A  |
+| Watch Mode         | ✅      | ✅   | ✅     | ✅    | ✅      | N/A  |
+| Import Transform   | ✅      | ✅   | ✅     | ✅    | ✅      | ✅   |
+| Dynamic Imports    | ✅      | ✅   | ✅     | ✅    | ✅      | ❌   |
+| Framework Agnostic | ✅      | ✅   | ✅     | ✅    | ❌      | ✅   |
+
+### Migration Guide from 2.x to 3.0
+
+**No Breaking Changes for CLI Users**: If you're using the CLI (`svger-cli`), everything works
+exactly as before.
+
+**New Features for Build Tool Users**:
+
+```bash
+# Install
+npm install svger-cli@3.0.0 --save-dev
+
+# Use with your build tool
+# See docs/INTEGRATIONS.md for detailed examples
+```
+
+### Performance
+
+- Zero runtime dependencies
+- 85% faster than SVGR for batch processing
+- Tree-shakeable exports - only bundle what you use
+- Optimized build tool integrations with minimal overhead
+
+### Documentation
+
+- Complete integration guide in `docs/INTEGRATIONS.md`
+- 6 working example configurations in `examples/` directory
+- Updated README with integration quick-start
+- Enhanced API documentation
+
+---
+
 ## [2.0.7] - 2025-11-20
 
 ### Fixed
@@ -81,6 +402,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [Unreleased] - 2025-11-12
 
 ### Added
+
 - Comprehensive performance analysis documentation with detailed technical breakdown
 - Professional competitive analysis with fair tool comparisons
 - Transparency section welcoming community feedback
@@ -89,6 +411,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Research sources and feedback channels for documentation accuracy
 
 ### Changed
+
 - Corrected SVGR description to acknowledge webpack ecosystem support (not React-only)
 - Clarified 85% performance improvement claim with proper context and scope
 - Enhanced "Advanced Props" definition vs standard SVG props
@@ -97,6 +420,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Updated documentation tone to be educational rather than competitive
 
 ### Fixed
+
 - Inaccurate claims about competitor tools' capabilities
 - Misleading performance comparisons without proper context
 - Unprofessional competitive analysis language
@@ -105,6 +429,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [2.0.5] - 2025-11-11
 
 ### Fixed
+
 - **CRITICAL**: PascalCase component naming preservation
   - Fixed issue where PascalCase filenames were incorrectly converted to lowercase
   - ArrowBendDownLeft.svg → ArrowBendDownLeft.tsx (was: Arrowbenddownleft.tsx)
@@ -114,12 +439,14 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - All 28 framework tests continue passing
 
 ### Changed
+
 - Updated package version to 2.0.5
 - Enhanced toPascalCase utility function for better case detection
 
 ## [2.0.4] - 2025-11-11
 
 ### Added
+
 - Complete 28-property configuration schema
 - React/Vue/Angular specific configuration options
 - Enhanced responsive design support with breakpoint configurations
@@ -129,6 +456,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Enhanced TypeScript support with improved type definitions
 
 ### Changed
+
 - Streamlined ESLint configuration (.eslintrc.js → .eslintrc.cjs)
 - Enhanced component templates with new configuration support
 - Improved configuration management across multiple files
@@ -136,12 +464,14 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Enhanced comparison tables and installation instructions
 
 ### Fixed
+
 - TypeScript duplicate export errors in index generation
 - Simplified index.ts generation to prevent conflicts
 - Improved configuration validation and error messages
 - Enhanced toPascalCase to preserve existing PascalCase names
 
 ### Removed
+
 - Redundant test documentation files (COMPLETE-TEST-REPORT.md, TEST-RESULTS.md, TESTING-SUMMARY.md)
 - Deprecated ESLint configuration format
 - Outdated package dependencies reducing bundle size
@@ -175,6 +505,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Native module file path resolution error
 
 ### Removed
+
 - Unnecessary test folders and configuration files
 - Redundant package configurations
 
@@ -197,6 +528,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - TypeScript-first approach with native type generation
 
 ### Removed
+
 - Legacy dependencies reducing package size by 89%
 - Single-framework limitation
 - Dependency-heavy build processes
@@ -204,17 +536,20 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [2.0.0] - 2024-10-30
 
 ### Added
+
 - Complete multi-framework support for all 8 UI frameworks
 - Enhanced CLI commands with comprehensive options
 - Open source project files (CODE_OF_CONDUCT, LICENSE, CONTRIBUTING)
 - Professional project structure and documentation
 
 ### Changed
+
 - Major version release with breaking changes from 1.x
 - Enhanced README with multi-framework guide and benchmarks
 - Consolidated project structure and test organization
 
 ### Removed
+
 - node_modules folder from repository
 - Legacy 1.x architecture and dependencies