/** * HTML Reporter for Footprint/Symbol Validation * * Generates side-by-side HTML reports comparing reference vs generated output */ import type { ValidationResult, FootprintComparisonResult, SymbolComparisonResult, PadDiff, PinDiff, } from './types.js'; // ============================================================================= // HTML Report Generation // ============================================================================= export interface ReportSvgs { footprintRef?: string; footprintGen?: string; symbolRef?: string; symbolGen?: string; } /** * Generate an HTML report for a single validation result */ export function generateValidationReport( result: ValidationResult, svgs?: ReportSvgs ): string { const statusClass = result.passed ? 'pass' : 'fail'; const statusText = result.passed ? 'PASS' : 'FAIL'; return ` Validation: ${result.lcscCode} - ${result.componentName}

${result.componentName}

LCSC: ${result.lcscCode} ${statusText} ${result.durationMs}ms
${result.error ? `
${escapeHtml(result.error)}
` : ''}
${(svgs?.footprintRef || svgs?.footprintGen || result.footprint) ? `

Footprint

${(svgs?.footprintRef || svgs?.footprintGen) ? `

Reference (EasyEDA/JLCPCB)

${svgs?.footprintRef || '
Not available
'}

Generated (JLC-CLI)

${svgs?.footprintGen || '
Not available
'}
` : ''} ${result.footprint ? generateFootprintSection(result.footprint) : ''}
` : ''} ${(svgs?.symbolRef || svgs?.symbolGen || result.symbol) ? `

Symbol

${(svgs?.symbolRef || svgs?.symbolGen) ? `

Reference (EasyEDA/JLCPCB)

${svgs?.symbolRef || '
Not available
'}

Generated (JLC-CLI)

${svgs?.symbolGen || '
Not available
'}
` : ''} ${result.symbol ? generateSymbolSection(result.symbol) : ''}
` : ''}
`; } /** * Generate a batch report for multiple validation results */ export function generateBatchReport( results: ValidationResult[], title = 'Validation Report' ): string { const passed = results.filter((r) => r.passed).length; const failed = results.filter((r) => !r.passed).length; const errorCount = results.filter((r) => r.error).length; return ` ${title}

${title}

${passed} passed ${failed} failed ${errorCount} errors ${results.length} total
${results.map((r) => generateResultRow(r)).join('\n')}
LCSC Component Footprint Symbol Status Duration
${generateDetailedResults(results)}
`; } // ============================================================================= // Section Generators // ============================================================================= function generateFootprintSection(result: FootprintComparisonResult): string { const statusClass = result.passed ? 'pass' : 'fail'; return `

Footprint Validation ${result.passed ? '✓' : '✗'}

Pad Count ${result.generatedPadCount}/${result.referencePadCount}
Via Count ${result.generatedViaCount}/${result.referenceViaCount}
Errors ${result.errors.length}
Warnings ${result.warnings.length}
${ result.errors.length > 0 ? `

Errors

${result.errors.map((d) => formatPadDiff(d)).join('\n')}
` : '' } ${ result.warnings.length > 0 ? `

Warnings

${result.warnings.map((d) => formatPadDiff(d)).join('\n')}
` : '' }
`; } function generateSymbolSection(result: SymbolComparisonResult): string { const statusClass = result.passed ? 'pass' : 'fail'; return `

Symbol Validation ${result.passed ? '✓' : '✗'}

Pin Count ${result.generatedPinCount}/${result.referencePinCount}
Errors ${result.errors.length}
Warnings ${result.warnings.length}
${ result.errors.length > 0 ? `

Errors

${result.errors.map((d) => formatPinDiff(d)).join('\n')}
` : '' } ${ result.warnings.length > 0 ? `

Warnings

${result.warnings.map((d) => formatPinDiff(d)).join('\n')}
` : '' }
`; } function generateResultRow(result: ValidationResult): string { const status = result.passed ? 'pass' : result.error ? 'error' : 'fail'; const fpStatus = result.footprint ? result.footprint.passed ? '✓' : '✗' : result.error ? '⚠' : '-'; const symStatus = result.symbol ? (result.symbol.passed ? '✓' : '✗') : result.error ? '⚠' : '-'; return ` ${result.lcscCode} ${escapeHtml(result.componentName)} ${fpStatus} ${symStatus} ${result.passed ? 'PASS' : result.error ? 'ERROR' : 'FAIL'} ${result.durationMs}ms `; } function generateDetailedResults(results: ValidationResult[]): string { const failedResults = results.filter((r) => !r.passed); if (failedResults.length === 0) return ''; return `

Detailed Results

${failedResults .map( (r) => `

${r.lcscCode} - ${escapeHtml(r.componentName)}

${r.error ? `
${escapeHtml(r.error)}
` : ''} ${r.footprint ? generateFootprintSection(r.footprint) : ''} ${r.symbol ? generateSymbolSection(r.symbol) : ''}
` ) .join('\n')}
`; } // ============================================================================= // Formatters // ============================================================================= function formatPadDiff(diff: PadDiff): string { const icon = diff.severity === 'error' ? '✗' : diff.severity === 'warning' ? '⚠' : 'ℹ'; return `
${icon} Pad ${diff.padNumber} ${diff.field} ${escapeHtml(diff.message)}
`; } function formatPinDiff(diff: PinDiff): string { const icon = diff.severity === 'error' ? '✗' : diff.severity === 'warning' ? '⚠' : 'ℹ'; return `
${icon} Pin ${diff.pinNumber} ${diff.field} ${escapeHtml(diff.message)}
`; } function escapeHtml(text: string): string { return text .replace(/&/g, '&') .replace(//g, '>') .replace(/"/g, '"') .replace(/'/g, '''); } // ============================================================================= // Styles // ============================================================================= function getStyles(): string { return ` * { box-sizing: border-box; margin: 0; padding: 0; } body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: #f5f5f5; color: #333; line-height: 1.6; } .container { max-width: 1400px; margin: 0 auto; padding: 2rem; } header { background: #fff; padding: 1.5rem; border-radius: 8px; margin-bottom: 2rem; box-shadow: 0 2px 4px rgba(0,0,0,0.1); } h1 { font-size: 1.5rem; margin-bottom: 0.5rem; } .meta { display: flex; gap: 1rem; align-items: center; } .lcsc { font-family: monospace; background: #e8e8e8; padding: 0.25rem 0.5rem; border-radius: 4px; } .status { font-weight: bold; padding: 0.25rem 0.75rem; border-radius: 4px; } .status.pass, .pass { color: #22c55e; } .status.fail, .fail { color: #ef4444; } .status.error { color: #f59e0b; } .warn { color: #f59e0b; } .summary { display: flex; gap: 1rem; margin-top: 1rem; } .stat { padding: 0.5rem 1rem; border-radius: 4px; background: #f0f0f0; } .stat.pass { background: #dcfce7; } .stat.fail { background: #fee2e2; } .stat.error { background: #fef3c7; } .error-banner { background: #fee2e2; color: #b91c1c; padding: 1rem; border-radius: 8px; margin-bottom: 2rem; } .comparison { display: grid; grid-template-columns: 1fr 1fr; gap: 2rem; margin-bottom: 2rem; } .svg-panel { background: #fff; padding: 1rem; border-radius: 8px; box-shadow: 0 2px 4px rgba(0,0,0,0.1); } .svg-panel h2 { font-size: 1rem; margin-bottom: 1rem; color: #666; } .main-columns { display: grid; grid-template-columns: repeat(auto-fit, minmax(500px, 1fr)); gap: 2rem; margin-bottom: 2rem; } .main-column { background: #fff; border-radius: 8px; padding: 1.5rem; box-shadow: 0 2px 4px rgba(0,0,0,0.1); } .column-header { font-size: 1.25rem; margin-bottom: 1.5rem; color: #333; text-align: center; border-bottom: 2px solid #e0e0e0; padding-bottom: 0.75rem; } .svg-comparison { display: grid; grid-template-columns: 1fr 1fr; gap: 1rem; margin-bottom: 1.5rem; } .svg-panel { background: #f8f8f8; border-radius: 8px; padding: 0.75rem; } .svg-panel h3 { font-size: 0.75rem; color: #666; margin-bottom: 0.5rem; text-align: center; } .svg-container { background: #1a1a1a; padding: 0.75rem; border-radius: 4px; overflow: hidden; display: flex; justify-content: center; align-items: center; height: 220px; } .svg-container svg { width: 100%; height: 100%; object-fit: contain; } .svg-container .no-preview { color: #888; font-style: italic; font-size: 0.875rem; } .validation-section { background: #f8f8f8; padding: 1rem; border-radius: 8px; } .validation-section h2 { display: flex; align-items: center; gap: 0.5rem; margin-bottom: 1rem; font-size: 1rem; } .stats-grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(120px, 1fr)); gap: 1rem; margin-bottom: 1.5rem; } .stat-item { background: #f8f8f8; padding: 0.75rem; border-radius: 4px; text-align: center; } .stat-item .label { display: block; font-size: 0.75rem; color: #666; margin-bottom: 0.25rem; } .stat-item .value { font-size: 1.25rem; font-weight: bold; } .diff-list { margin-top: 1rem; } .diff-list h3 { font-size: 0.875rem; color: #666; margin-bottom: 0.5rem; } .diff-item { display: flex; align-items: center; gap: 0.5rem; padding: 0.5rem; background: #f8f8f8; border-radius: 4px; margin-bottom: 0.25rem; font-size: 0.875rem; } .diff-item.error { background: #fee2e2; } .diff-item.warning { background: #fef3c7; } .diff-item.info { background: #e0f2fe; } .diff-item .icon { width: 1rem; } .diff-item .pad, .diff-item .pin { font-weight: bold; min-width: 4rem; } .diff-item .field { color: #666; min-width: 5rem; } .diff-item .message { flex: 1; } .results-table { background: #fff; border-radius: 8px; overflow: hidden; margin-bottom: 2rem; box-shadow: 0 2px 4px rgba(0,0,0,0.1); } table { width: 100%; border-collapse: collapse; } th, td { padding: 0.75rem 1rem; text-align: left; border-bottom: 1px solid #eee; } th { background: #f8f8f8; font-weight: 600; } tr.pass { background: #f0fdf4; } tr.fail { background: #fef2f2; } tr.error { background: #fffbeb; } .center { text-align: center; } .right { text-align: right; } .detailed-results { margin-top: 2rem; } .result-detail { background: #fff; padding: 1.5rem; border-radius: 8px; margin-bottom: 1.5rem; box-shadow: 0 2px 4px rgba(0,0,0,0.1); } .result-detail h3 { margin-bottom: 1rem; } .error-message { background: #fee2e2; color: #b91c1c; padding: 0.75rem; border-radius: 4px; margin-bottom: 1rem; } footer { text-align: center; color: #666; font-size: 0.875rem; margin-top: 2rem; padding-top: 2rem; border-top: 1px solid #ddd; } @media (max-width: 768px) { .comparison { grid-template-columns: 1fr; } } `; }