qleaner 1.0.10 → 1.0.11

package/README.md

@@ -1,14 +1,15 @@
 # Qleaner
 
-A powerful CLI tool to analyze and clean up your React codebase by finding unused files and listing all imports. Built with Node.js and Babel AST parsing.
+A powerful CLI tool to analyze and clean up your React codebase by finding unused files and listing all imports.
 
 ## Features
 
 - 🔍 **Scan for unused files**: Identify files that are not imported anywhere in your project
-- 📋 **List all imports**: Get a complete list of all import statements in your codebase
+- 📋 **List all imports**: Get a complete list of all import statements in your codebase with file locations
 - 🎯 **File listing**: List all files in your project
+- 📊 **Table output**: Display results in formatted tables for better readability
 - ⚙️ **Flexible configuration**: Exclude directories and files from scanning
-- 🚀 **Fast performance**: Uses fast-glob for efficient file scanning
+- 🚀 **Fast performance**: Efficient file scanning across large codebases
 - 💪 **TypeScript support**: Works with TypeScript, JavaScript, JSX, and TSX files
 
 ## Installation
@@ -40,6 +41,7 @@ qleaner qlean-list <path> [options]
 - `-e, --exclude-dir <dir...>` - Exclude directories from the scan
 - `-f, --exclude-file <file...>` - Exclude files from the scan
 - `-F, --exclude-file-print <file...>` - Do not print the excluded files
+- `-t, --table` - Display results in a formatted table
 
 **Examples:**
 
@@ -50,11 +52,17 @@ qleaner qlean-list src --list-files
 # List all imports in src directory
 qleaner qlean-list src --list-imports
 
+# List both files and imports in table format
+qleaner qlean-list src --list-files --list-imports --table
+
 # List files excluding node_modules and dist
 qleaner qlean-list src --list-files -e node_modules dist
 
 # List imports excluding specific files
 qleaner qlean-list src --list-imports -f "**/*.test.js" "**/*.spec.js"
+
+# List with table output
+qleaner qlean-list src --list-files --list-imports --table
 ```
 
 ### Scan for Unused Files
@@ -69,6 +77,7 @@ qleaner qlean-scan <path> [options]
 - `-e, --exclude-dir <dir...>` - Exclude directories from the scan
 - `-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
 
 **Examples:**
 
@@ -76,6 +85,9 @@ qleaner qlean-scan <path> [options]
 # Scan src directory for unused files
 qleaner qlean-scan src
 
+# Display unused files in a table format
+qleaner qlean-scan src --table
+
 # Scan excluding test directories
 qleaner qlean-scan src -e __tests__ __mocks__ test
 
@@ -84,14 +96,31 @@ qleaner qlean-scan src -f "**/*.test.js" "**/*.stories.js"
 
 # Scan with multiple exclusions
 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"
 ```
 
+## Output Formats
+
+Qleaner provides two output formats:
+
+1. **Standard output**: Color-coded text output
+   - Green for files
+   - Yellow for imports
+   - Red for unused files
+
+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
+
 ## How It Works
 
-1. **File Discovery**: Uses `fast-glob` to recursively find all `.tsx`, `.ts`, `.js`, and `.jsx` files in the specified directory
-2. **AST Parsing**: Uses Babel parser to parse files and extract import statements
+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 based on the selected command and options
+4. **Reporting**: Outputs the results in standard or table format based on your preferences
 
 ## Supported File Types
 
@@ -106,6 +135,7 @@ qleaner qlean-scan src -e node_modules dist -f "**/*.config.js"
 - 📊 **Code analysis**: Understand import patterns and dependencies in your codebase
 - 🔍 **Project audit**: Identify orphaned files that may have been forgotten
 - 📦 **Bundle optimization**: Find files that can be removed to reduce bundle size
+- 🎯 **Maintenance**: Keep your codebase clean and maintainable
 
 ## Configuration
 
@@ -115,6 +145,31 @@ You can exclude directories and files from scanning using the command-line optio
 - Excluding third-party libraries
 - Excluding configuration files
 
+**Common exclusions:**
+- Test files: `-f "**/*.test.*" "**/*.spec.*"`
+- Storybook files: `-f "**/*.stories.*"`
+- Test directories: `-e __tests__ __mocks__ test`
+- Build outputs: `-e dist build .next`
+- Configuration files: `-f "**/*.config.*"`
+- Third-party code: `-e node_modules vendor`
+
+## 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
+
+## Important Notes
+
+⚠️ **Warning**: Always review files before deletion. Some files might be:
+- Used dynamically (dynamic imports)
+- Referenced in configuration files
+- Required for build processes
+- Used as entry points that aren't directly imported
+
 ## Requirements
 
 - Node.js 14+ 

package/bin/cli.js

@@ -48,7 +48,7 @@ async function loadChalk() {
     .option("-f, --exclude-file <file...>", "Exclude files from the scan")
     .option(
       "-F, --exclude-file-print <files...>",
-      "Do not Print the excluded files"
+      "Scan but don't print the excluded files"
     )
     .option("-t, --table", "Print the results in a table")
     .action(async (path, options) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qleaner",
   "packageManager": "yarn@4.6.0",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "main": "command.js",
   "bin": "./bin/cli.js",
   "scripts": {
@@ -17,6 +17,7 @@
     "chalk": "^5.6.2",
     "cli-table3": "^0.6.5",
     "commander": "^14.0.2",
-    "fast-glob": "^3.3.3"
+    "fast-glob": "^3.3.3",
+    "prompts": "^2.4.2"
   }
 }

package/utils/utils.js

@@ -0,0 +1,57 @@
+const prompts = require('prompts');
+const fs = require('fs');
+const path = require('path');
+
+async function askDeleteFiles(files) {
+    const response = await prompts({
+        type: 'multiselect',
+        name: 'toDelete',
+        message: 'Select unused files to delete or move to .trash directory',
+        choices: files.map(file => ({
+            title: file,
+            value: file,
+        })) 
+    })
+    if(response && response.toDelete && response.toDelete.length > 0) {
+        const method = await prompts({
+            type: 'select',
+            name: 'method',
+            message: 'Select a method to delete the files',
+            choices: [
+                { title: 'Move to .trash directory', value: 'moveToTrash' },
+                { title: 'Delete files', value: 'deleteFiles' },
+            ]
+        })
+        if(method.method === 'moveToTrash') {
+            return await moveToTrash(response.toDelete);
+        } else if(method.method === 'deleteFiles') {
+            return await deleteFiles(response.toDelete);
+        }
+    }
+    return response && response.toDelete ? response.toDelete : [];
+}
+
+async function moveToTrash(files) {
+    const trashDir = path.join(process.cwd(), '.trash');
+
+    if(!fs.existsSync(trashDir)) {
+        fs.mkdirSync(trashDir);
+    }
+
+    for(const file of files) {
+       const fileName = path.basename(file);
+       const destination = path.join(trashDir, fileName);
+       fs.renameSync(file, destination);
+    }
+
+    console.log(`Moved ${files.length} files to .trash directory`);
+}
+
+async function deleteFiles(files) {
+    for(const file of files) {
+        fs.unlinkSync(file);
+    }
+    console.log(`Deleted ${files.length} files`);
+}
+
+module.exports = askDeleteFiles;