@herodevs/cli 1.0.0-beta.2 → 1.2.0-beta.1

package/dist/commands/report/committers.js

@@ -2,15 +2,16 @@ import { spawnSync } from 'node:child_process';
 import { Command, Flags } from '@oclif/core';
 import fs from 'node:fs';
 import path from 'node:path';
-import { calculateOverallStats, formatOutputBasedOnFlag, groupCommitsByMonth, parseGitLogOutput, } from "../../service/committers.svc.js";
+import { calculateOverallStats, formatAsCsv, formatAsText, groupCommitsByMonth, parseGitLogOutput, } from "../../service/committers.svc.js";
+import { getErrorMessage, isErrnoException } from "../../service/error.svc.js";
 export default class Committers extends Command {
     static description = 'Generate report of committers to a git repository';
     static enableJsonFlag = true;
     static examples = [
         '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> -o csv -s',
-        '<%= config.bin %> <%= command.id %> --output=json',
-        '<%= config.bin %> <%= command.id %> --output=csv',
+        '<%= config.bin %> <%= command.id %> --csv -s',
+        '<%= config.bin %> <%= command.id %> --json',
+        '<%= config.bin %> <%= command.id %> --csv',
     ];
     static flags = {
         months: Flags.integer({
@@ -18,11 +19,10 @@ export default class Committers extends Command {
             description: 'The number of months of git history to review',
             default: 12,
         }),
-        output: Flags.string({
-            char: 'o',
-            description: 'Output format: text, json, or csv',
-            options: ['text', 'json', 'csv'],
-            default: 'text',
+        csv: Flags.boolean({
+            char: 'c',
+            description: 'Output in CSV format',
+            default: false,
         }),
         save: Flags.boolean({
             char: 's',
@@ -32,24 +32,63 @@ export default class Committers extends Command {
     };
     async run() {
         const { flags } = await this.parse(Committers);
-        const { months, output, save } = flags;
+        const { months, csv, save } = flags;
+        const isJson = this.jsonEnabled();
         const sinceDate = `${months} months ago`;
+        this.log('Starting committers report with flags: %O', flags);
         try {
             // Generate structured report data
             const entries = this.fetchGitCommitData(sinceDate);
+            this.log('Fetched %d commit entries', entries.length);
             const reportData = this.generateReportData(entries);
-            const formattedOutput = formatOutputBasedOnFlag(output, reportData);
-            // Output to file or stdout
+            // Handle different output scenarios
+            if (isJson) {
+                // JSON mode
+                if (save) {
+                    try {
+                        fs.writeFileSync(path.resolve('nes.committers.json'), JSON.stringify(reportData, null, 2));
+                        this.log('Report written to json');
+                    }
+                    catch (error) {
+                        this.error(`Failed to save JSON report: ${getErrorMessage(error)}`);
+                    }
+                }
+                return reportData;
+            }
+            const textOutput = formatAsText(reportData);
+            if (csv) {
+                // CSV mode
+                const csvOutput = formatAsCsv(reportData);
+                if (save) {
+                    try {
+                        fs.writeFileSync(path.resolve('nes.committers.csv'), csvOutput);
+                        this.log('Report written to csv');
+                    }
+                    catch (error) {
+                        this.error(`Failed to save CSV report: ${getErrorMessage(error)}`);
+                    }
+                }
+                else {
+                    this.log(textOutput);
+                }
+                return csvOutput;
+            }
             if (save) {
-                fs.writeFileSync(path.resolve(`nes.committers.${output}`), formattedOutput);
-                this.log(`Report written to ${output}`);
+                try {
+                    fs.writeFileSync(path.resolve('nes.committers.txt'), textOutput);
+                    this.log('Report written to txt');
+                }
+                catch (error) {
+                    this.error(`Failed to save txt report: ${getErrorMessage(error)}`);
+                }
             }
             else {
-                this.log(formattedOutput);
+                this.log(textOutput);
             }
+            return textOutput;
         }
         catch (error) {
-            this.error(`Failed to generate report: ${error.message}`);
+            this.error(`Failed to generate report: ${getErrorMessage(error)}`);
         }
     }
     /**
@@ -80,25 +119,28 @@ export default class Committers extends Command {
      * @param sinceDate - Date range for git log
      */
     fetchGitCommitData(sinceDate) {
-        try {
-            const logProcess = spawnSync('git', [
-                'log',
-                '--all', // Include committers on all branches in the repo
-                '--format="%ad|%an"', // Format: date|author
-                '--date=format:%Y-%m', // Format date as YYYY-MM
-                `--since="${sinceDate}"`,
-            ], { encoding: 'utf-8' });
-            if (logProcess.error) {
-                throw new Error(`Git command failed: ${logProcess.error.message}`);
+        const logProcess = spawnSync('git', [
+            'log',
+            '--all', // Include committers on all branches in the repo
+            '--format="%ad|%an"', // Format: date|author
+            '--date=format:%Y-%m', // Format date as YYYY-MM
+            `--since="${sinceDate}"`,
+        ], { encoding: 'utf-8' });
+        if (logProcess.error) {
+            if (isErrnoException(logProcess.error)) {
+                if (logProcess.error.code === 'ENOENT') {
+                    this.error('Git command not found. Please ensure git is installed and available in your PATH.');
+                }
+                this.error(`Git command failed: ${getErrorMessage(logProcess.error)}`);
             }
-            if (!logProcess.stdout) {
-                return [];
-            }
-            return parseGitLogOutput(logProcess.stdout);
+            this.error(`Git command failed: ${getErrorMessage(logProcess.error)}`);
         }
-        catch (error) {
-            this.error(`Failed to fetch git data: ${error.message}`);
-            return []; // This line won't execute due to this.error() above
+        if (logProcess.status !== 0) {
+            this.error(`Git command failed with status ${logProcess.status}: ${logProcess.stderr}`);
+        }
+        if (!logProcess.stdout) {
+            return [];
         }
+        return parseGitLogOutput(logProcess.stdout);
     }
 }

package/dist/commands/report/purls.d.ts

@@ -7,7 +7,9 @@ export default class ReportPurls extends Command {
         file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         dir: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        csv: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<string[]>;
+    run(): Promise<{
+        purls: string[];
+    }>;
 }

package/dist/commands/report/purls.js

@@ -1,16 +1,18 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { Command, Flags, ux } from '@oclif/core';
+import { getErrorMessage, isErrnoException } from "../../service/error.svc.js";
 import { extractPurls, getPurlOutput } from "../../service/purls.svc.js";
-import SbomScan from "../scan/sbom.js";
+import ScanSbom from "../scan/sbom.js";
 export default class ReportPurls extends Command {
     static description = 'Generate a list of purls from a sbom';
     static enableJsonFlag = true;
     static examples = [
+        '<%= config.bin %> <%= command.id %> --json -s',
         '<%= config.bin %> <%= command.id %> --dir=./my-project',
         '<%= config.bin %> <%= command.id %> --file=path/to/sbom.json',
         '<%= config.bin %> <%= command.id %> --dir=./my-project --save',
-        '<%= config.bin %> <%= command.id %> --save --output=csv',
+        '<%= config.bin %> <%= command.id %> --save --csv',
     ];
     static flags = {
         file: Flags.string({
@@ -26,41 +28,59 @@ export default class ReportPurls extends Command {
             default: false,
             description: 'Save the list of purls as nes.purls.<output>',
         }),
-        output: Flags.string({
-            char: 'o',
-            options: ['json', 'csv'],
-            default: 'json',
-            description: 'The format of the saved file (when using --save)',
+        csv: Flags.boolean({
+            char: 'c',
+            default: false,
+            description: 'Save output in CSV format (only applies when using --save)',
         }),
     };
     async run() {
         const { flags } = await this.parse(ReportPurls);
-        const { dir: _dirFlag, file: _fileFlag, save, output } = flags;
-        // Load the SBOM: Only pass the file, dir, and save flags to SbomScan
-        const sbomArgs = SbomScan.getSbomArgs(flags);
-        const sbomCommand = new SbomScan(sbomArgs, this.config);
-        const sbom = await sbomCommand.run();
-        // Extract purls from SBOM
-        const purls = await extractPurls(sbom);
-        ux.action.stop('Scan completed');
-        // Print the purls
-        this.log('Found purls:');
-        for (const purl of purls) {
-            this.log(purl);
-        }
-        // Save if requested
-        if (save) {
-            try {
-                const outputPath = path.join(_dirFlag || process.cwd(), `nes.purls.${output}`);
-                const purlOutput = getPurlOutput(purls, output);
-                fs.writeFileSync(outputPath, purlOutput);
-                this.log(`\nPurls saved to ${outputPath}`);
+        const { dir: _dirFlag, file: _fileFlag, save, csv } = flags;
+        try {
+            const sbom = await ScanSbom.loadSbom(flags, this.config);
+            const purls = await extractPurls(sbom);
+            this.log('Extracted %d purls from SBOM', purls.length);
+            ux.action.stop('Scan completed');
+            // Print the purls
+            for (const purl of purls) {
+                this.log(purl);
             }
-            catch (error) {
-                const errorMessage = error && typeof error === 'object' && 'message' in error ? error.message : 'Unknown error';
-                this.warn(`Failed to save purls: ${errorMessage}`);
+            // Save if requested
+            if (save) {
+                try {
+                    const outputFile = csv && !this.jsonEnabled() ? 'csv' : 'json';
+                    const outputPath = path.join(_dirFlag || process.cwd(), `nes.purls.${outputFile}`);
+                    const purlOutput = getPurlOutput(purls, outputFile);
+                    fs.writeFileSync(outputPath, purlOutput);
+                    this.log('Purls saved to %s', outputPath);
+                }
+                catch (error) {
+                    if (isErrnoException(error)) {
+                        switch (error.code) {
+                            case 'EACCES':
+                                this.error('Permission denied: Cannot write to output file');
+                                break;
+                            case 'ENOSPC':
+                                this.error('No space left on device');
+                                break;
+                            case 'EISDIR':
+                                this.error('Cannot write to output file: Is a directory');
+                                break;
+                            default:
+                                this.error(`Failed to save purls: ${getErrorMessage(error)}`);
+                        }
+                    }
+                    this.error(`Failed to save purls: ${getErrorMessage(error)}`);
+                }
             }
+            // Return wrapped object with metadata
+            return {
+                purls,
+            };
+        }
+        catch (error) {
+            this.error(`Failed to generate PURLs: ${getErrorMessage(error)}`);
         }
-        return purls;
     }
 }

package/dist/commands/scan/eol.d.ts

@@ -1,5 +1,5 @@
 import { Command } from '@oclif/core';
-import type { ScanResult } from '../../api/types/nes.types.ts';
+import type { ScanResultComponent } from '../../api/types/nes.types.ts';
 export default class ScanEol extends Command {
     static description: string;
     static enableJsonFlag: boolean;
@@ -8,9 +8,18 @@ export default class ScanEol extends Command {
         file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         dir: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        all: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        getCustomerSupport: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<ScanResult | {
-        components: [];
+    run(): Promise<{
+        components: ScanResultComponent[];
     }>;
-    private checkEolScanDisabled;
+    private scanSbom;
+    private getFilteredComponents;
+    private saveReport;
+    private displayResults;
+    private displayNoComponentsMessage;
+    private logLine;
+    private displayStatusSection;
+    private logLegend;
 }

package/dist/commands/scan/eol.js

@@ -1,13 +1,18 @@
+import fs from 'node:fs';
 import { Command, Flags, ux } from '@oclif/core';
-import { prepareRows, scanForEol } from "../../service/eol/eol.svc.js";
-import { promptComponentDetails } from "../../ui/eol.ui.js";
-import SbomScan from "./sbom.js";
+import { submitScan } from "../../api/nes/nes.client.js";
+import { getErrorMessage, isErrnoException } from "../../service/error.svc.js";
+import { extractPurls } from "../../service/purls.svc.js";
+import { createStatusDisplay } from "../../ui/eol.ui.js";
+import { INDICATORS, STATUS_COLORS } from "../../ui/shared.us.js";
+import ScanSbom from "./sbom.js";
 export default class ScanEol extends Command {
     static description = 'Scan a given sbom for EOL data';
     static enableJsonFlag = true;
     static examples = [
         '<%= config.bin %> <%= command.id %> --dir=./my-project',
         '<%= config.bin %> <%= command.id %> --file=path/to/sbom.json',
+        '<%= config.bin %> <%= command.id %> -a --dir=./my-project',
     ];
     static flags = {
         file: Flags.string({
@@ -23,49 +28,119 @@ export default class ScanEol extends Command {
             default: false,
             description: 'Save the generated SBOM as nes.sbom.json in the scanned directory',
         }),
+        all: Flags.boolean({
+            char: 'a',
+            description: 'Show all components (default is EOL and LTS only)',
+            default: false,
+        }),
+        getCustomerSupport: Flags.boolean({
+            char: 'c',
+            description: 'Get Never-Ending Support for End-of-Life components',
+            default: false,
+        }),
     };
     async run() {
-        this.checkEolScanDisabled();
         const { flags } = await this.parse(ScanEol);
-        const { dir: _dirFlag, file: _fileFlag } = flags;
-        // Load the SBOM: Only pass the file, dir, and save flags to SbomScan
-        const sbomArgs = SbomScan.getSbomArgs(flags);
-        const sbomCommand = new SbomScan(sbomArgs, this.config);
-        const sbom = await sbomCommand.run();
-        // Scan the SBOM for EOL information
-        const { purls, scan } = await scanForEol(sbom);
-        ux.action.stop('Scan completed');
-        if (!scan?.components) {
-            if (_fileFlag) {
-                throw new Error(`Scan failed to generate for file path: ${_fileFlag}`);
+        if (flags.getCustomerSupport) {
+            this.log(ux.colorize('yellow', 'Never-Ending Support is on the way. Please stay tuned for this feature.'));
+        }
+        const sbom = await ScanSbom.loadSbom(flags, this.config);
+        const scan = await this.scanSbom(sbom);
+        ux.action.stop('\nScan completed');
+        const filteredComponents = this.getFilteredComponents(scan, flags.all);
+        if (flags.save) {
+            await this.saveReport(filteredComponents);
+        }
+        if (this.jsonEnabled()) {
+            return { components: filteredComponents };
+        }
+        await this.displayResults(scan, flags.all);
+        return { components: filteredComponents };
+    }
+    async scanSbom(sbom) {
+        let scan;
+        let purls;
+        try {
+            purls = await extractPurls(sbom);
+        }
+        catch (error) {
+            this.error(`Failed to extract purls from sbom. ${getErrorMessage(error)}`);
+        }
+        try {
+            scan = await submitScan(purls);
+        }
+        catch (error) {
+            this.error(`Failed to submit scan to NES from sbom. ${getErrorMessage(error)}`);
+        }
+        if (scan.components.size === 0) {
+            this.warn('No components found in scan');
+        }
+        return scan;
+    }
+    getFilteredComponents(scan, all) {
+        return Array.from(scan.components.entries())
+            .filter(([_, component]) => all || ['EOL', 'LTS'].includes(component.info.status))
+            .map(([_, component]) => component);
+    }
+    async saveReport(components) {
+        try {
+            fs.writeFileSync('nes.eol.json', JSON.stringify({ components }, null, 2));
+            this.log('Report saved to nes.eol.json');
+        }
+        catch (error) {
+            if (isErrnoException(error)) {
+                switch (error.code) {
+                    case 'EACCES':
+                        this.error('Permission denied. Unable to save report to nes.eol.json');
+                        break;
+                    case 'ENOSPC':
+                        this.error('No space left on device. Unable to save report to nes.eol.json');
+                        break;
+                    default:
+                        this.error(`Failed to save report: ${getErrorMessage(error)}`);
+                }
             }
-            if (_dirFlag) {
-                throw new Error(`Scan failed to generate for dir: ${_dirFlag}`);
+            else {
+                this.error(`Failed to save report: ${getErrorMessage(error)}`);
             }
-            throw new Error('Scan failed to generate components.');
         }
-        const lines = await prepareRows(purls, scan);
-        if (lines?.length === 0) {
-            this.log('No dependencies found');
-            return { components: [] };
+    }
+    async displayResults(scan, all) {
+        const { UNKNOWN, OK, LTS, EOL } = createStatusDisplay(scan.components, all);
+        if (!UNKNOWN.length && !OK.length && !LTS.length && !EOL.length) {
+            this.displayNoComponentsMessage(all);
+            return;
+        }
+        this.log(ux.colorize('bold', 'Here are the results of the scan:'));
+        this.logLine();
+        // Display sections in order of increasing severity
+        for (const components of [UNKNOWN, OK, LTS, EOL]) {
+            this.displayStatusSection(components);
         }
-        const r = await promptComponentDetails(lines);
-        this.log('What now %o', r);
-        return scan;
+        this.logLegend();
     }
-    checkEolScanDisabled(override = true) {
-        // Check if running in beta version or pre v1.0.0
-        const version = this.config.version;
-        const [major] = version.split('.').map(Number);
-        if (version.includes('beta') || major < 1) {
-            this.log(`VERSION=${version}`);
-            throw new Error('The EOL scan feature is not available in beta releases. Please wait for the stable release.');
+    displayNoComponentsMessage(all) {
+        if (!all) {
+            this.log(ux.colorize('yellow', 'No End-of-Life or Long Term Support components found in scan.'));
+            this.log(ux.colorize('yellow', 'Use --all flag to view all components.'));
+        }
+        else {
+            this.log(ux.colorize('yellow', 'No components found in scan.'));
         }
-        // Just in case the beta check fails
-        if (override) {
-            this.log(`VERSION=${version}`);
-            this.log('EOL scan is disabled');
-            return { components: [] };
+    }
+    logLine() {
+        this.log(ux.colorize('bold', '-'.repeat(50)));
+    }
+    displayStatusSection(components) {
+        if (components.length > 0) {
+            this.log(components.join('\n'));
+            this.logLine();
         }
     }
+    logLegend() {
+        this.log(ux.colorize(`${STATUS_COLORS.UNKNOWN}`, `${INDICATORS.UNKNOWN} = No Known Issues`));
+        this.log(ux.colorize(`${STATUS_COLORS.OK}`, `${INDICATORS.OK} = OK`));
+        this.log(ux.colorize(`${STATUS_COLORS.LTS}`, `${INDICATORS.LTS}= Long Term Support (LTS)`));
+        this.log(ux.colorize(`${STATUS_COLORS.EOL}`, `${INDICATORS.EOL} = End of Life (EOL)`));
+    }
 }

package/dist/commands/scan/sbom.d.ts

@@ -8,11 +8,14 @@ export default class ScanSbom extends Command {
         file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         dir: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         save: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        background: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
+    static loadSbom(flags: Record<string, string>, config: Command['config']): Promise<Sbom>;
     static getSbomArgs(flags: Record<string, string>): string[];
     getScanOptions(): {};
-    run(): Promise<Sbom>;
+    run(): Promise<Sbom | undefined>;
     private _getSbomFromScan;
+    private _getSbomInBackground;
     private _getSbomFromFile;
     private _saveSbom;
 }