feat: add option to run in debug mode

README.md

@@ -12,7 +12,7 @@ Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rep
 
 </div>
 
-This project is designed to generate periodic security reports in both HTML and PDF formats. It leverages the [@nodesecure/scanner](https://github.com/NodeSecure/scanner)  to retrieve all necessary data.
+This project is designed to generate periodic security reports in both HTML and PDF formats. It leverages the [@nodesecure/scanner](https://github.com/NodeSecure/scanner) to retrieve all necessary data.
 
 |               Screen1                |               Screen2                |
 | :----------------------------------: | :----------------------------------: |
@@ -85,9 +85,7 @@ This uses the official NodeSecure [runtime configuration](https://github.com/Nod
     },
     "git": {
       "organizationUrl": "https://github.com/NodeSecure",
-      "repositories": [
-        "vulnera"
-      ]
+      "repositories": ["vulnera"]
     },
     "charts": [
       {
@@ -230,6 +228,14 @@ $ npm run preview:light
 $ npm run preview:dark
 ```
 
+## Debug mode
+
+You can write in the file "reports/debug-pkg-repo.txt", all data generated from NPM package and GIT repository scanners using the following option. Usefull if you want to get a preview from this data set.
+
+```bash
+$ nreport exec --debug
+```
+
 ## Contributors ✨
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

bin/commands/execute.js

@@ -1,5 +1,8 @@
 // Import Node.js Dependencies
 import fs from "node:fs/promises";
+import { writeFileSync } from "node:fs";
+import path from "node:path";
+import { inspect } from "node:util";
 
 // Import Third-party Dependencies
 import * as rc from "@nodesecure/rc";
@@ -12,7 +15,13 @@ import { fetchPackagesAndRepositoriesData } from "../../src/analysis/fetch.js";
 import * as CONSTANTS from "../../src/constants.js";
 import * as reporting from "../../src/reporting/index.js";
 
-export async function execute() {
+export async function execute(options = {}) {
+  const { debug: debugMode } = options;
+
+  if (debugMode) {
+    console.log(kleur.bgMagenta().bold(` > Debug mode enabled \n`));
+  }
+
   const [configResult] = await Promise.all([
     rc.read(
       process.cwd()
@@ -22,6 +31,7 @@ export async function execute() {
 
   const config = configResult.unwrap();
   const { report } = config;
+
   if (report.reporters.length === 0) {
     throw new Error("At least one reporter must be selected (either 'HTML' or 'PDF')");
   }
@@ -31,7 +41,13 @@ export async function execute() {
 
   store.run(config, () => {
     fetchPackagesAndRepositoriesData()
-      .then((data) => reporting.proceed(data))
+      .then((data) => {
+        if (debugMode) {
+          debug(data);
+        }
+
+        return reporting.proceed(data);
+      })
       .catch((error) => {
         console.error(error);
         process.exit(0);
@@ -59,3 +75,9 @@ function teardown() {
     recursive: true, force: true
   });
 }
+
+function debug(obj) {
+  const filePath = path.join(CONSTANTS.DIRS.REPORTS, `debug-pkg-repo.txt`);
+  writeFileSync(filePath, inspect(obj, { showHidden: true, depth: null }), "utf8");
+}
+

bin/index.js

@@ -19,6 +19,7 @@ const cli = sade("nreport").version(version);
 
 cli
   .command("execute")
+  .option("-d, --debug", "Enable debug mode", false)
   .alias("exec")
   .describe("Execute report at the current working dir with current configuration.")
   .example("nreport exec")

src/analysis/fetch.js

@@ -77,10 +77,14 @@ async function fetchRepositoriesStats(
     },
     async(spinner) => {
       const repos = await Promise.all(
-        repositories.map((repositoryName) => utils.cloneGITRepository(
-          path.join(CONSTANTS.DIRS.CLONES, repositoryName),
-          `${organizationUrl}/${repositoryName}.git`
-        ))
+        repositories.map((repositoryName) => {
+          const trimmedRepositoryName = repositoryName.trim();
+
+          return utils.cloneGITRepository(
+            path.join(CONSTANTS.DIRS.CLONES, trimmedRepositoryName),
+            `${organizationUrl}/${trimmedRepositoryName}.git`
+          );
+        })
       );
       spinner.text = "Fetching repositories metadata on the NPM Registry";