-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: stage work * refactor: revamp public API & refactor bin/execute
- Loading branch information
Showing
8 changed files
with
128 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,61 @@ | ||
| // Import Node.js Dependencies | ||
| import fs from "node:fs/promises"; | ||
|
|
||
| // Import Third-party Dependencies | ||
| import * as rc from "@nodesecure/rc"; | ||
| import kleur from "kleur"; | ||
|
|
||
| // Import Internal Dependencies | ||
| import { store } from "../../src/localStorage.js"; | ||
| import * as nreport from "../../src/index.js"; | ||
|
|
||
| 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() { | ||
| const config = await rc.read( | ||
| process.cwd() | ||
| const [configResult] = await Promise.all([ | ||
| rc.read( | ||
| process.cwd() | ||
| ), | ||
| init() | ||
| ]); | ||
|
|
||
| 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')"); | ||
| } | ||
|
|
||
| console.log(`>> title: ${kleur.cyan().bold(report.title)}`); | ||
| console.log(`>> reporters: ${kleur.magenta().bold(report.reporters.join(","))}\n`); | ||
|
|
||
| store.run(config, () => { | ||
| fetchPackagesAndRepositoriesData() | ||
| .then((data) => reporting.proceed(data)) | ||
| .catch((error) => { | ||
| console.error(error); | ||
| process.exit(0); | ||
| }) | ||
| .finally(teardown); | ||
| }); | ||
| } | ||
|
|
||
| function init() { | ||
| const directoriesToInitialize = [ | ||
| CONSTANTS.DIRS.JSON, | ||
| CONSTANTS.DIRS.CLONES, | ||
| CONSTANTS.DIRS.REPORTS | ||
| ]; | ||
|
|
||
| return Promise.all( | ||
| directoriesToInitialize.map((dir) => fs.mkdir(dir, { recursive: true })) | ||
| ); | ||
| } | ||
|
|
||
| function teardown() { | ||
| console.log(kleur.green().bold("\n>> Security report successfully generated! Enjoy 🚀.\n")); | ||
|
|
||
| store.run(config.unwrap(), () => { | ||
| nreport | ||
| .execute() | ||
| .catch(console.error); | ||
| return fs.rm(CONSTANTS.DIRS.CLONES, { | ||
| recursive: true, force: true | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| }, | ||
| "exports": { | ||
| ".": { | ||
| "import": "./src/api/index.js" | ||
| "import": "./src/index.js" | ||
| } | ||
| }, | ||
| "scripts": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Import Node.js Dependencies | ||
| import path from "node:path"; | ||
| import os from "node:os"; | ||
| import fs from "node:fs/promises"; | ||
|
|
||
| // Import Internal Dependencies | ||
| import { buildStatsFromNsecurePayloads } from "../analysis/extractScannerData.js"; | ||
| import { HTML, PDF } from "../reporting/index.js"; | ||
|
|
||
| export async function report( | ||
| reportOptions, | ||
| scannerPayload | ||
| ) { | ||
| const [pkgStats, reportOutputLocation] = await Promise.all([ | ||
| buildStatsFromNsecurePayloads(scannerPayload, { | ||
| isJson: true, | ||
| reportOptions | ||
| }), | ||
| fs.mkdtemp( | ||
| path.join(os.tmpdir(), "nsecure-report-") | ||
| ) | ||
| ]); | ||
|
|
||
| const reportHTMLPath = await HTML( | ||
| { | ||
| pkgStats, | ||
| repoStats: null | ||
| }, | ||
| reportOptions, | ||
| reportOutputLocation | ||
| ); | ||
|
|
||
| return PDF(reportHTMLPath, { | ||
| title: reportOptions.title, | ||
| saveOnDisk: false | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1 @@ | ||
| // Import Node.js Dependencies | ||
| import fs from "node:fs/promises"; | ||
|
|
||
| // Import Third-party Dependencies | ||
| import kleur from "kleur"; | ||
|
|
||
| // Import Internal Dependencies | ||
| import { fetchPackagesAndRepositoriesData } from "./analysis/fetch.js"; | ||
| import * as localStorage from "./localStorage.js"; | ||
| import * as CONSTANTS from "./constants.js"; | ||
| import * as reporting from "./reporting/index.js"; | ||
|
|
||
| export async function execute(options = Object.create(null)) { | ||
| const { exitOnError = true } = options; | ||
|
|
||
| try { | ||
| await prepareExecute(); | ||
|
|
||
| const config = localStorage.getConfig().report; | ||
| if (config.reporters.length === 0) { | ||
| throw new Error("At least one reporter must be selected (either 'HTML' or 'PDF')"); | ||
| } | ||
|
|
||
| console.log(`>> ${kleur.cyan().bold(config.title)}`); | ||
| console.log(`>> reporters: ${kleur.magenta().bold(config.reporters.join(","))}\n`); | ||
|
|
||
| const data = await fetchPackagesAndRepositoriesData(); | ||
| await reporting.proceed(data); | ||
|
|
||
| console.log(kleur.green().bold("\n>> Security report successfully generated! Enjoy 🚀.\n")); | ||
| } | ||
| catch (error) { | ||
| console.log(kleur.bold().red(error.message)); | ||
|
|
||
| if (!exitOnError) { | ||
| throw error; | ||
| } | ||
| setImmediate(() => process.exit(0)); | ||
| } | ||
| finally { | ||
| await fs.rm(CONSTANTS.DIRS.CLONES, { | ||
| recursive: true, force: true | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| async function prepareExecute() { | ||
| const directoriesToInitialize = [ | ||
| CONSTANTS.DIRS.JSON, CONSTANTS.DIRS.CLONES, CONSTANTS.DIRS.REPORTS | ||
| ]; | ||
|
|
||
| await Promise.all( | ||
| directoriesToInitialize.map((dir) => fs.mkdir(dir, { recursive: true })) | ||
| ); | ||
| } | ||
| export * from "./api/report.js"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters