qleaner 1.2.0 → 1.3.0

package/controllers/initialize.js

@@ -11,13 +11,15 @@ const {
 
 async function init(chalk) {
   const responses = await prompts(QUESTIONS);
-  const ISROOT = responses.alias ? false : true;
-  const ALIAS = responses.alias ? true : false;
+  const ISROOT = responses.alias === "relative" ? true : false;
+  const ALIAS = responses.alias === "public" ? true : false;
   const configFile = path.join(process.cwd(), "qleaner.config.json");
   fs.writeFileSync(
     configFile,
     JSON.stringify(
       {
+        codeAlias: responses.codeAlias,
+        paths: {},
         packageManager: responses.packageManager || "npm",
         excludeDir: DIRECTORIES_TO_EXCLUDE, // Exclude directories from the scan
         excludeFile: ["payload-types.ts", "payload-types.js"], // Exclude files from the scan

package/controllers/list.js

@@ -1,6 +1,7 @@
-const { unUsedFiles, hydrateGraph } = require("../command");
+const { unUsedFiles } = require("../command");
+const { hydrateGraph } = require("../utils/graphUtils");
 const Table = require('cli-table3');
-const { askDeleteFiles } = require("../utils/utils");
+const { askDeleteFiles, loadTSConfig } = require("../utils/utils");
 const fs = require('fs');
 const path = require('path');
 const { summarizeAll, getTop10LargestFiles, dependenciesSummary, formatFilePath } = require("./summary");
@@ -17,7 +18,7 @@ const { query, unusedDependencies: findUnusedDeps } = require("./query");
   let cache;
   try {
     cache = JSON.parse(fs.readFileSync(cachePath, "utf8"));
-  } catch (error) {
+  } catch {
     console.log(chalk.red('⚠️  Error reading cache file. Please run "qleaner scan" again.'));
     return;
   }
@@ -77,7 +78,7 @@ async function unusedDependencies(chalk, directoryPath = process.cwd(), options
   let packageJson;
   try {
     packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
-  } catch (error) {
+  } catch {
     console.log(chalk.red('⚠️  Error reading package.json file.'));
     return;
   }
@@ -99,7 +100,7 @@ async function unusedDependencies(chalk, directoryPath = process.cwd(), options
   let cache;
   try {
     cache = JSON.parse(fs.readFileSync(cachePath, "utf8"));
-  } catch (error) {
+  } catch {
     console.log(chalk.red('⚠️  Error reading cache file. Please run "qleaner scan" again.'));
     return;
   }
@@ -155,7 +156,9 @@ async function summary(chalk, options) {
     }
 }
 
-async function scan(ora, chalk, filePath, options) {
+
+async function scan(ora, chalk, pathToScan, options) {
+    let pathConfig = {};
     // check if qleaner.config.json exists
     if (fs.existsSync(path.join(process.cwd(), "qleaner.config.json"))) {
       const config = JSON.parse(
@@ -165,9 +168,20 @@ async function scan(ora, chalk, filePath, options) {
         ...config,
         ...options,
       };
+      // config file will take precedence over the tsconfig.json file
+      if(config.paths && Object.entries(config.paths).length > 0){
+        pathConfig = config.paths;
+      }else if(config.codeAlias){
+        pathConfig = loadTSConfig(pathToScan, config.codeAlias).paths;
+        if(!pathConfig){
+          console.log(chalk.red('⚠️  Error reading config file. Please run "qleaner scan" again.'));
+          pathConfig = {}
+        }
+      }
     }
+
     // read qleaner.config.json
-    const unusedFiles = await unUsedFiles(ora, chalk,filePath, options);
+    const unusedFiles = await unUsedFiles(ora, chalk,pathToScan, pathConfig, options);
     
     let totalSize = 0;
     const fileArray = Array.from(unusedFiles.values());

package/controllers/summary.js

@@ -1,7 +1,7 @@
 const fs = require("fs");
 const path = require("path");
 const Table = require("cli-table3");
-const { hydrateGraph } = require("../command");
+const { hydrateGraph } = require("../utils/graphUtils");
 const {
   getDeadLinks,
   getTotalImageSize,
@@ -13,8 +13,9 @@ const {
   getTop10FilesWithLightDependencies,
   getTop10FilesHotspots,
   getTotalImageFiles,
-  getTop10FilesCodeDependencies,
   getTop10FilesDependenciesHotspots,
+  getTop10FilesWithMostReexports,
+  getTop10FilesWithMostReexportedBy,
 } = require("../utils/summary");
 
 function formatFilePath(filePath, maxLength = 70) {
@@ -29,7 +30,7 @@ function formatFilePath(filePath, maxLength = 70) {
         relativePath = filePath; // Use absolute if outside project
       }
     }
-  } catch (e) {
+  } catch {
     // If conversion fails, use original path
   }
 
@@ -196,7 +197,7 @@ function getTop10LargestFiles(chalk) {
       colWidths: [90, 15],
       style: { head: [], border: [] },
     });
-    top10CodeFiles.forEach((file, index) => {
+    top10CodeFiles.forEach((file) => {
       codeTable.push([
         chalk.white(formatFilePath(file[0], 85)),
         chalk.magenta((file[1] / 1024).toFixed(2) + " KB"),
@@ -279,10 +280,146 @@ function getTop10LargestFiles(chalk) {
   );
 }
 
-function dependenciesSummary(chalk) {
-  const { codeGraph, imageGraph } = readCacheAndHydrateGraph();
+function printSectionHeader(chalk, title) {
+  console.log(chalk.green.bold(`\n${title}`));
+  console.log(chalk.green("════════════════════════════════════════════════"));
+}
 
-  // Check if data is available
+function printSectionFooter(chalk) {
+  console.log(chalk.green("════════════════════════════════════════════════"));
+}
+
+function displayTableSection(chalk, data, config) {
+  const { title, emptyMessage, headers, colWidths, getRowData, emptyMessageColor } = config;
+  
+  printSectionHeader(chalk, title);
+  
+  if (!data || data.length === 0) {
+    const colorFn = emptyMessageColor || chalk.yellow;
+    console.log(colorFn(`   ${emptyMessage}`));
+  } else {
+    const table = new Table({
+      head: headers.map(h => chalk.cyan(h)),
+      colWidths,
+      style: { head: [], border: [] },
+    });
+    
+    data.forEach((item) => {
+      table.push(getRowData(item));
+    });
+    
+    console.log(table.toString());
+  }
+  
+  printSectionFooter(chalk);
+}
+
+function displayHeavyDependencies(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "🔴 Top 10 Files with Heavy Dependencies",
+    emptyMessage: "No files with heavy dependencies found.",
+    headers: ["File Path", "Imports"],
+    colWidths: [90, 12],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.red((node.imports?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayLightDependencies(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "🟢 Top 10 Files with Light Dependencies",
+    emptyMessage: "No files with light dependencies found.",
+    headers: ["File Path", "Imports"],
+    colWidths: [90, 12],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.green((node.imports?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayFileHotspots(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "🔥 Top 10 File Hotspots (Most Imported)",
+    emptyMessage: "No file hotspots found.",
+    headers: ["File Path", "Imported By"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.magenta((node.importedBy?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayDependencyHotspots(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "📦 Top 10 Files Dependencies Hotspots",
+    emptyMessage: "No dependency hotspots found.",
+    headers: ["File Path", "Dependencies"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.yellow((node.importedBy?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayReexports(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "📤 Top 10 Files that Export the Most Files",
+    emptyMessage: "No files with re-exports found.",
+    headers: ["File Path", "Re-exports"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.blue((node.reExported?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayReexportedBy(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "📥 Top 10 Files that Have Been Exported Most",
+    emptyMessage: "No files re-exported by others found.",
+    headers: ["File Path", "Re-exported By"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.cyan((node.reExportedBy?.size || 0).toString()),
+    ],
+  });
+}
+
+function displayDeadImageHotspots(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "🖼️  Top 10 Dead Image Hotspots",
+    emptyMessage: "✓ No dead image hotspots found.",
+    headers: ["File Path", "Referenced By"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.red((node.importedBy?.size || 0).toString()),
+    ],
+    emptyMessageColor: chalk.green,
+  });
+}
+
+function displayAliveImageHotspots(chalk, data) {
+  displayTableSection(chalk, data, {
+    title: "✅ Top 10 Alive Image Hotspots",
+    emptyMessage: "No alive image hotspots found.",
+    headers: ["File Path", "Referenced By"],
+    colWidths: [90, 15],
+    getRowData: ([filePath, node]) => [
+      chalk.white(formatFilePath(filePath, 85)),
+      chalk.green((node.importedBy?.size || 0).toString()),
+    ],
+  });
+}
+
+function checkDataAvailability(chalk, codeGraph, imageGraph) {
   const hasData = codeGraph.graph.size > 0 || imageGraph.graph.size > 0;
   if (!hasData) {
     console.log(chalk.yellow.bold("\n⚠️  No Project Data Found"));
@@ -293,9 +430,12 @@ function dependenciesSummary(chalk) {
     console.log(
       chalk.yellow("   Use the scan command to generate project data.\n")
     );
-    return;
+    return false;
   }
+  return true;
+}
 
+function collectDependencyData(codeGraph, imageGraph) {
   const top10FilesWithHeavyDependencies = getTop10FilesWithHeavyDependencies(
     codeGraph.graph
   );
@@ -304,153 +444,46 @@ function dependenciesSummary(chalk) {
   );
   const top10FilesHotspots = getTop10FilesDependenciesHotspots(codeGraph.graph, false);
   const top10FilesDependenciesHotspots = getTop10FilesDependenciesHotspots(codeGraph.graph);
-  // image graph
+  const top10FilesWithMostReexports = getTop10FilesWithMostReexports(codeGraph.graph);
+  const top10FilesWithMostReexportedBy = getTop10FilesWithMostReexportedBy(codeGraph.graph);
+  
   const { deadLinks, aliveLinks } = getDeadLinks(imageGraph.graph);
   const top10FilesHotspotsDeadImage = getTop10FilesHotspots(deadLinks);
   const top10FilesHotspotsAliveImage = getTop10FilesHotspots(aliveLinks, false);
 
-  console.log(chalk.green.bold("\n📊 Dependencies Summary"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
+  return {
+    top10FilesWithHeavyDependencies,
+    top10FilesWithLightDependencies,
+    top10FilesHotspots,
+    top10FilesDependenciesHotspots,
+    top10FilesWithMostReexports,
+    top10FilesWithMostReexportedBy,
+    top10FilesHotspotsDeadImage,
+    top10FilesHotspotsAliveImage,
+  };
+}
 
-  // Top 10 Files with Heavy Dependencies
-  console.log(chalk.green.bold("\n🔴 Top 10 Files with Heavy Dependencies"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (
-    !top10FilesWithHeavyDependencies ||
-    top10FilesWithHeavyDependencies.length === 0
-  ) {
-    console.log(chalk.yellow("   No files with heavy dependencies found."));
-  } else {
-    const heavyDepsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Imports")],
-      colWidths: [90, 12],
-      style: { head: [], border: [] },
-    });
-    top10FilesWithHeavyDependencies.forEach(([filePath, node]) => {
-      heavyDepsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.red((node.imports?.size || 0).toString()),
-      ]);
-    });
-    console.log(heavyDepsTable.toString());
-  }
-  console.log(chalk.green("════════════════════════════════════════════════"));
+function dependenciesSummary(chalk) {
+  const { codeGraph, imageGraph } = readCacheAndHydrateGraph();
 
-  // Top 10 Files with Light Dependencies
-  console.log(chalk.green.bold("\n🟢 Top 10 Files with Light Dependencies"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (
-    !top10FilesWithLightDependencies ||
-    top10FilesWithLightDependencies.length === 0
-  ) {
-    console.log(chalk.yellow("   No files with light dependencies found."));
-  } else {
-    const lightDepsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Imports")],
-      colWidths: [90, 12],
-      style: { head: [], border: [] },
-    });
-    top10FilesWithLightDependencies.forEach(([filePath, node]) => {
-      lightDepsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.green((node.imports?.size || 0).toString()),
-      ]);
-    });
-    console.log(lightDepsTable.toString());
+  if (!checkDataAvailability(chalk, codeGraph, imageGraph)) {
+    return;
   }
-  console.log(chalk.green("════════════════════════════════════════════════"));
 
-  // Top 10 Files Hotspots (Most Imported Files)
-  console.log(chalk.green.bold("\n🔥 Top 10 File Hotspots (Most Imported)"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (!top10FilesHotspots || top10FilesHotspots.length === 0) {
-    console.log(chalk.yellow("   No file hotspots found."));
-  } else {
-    const hotspotsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Imported By")],
-      colWidths: [90, 15],
-      style: { head: [], border: [] },
-    });
-    top10FilesHotspots.forEach(([filePath, node]) => {
-      hotspotsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.magenta((node.importedBy?.size || 0).toString()),
-      ]);
-    });
-    console.log(hotspotsTable.toString());
-  }
-  console.log(chalk.green("════════════════════════════════════════════════"));
+  const data = collectDependencyData(codeGraph, imageGraph);
 
-  // Top 10 Files Dependencies Hotspots
-  console.log(chalk.green.bold("\n📦 Top 10 Files Dependencies Hotspots"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (
-    !top10FilesDependenciesHotspots ||
-    top10FilesDependenciesHotspots.length === 0
-  ) {
-    console.log(chalk.yellow("   No dependency hotspots found."));
-  } else {
-    const dependenciesHotspotsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Dependencies")],
-      colWidths: [90, 15],
-      style: { head: [], border: [] },
-    });
-    top10FilesDependenciesHotspots.forEach(([filePath, node]) => {
-      dependenciesHotspotsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.yellow((node.importedBy?.size || 0).toString()),
-      ]);
-    });
-    console.log(dependenciesHotspotsTable.toString());
-  }
+  console.log(chalk.green.bold("\n📊 Dependencies Summary"));
   console.log(chalk.green("════════════════════════════════════════════════"));
 
-  // Image Hotspots - Dead Links
-  console.log(chalk.green.bold("\n🖼️  Top 10 Dead Image Hotspots"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (
-    !top10FilesHotspotsDeadImage ||
-    top10FilesHotspotsDeadImage.length === 0
-  ) {
-    console.log(chalk.green("   ✓ No dead image hotspots found."));
-  } else {
-    const deadImageHotspotsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Referenced By")],
-      colWidths: [90, 15],
-      style: { head: [], border: [] },
-    });
-    top10FilesHotspotsDeadImage.forEach(([filePath, node]) => {
-      deadImageHotspotsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.red((node.importedBy?.size || 0).toString()),
-      ]);
-    });
-    console.log(deadImageHotspotsTable.toString());
-  }
-  console.log(chalk.green("════════════════════════════════════════════════"));
+  displayHeavyDependencies(chalk, data.top10FilesWithHeavyDependencies);
+  displayLightDependencies(chalk, data.top10FilesWithLightDependencies);
+  displayFileHotspots(chalk, data.top10FilesHotspots);
+  displayDependencyHotspots(chalk, data.top10FilesDependenciesHotspots);
+  displayReexports(chalk, data.top10FilesWithMostReexports);
+  displayReexportedBy(chalk, data.top10FilesWithMostReexportedBy);
+  displayDeadImageHotspots(chalk, data.top10FilesHotspotsDeadImage);
+  displayAliveImageHotspots(chalk, data.top10FilesHotspotsAliveImage);
 
-  // Image Hotspots - Alive Links
-  console.log(chalk.green.bold("\n✅ Top 10 Alive Image Hotspots"));
-  console.log(chalk.green("════════════════════════════════════════════════"));
-  if (
-    !top10FilesHotspotsAliveImage ||
-    top10FilesHotspotsAliveImage.length === 0
-  ) {
-    console.log(chalk.yellow("   No alive image hotspots found."));
-  } else {
-    const aliveImageHotspotsTable = new Table({
-      head: [chalk.cyan("File Path"), chalk.cyan("Referenced By")],
-      colWidths: [90, 15],
-      style: { head: [], border: [] },
-    });
-    top10FilesHotspotsAliveImage.forEach(([filePath, node]) => {
-      aliveImageHotspotsTable.push([
-        chalk.white(formatFilePath(filePath, 85)),
-        chalk.green((node.importedBy?.size || 0).toString()),
-      ]);
-    });
-    console.log(aliveImageHotspotsTable.toString());
-  }
   console.log(
     chalk.green("════════════════════════════════════════════════\n")
   );

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qleaner",
   "description": "A CLI tool for analyzing and identifying unused files, images, imports, and dead code in React, TypeScript, and JavaScript projects to help optimize bundle size and maintain clean codebases",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "license": "MIT",
   "main": "command.js",
   "bin": "bin/cli.js",
@@ -60,7 +60,7 @@
     "@types/node": "^20.10.5",
     "eslint": "^9.39.2",
     "globals": "^16.5.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.9.3"
   },
   "dependencies": {
     "@babel/parser": "^7.28.5",
@@ -75,5 +75,3 @@
     "prompts": "^2.4.2"
   }
 }
-
-

package/qleaner.config.json

@@ -1,4 +1,6 @@
 {
+  "codeAlias": null,
+  "paths": {},
   "packageManager": "yarn",
   "excludeDir": [
     "node_modules",
@@ -29,7 +31,20 @@
     "test.tsx",
     "test.ts",
     "test.js",
-    "test.jsx"
+    "test.jsx",
+    "spec.tsx",
+    "spec.ts",
+    "spec.js",
+    "spec.jsx",
+    "d.ts",
+    "config.js",
+    "config.cjs",
+    "config.mjs",
+    "config.ts",
+    "setupTests.ts",
+    "setupTests.js",
+    "setup.ts",
+    "setup.js"
   ],
   "excludeFilePrint": [
     "page.tsx",
@@ -53,7 +68,16 @@
     "_document.tsx",
     "_document.jsx",
     "_error.tsx",
-    "_error.jsx"
+    "_error.jsx",
+    "robots.ts",
+    "robots.js",
+    "sitemap.ts",
+    "sitemap.js",
+    "manifest.ts",
+    "manifest.js",
+    "robots.txt",
+    "not-found.tsx",
+    "not-found.jsx"
   ],
   "excludeDirAssets": [],
   "excludeFileAssets": [],

package/test.js

@@ -0,0 +1,2 @@
+const fs = require('fs');
+console.log(fs.existsSync('src/afxm-iatf-frontent'));