svger-cli 3.1.0 → 3.1.1

package/CHANGELOG.md

@@ -5,6 +5,73 @@ 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.1] - 2025-12-25
+
+### 🐛 Bug Fixes
+
+#### **Critical: Locked Files Missing from Index Exports**
+- **Fixed**: Locked SVG files are now correctly included in auto-generated `index.ts` exports
+- **Issue**: When SVG files were locked using `svger-cli lock`, their generated components were excluded from the `index.ts` barrel file, breaking imports and requiring manual maintenance
+- **Root Cause**: Index generation logic only included files processed in the current build session, excluding locked files that were intentionally skipped
+- **Solution**: Modified index generation to scan output directory for ALL existing component files instead of relying on processed files list
+
+#### **Files Changed**
+- **Core Service** (`src/services/svg-service.ts`):
+  - Updated `generateIndexFile()` to scan output directory for all component files (`.tsx`, `.jsx`, `.ts`, `.js`)
+  - Now includes both newly generated and previously locked components in exports
+  - Fixed incorrect property access `output?.naming` → `outputConfig?.naming`
+
+- **Integration Plugins** (all updated to scan output directory):
+  - `src/integrations/babel.ts` - Babel plugin index generation
+  - `src/integrations/vite.ts` - Vite plugin index generation
+  - `src/integrations/webpack.ts` - Webpack plugin index generation (affects Next.js)
+  - `src/integrations/rollup.ts` - Rollup plugin index generation
+
+#### **Framework Coverage**
+- ✅ React (TSX/JSX)
+- ✅ React Native
+- ✅ Vue (Composition & Options API)
+- ✅ Angular (Module & Standalone)
+- ✅ Svelte
+- ✅ Solid
+- ✅ Preact
+- ✅ Lit
+- ✅ Vanilla JS/TS
+
+#### **Build Tool Coverage**
+- ✅ CLI (`svger-cli build`)
+- ✅ Babel Plugin
+- ✅ Vite Plugin
+- ✅ Webpack Plugin
+- ✅ Rollup Plugin
+- ✅ Next.js Plugin (uses Webpack)
+
+#### **Testing**
+- Added comprehensive test suite: `tests/locked-files-index.test.ts`
+- Tests verify locked files remain in index after build
+- Tests verify multiple locked files are handled correctly
+- Tests verify unlocking allows regeneration
+- Tests verify locked files aren't regenerated
+- All existing tests pass (40+ tests)
+
+#### **Lock Mechanism Behavior (Corrected)**
+- **Locking a file**: Prevents regeneration/overwrite of component file ✅
+- **Building with locked files**: Skips locked file regeneration but **includes in index.ts** ✅
+- **Index exports**: Now includes ALL components (locked + unlocked) ✅
+
+### 🧹 Code Quality
+- Removed unused `viteConfig` variable from Vite plugin
+- Fixed TypeScript compilation warnings
+- All linting rules pass
+
+### 📝 Documentation
+- Created detailed GitHub issue response documentation
+- Updated fix summary with comprehensive coverage details
+- No breaking changes
+- No migration required
+
+---
+
 ## [3.1.0] - 2025-12-04
 
 ### 🚀 Major Improvements - Testing & DevOps

package/README.md

@@ -1,18 +1,22 @@
-# SVGER-CLI v3.1.0 - Enterprise SVG Processing Framework
-
-[![npm version](https://badge.fury.io/js/svger-cli.svg)](https://badge.fury.io/js/svger-cli)
-[![npm downloads](https://img.shields.io/npm/dm/svger-cli.svg)](https://www.npmjs.com/package/svger-cli)
-[![npm](https://img.shields.io/npm/v/svger-cli.svg)](https://www.npmjs.com/package/svger-cli)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
-[![Zero Dependencies](https://img.shields.io/badge/Dependencies-Zero-green.svg)](https://www.npmjs.com/package/svger-cli)
-[![Tests](https://img.shields.io/badge/Tests-114%20passing-success.svg)](https://github.com/faezemohades/svger-cli)
-[![Coverage](https://img.shields.io/badge/Coverage-82%25-yellow.svg)](https://github.com/faezemohades/svger-cli)
-
-> **The most advanced, zero-dependency SVG to component converter with official build tool
-> integrations. First-class support for Webpack, Vite, Rollup, Babel, Next.js, and Jest. Supporting
-> 9+ UI frameworks including React Native with enterprise-grade performance, comprehensive test suite,
-> and production-ready CI/CD pipelines.**
+<div align="center">
+  <img src="./assets/svger-cli.png" alt="SVGER-CLI Banner" width="100%" />
+  
+  <h1>SVGER-CLI v3.1.1</h1>
+  <h3>Enterprise SVG Processing Framework</h3>
+  
+  <p>
+    <a href="https://badge.fury.io/js/svger-cli"><img src="https://badge.fury.io/js/svger-cli.svg" alt="npm version" /></a>
+    <a href="https://www.npmjs.com/package/svger-cli"><img src="https://img.shields.io/npm/dm/svger-cli.svg" alt="npm downloads" /></a>
+    <a href="https://www.npmjs.com/package/svger-cli"><img src="https://img.shields.io/npm/v/svger-cli.svg" alt="npm" /></a>
+    <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
+    <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-Ready-blue.svg" alt="TypeScript" /></a>
+    <a href="https://www.npmjs.com/package/svger-cli"><img src="https://img.shields.io/badge/Dependencies-Zero-green.svg" alt="Zero Dependencies" /></a>
+    <a href="https://github.com/faezemohades/svger-cli"><img src="https://img.shields.io/badge/Tests-114%20passing-success.svg" alt="Tests" /></a>
+    <a href="https://github.com/faezemohades/svger-cli"><img src="https://img.shields.io/badge/Coverage-82%25-yellow.svg" alt="Coverage" /></a>
+  </p>
+
+  <p><strong>The most advanced, zero-dependency SVG to component converter with official build tool integrations. First-class support for Webpack, Vite, Rollup, Babel, Next.js, and Jest. Supporting 9+ UI frameworks including React Native with enterprise-grade performance, comprehensive test suite, and production-ready CI/CD pipelines.</strong></p>
+</div>
 
 ---
 
@@ -2763,7 +2767,7 @@ svger-cli build --framework react --responsive --theme dark
 
 ### **Comprehensive Test Suite**
 
-SVGER-CLI v3.1.0 includes a production-ready test suite with **114 automated tests** covering:
+SVGER-CLI v3.1.1 includes a production-ready test suite with **114 automated tests** covering:
 
 - ✅ **Unit Tests** - Core modules, utilities, and processors
 - ✅ **Integration Tests** - Complete workflows and multi-framework support

package/dist/cli.js

@@ -11,7 +11,7 @@ const program = new CLI();
 program
     .name('svger-cli')
     .description('Custom SVG to Angular, React, Vue, Svelte, Solid, and other component converter')
-    .version('2.0.0');
+    .version('3.0.0');
 // -------- Build Command --------
 /**
  * Build all SVGs from a source folder to an output folder.

package/dist/integrations/babel.js

@@ -85,9 +85,9 @@ async function processAllSVGs(options, processedFiles) {
         }
     }
     // Generate index file if enabled
-    if (options.generateIndex && results.length > 0) {
+    if (options.generateIndex) {
         try {
-            await generateIndexFile(outputPath, results, options);
+            await generateIndexFile(outputPath, options);
         }
         catch (error) {
             logger.error('Failed to generate index file:', error);
@@ -97,16 +97,35 @@ async function processAllSVGs(options, processedFiles) {
 }
 /**
  * Generate index file with all exports
+ * Scans the output directory for all existing component files
  */
-async function generateIndexFile(outputDir, results, options) {
-    const extension = options.typescript ? 'ts' : 'js';
-    const exports = results
-        .filter(r => r.componentName)
-        .map(r => `export { default as ${r.componentName} } from './${r.componentName}';`)
-        .join('\n');
-    const indexPath = path.join(outputDir, `index.${extension}`);
-    await FileSystem.writeFile(indexPath, exports, 'utf-8');
-    logger.debug(`Generated index file: ${indexPath}`);
+async function generateIndexFile(outputDir, options) {
+    try {
+        // Scan output directory for all component files
+        const files = await FileSystem.readDir(outputDir);
+        const extension = options.typescript ? 'tsx' : 'jsx';
+        // Filter component files (exclude index files)
+        const componentFiles = files.filter(file => (file.endsWith(`.${extension}`) ||
+            file.endsWith('.ts') ||
+            file.endsWith('.js')) &&
+            !file.startsWith('index.'));
+        if (componentFiles.length === 0) {
+            logger.warn('No component files found for index generation');
+            return;
+        }
+        // Extract component names
+        const componentNames = componentFiles.map(file => path.basename(file, path.extname(file)));
+        const indexExtension = options.typescript ? 'ts' : 'js';
+        const exports = componentNames
+            .map(name => `export { default as ${name} } from './${name}';`)
+            .join('\n');
+        const indexPath = path.join(outputDir, `index.${indexExtension}`);
+        await FileSystem.writeFile(indexPath, exports, 'utf-8');
+        logger.debug(`Generated index file: ${indexPath}`);
+    }
+    catch (error) {
+        logger.error('Failed to generate index file:', error);
+    }
 }
 /**
  * Transform SVG import path to component path

package/dist/integrations/rollup.js

@@ -140,7 +140,7 @@ async function processAllSVGs(options, processedFiles) {
     }
     // Generate index file
     if (options.generateIndex) {
-        await generateIndexFile(outputDir, results, options);
+        await generateIndexFile(outputDir, options);
     }
     const successful = results.filter(r => r.success).length;
     logger.info(`SVGER: Processed ${successful}/${svgFiles.length} SVG files`);
@@ -182,16 +182,35 @@ async function processSVGFile(svgPath, outputDir, options) {
 }
 /**
  * Generate index file with all exports
+ * Scans the output directory for all existing component files
  */
-async function generateIndexFile(outputDir, results, options) {
-    const extension = options.typescript ? 'ts' : 'js';
-    const exports = results
-        .filter(r => r.componentName)
-        .map(r => `export { default as ${r.componentName} } from './${r.componentName}';`)
-        .join('\n');
-    const indexPath = path.join(outputDir, `index.${extension}`);
-    await FileSystem.writeFile(indexPath, exports, 'utf-8');
-    logger.debug(`Generated index file: ${indexPath}`);
+async function generateIndexFile(outputDir, options) {
+    try {
+        // Scan output directory for all component files
+        const files = await FileSystem.readDir(outputDir);
+        const extension = options.typescript ? 'tsx' : 'jsx';
+        // Filter component files (exclude index files)
+        const componentFiles = files.filter(file => (file.endsWith(`.${extension}`) ||
+            file.endsWith('.ts') ||
+            file.endsWith('.js')) &&
+            !file.startsWith('index.'));
+        if (componentFiles.length === 0) {
+            logger.warn('No component files found for index generation');
+            return;
+        }
+        // Extract component names
+        const componentNames = componentFiles.map(file => path.basename(file, path.extname(file)));
+        const indexExtension = options.typescript ? 'ts' : 'js';
+        const exports = componentNames
+            .map(name => `export { default as ${name} } from './${name}';`)
+            .join('\n');
+        const indexPath = path.join(outputDir, `index.${indexExtension}`);
+        await FileSystem.writeFile(indexPath, exports, 'utf-8');
+        logger.debug(`Generated index file: ${indexPath}`);
+    }
+    catch (error) {
+        logger.error('Failed to generate index file:', error);
+    }
 }
 // Default export
 export default svgerRollupPlugin;

package/dist/integrations/vite.js

@@ -47,13 +47,9 @@ export function svgerVitePlugin(options = {}) {
         svgo: options.svgo !== undefined ? options.svgo : false,
         generateIndex: options.generateIndex !== undefined ? options.generateIndex : true,
     };
-    let viteConfig;
     const processedFiles = new Set();
     return {
         name: PLUGIN_NAME,
-        configResolved(resolvedConfig) {
-            viteConfig = resolvedConfig;
-        },
         async buildStart() {
             logger.info('SVGER Vite Plugin: Processing SVG files...');
             await processAllSVGs(pluginOptions, processedFiles);
@@ -164,7 +160,7 @@ async function processAllSVGs(options, processedFiles) {
     }
     // Generate index file
     if (options.generateIndex) {
-        await generateIndexFile(outputDir, results, options);
+        await generateIndexFile(outputDir, options);
     }
     const successful = results.filter(r => r.success).length;
     logger.info(`SVGER: Processed ${successful}/${svgFiles.length} SVG files`);
@@ -206,16 +202,35 @@ async function processSVGFile(svgPath, outputDir, options) {
 }
 /**
  * Generate index file with all exports
+ * Scans the output directory for all existing component files
  */
-async function generateIndexFile(outputDir, results, options) {
-    const extension = options.typescript ? 'ts' : 'js';
-    const exports = results
-        .filter(r => r.componentName)
-        .map(r => `export { default as ${r.componentName} } from './${r.componentName}';`)
-        .join('\n');
-    const indexPath = path.join(outputDir, `index.${extension}`);
-    await FileSystem.writeFile(indexPath, exports, 'utf-8');
-    logger.debug(`Generated index file: ${indexPath}`);
+async function generateIndexFile(outputDir, options) {
+    try {
+        // Scan output directory for all component files
+        const files = await FileSystem.readDir(outputDir);
+        const extension = options.typescript ? 'tsx' : 'jsx';
+        // Filter component files (exclude index files)
+        const componentFiles = files.filter(file => (file.endsWith(`.${extension}`) ||
+            file.endsWith('.ts') ||
+            file.endsWith('.js')) &&
+            !file.startsWith('index.'));
+        if (componentFiles.length === 0) {
+            logger.warn('No component files found for index generation');
+            return;
+        }
+        // Extract component names
+        const componentNames = componentFiles.map(file => path.basename(file, path.extname(file)));
+        const indexExtension = options.typescript ? 'ts' : 'js';
+        const exports = componentNames
+            .map(name => `export { default as ${name} } from './${name}';`)
+            .join('\n');
+        const indexPath = path.join(outputDir, `index.${indexExtension}`);
+        await FileSystem.writeFile(indexPath, exports, 'utf-8');
+        logger.debug(`Generated index file: ${indexPath}`);
+    }
+    catch (error) {
+        logger.error('Failed to generate index file:', error);
+    }
 }
 // Default export
 export default svgerVitePlugin;

package/dist/integrations/webpack.d.ts

@@ -45,6 +45,7 @@ export declare class SvgerWebpackPlugin {
     private processSVGFile;
     /**
      * Generate index file with all exports
+     * Scans the output directory for all existing component files
      */
     private generateIndexFile;
     /**

package/dist/integrations/webpack.js

@@ -111,7 +111,7 @@ export class SvgerWebpackPlugin {
         }
         // Generate index file
         if (this.options.generateIndex) {
-            await this.generateIndexFile(outputDir, results.filter(r => r.success));
+            await this.generateIndexFile(outputDir);
         }
         const successful = results.filter(r => r.success).length;
         logger.info(`SVGER: Processed ${successful}/${svgFiles.length} SVG files`);
@@ -176,16 +176,35 @@ export class SvgerWebpackPlugin {
     }
     /**
      * Generate index file with all exports
+     * Scans the output directory for all existing component files
      */
-    async generateIndexFile(outputDir, results) {
-        const extension = this.options.typescript ? 'ts' : 'js';
-        const exports = results
-            .filter(r => r.componentName)
-            .map(r => `export { default as ${r.componentName} } from './${r.componentName}';`)
-            .join('\n');
-        const indexPath = path.join(outputDir, `index.${extension}`);
-        await FileSystem.writeFile(indexPath, exports, 'utf-8');
-        logger.debug(`Generated index file: ${indexPath}`);
+    async generateIndexFile(outputDir) {
+        try {
+            // Scan output directory for all component files
+            const files = await FileSystem.readDir(outputDir);
+            const extension = this.options.typescript ? 'tsx' : 'jsx';
+            // Filter component files (exclude index files)
+            const componentFiles = files.filter(file => (file.endsWith(`.${extension}`) ||
+                file.endsWith('.ts') ||
+                file.endsWith('.js')) &&
+                !file.startsWith('index.'));
+            if (componentFiles.length === 0) {
+                logger.warn('No component files found for index generation');
+                return;
+            }
+            // Extract component names
+            const componentNames = componentFiles.map(file => path.basename(file, path.extname(file)));
+            const indexExtension = this.options.typescript ? 'ts' : 'js';
+            const exports = componentNames
+                .map(name => `export { default as ${name} } from './${name}';`)
+                .join('\n');
+            const indexPath = path.join(outputDir, `index.${indexExtension}`);
+            await FileSystem.writeFile(indexPath, exports, 'utf-8');
+            logger.debug(`Generated index file: ${indexPath}`);
+        }
+        catch (error) {
+            logger.error('Failed to generate index file:', error);
+        }
     }
     /**
      * Get changed files from webpack

package/dist/services/svg-service.d.ts

@@ -42,6 +42,8 @@ export declare class SVGService {
     clean(outDir: string): Promise<void>;
     /**
      * Generate index.ts file with all component exports
+     * Scans the output directory for all existing component files,
+     * including those from locked SVGs that weren't regenerated
      */
     private generateIndexFile;
     /**

package/dist/services/svg-service.js

@@ -76,7 +76,7 @@ export class SVGService {
                     defaultWidth: mergedConfig.defaultWidth,
                     defaultHeight: mergedConfig.defaultHeight,
                     defaultFill: mergedConfig.defaultFill,
-                    namingConvention: mergedConfig.output?.naming || 'pascal',
+                    namingConvention: mergedConfig.outputConfig?.naming || 'pascal',
                     styleRules: Object.fromEntries(Object.entries(mergedConfig.styleRules || {}).filter(([, v]) => v !== undefined)),
                 });
                 results.push({
@@ -107,9 +107,8 @@ export class SVGService {
             });
         }
         // Generate index.ts file with all component exports
-        if (successful > 0) {
-            await this.generateIndexFile(outDir, results.filter(r => r.success).map(r => r.file), mergedConfig);
-        }
+        // This includes both newly generated components and existing locked components
+        await this.generateIndexFile(outDir, mergedConfig);
     }
     /**
      * Generate a React component from a single SVG file
@@ -257,13 +256,30 @@ export class SVGService {
     }
     /**
      * Generate index.ts file with all component exports
+     * Scans the output directory for all existing component files,
+     * including those from locked SVGs that weren't regenerated
      */
-    async generateIndexFile(outDir, svgFiles, config) {
+    async generateIndexFile(outDir, config) {
         try {
-            const namingConvention = config?.output?.naming || 'pascal';
-            const componentNames = svgFiles.map(file => {
-                const baseName = path.basename(file, '.svg');
-                return svgProcessor.generateComponentName(baseName, namingConvention);
+            // Scan output directory for all component files
+            const files = await FileSystem.readDir(outDir);
+            // Get the file extension based on typescript setting
+            const typescript = config?.typescript !== false;
+            const ext = typescript ? '.tsx' : '.jsx';
+            // Filter component files (exclude index.ts/index.js)
+            const componentFiles = files.filter(file => (file.endsWith(ext) ||
+                file.endsWith('.ts') ||
+                file.endsWith('.js')) &&
+                !file.startsWith('index.'));
+            if (componentFiles.length === 0) {
+                logger.warn('No component files found in output directory for index generation');
+                return;
+            }
+            // Extract component names from filenames
+            const componentNames = componentFiles.map(file => {
+                // Remove extension to get component name
+                const baseName = path.basename(file, path.extname(file));
+                return baseName;
             });
             const indexContent = this.generateIndexContent(componentNames);
             const indexPath = path.join(outDir, 'index.ts');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svger-cli",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Enterprise-grade, zero-dependency SVG to component converter with official Webpack, Vite, Rollup, Babel, Next.js & Jest integrations. Supporting React, React Native, Vue, Angular, Svelte, Solid, Lit, Preact & Vanilla. Features auto-generated TypeScript exports, HMR, responsive design, themes & 85% faster processing than SVGR.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/DEVELOPMENT.md

@@ -1,353 +0,0 @@
-# Development Guide
-
-This guide will help you set up the development environment and contribute to SVGER-CLI.
-
-## Prerequisites
-
-- **Node.js**: >= 18.17.0 (we recommend using [nvm](https://github.com/nvm-sh/nvm))
-- **npm**: >= 9.0.0
-- **Git**: Latest version
-
-## Setup Development Environment
-
-1. **Clone the repository:**
-   ```bash
-   git clone https://github.com/faezemohades/svger-cli.git
-   cd svger-cli
-   ```
-
-2. **Install dependencies:**
-   ```bash
-   npm install
-   ```
-
-3. **Build the project:**
-   ```bash
-   npm run build
-   ```
-
-4. **Run tests:**
-   ```bash
-   npm test
-   ```
-
-## Development Workflow
-
-### Building
-
-```bash
-# Build once
-npm run build
-
-# Build and watch for changes
-npm run build:watch
-```
-
-### Testing
-
-```bash
-# Run all tests
-npm test
-
-# Run tests in watch mode
-npm run test:watch
-
-# Run with coverage
-npm run test:coverage
-
-# Run integration tests only
-npm run test:integration
-```
-
-### Linting and Formatting
-
-```bash
-# Check for linting issues
-npm run lint
-
-# Fix linting issues
-npm run lint:fix
-
-# Check formatting
-npm run format:check
-
-# Fix formatting
-npm run format
-```
-
-### Development Mode
-
-To test the CLI during development:
-
-```bash
-# Run CLI directly from source
-npm run dev -- build ./test-icons ./test-output
-
-# Or install globally for testing
-npm run build
-npm link
-svger-cli --version
-```
-
-## Project Structure
-
-```
-svger-cli/
-├── src/                    # Source code
-│   ├── core/              # Core functionality
-│   ├── processors/        # SVG processing logic
-│   ├── services/          # Business logic services
-│   ├── templates/         # Framework templates
-│   ├── types/            # TypeScript definitions
-│   └── utils/            # Utility functions
-├── bin/                   # CLI entry point
-├── docs/                  # Documentation
-├── dist/                  # Compiled output (generated)
-└── tests/                # Test files
-```
-
-## Adding New Framework Support
-
-1. **Create framework template:**
-   ```typescript
-   // src/core/framework-templates.ts
-   export const newFrameworkTemplate = {
-     name: 'newframework',
-     extension: '.jsx',
-     generate: (svgContent: string, componentName: string, options: any) => {
-       // Implementation
-     }
-   };
-   ```
-
-2. **Add to framework list:**
-   ```typescript
-   // src/types/index.ts
-   export type FrameworkType = 'react' | 'vue' | 'angular' | 'newframework';
-   ```
-
-3. **Update CLI options:**
-   ```typescript
-   // src/cli.ts - Add to framework choices
-   ```
-
-4. **Add tests:**
-   ```typescript
-   // tests/frameworks/newframework.test.ts
-   ```
-
-## Testing Strategy
-
-### Unit Tests
-- Test individual functions and classes
-- Mock external dependencies
-- Focus on business logic
-
-### Integration Tests
-- Test CLI commands end-to-end
-- Test file generation with real SVG files
-- Verify output correctness
-
-### Performance Tests
-- Benchmark processing times
-- Memory usage testing
-- Regression detection
-
-## Code Style Guidelines
-
-### TypeScript
-- Use strict TypeScript configuration
-- Prefer interfaces over types for object shapes
-- Use generics for reusable code
-- Document complex types
-
-### Naming Conventions
-- **Files**: kebab-case (e.g., `svg-processor.ts`)
-- **Classes**: PascalCase (e.g., `SVGProcessor`)
-- **Functions/Variables**: camelCase (e.g., `processFile`)
-- **Constants**: SCREAMING_SNAKE_CASE (e.g., `DEFAULT_SIZE`)
-
-### Error Handling
-- Use custom error classes
-- Provide meaningful error messages
-- Include context in errors
-- Log appropriate levels
-
-## Performance Considerations
-
-### Optimization Guidelines
-- Use streaming for large files
-- Implement caching where appropriate
-- Parallelize CPU-intensive tasks
-- Monitor memory usage
-
-### Benchmarking
-```bash
-# Run performance benchmarks
-npm run benchmark
-
-# Compare with previous versions
-npm run benchmark -- --compare
-```
-
-## Contributing Guidelines
-
-### Before You Start
-1. Check existing issues and PRs
-2. Create an issue for new features
-3. Follow coding standards
-4. Write tests for new code
-
-### Pull Request Process
-1. **Create feature branch:**
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-
-2. **Make changes and test:**
-   ```bash
-   npm run validate  # runs typecheck, lint, and test
-   ```
-
-3. **Commit with conventional format:**
-   ```bash
-   git commit -m "feat: add support for new framework"
-   ```
-
-4. **Push and create PR:**
-   ```bash
-   git push origin feature/your-feature-name
-   ```
-
-### Commit Message Format
-```
-<type>(<scope>): <description>
-
-[optional body]
-
-[optional footer]
-```
-
-**Types:**
-- `feat`: New feature
-- `fix`: Bug fix
-- `docs`: Documentation changes
-- `style`: Formatting changes
-- `refactor`: Code restructuring
-- `test`: Adding tests
-- `chore`: Maintenance tasks
-
-## Debugging
-
-### CLI Debugging
-```bash
-# Enable verbose logging
-DEBUG=svger:* npm run dev -- build ./icons ./components
-
-# Debug specific modules
-DEBUG=svger:processor npm run dev -- build ./icons ./components
-```
-
-### VS Code Configuration
-Create `.vscode/launch.json`:
-```json
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Debug CLI",
-      "type": "node",
-      "request": "launch",
-      "program": "${workspaceFolder}/src/cli.ts",
-      "args": ["build", "./test-icons", "./test-output"],
-      "runtimeArgs": ["--loader", "ts-node/esm"],
-      "console": "integratedTerminal"
-    }
-  ]
-}
-```
-
-## Release Process
-
-### Version Management
-```bash
-# Patch release (bug fixes)
-npm run release
-
-# Minor release (new features)
-npm run release:minor
-
-# Major release (breaking changes)
-npm run release:major
-```
-
-### Manual Release Steps
-1. Update CHANGELOG.md
-2. Run all tests and validation
-3. Build and test package
-4. Update version and tag
-5. Publish to npm
-6. Create GitHub release
-
-## Documentation
-
-### API Documentation
-```bash
-# Generate API docs
-npm run docs:generate
-```
-
-### Adding Documentation
-- Update README.md for user-facing changes
-- Add JSDoc comments for public APIs
-- Update CHANGELOG.md for releases
-- Create ADRs for architectural decisions
-
-## Troubleshooting
-
-### Common Issues
-
-**Build Errors:**
-```bash
-# Clean and rebuild
-npm run clean
-npm install
-npm run build
-```
-
-**Test Failures:**
-```bash
-# Update snapshots
-npm test -- --updateSnapshot
-
-# Run specific test
-npm test -- --testNamePattern="specific test"
-```
-
-**TypeScript Errors:**
-```bash
-# Check types without emitting
-npm run typecheck
-
-# Check specific file
-npx tsc --noEmit src/specific-file.ts
-```
-
-## Resources
-
-- [TypeScript Handbook](https://www.typescriptlang.org/docs/)
-- [Jest Testing Framework](https://jestjs.io/docs/getting-started)
-- [ESLint Rules](https://eslint.org/docs/rules/)
-- [Conventional Commits](https://www.conventionalcommits.org/)
-
-## Support
-
-If you need help with development:
-
-1. Check existing issues and documentation
-2. Ask in GitHub Discussions
-3. Contact maintainers: faezemohades@gmail.com
-
----
-
-Happy coding! 🚀