qleaner 1.0.13 → 1.0.14

package/README.md

@@ -11,6 +11,7 @@ A powerful CLI tool to analyze and clean up your React codebase by finding unuse
 - ⚙️ **Flexible configuration**: Exclude directories and files from scanning
 - 🚀 **Fast performance**: Efficient file scanning across large codebases
 - 💪 **TypeScript support**: Works with TypeScript, JavaScript, JSX, and TSX files
+- 🧪 **Dry run mode**: Preview what would be deleted without actually deleting files
 
 ## Installation
 
@@ -78,6 +79,7 @@ qleaner qlean-scan <path> [options]
 - `-f, --exclude-file <file...>` - Exclude files from the scan
 - `-F, --exclude-file-print <files...>` - Do not print the excluded files
 - `-t, --table` - Display results in a formatted table
+- `-d, --dry-run` - Show what would be deleted without actually deleting (skips prompt)
 
 **Examples:**
 
@@ -99,6 +101,12 @@ qleaner qlean-scan src -e node_modules dist -f "**/*.config.js"
 
 # Scan with table output and exclusions
 qleaner qlean-scan src --table -e __tests__ dist -f "**/*.config.js"
+
+# Dry run - preview what would be deleted without deleting
+qleaner qlean-scan src --dry-run
+
+# Dry run with table output
+qleaner qlean-scan src --dry-run --table
 ```
 
 ## Output Formats
@@ -109,18 +117,21 @@ Qleaner provides two output formats:
    - Green for files
    - Yellow for imports
    - Red for unused files
+   - Cyan for dry run mode messages
 
 2. **Table output**: Formatted tables with organized columns (use `--table` flag)
    - Import tables show: File, Line, Column, and Import path
    - File tables show: File path
-   - Unused files table shows: Unused file paths
+   - Unused files table shows: Unused file paths (or "Would Delete" in dry run mode)
 
 ## How It Works
 
 1. **File Discovery**: Recursively finds all `.tsx`, `.ts`, `.js`, and `.jsx` files in the specified directory
-2. **Import Extraction**: Parses files and extracts all import statements
-3. **Analysis**: Compares file paths with import paths to identify unused files
-4. **Reporting**: Outputs the results in standard or table format based on your preferences
+2. **Import Extraction**: Parses files using Babel AST and extracts all import statements
+3. **Module Resolution**: Uses enhanced-resolve to properly resolve import paths (supports path aliases like `@/` and `~/`)
+4. **Analysis**: Compares file paths with resolved import paths to identify unused files
+5. **Reporting**: Outputs the results in standard or table format based on your preferences
+6. **Safe Deletion**: In dry run mode, shows what would be deleted without making changes. In normal mode, prompts for confirmation before deletion
 
 ## Supported File Types
 
@@ -156,11 +167,12 @@ You can exclude directories and files from scanning using the command-line optio
 ## Tips and Best Practices
 
 1. **Start with a small scope**: Begin by scanning a specific directory before scanning the entire project
-2. **Use exclusions**: Exclude test files and build outputs when scanning for unused files
-3. **Review before deleting**: Always review the unused files list before removing them - some files might be used dynamically (e.g., through dynamic imports, configuration files, or asset references)
-4. **Use table format**: The table format is easier to read for large results
-5. **Combine options**: Use multiple flags together for comprehensive analysis
-6. **Check dynamic imports**: Files imported using dynamic imports (`import()`) may appear as unused but are actually needed
+2. **Use dry run first**: Always run with `--dry-run` first to preview what would be deleted before actually deleting files
+3. **Use exclusions**: Exclude test files and build outputs when scanning for unused files
+4. **Review before deleting**: Always review the unused files list before removing them - some files might be used dynamically (e.g., through dynamic imports, configuration files, or asset references)
+5. **Use table format**: The table format is easier to read for large results
+6. **Combine options**: Use multiple flags together for comprehensive analysis
+7. **Check dynamic imports**: Files imported using dynamic imports (`import()`) may appear as unused but are actually needed
 
 ## Important Notes
 
@@ -170,6 +182,8 @@ You can exclude directories and files from scanning using the command-line optio
 - Required for build processes
 - Used as entry points that aren't directly imported
 
+💡 **Tip**: Always use `--dry-run` first to preview what would be deleted. This is especially important in CI/CD pipelines or when scanning large codebases.
+
 ## Requirements
 
 - Node.js 14+ 
@@ -185,4 +199,4 @@ MIT
 
 ## Version
 
-Current version: 1.0.9
+Current version: 1.0.13

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qleaner",
   "packageManager": "yarn@4.6.0",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "main": "command.js",
   "bin": "./bin/cli.js",
   "scripts": {