qleaner 1.0.14 → 1.0.16

package/README.md

@@ -9,9 +9,10 @@ A powerful CLI tool to analyze and clean up your React codebase by finding unuse
 - 🎯 **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
+- 🚀 **Fast performance**: Efficient file scanning across large codebases with intelligent caching
 - 💪 **TypeScript support**: Works with TypeScript, JavaScript, JSX, and TSX files
 - 🧪 **Dry run mode**: Preview what would be deleted without actually deleting files
+- 💾 **Smart caching**: Caches scan results for faster subsequent runs (automatically invalidates on file changes)
 
 ## Installation
 
@@ -80,6 +81,7 @@ qleaner qlean-scan <path> [options]
 - `-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)
+- `-C, --clear-cache` - Clear the cache before scanning (use when code changes have been made)
 
 **Examples:**
 
@@ -107,6 +109,12 @@ qleaner qlean-scan src --dry-run
 
 # Dry run with table output
 qleaner qlean-scan src --dry-run --table
+
+# Clear cache and scan (recommended after making code changes)
+qleaner qlean-scan src --clear-cache
+
+# Clear cache with dry run
+qleaner qlean-scan src --clear-cache --dry-run
 ```
 
 ## Output Formats
@@ -127,11 +135,13 @@ Qleaner provides two output formats:
 ## How It Works
 
 1. **File Discovery**: Recursively finds all `.tsx`, `.ts`, `.js`, and `.jsx` files in the specified directory
-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
+2. **Caching**: Checks cache for previously scanned files. Files that haven't changed are skipped for faster performance
+3. **Import Extraction**: Parses files using Babel AST and extracts all import statements (only for changed files or cache misses)
+4. **Module Resolution**: Uses enhanced-resolve to properly resolve import paths (supports path aliases like `@/` and `~/`)
+5. **Analysis**: Compares file paths with resolved import paths to identify unused files
+6. **Cache Update**: Saves scan results to cache for faster subsequent runs
+7. **Reporting**: Outputs the results in standard or table format based on your preferences
+8. **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
 
@@ -168,11 +178,12 @@ You can exclude directories and files from scanning using the command-line optio
 
 1. **Start with a small scope**: Begin by scanning a specific directory before scanning the entire project
 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
+3. **Clear cache after code changes**: If you've made changes to your codebase (added/removed files, changed imports), use `--clear-cache` to ensure accurate results. The cache automatically invalidates when files change, but clearing it manually ensures a fresh scan
+4. **Use exclusions**: Exclude test files and build outputs when scanning for unused files
+5. **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)
+6. **Use table format**: The table format is easier to read for large results
+7. **Combine options**: Use multiple flags together for comprehensive analysis
+8. **Check dynamic imports**: Files imported using dynamic imports (`import()`) may appear as unused but are actually needed
 
 ## Important Notes
 
@@ -184,6 +195,12 @@ You can exclude directories and files from scanning using the command-line optio
 
 💡 **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.
 
+💾 **Cache Management**: Qleaner uses intelligent caching to speed up scans. The cache automatically detects file changes via content hashing. However, if you've made significant changes to your codebase structure or want to ensure a completely fresh scan, use `--clear-cache` before scanning. This is particularly useful:
+- After major refactoring
+- When files have been moved or renamed
+- When you want to ensure the most up-to-date results
+- In CI/CD pipelines where you want consistent, fresh scans
+
 ## Requirements
 
 - Node.js 14+ 

package/bin/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 const { Command } = require("commander");
 const { list, scan } = require("../controllers/list");
-
+const { clearCache } = require("../utils/cache");
 
 async function loadChalk() {
   return (await import("chalk")).default;
@@ -46,7 +46,12 @@ async function loadChalk() {
     )
     .option("-t, --table", "Print the results in a table")
     .option("-d, --dry-run", "Show what would be deleted without actually deleting (skips prompt)")
+    .option("-C, --clear-cache", "Clear the cache")
     .action(async (path, options) => {
+      if(options.clearCache) {
+        clearCache(process.cwd());
+        console.log(chalk.green('✓ Cache cleared successfully'));
+      }
       await scan(chalk, path, options);
     });
 

package/command.js

@@ -5,7 +5,12 @@ const parser = require("@babel/parser");
 const traverse = require("@babel/traverse").default;
 const path = require("path");
 const { createResolver } = require("./utils/resolver");
-const { loadCache, getFileHash, needsRebuild, saveCache } = require("./utils/cache");
+const {
+  loadCache,
+  getFileHash,
+  needsRebuild,
+  saveCache,
+} = require("./utils/cache");
 
 async function getFiles(directory = "src", options, chalk) {
   const contentPaths = [`${directory}/**/*.{tsx,ts,js,jsx}`];
@@ -101,7 +106,6 @@ async function getFiles(directory = "src", options, chalk) {
 }
 
 async function unUsedFiles(chalk, directory = "src", options) {
-  console.time('unUsedFiles');
   const resolver = createResolver(directory);
   const cache = loadCache(process.cwd());
   const contentPaths = [`${directory}/**/*.{tsx,ts,js,jsx}`];
@@ -117,7 +121,7 @@ async function unUsedFiles(chalk, directory = "src", options) {
   }
 
   const files = await fg(contentPaths);
-  const imports = [];
+  let imports = [];
   const unusedFiles = [];
 
   // debug log
@@ -125,7 +129,7 @@ async function unUsedFiles(chalk, directory = "src", options) {
   // console.log('total files---', files.length);
   for (const file of files) {
     const code = fs.readFileSync(file, "utf8");
-    if(needsRebuild(file, code, cache)) {
+    if (needsRebuild(file, code, cache)) {
       const ast = parser.parse(code, {
         sourceType: "module",
         plugins: ["jsx", "typescript"],
@@ -149,25 +153,26 @@ async function unUsedFiles(chalk, directory = "src", options) {
             file: file,
             line: node.loc.start.line,
             column: node.loc.start.column,
-            lastModified: fs.statSync(file).mtime.getTime(),
+            lastModified: fs.statSync(path.resolve(file)).mtime.getTime(),
           });
         },
       });
-    }else {
+    } else {
       // debugCount++;
       // console.log('cache hit', debugCount);
     }
   }
 
-  // console.log('imports', imports);
-  // console.log('files', files);
+  // imports beings empty shows all the files were cached
+  if(imports.length === 0) {
+    imports = cache[directory]? cache[directory].imports: [];
+  }
+
   // debugCount = 0;
-  // console.log('total files', files.length);
   for (const file of files) {
     const code = fs.readFileSync(file, "utf8");
-    if(!cache[file].isImported || needsRebuild(file, code, cache)) {
+    if (!cache[file].isImported || needsRebuild(file, code, cache)) {
       let i = 0;
-      // console.log('Checking', file);
       let isFound = false;
       while (!isFound && i < imports.length) {
         const importFilePath = await resolver(
@@ -175,7 +180,6 @@ async function unUsedFiles(chalk, directory = "src", options) {
           imports[i].file,
           imports[i].from
         );
-        // console.log(chalk.blue('importFilePath'), importFilePath);
         if (compareFiles(path.resolve(file), importFilePath)) {
           isFound = true;
           cache[file].isImported = true;
@@ -192,12 +196,14 @@ async function unUsedFiles(chalk, directory = "src", options) {
         }
         i++;
       }
-    }else {
+    } else {
       // debugCount++;
-      // console.log('debug hit', debugCount);
+      // console.log("debug hit", debugCount);
     }
   }
-  console.timeEnd('unUsedFiles');
+  cache[directory] =  {
+    imports: imports,
+  }
   saveCache(process.cwd(), cache);
   return unusedFiles;
 }

package/package.json

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

package/utils/cache.js

@@ -30,9 +30,17 @@ function saveCache(rootPath, cache) {
     fs.writeFileSync(file, JSON.stringify(cache, null, 2))
 }
 
+
+function clearCache(rootPath) {
+    const file = path.join(rootPath, "unused-check-cache.json");
+    if (fs.existsSync(file)) {
+        fs.unlinkSync(file);
+    }
+}
 module.exports = {
     loadCache,
     getFileHash,
     needsRebuild,
-    saveCache
+    saveCache,
+    clearCache
 }

package/unused-check-cache.json

@@ -1,180 +0,0 @@
-{
-  "src/hello.find.tsx": {
-    "hash": "13088ef1169a758d26b7fde99ca67d5a",
-    "imports": [
-      {
-        "from": "./demo/functions",
-        "file": "src/hello.find.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380790
-      },
-      {
-        "from": "~/demo/book/hidden",
-        "file": "src/hello.find.tsx",
-        "line": 2,
-        "column": 0,
-        "lastModified": 1764776380790
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764776380790
-  },
-  "src/jambo.tsx": {
-    "hash": "6b9a7f99ad2bd68e567368a35bc2831c",
-    "imports": [
-      {
-        "from": "./demo/functions",
-        "file": "src/jambo.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380792
-      },
-      {
-        "from": "hello.find",
-        "file": "src/jambo.tsx",
-        "line": 2,
-        "column": 0,
-        "lastModified": 1764776380792
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764776380792
-  },
-  "src/main.js": {
-    "hash": "961f4425237e1551bb8ec8a136f12a66",
-    "imports": [
-      {
-        "from": "jambo",
-        "file": "src/main.js",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380796
-      },
-      {
-        "from": "poa",
-        "file": "src/main.js",
-        "line": 2,
-        "column": 0,
-        "lastModified": 1764776380796
-      },
-      {
-        "from": "./style.css",
-        "file": "src/main.js",
-        "line": 3,
-        "column": 0,
-        "lastModified": 1764776380796
-      },
-      {
-        "from": "./demo/demo",
-        "file": "src/main.js",
-        "line": 4,
-        "column": 0,
-        "lastModified": 1764776380796
-      },
-      {
-        "from": "./jambo",
-        "file": "src/main.js",
-        "line": 5,
-        "column": 0,
-        "lastModified": 1764776380796
-      },
-      {
-        "from": "@/demo/book/hidden",
-        "file": "src/main.js",
-        "line": 6,
-        "column": 0,
-        "lastModified": 1764776380796
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764776380796
-  },
-  "src/poa.tsx": {
-    "hash": "09d1c8072d500780c9d6b223f5609cc5",
-    "imports": [
-      {
-        "from": "one.png",
-        "file": "src/poa.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380809
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764776380809
-  },
-  "src/demo/demo.tsx": {
-    "hash": "fe20d628c85aad8b491b3e45e6559ce4",
-    "imports": [
-      {
-        "from": "../hello.find",
-        "file": "src/demo/demo.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764828590237
-      },
-      {
-        "from": "../demo/book/hidden",
-        "file": "src/demo/demo.tsx",
-        "line": 2,
-        "column": 0,
-        "lastModified": 1764828590237
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764828590237
-  },
-  "src/demo/functions.js": {
-    "hash": "091a10616a5be2b7c7803a3f7513453e",
-    "imports": [],
-    "isImported": true,
-    "lastModified": 1764776380788
-  },
-  "src/demo/public.tsx": {
-    "hash": "d41d8cd98f00b204e9800998ecf8427e",
-    "imports": [],
-    "isImported": false,
-    "lastModified": 1764690373726
-  },
-  "src/shell/main.js": {
-    "hash": "d41d8cd98f00b204e9800998ecf8427e",
-    "imports": [],
-    "isImported": false,
-    "lastModified": 1764822800241
-  },
-  "src/demo/book/hidden.tsx": {
-    "hash": "6c3fb783f6f246ad67252489ba9367f4",
-    "imports": [
-      {
-        "from": "../../main",
-        "file": "src/demo/book/hidden.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380785
-      }
-    ],
-    "isImported": true,
-    "lastModified": 1764776380785
-  },
-  "src/demo/book/public.tsx": {
-    "hash": "d41d8cd98f00b204e9800998ecf8427e",
-    "imports": [],
-    "isImported": false,
-    "lastModified": 1764690329997
-  },
-  "src/layer/shell/shell.tsx": {
-    "hash": "659029bd48113a93f0ce44bc1e8005d3",
-    "imports": [
-      {
-        "from": "../../demo/book/hidden",
-        "file": "src/layer/shell/shell.tsx",
-        "line": 1,
-        "column": 0,
-        "lastModified": 1764776380795
-      }
-    ],
-    "isImported": false,
-    "lastModified": 1764776380795
-  }
-}