@eduardbar/drift 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -11,6 +11,17 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Added
 
+- **Phase 6: Static HTML report + README badge** — output commands for visibility
+  - `drift report [path]` — generates a self-contained `drift-report.html` with score, per-file breakdown, collapsible issue list, and fix suggestions
+  - `drift badge [path]` — generates a `badge.svg` with the current drift score for your README
+  - `drift ci [path]` — emits GitHub Actions workflow annotations inline on PR diffs and writes a step summary; supports `--min-score` to gate PRs
+
+---
+
+## [0.5.0] — 2026-02-24
+
+### Added
+
 - **Phase 5: AI authorship heuristics** — 5 new rules that detect patterns AI code generators produce
   - `over-commented` (info, weight 4): functions where comment density ≥ 40% — AI over-documents the obvious
   - `hardcoded-config` (warning, weight 10): hardcoded URLs, IPs, or connection strings instead of env vars

package/README.md

@@ -105,6 +105,40 @@ drift diff --json    # Output raw JSON diff
 
 Shows score delta, new issues introduced, and issues resolved per file.
 
+### `drift report [path]`
+
+Generate a self-contained `drift-report.html` — open in any browser:
+
+```bash
+drift report           # scan current directory
+drift report ./src     # scan specific path
+```
+
+No server needed. The file embeds all styles and data inline.
+
+### `drift badge [path]`
+
+Generate a `badge.svg` with the current score for your README:
+
+```bash
+drift badge            # writes badge.svg to current directory
+drift badge ./src      # scan specific path
+```
+
+Drop the generated file in your repo and reference it as a local badge.
+
+### `drift ci [path]`
+
+Emit GitHub Actions annotations and step summary:
+
+```bash
+drift ci               # scan current directory
+drift ci ./src         # scan specific path
+drift ci --min-score 60  # exit code 1 if score exceeds threshold
+```
+
+Outputs inline annotations visible in the PR diff. Use `--min-score` to gate merges.
+
 ### AI Integration
 
 Use `--ai` to get structured output that LLMs can consume:
@@ -183,9 +217,21 @@ Without a config file, these two rules are silently skipped. All other rules run
 
 ---
 
-## ⚙️ CI Integration
+## ⚙️ CI / GitHub Actions
+
+Add drift to your PR workflow to gate on score and get inline annotations:
+
+```yaml
+- name: Run drift
+  run: npx @eduardbar/drift ci --min-score 60
+```
+
+This will:
+- Emit inline annotations on the exact lines with issues (visible in the PR diff)
+- Write a summary to the GitHub Actions step summary
+- Exit with code 1 if the score exceeds the threshold
 
-Drop this into your GitHub Actions workflow to block merges when drift exceeds your threshold:
+If you only need a pass/fail gate without annotations, `scan` works too:
 
 ```yaml
 - name: Check for vibe coding drift

package/dist/badge.d.ts

@@ -0,0 +1,2 @@
+export declare function generateBadge(score: number): string;
+//# sourceMappingURL=badge.d.ts.map

package/dist/badge.js

@@ -0,0 +1,57 @@
+const LEFT_WIDTH = 47;
+const CHAR_WIDTH = 7;
+const PADDING = 16;
+function scoreColor(score) {
+    if (score < 20)
+        return '#4c1';
+    if (score < 45)
+        return '#dfb317';
+    if (score < 70)
+        return '#fe7d37';
+    return '#e05d44';
+}
+function scoreLabel(score) {
+    if (score < 20)
+        return 'LOW';
+    if (score < 45)
+        return 'MODERATE';
+    if (score < 70)
+        return 'HIGH';
+    return 'CRITICAL';
+}
+function rightWidth(text) {
+    return text.length * CHAR_WIDTH + PADDING;
+}
+export function generateBadge(score) {
+    const valueText = `${score} ${scoreLabel(score)}`;
+    const color = scoreColor(score);
+    const rWidth = rightWidth(valueText);
+    const totalWidth = LEFT_WIDTH + rWidth;
+    const leftCenterX = LEFT_WIDTH / 2;
+    const rightCenterX = LEFT_WIDTH + rWidth / 2;
+    // shields.io pattern: font-size="110" + scale(.1) = effective 11px
+    // all X/Y coords are ×10
+    const leftTextWidth = (LEFT_WIDTH - 10) * 10;
+    const rightTextWidth = (rWidth - PADDING) * 10;
+    return `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="${totalWidth}" height="20">
+  <linearGradient id="s" x2="0" y2="100%">
+    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <clipPath id="r">
+    <rect width="${totalWidth}" height="20" rx="3" fill="#fff"/>
+  </clipPath>
+  <g clip-path="url(#r)">
+    <rect width="${LEFT_WIDTH}" height="20" fill="#555"/>
+    <rect x="${LEFT_WIDTH}" width="${rWidth}" height="20" fill="${color}"/>
+    <rect width="${totalWidth}" height="20" fill="url(#s)"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
+    <text x="${leftCenterX * 10}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="${leftTextWidth}" lengthAdjust="spacing">drift</text>
+    <text x="${leftCenterX * 10}" y="140" transform="scale(.1)" textLength="${leftTextWidth}" lengthAdjust="spacing">drift</text>
+    <text x="${rightCenterX * 10}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="${rightTextWidth}" lengthAdjust="spacing">${valueText}</text>
+    <text x="${rightCenterX * 10}" y="140" transform="scale(.1)" textLength="${rightTextWidth}" lengthAdjust="spacing">${valueText}</text>
+  </g>
+</svg>`;
+}
+//# sourceMappingURL=badge.js.map

package/dist/ci.d.ts

@@ -0,0 +1,4 @@
+import type { DriftReport } from './types.js';
+export declare function emitCIAnnotations(report: DriftReport): void;
+export declare function printCISummary(report: DriftReport): void;
+//# sourceMappingURL=ci.d.ts.map

package/dist/ci.js

@@ -0,0 +1,85 @@
+import { writeFileSync } from 'node:fs';
+import { relative } from 'node:path';
+function encodeMessage(msg) {
+    return msg
+        .replace(/%/g, '%25')
+        .replace(/\r/g, '%0D')
+        .replace(/\n/g, '%0A')
+        .replace(/:/g, '%3A')
+        .replace(/,/g, '%2C');
+}
+function severityToAnnotation(s) {
+    if (s === 'error')
+        return 'error';
+    if (s === 'warning')
+        return 'warning';
+    return 'notice';
+}
+function scoreLabel(score) {
+    if (score >= 80)
+        return 'A';
+    if (score >= 60)
+        return 'B';
+    if (score >= 40)
+        return 'C';
+    if (score >= 20)
+        return 'D';
+    return 'F';
+}
+export function emitCIAnnotations(report) {
+    for (const file of report.files) {
+        for (const issue of file.issues) {
+            const level = severityToAnnotation(issue.severity);
+            const relPath = relative(process.cwd(), file.path).replace(/\\/g, '/');
+            const msg = encodeMessage(`[drift/${issue.rule}] ${issue.message}`);
+            const line = issue.line ?? 1;
+            const col = issue.column ?? 1;
+            process.stdout.write(`::${level} file=${relPath},line=${line},col=${col}::${msg}\n`);
+        }
+    }
+}
+export function printCISummary(report) {
+    const summaryPath = process.env['GITHUB_STEP_SUMMARY'];
+    if (!summaryPath)
+        return;
+    const score = report.totalScore;
+    const grade = scoreLabel(score);
+    let errors = 0;
+    let warnings = 0;
+    let info = 0;
+    for (const file of report.files) {
+        for (const issue of file.issues) {
+            if (issue.severity === 'error')
+                errors++;
+            else if (issue.severity === 'warning')
+                warnings++;
+            else
+                info++;
+        }
+    }
+    const sorted = [...report.files]
+        .sort((a, b) => b.issues.length - a.issues.length)
+        .slice(0, 10);
+    const rows = sorted
+        .map((f) => {
+        const relPath = relative(process.cwd(), f.path).replace(/\\/g, '/');
+        return `| ${relPath} | ${f.score} | ${f.issues.length} |`;
+    })
+        .join('\n');
+    const md = [
+        '## drift scan results',
+        '',
+        `**Score:** ${score}/100 — Grade **${grade}**`,
+        '',
+        '### Top files by issue count',
+        '',
+        '| File | Score | Issues |',
+        '|------|-------|--------|',
+        rows,
+        '',
+        `**Total issues:** ${errors} errors, ${warnings} warnings, ${info} info`,
+        '',
+    ].join('\n');
+    writeFileSync(summaryPath, md, { flag: 'a' });
+}
+//# sourceMappingURL=ci.js.map

package/dist/cli.js

@@ -8,11 +8,14 @@ import { printConsole, printDiff } from './printer.js';
 import { loadConfig } from './config.js';
 import { extractFilesAtRef, cleanupTempDir } from './git.js';
 import { computeDiff } from './diff.js';
+import { generateHtmlReport } from './report.js';
+import { generateBadge } from './badge.js';
+import { emitCIAnnotations, printCISummary } from './ci.js';
 const program = new Command();
 program
     .name('drift')
     .description('Detect silent technical debt left by AI-generated code')
-    .version('0.1.0');
+    .version('0.6.0');
 program
     .command('scan [path]', { isDefault: true })
     .description('Scan a directory for vibe coding drift')
@@ -95,5 +98,53 @@ program
             cleanupTempDir(tempDir);
     }
 });
+program
+    .command('report [path]')
+    .description('Generate a self-contained HTML report')
+    .option('-o, --output <file>', 'Output file path (default: drift-report.html)', 'drift-report.html')
+    .action(async (targetPath, options) => {
+    const resolvedPath = resolve(targetPath ?? '.');
+    process.stderr.write(`\nScanning ${resolvedPath}...\n`);
+    const config = await loadConfig(resolvedPath);
+    const files = analyzeProject(resolvedPath, config);
+    process.stderr.write(`  Found ${files.length} TypeScript file(s)\n\n`);
+    const report = buildReport(resolvedPath, files);
+    const html = generateHtmlReport(report);
+    const outPath = resolve(options.output);
+    writeFileSync(outPath, html, 'utf8');
+    process.stderr.write(`  Report saved to ${outPath}\n\n`);
+});
+program
+    .command('badge [path]')
+    .description('Generate a badge.svg with the current drift score')
+    .option('-o, --output <file>', 'Output file path (default: badge.svg)', 'badge.svg')
+    .action(async (targetPath, options) => {
+    const resolvedPath = resolve(targetPath ?? '.');
+    process.stderr.write(`\nScanning ${resolvedPath}...\n`);
+    const config = await loadConfig(resolvedPath);
+    const files = analyzeProject(resolvedPath, config);
+    const report = buildReport(resolvedPath, files);
+    const svg = generateBadge(report.totalScore);
+    const outPath = resolve(options.output);
+    writeFileSync(outPath, svg, 'utf8');
+    process.stderr.write(`  Badge saved to ${outPath}\n`);
+    process.stderr.write(`  Score: ${report.totalScore}/100\n\n`);
+});
+program
+    .command('ci [path]')
+    .description('Emit GitHub Actions annotations and step summary')
+    .option('--min-score <n>', 'Exit with code 1 if overall score exceeds this threshold', '0')
+    .action(async (targetPath, options) => {
+    const resolvedPath = resolve(targetPath ?? '.');
+    const config = await loadConfig(resolvedPath);
+    const files = analyzeProject(resolvedPath, config);
+    const report = buildReport(resolvedPath, files);
+    emitCIAnnotations(report);
+    printCISummary(report);
+    const minScore = Number(options.minScore);
+    if (minScore > 0 && report.totalScore > minScore) {
+        process.exit(1);
+    }
+});
 program.parse();
 //# sourceMappingURL=cli.js.map

package/dist/report.d.ts

@@ -0,0 +1,3 @@
+import { DriftReport } from './types.js';
+export declare function generateHtmlReport(report: DriftReport): string;
+//# sourceMappingURL=report.d.ts.map