vibe-guard 1.2.0 → 2.1.0

package/dist/reporter.js

@@ -4,496 +4,160 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Reporter = void 0;
-const Table = require('cli-table3');
 const chalk_1 = __importDefault(require("chalk"));
-// Class for reporting the scan results
+const path_1 = __importDefault(require("path"));
+const version_1 = require("./types/version");
 class Reporter {
-    // Formats the scan results as a table
     formatTable(result) {
         if (result.issues.length === 0) {
-            return this.formatSuccess(result);
+            return chalk_1.default.green(`No security issues found in ${result.filesScanned} files`);
         }
-        const table = new Table({
-            head: [
-                chalk_1.default.bold('Rule'),
-                chalk_1.default.bold('Severity'),
-                chalk_1.default.bold('File'),
-                chalk_1.default.bold('Line'),
-                chalk_1.default.bold('Message')
-            ],
-            colWidths: [25, 12, 40, 8, 60],
-            wordWrap: true
-        });
-        result.issues.forEach(issue => {
-            table.push([
-                issue.rule,
-                this.colorSeverity(issue.severity),
-                this.truncateFilePath(issue.file),
-                issue.line.toString(),
-                issue.message
-            ]);
-        });
-        return this.formatHeader(result) + '\n\n' + table.toString() + '\n\n' + this.formatSummary(result);
+        const issues = result.issues.map((i) => {
+            const finding = `${this.colorSeverity(i.severity)} ${i.rule.padEnd(25)} ${this.truncateFilePath(i.file)}:${i.line} ${i.message}`;
+            return i.suggestion ? `${finding}\n  Remediation: ${i.suggestion}` : finding;
+        }).join('\n');
+        return `${chalk_1.default.red.bold(`Found ${result.issuesFound} issues in ${result.filesScanned} files`)}\n${issues}`;
     }
-    // Formats the scan results as a JSON string
     formatJson(result) {
         return JSON.stringify(result, null, 2);
     }
-    // Formats the scan results as a SARIF string
+    truncateFilePath(filePath, maxLength = 50) {
+        if (!filePath || filePath.trim() === '' || /^[\.\/\\]*$/.test(filePath)) {
+            return '';
+        }
+        const sanitized = path_1.default.posix.normalize(filePath)
+            .replace(/\\/g, '/')
+            .replace(/^\/+/, '')
+            .replace(/^(\.\.[/\\])+/, '');
+        if (sanitized.length <= maxLength)
+            return sanitized;
+        const parts = sanitized.split('/');
+        if (parts.length === 2)
+            return sanitized;
+        if (parts.length >= 3) {
+            const first = parts[0];
+            const last = parts[parts.length - 1];
+            const result = `${first}/.../${last}`;
+            if (result.length <= maxLength)
+                return result;
+        }
+        const left = Math.ceil((maxLength - 3) / 2);
+        const right = Math.floor((maxLength - 3) / 2);
+        return `${sanitized.slice(0, left)}...${sanitized.slice(-right)}`;
+    }
     formatSarif(result) {
-        const sarif = {
-            $schema: "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json",
+        return JSON.stringify({
+            $schema: "https://json.schemastore.org/sarif-2.1.0-rtm.5.json",
             version: "2.1.0",
-            runs: [
-                {
+            runs: [{
                     tool: {
                         driver: {
                             name: "Vibe-Guard",
-                            version: "1.1.5",
-                            informationUri: "https://github.com/Devjosef/vibe-guard",
-                            rules: this.generateSarifRules(result)
+                            version: version_1.VERSION,
+                            informationUri: "https://github.com/Devjosef/vibe-guard"
                         }
                     },
-                    results: this.generateSarifResults(result),
-                    invocations: [
-                        {
-                            executionSuccessful: true,
-                            toolExecutionNotifications: [
-                                {
-                                    descriptor: {
-                                        id: "vibe-guard-scan"
-                                    },
-                                    message: {
-                                        text: `Scanned ${result.filesScanned} files and found ${result.issuesFound} security issues`
-                                    }
+                    invocations: [{
+                            executionSuccessful: true
+                        }],
+                    results: result.issues.map(issue => ({
+                        ruleId: issue.rule,
+                        level: issue.severity === 'critical' || issue.severity === 'high'
+                            ? 'error'
+                            : issue.severity === 'medium' ? 'warning' : 'note',
+                        message: {
+                            text: issue.suggestion
+                                ? `${issue.message}\nRemediation: ${issue.suggestion}`
+                                : issue.message
+                        },
+                        locations: [{
+                                physicalLocation: {
+                                    artifactLocation: { uri: issue.file },
+                                    region: { startLine: issue.line }
                                 }
-                            ]
-                        }
-                    ]
-                }
-            ]
-        };
-        return JSON.stringify(sarif, null, 2);
+                            }]
+                    }))
+                }]
+        }, null, 2);
     }
-    // Formats the scan results as an HTML string
     formatHtml(result) {
-        const html = `<!DOCTYPE html>
-<html lang="en">
+        let contentHtml = '';
+        if (result.issues.length === 0) {
+            contentHtml = `
+      <div class="summary">
+        <h2>Scan Summary</h2>
+        <p><strong>No security issues found</strong></p>
+      </div>`;
+        }
+        else {
+            const issuesHtml = result.issues.map(issue => {
+                const rule = this.escapeHtml(issue.rule);
+                const file = this.escapeHtml(this.truncateFilePath(issue.file));
+                const message = this.escapeHtml(issue.message);
+                const suggestion = this.escapeHtml(issue.suggestion);
+                return `<div style="border-left: 4px solid ${this.getSeverityColor(issue.severity)}; padding: 10px; margin: 10px 0; background: #f8f9fa;">
+        <h3 style="margin-top: 0; color: ${this.getSeverityColor(issue.severity)};">${rule}</h3>
+        <p><strong>File:</strong> ${file}:${issue.line}</p>
+        <p>${message}</p>
+        ${suggestion ? `<p><strong>Suggested fix:</strong> ${suggestion}</p>` : ''}
+      </div>`;
+            }).join('');
+            contentHtml = `
+      <div class="summary">
+        <h2>Scan Summary</h2>
+        <p>Found <strong>${result.issuesFound}</strong> issues in <strong>${result.filesScanned}</strong> files</p>
+      </div>
+      ${issuesHtml}`;
+        }
+        return `<!DOCTYPE html>
+<html>
 <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Vibe-Guard Security Report</title>
-    <style>
-        * {
-            margin: 0;
-            padding: 0;
-            box-sizing: border-box;
-        }
-        
-        body {
-            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
-            line-height: 1.6;
-            color: #333;
-            background: #f5f5f5;
-            padding: 2rem;
-        }
-        
-        .container {
-            max-width: 1200px;
-            margin: 0 auto;
-            background: white;
-            border-radius: 8px;
-            box-shadow: 0 2px 10px rgba(0,0,0,0.1);
-            overflow: hidden;
-        }
-        
-        .header {
-            background: linear-gradient(135deg, #ff4757, #ff3838);
-            color: white;
-            padding: 2rem;
-            text-align: center;
-        }
-        
-        .header h1 {
-            font-size: 2.5rem;
-            margin-bottom: 0.5rem;
-        }
-        
-        .header p {
-            font-size: 1.1rem;
-            opacity: 0.9;
-        }
-        
-        .summary {
-            padding: 2rem;
-            background: #f8f9fa;
-            border-bottom: 1px solid #e9ecef;
-        }
-        
-        .summary-grid {
-            display: grid;
-            grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
-            gap: 1rem;
-            margin-top: 1rem;
-        }
-        
-        .summary-card {
-            background: white;
-            padding: 1.5rem;
-            border-radius: 8px;
-            text-align: center;
-            border-left: 4px solid;
-        }
-        
-        .summary-card.critical { border-left-color: #dc3545; }
-        .summary-card.high { border-left-color: #fd7e14; }
-        .summary-card.medium { border-left-color: #ffc107; }
-        .summary-card.low { border-left-color: #17a2b8; }
-        
-        .summary-card h3 {
-            font-size: 2rem;
-            margin-bottom: 0.5rem;
-        }
-        
-        .summary-card.critical h3 { color: #dc3545; }
-        .summary-card.high h3 { color: #fd7e14; }
-        .summary-card.medium h3 { color: #ffc107; }
-        .summary-card.low h3 { color: #17a2b8; }
-        
-        .issues {
-            padding: 2rem;
-        }
-        
-        .issue {
-            background: white;
-            border: 1px solid #e9ecef;
-            border-radius: 8px;
-            margin-bottom: 1rem;
-            overflow: hidden;
-        }
-        
-        .issue-header {
-            padding: 1rem;
-            border-bottom: 1px solid #e9ecef;
-            display: flex;
-            justify-content: space-between;
-            align-items: center;
-        }
-        
-        .issue-title {
-            font-weight: 600;
-            font-size: 1.1rem;
-        }
-        
-        .severity {
-            padding: 0.25rem 0.75rem;
-            border-radius: 20px;
-            font-size: 0.875rem;
-            font-weight: 600;
-            text-transform: uppercase;
-        }
-        
-        .severity.critical { background: #dc3545; color: white; }
-        .severity.high { background: #fd7e14; color: white; }
-        .severity.medium { background: #ffc107; color: #212529; }
-        .severity.low { background: #17a2b8; color: white; }
-        
-        .issue-content {
-            padding: 1rem;
-        }
-        
-        .issue-meta {
-            display: grid;
-            grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
-            gap: 1rem;
-            margin-bottom: 1rem;
-        }
-        
-        .meta-item {
-            background: #f8f9fa;
-            padding: 0.75rem;
-            border-radius: 4px;
-        }
-        
-        .meta-label {
-            font-size: 0.875rem;
-            color: #6c757d;
-            margin-bottom: 0.25rem;
-        }
-        
-        .meta-value {
-            font-weight: 600;
-            font-family: 'SF Mono', Monaco, 'Cascadia Code', monospace;
-        }
-        
-        .code-snippet {
-            background: #f8f9fa;
-            border: 1px solid #e9ecef;
-            border-radius: 4px;
-            padding: 1rem;
-            font-family: 'SF Mono', Monaco, 'Cascadia Code', monospace;
-            font-size: 0.875rem;
-            overflow-x: auto;
-        }
-        
-        .suggestion {
-            background: #e7f3ff;
-            border: 1px solid #b3d9ff;
-            border-radius: 4px;
-            padding: 1rem;
-            margin-top: 1rem;
-        }
-        
-        .suggestion h4 {
-            color: #0066cc;
-            margin-bottom: 0.5rem;
-        }
-        
-        .footer {
-            background: #f8f9fa;
-            padding: 2rem;
-            text-align: center;
-            color: #6c757d;
-            border-top: 1px solid #e9ecef;
-        }
-        
-        @media (max-width: 768px) {
-            body { padding: 1rem; }
-            .header h1 { font-size: 2rem; }
-            .issue-header { flex-direction: column; align-items: flex-start; gap: 0.5rem; }
-        }
-    </style>
+  <title>Vibe-Guard Security Scan Results</title>
+  <style>
+    body { font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif; max-width: 1000px; margin: 0 auto; padding: 20px; }
+    h1 { color: #1e40af; }
+    .summary { background: #f0f9ff; padding: 20px; border-radius: 8px; margin-bottom: 20px; }
+  </style>
 </head>
 <body>
-    <div class="container">
-        <div class="header">
-            <h1>██ Vibe-Guard Security Report</h1>
-            <p>Security scan completed on ${new Date().toLocaleDateString()}</p>
-        </div>
-        
-        <div class="summary">
-            <h2>Summary</h2>
-            <div class="summary-grid">
-                <div class="summary-card critical">
-                    <h3>${result.summary.critical}</h3>
-                    <p>Critical Issues</p>
-                </div>
-                <div class="summary-card high">
-                    <h3>${result.summary.high}</h3>
-                    <p>High Issues</p>
-                </div>
-                <div class="summary-card medium">
-                    <h3>${result.summary.medium}</h3>
-                    <p>Medium Issues</p>
-                </div>
-                <div class="summary-card low">
-                    <h3>${result.summary.low}</h3>
-                    <p>Low Issues</p>
-                </div>
-            </div>
-            <p style="margin-top: 1rem; color: #6c757d;">
-                Scanned ${result.filesScanned} files and found ${result.issuesFound} security issues
-            </p>
-        </div>
-        
-        <div class="issues">
-            <h2>Security Issues</h2>
-            ${result.issues.length === 0 ?
-            '<div style="text-align: center; padding: 3rem; color: #28a745;"><h3>✅ No security issues found!</h3><p>Your code looks secure.</p></div>' :
-            result.issues.map(issue => this.formatHtmlIssue(issue)).join('')}
-        </div>
-        
-        <div class="footer">
-            <p>Generated by Vibe-Guard v1.1.5 | <a href="https://github.com/Devjosef/vibe-guard">GitHub</a></p>
-        </div>
-    </div>
+  <h1>Vibe-Guard Security Report</h1>
+  ${contentHtml}
 </body>
 </html>`;
-        return html;
     }
-    // Generates the SARIF rules
-    generateSarifRules(result) {
-        const ruleNames = [...new Set(result.issues.map(issue => issue.rule))];
-        return ruleNames.map(ruleName => ({
-            id: ruleName,
-            name: ruleName,
-            shortDescription: {
-                text: `Security rule: ${ruleName}`
-            }
-        }));
-    }
-    // Generates the SARIF results
-    generateSarifResults(result) {
-        return result.issues.map(issue => ({
-            ruleId: issue.rule,
-            level: this.mapSeverityToSarifLevel(issue.severity),
-            message: {
-                text: issue.message
-            },
-            locations: [
-                {
-                    physicalLocation: {
-                        artifactLocation: {
-                            uri: issue.file
-                        },
-                        region: {
-                            startLine: issue.line,
-                            startColumn: issue.column
-                        }
-                    }
-                }
-            ],
-            properties: {
-                suggestion: issue.suggestion
-            }
-        }));
-    }
-    // Maps the severity to the SARIF level
-    mapSeverityToSarifLevel(severity) {
-        switch (severity) {
-            case 'critical':
-            case 'high':
-                return 'error';
-            case 'medium':
-                return 'warning';
-            case 'low':
-                return 'note';
-            default:
-                return 'note';
-        }
-    }
-    // Formats the HTML issue
-    formatHtmlIssue(issue) {
-        return `
-        <div class="issue">
-            <div class="issue-header">
-                <div class="issue-title">${this.escapeHtml(issue.rule)}</div>
-                <div class="severity ${issue.severity}">${issue.severity.toUpperCase()}</div>
-            </div>
-            <div class="issue-content">
-                <p><strong>${this.escapeHtml(issue.message)}</strong></p>
-                
-                <div class="issue-meta">
-                    <div class="meta-item">
-                        <div class="meta-label">File</div>
-                        <div class="meta-value">${this.escapeHtml(issue.file)}</div>
-                    </div>
-                    <div class="meta-item">
-                        <div class="meta-label">Line</div>
-                        <div class="meta-value">${issue.line}:${issue.column}</div>
-                    </div>
-                    <div class="meta-item">
-                        <div class="meta-label">Rule</div>
-                        <div class="meta-value">${this.escapeHtml(issue.rule)}</div>
-                    </div>
-                </div>
-                
-                <div class="code-snippet">${this.escapeHtml(issue.code)}</div>
-                
-                <div class="suggestion">
-                    <h4>💡 Suggestion</h4>
-                    <p>${this.escapeHtml(issue.suggestion)}</p>
-                </div>
-            </div>
-        </div>
-    `;
-    }
-    escapeHtml(text) {
-        return text
+    formatIssueDetails(issue) {
+        const location = `${this.truncateFilePath(issue.file)}:${issue.line}${issue.column ? `:${issue.column}` : ''}`;
+        const fullMessage = `${issue.message}\n\n${issue.code}` +
+            (issue.suggestion ? `\nSuggested fix: ${issue.suggestion}` : '');
+        return `${chalk_1.default.bold.yellow(issue.rule)} ${this.colorSeverity(issue.severity)}\n` +
+            `${chalk_1.default.gray(`File: ${location}`)}\n\n` +
+            `${fullMessage}`;
+    }
+    colorSeverity(sev) {
+        switch (sev) {
+            case 'critical': return chalk_1.default.red.bold('CRITICAL');
+            case 'high': return chalk_1.default.red('HIGH');
+            case 'medium': return chalk_1.default.yellow('MEDIUM');
+            case 'low': return chalk_1.default.blue('LOW');
+            default: return String(sev).toUpperCase();
+        }
+    }
+    getSeverityColor(sev) {
+        switch (sev) {
+            case 'critical': return '#dc3545';
+            case 'high': return '#fd7e14';
+            case 'medium': return '#ffc107';
+            case 'low': return '#0d6efd';
+            default: return '#6c757d';
+        }
+    }
+    escapeHtml(value) {
+        return value
             .replace(/&/g, '&amp;')
             .replace(/</g, '&lt;')
             .replace(/>/g, '&gt;')
             .replace(/"/g, '&quot;')
-            .replace(/'/g, '&#039;');
-    }
-    formatSuccess(result) {
-        const header = chalk_1.default.green.bold('╔══════════════════════════════════════════════════════════════════════════════╗');
-        const title = chalk_1.default.green.bold('║                           VIBE-GUARD SECURITY SCAN COMPLETE                    ║');
-        const subtitle = chalk_1.default.green.bold('║                                NO THREATS DETECTED                            ║');
-        const summary = chalk_1.default.green(`║  ✅ No security issues found in ${result.filesScanned} files`);
-        const footer = chalk_1.default.green.bold('╚══════════════════════════════════════════════════════════════════════════════╝');
-        return `${header}\n${title}\n${subtitle}\n${summary.padEnd(75)} ║\n${footer}\n`;
-    }
-    formatHeader(result) {
-        const header = chalk_1.default.red.bold('╔══════════════════════════════════════════════════════════════════════════════╗');
-        const title = chalk_1.default.red.bold('║                        VIBE-GUARD SECURITY ISSUES DETECTED                     ║');
-        const subtitle = chalk_1.default.yellow.bold(`║                           ${result.issuesFound} THREATS FOUND IN ${result.filesScanned} FILES                           ║`);
-        const footer = chalk_1.default.red.bold('╚══════════════════════════════════════════════════════════════════════════════╝');
-        return `${header}\n${title}\n${subtitle}\n${footer}\n`;
-    }
-    formatSummary(result) {
-        const { summary } = result;
-        const parts = [];
-        if (summary.critical > 0) {
-            parts.push(chalk_1.default.red.bold(`${summary.critical} CRITICAL`));
-        }
-        if (summary.high > 0) {
-            parts.push(chalk_1.default.red(`${summary.high} HIGH`));
-        }
-        if (summary.medium > 0) {
-            parts.push(chalk_1.default.yellow(`${summary.medium} MEDIUM`));
-        }
-        if (summary.low > 0) {
-            parts.push(chalk_1.default.blue(`${summary.low} LOW`));
-        }
-        const summaryText = parts.length > 0 ? parts.join(' | ') : 'No issues';
-        return chalk_1.default.bold('╔══════════════════════════════════════════════════════════════════════════════╗\n') +
-            chalk_1.default.bold('║                                    SUMMARY                                    ║\n') +
-            chalk_1.default.bold('║  ') + summaryText.padEnd(73) + chalk_1.default.bold('║\n') +
-            chalk_1.default.bold('╚══════════════════════════════════════════════════════════════════════════════╝\n\n') +
-            this.formatRecommendations();
-    }
-    formatRecommendations() {
-        return chalk_1.default.cyan.bold('╔══════════════════════════════════════════════════════════════════════════════╗\n') +
-            chalk_1.default.cyan.bold('║                                RECOMMENDATIONS                               ║\n') +
-            chalk_1.default.cyan.bold('║  • Review and fix critical and high severity issues immediately').padEnd(73) + chalk_1.default.cyan.bold('║\n') +
-            chalk_1.default.cyan.bold('║  • Consider implementing security linting in your CI/CD pipeline').padEnd(73) + chalk_1.default.cyan.bold('║\n') +
-            chalk_1.default.cyan.bold('║  • Run Vibe-Guard regularly during development').padEnd(73) + chalk_1.default.cyan.bold('║\n') +
-            chalk_1.default.cyan.bold('║  • Check our documentation for detailed fix suggestions').padEnd(73) + chalk_1.default.cyan.bold('║\n') +
-            chalk_1.default.cyan.bold('╚══════════════════════════════════════════════════════════════════════════════╝');
-    }
-    // Colors the severity
-    colorSeverity(severity) {
-        switch (severity) {
-            case 'critical':
-                return chalk_1.default.red.bold('CRITICAL');
-            case 'high':
-                return chalk_1.default.red('HIGH');
-            case 'medium':
-                return chalk_1.default.yellow('MEDIUM');
-            case 'low':
-                return chalk_1.default.blue('LOW');
-            default:
-                return String(severity).toUpperCase();
-        }
-    }
-    // Truncates the file path
-    truncateFilePath(filePath, maxLength = 35) {
-        let sanitizedPath = filePath.replace(/\\+/g, '/').replace(/\\/g, '/').replace(/\/+/g, '/');
-        sanitizedPath = sanitizedPath.replace(/\.\./g, '').replace(/\/+/g, '/');
-        sanitizedPath = sanitizedPath.replace(/^\/+/, '');
-        if (sanitizedPath.length <= maxLength) {
-            return sanitizedPath;
-        }
-        const parts = sanitizedPath.split('/');
-        if (parts.length <= 2) {
-            return sanitizedPath;
-        }
-        const first = parts[0];
-        const last = parts[parts.length - 1];
-        const truncated = `${first}/.../${last}`;
-        if (truncated.length <= maxLength) {
-            return truncated;
-        }
-        return '...' + sanitizedPath.slice(-(maxLength - 3));
-    }
-    formatIssueDetails(issue) {
-        const header = chalk_1.default.red.bold(`\n🚨 ${issue.rule} (${this.colorSeverity(issue.severity)})`);
-        const location = chalk_1.default.gray(`📍 ${issue.file}:${issue.line}:${issue.column}`);
-        const message = chalk_1.default.white(`💬 ${issue.message}`);
-        const code = chalk_1.default.gray(`📝 Code: ${issue.code}`);
-        const suggestion = chalk_1.default.green(`💡 Suggestion: ${issue.suggestion}`);
-        return `${header}\n${location}\n${message}\n${code}\n${suggestion}\n`;
+            .replace(/'/g, '&#39;');
     }
 }
 exports.Reporter = Reporter;