analyze-codebase 1.0.2 → 1.1.0

package/dist/analyze/index.js

@@ -20,7 +20,7 @@ const analyzeCodebase = async (options) => {
         Mixed: 0,
         EmptyBlockComment: 0,
         Empty: 0,
-        ToDo: 0
+        ToDo: 0,
     };
     console.log(chalk_1.default.bold(`\n\nAnalyzing codebase in ${chalk_1.default.cyan(options.directory)} ${(options === null || options === void 0 ? void 0 : options.framework) ? `framework: ${chalk_1.default.cyan(options.framework)}` : ""}\n`));
     let fileCount = 0;
@@ -37,13 +37,13 @@ const analyzeCodebase = async (options) => {
                 fileNameCases[fileNameCase] += 1;
             else
                 fileNameCases[fileNameCase] = 0;
-        }
+        },
     });
     (0, output_1.logOutput)({
         fileCount,
         fileNameCases,
         options,
-        output
+        output,
     });
     const totalSecond = ((Date.now() - start) / 1000).toFixed(2);
     console.log(chalk_1.default.bold(`Time taken: ${chalk_1.default.yellow(totalSecond)}s\n`));

package/dist/index.js

@@ -9,27 +9,34 @@ const commander_1 = require("commander");
 const runner_1 = __importDefault(require("./runner"));
 chalk_1.default.level = 3;
 commander_1.program
-    .arguments('<directory>')
-    .description('Analyze the specified directory')
-    .option('-f, --framework <framework>', 'Specify the framework')
-    .option('-e, --extensions <extensions...>', 'Specify the extensions', (value, previous) => previous.concat(value), [])
-    .option('-exc, --exclude <exclude...>', 'Specify the exclude', (value, previous) => previous.concat(value), [])
-    .option('--checkFileNames [checkFileNames]', 'Check file names', parseBoolean)
-    .option('--checkFileContent [checkFileContent]', 'Check directories', parseBoolean)
+    .arguments("<directory>")
+    .description("Analyze the specified directory")
+    .option("-f, --framework <framework>", "Specify the framework")
+    .option("-e, --extensions <extensions...>", "Specify the extensions", (value, previous) => previous.concat(value), [])
+    .option("-exc, --exclude <exclude...>", "Specify the exclude", (value, previous) => previous.concat(value), [])
+    .option("--checkFileNames [checkFileNames]", "Check file names", parseBoolean)
+    .option("--checkFileContent [checkFileContent]", "Check directories", parseBoolean)
+    .option("-w --writeJsonOutput [writeJsonOutput]", "Write json output", parseBoolean)
     .action((directory, options) => {
     var _a, _b, _c;
-    if (options.checkFileNames === false && options.checkFileContent === false) {
+    if (options.checkFileNames === false &&
+        options.checkFileContent === false) {
         return console.error(chalk_1.default.red(`\nError: You must specify ${chalk_1.default.yellow("true")} at least one of the following options: ${chalk_1.default.yellow("--checkFileNames")}, ${chalk_1.default.yellow("--checkFileContent")}\n`));
     }
-    if ((_a = options === null || options === void 0 ? void 0 : options.extensions) === null || _a === void 0 ? void 0 : _a.find((d) => !d.includes('.'))) {
-        return console.error(chalk_1.default.red('\nError: Extensions must include a dot (.)\n'));
+    if ((_a = options === null || options === void 0 ? void 0 : options.extensions) === null || _a === void 0 ? void 0 : _a.find((d) => !d.includes("."))) {
+        return console.error(chalk_1.default.red("\nError: Extensions must include a dot (.)\n"));
     }
-    (0, runner_1.default)({ ...options, directory, checkFileContent: (_b = options.checkFileContent) !== null && _b !== void 0 ? _b : true, checkFileNames: (_c = options.checkFileNames) !== null && _c !== void 0 ? _c : true });
+    (0, runner_1.default)({
+        ...options,
+        directory,
+        checkFileContent: (_b = options.checkFileContent) !== null && _b !== void 0 ? _b : true,
+        checkFileNames: (_c = options.checkFileNames) !== null && _c !== void 0 ? _c : true,
+    });
 });
 commander_1.program.parse(process.argv);
 function parseBoolean(value) {
-    if (typeof value === 'undefined') {
+    if (typeof value === "undefined") {
         return undefined;
     }
-    return value.toLowerCase() === 'true';
+    return value.toLowerCase() === "true";
 }

package/dist/utils/file.js

@@ -26,14 +26,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.traverseDirectory = void 0;
 const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
+const blackList = [
+    "node_modules",
+    "dist",
+    "build",
+    "coverage",
+    "public",
+    "test",
+    "tests",
+    "mocks",
+];
 const traverseDirectory = async ({ directory, onFile, onDirectory, exclude, extensions, checkFileNames = true, }) => {
     const files = await fs.readdir(directory, { withFileTypes: true });
     const tasks = files.map(async (file) => {
+        var _a;
         const filePath = path.join(directory, file.name);
-        if (exclude === null || exclude === void 0 ? void 0 : exclude.length) {
-            if (exclude.includes(file.name))
-                return;
-        }
+        if (((_a = exclude === null || exclude === void 0 ? void 0 : exclude.includes) === null || _a === void 0 ? void 0 : _a.call(exclude, file.name)) ||
+            file.name.startsWith(".") ||
+            blackList.includes(file.name))
+            return;
         if (file.isDirectory()) {
             onDirectory === null || onDirectory === void 0 ? void 0 : onDirectory(filePath);
             await (0, exports.traverseDirectory)({

package/dist/utils/output.js

@@ -1,21 +1,70 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logOutput = void 0;
-const chalk_1 = __importDefault(require("chalk"));
+const fs = __importStar(require("fs"));
 const cli_table3_1 = __importDefault(require("cli-table3"));
-const logOutput = ({ fileCount, output, fileNameCases, options }) => {
-    console.log(chalk_1.default.bold('------------- Result -------------\n'));
+const chalk_1 = __importDefault(require("chalk"));
+const logOutput = ({ fileCount, output, fileNameCases, options, }) => {
+    // Create an object to store the result information
+    const resultObject = {
+        date: new Date().toISOString(),
+        fileCount,
+        fileNameCases,
+        options,
+        output,
+        // ... other result information ...
+    };
+    // Convert the object to a JSON string
+    const resultJson = JSON.stringify(resultObject, null, 2); // The third parameter (2) adds indentation for better readability
+    // Log the JSON output to the console
+    console.log(chalk_1.default.bold("------------- Result -------------\n"));
+    // console.log(resultJson);
+    if (options.writeJsonOutput) {
+        // Create the directory if it doesn't exist
+        const directoryPath = `${options.directory}/.analyze-codebase`;
+        if (!fs.existsSync(directoryPath))
+            fs.mkdirSync(directoryPath, { recursive: true });
+    }
+    // Write the JSON output to a file (optional)
+    // Continue with your existing console logs (if needed)
     if (fileCount === 0) {
         console.log(chalk_1.default.red(`No files found in ${chalk_1.default.cyan(options.directory)} with extensions ${chalk_1.default.cyan(options.extensions)}\n`));
     }
     else {
         if (options.checkFileNames) {
-            console.log(chalk_1.default.bold('File Name Summary:\n'));
+            console.log(chalk_1.default.bold("File Name Summary:\n"));
             const fileNameTable = new cli_table3_1.default({
-                head: [chalk_1.default.bold('File Name Case'), chalk_1.default.bold('Count'), chalk_1.default.bold('Percentage')],
+                head: [
+                    chalk_1.default.bold("File Name Case"),
+                    chalk_1.default.bold("Count"),
+                    chalk_1.default.bold("Percentage"),
+                ],
                 colWidths: [30, 10, 15],
             });
             Object.entries(fileNameCases).forEach(([key, value]) => {
@@ -23,12 +72,16 @@ const logOutput = ({ fileCount, output, fileNameCases, options }) => {
                 fileNameTable.push([key, value.toString(), `${percentage}%`]);
             });
             console.log(fileNameTable.toString());
-            console.log('\n');
+            console.log("\n");
         }
         if (options.checkFileContent) {
-            console.log(chalk_1.default.bold('Content Type Summary:\n'));
+            console.log(chalk_1.default.bold("Content Type Summary:\n"));
             const contentTypeTable = new cli_table3_1.default({
-                head: [chalk_1.default.bold('Content Type'), chalk_1.default.bold('Count'), chalk_1.default.bold('Percentage')],
+                head: [
+                    chalk_1.default.bold("Content Type"),
+                    chalk_1.default.bold("Count"),
+                    chalk_1.default.bold("Percentage"),
+                ],
                 colWidths: [30, 10, 15],
             });
             Object.entries(output).forEach(([key, value]) => {
@@ -38,7 +91,14 @@ const logOutput = ({ fileCount, output, fileNameCases, options }) => {
             console.log(contentTypeTable.toString());
         }
     }
-    console.log(chalk_1.default.bold('\n----------------------------'));
+    if (options.writeJsonOutput) {
+        const writePath = `${options.directory}/.analyze-codebase/${resultObject.date}.json`;
+        fs.writeFileSync(writePath, resultJson, {
+            flag: "w",
+        });
+        console.log(chalk_1.default.bold(`\nJSON output written to: ${chalk_1.default.cyan(writePath)}\n`));
+    }
+    console.log(chalk_1.default.bold("\n----------------------------"));
     console.log(chalk_1.default.bold(`\nNumber of files read: ${chalk_1.default.yellow(fileCount)}\n`));
 };
 exports.logOutput = logOutput;

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "https://github.com/mtahagocer/analyze-codebase"
   },
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "dist/index.js",
   "license": "MIT",
   "bin": {
@@ -16,18 +16,10 @@
     "start": "node ./dist/index.js",
     "compile": "npx rimraf dist && npx tsc"
   },
-  "contributes": {
-    "commands": [
-      {
-        "command": "extension.analyzeCode",
-        "title": "Analyze Codebase"
-      }
-    ]
-  },
   "devDependencies": {
     "@types/node": "^20.1.5",
-    "typescript": "^5.0.4",
-    "ts-node": "^10.9.1"
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
   },
   "dependencies": {
     "chalk": "4.1.0",

package/readme.md

@@ -21,12 +21,18 @@ You can install Codebase Analyzer globally using NPM:
 npm install -g analyze-codebase 
 ```
 
+or use with npx
+
+```bash
+npx analyze-codebase ./MyProject --exclude node_modules dist --extensions .tsx .ts
+```
+
 ## Usage
 
 To analyze a directory, use the analyze command followed by the directory path. Here's an example:
 
 ```bash
-analyze-codebase analyze ./src
+analyze-codebase ./MyProject --exclude node_modules dist --extensions .tsx .ts
 ```
 
 ## Options
@@ -45,31 +51,31 @@ analyze-codebase analyze ./src
 Analyze a directory with default options:
 
 ```bash
-analyze-codebase analyze ./src
+analyze-codebase ./src
 ```
 
 Analyze a directory with a specified framework and file extensions:
 
 ```bash
-analyze-codebase analyze ./src -f react --extensions .js .jsx .ts .tsx
+analyze-codebase ./src -f react --extensions .js .jsx .ts .tsx
 ```
 
 Exclude specific directories from the analysis:
 
 ```bash
-analyze-codebase analyze ./src --exclude node_modules dist
+analyze-codebase ./src --exclude node_modules dist
 ```
 
 Analyze only file names
 
 ```bash
-analyze-codebase analyze ./src --exclude node_modules dist --checkFileContent=false
+analyze-codebase ./src --exclude node_modules dist --checkFileContent=false
 ```
 
 Analyze only file content
 
 ```bash
-analyze-codebase analyze ./src --exclude node_modules dist --checkFileNames=false
+analyze-codebase ./src --exclude node_modules dist --checkFileNames=false
 ```
 
 ## Contribution