qleaner 1.0.9 → 1.0.11

package/README.md

@@ -1 +1,188 @@
-# react-cleaner
+# Qleaner
+
+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 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**: Efficient file scanning across large codebases
+- 💪 **TypeScript support**: Works with TypeScript, JavaScript, JSX, and TSX files
+
+## Installation
+
+```bash
+# Install globally
+npm install -g qleaner
+
+# Or use with npx
+npx qleaner
+
+# Or install locally
+yarn add qleaner
+```
+
+## Usage
+
+### List Imports and Files
+
+List all imports and files in your project:
+
+```bash
+qleaner qlean-list <path> [options]
+```
+
+**Options:**
+- `-l, --list-files` - List all the files in the project
+- `-i, --list-imports` - List all the imports in the project
+- `-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:**
+
+```bash
+# List all files in src directory
+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
+
+Find files that are not imported anywhere in your project:
+
+```bash
+qleaner qlean-scan <path> [options]
+```
+
+**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:**
+
+```bash
+# 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
+
+# Scan excluding specific file patterns
+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**: 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
+
+## Supported File Types
+
+- `.js` - JavaScript files
+- `.jsx` - JavaScript React files
+- `.ts` - TypeScript files
+- `.tsx` - TypeScript React files
+
+## Use Cases
+
+- 🧹 **Code cleanup**: Remove dead code and unused files from your React projects
+- 📊 **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
+
+You can exclude directories and files from scanning using the command-line options. This is useful for:
+- Excluding test files
+- Excluding build outputs
+- 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+ 
+- Yarn or npm
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
+
+## Version
+
+Current version: 1.0.9

package/bin/cli.js

@@ -1,38 +1,74 @@
 #!/usr/bin/env node
 const { Command } = require("commander");
 const { getFiles, unUsedFiles } = require("../command");
+const Table = require('cli-table3')
 
-const program = new Command();
+async function loadChalk() {
+  return (await import("chalk")).default;
+}
 
-program
-  .name("qleaner")
-  .description("A tool to clean up your React code")
-  .version("1.0.0");
+(async () => {
+  const chalk = await loadChalk();
 
-program
-  .command("qlean-list")
-  .description("List all the imports in the project")
-  .argument("<path>", "The path to the directory to scan for imports")
-  .option("-l, --list-files", "List all the files in the project")
-  .option("-i, --list-imports", "List all the imports in the project")
-  .option("-e, --exclude-dir <dir...>", "Exclude directories from the scan")
-  .option("-f, --exclude-file <file...>", "Exclude files from the scan")
-  .option("-F, --exclude-file-print <file...>", "Do not Print the excluded files")
-  .action(async (path, options) => {
-    const imports = await getFiles(path, options);
-  });
+  const program = new Command();
 
-  program.command("qlean-scan")
-  .description("Scan the project for unused files")
-  .argument("<path>", "The path to the directory to scan for unused files")
-  .option("-e, --exclude-dir <dir...>", "Exclude directories from the scan")
-  .option("-f, --exclude-file <file...>", "Exclude files from the scan")
-  .option("-F, --exclude-file-print <files...>", "Do not Print the excluded files")
-  .action(async (path, options) => {
-    const unusedFiles = await unUsedFiles(path, options);
-    // console.clear()
-    unusedFiles.forEach((file) => {
-      console.log(file);
+  program
+    .name("qleaner")
+    .description("A tool to clean up your React code")
+    .version("1.0.0");
+
+  program
+    .command("qlean-list")
+    .description("List all the imports in the project")
+    .argument("<path>", "The path to the directory to scan for imports")
+    .option("-l, --list-files", "List all the files in the project")
+    .option("-i, --list-imports", "List all the imports in the project")
+    .option("-e, --exclude-dir <dir...>", "Exclude directories from the scan")
+    .option("-f, --exclude-file <file...>", "Exclude files from the scan")
+    .option(
+      "-F, --exclude-file-print <file...>",
+      "Do not Print the excluded files"
+    )
+    .option("-t, --table", "Print the results in a table")
+    .action(async (path, options) => {
+      const { tableImports, tableFiles } = await getFiles(path, options, chalk);
+      if(options.table){
+        console.log(chalk.yellow('***************** Imported Files *****************'));
+        console.log(tableImports.toString());
+        console.log(chalk.green('***************** List Files *****************'));
+        console.log(tableFiles.toString());
+      }
+    });
+
+  program
+    .command("qlean-scan")
+    .description("Scan the project for unused files")
+    .argument("<path>", "The path to the directory to scan for unused files")
+    .option("-e, --exclude-dir <dir...>", "Exclude directories from the scan")
+    .option("-f, --exclude-file <file...>", "Exclude files from the scan")
+    .option(
+      "-F, --exclude-file-print <files...>",
+      "Scan but don't print the excluded files"
+    )
+    .option("-t, --table", "Print the results in a table")
+    .action(async (path, options) => {
+      const unusedFiles = await unUsedFiles(path, options);
+      // console.clear()
+      if(options.table){
+        const table = new Table({
+            head: ['Unused Files'],
+            colWidths: [50]
+        })
+        unusedFiles.forEach(file => {
+            table.push([file])
+        })
+        console.log(table.toString())
+
+      }else {
+        unusedFiles.forEach((file) => {
+            console.log(chalk.red(file));
+          });
+      }
     });
-  });
-program.parse(process.argv);
+  program.parse(process.argv);
+})();

package/command.js

@@ -1,11 +1,13 @@
 const fg = require("fast-glob");
 const fs = require("fs");
-const path = require("path");
+const Table = require('cli-table3');
 const parser = require("@babel/parser");
 const traverse = require("@babel/traverse").default;
 
 
-async function getFiles(directory = "src", options) {
+
+
+async function getFiles(directory = "src", options, chalk) {
     const contentPaths = [`${directory}/**/*.{tsx,ts,js,jsx}`];
     if (options.excludeDir && options.excludeDir.length > 0) {
         options.excludeDir.forEach(dir => {
@@ -49,18 +51,42 @@ async function getFiles(directory = "src", options) {
     //   },
     // });
   }
-
-  if (options.listFiles) {
-    console.log('***************** Files *****************');
-    files.forEach((file) => {
-        console.log(file);
-    })
-  }
-  if (options.listImports) {
-    console.log('***************** Imports *****************');
-    imports.forEach((importStatement) => {
-      console.log(`${importStatement.file}:${importStatement.line}:${importStatement.column}  ${importStatement.from}`);
-    })
+  
+  if (options.table) {
+    const tableImports = new Table({
+        head: ['File', 'Line', 'Column', 'Import'],
+        colWidths: [20, 10, 10, 20],
+      });
+    
+      const tableFiles = new Table({
+        head: ['File'],
+        colWidths: [20],
+      });
+    
+      if (options.listFiles) {
+        files.forEach((file) => {
+            tableFiles.push([file]);
+        })
+      }
+      if (options.listImports) {
+        imports.forEach((importStatement) => {
+          tableImports.push([importStatement.file, importStatement.line, importStatement.column, importStatement.from]);
+        })
+      }
+      return { tableImports, tableFiles };
+  }else{
+    if (options.listFiles) {
+        console.log(chalk.green('***************** Files *****************'));
+        files.forEach((file) => {
+            console.log(chalk.green(file));
+        })
+      }
+      if (options.listImports) {
+        console.log(chalk.yellow('***************** Imports *****************'));
+        imports.forEach((importStatement) => {
+          console.log(chalk.yellow(`${importStatement.file}:${importStatement.line}:${importStatement.column}  ${importStatement.from}`));
+        })
+      }
   }
 }
 
@@ -76,6 +102,7 @@ async function unUsedFiles(directory = "src", options) {
             contentPaths.push(`!${directory}/**/${file}`);
         });
     }
+    
     const files = await fg(contentPaths);
     const imports = [];
     const unusedFiles = [];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qleaner",
   "packageManager": "yarn@4.6.0",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "main": "command.js",
   "bin": "./bin/cli.js",
   "scripts": {
@@ -15,7 +15,9 @@
     "@babel/parser": "^7.28.5",
     "@babel/traverse": "^7.28.5",
     "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;