devkit-quality 0.1.0 → 0.1.1

package/dist/terminal.js

@@ -3,24 +3,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Spinner = exports.color = void 0;
+exports.ProgressRenderer = exports.color = exports.glyph = void 0;
+exports.terminalWidth = terminalWidth;
 exports.severityColor = severityColor;
+exports.severityBadge = severityBadge;
 exports.scoreColor = scoreColor;
 exports.scoreLabel = scoreLabel;
+exports.scoreGrade = scoreGrade;
 exports.renderScoreBar = renderScoreBar;
+exports.renderStackedBar = renderStackedBar;
 exports.pad = pad;
 exports.padStart = padStart;
+exports.truncateMiddle = truncateMiddle;
+exports.renderBox = renderBox;
+exports.sectionHeading = sectionHeading;
+exports.formatDuration = formatDuration;
 exports.renderCodeFrame = renderCodeFrame;
-exports.waitForNextTick = waitForNextTick;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const colorEnabled = Boolean(process.env.FORCE_COLOR) || (Boolean(process.stdout.isTTY) && !process.env.NO_COLOR);
+/** Box-drawing and block glyphs, with a plain-ASCII fallback for dumb terminals. */
+const ascii = process.env.TERM === 'dumb' || Boolean(process.env.DEVKIT_ASCII);
+exports.glyph = ascii
+    ? { full: '#', empty: '.', tl: '+', tr: '+', bl: '+', br: '+', h: '-', v: '|', dot: '*', bullet: '-', arrow: '->', check: 'ok', warn: '!', rail: '|', sep: '-' }
+    : { full: '█', empty: '░', tl: '╭', tr: '╮', bl: '╰', br: '╯', h: '─', v: '│', dot: '●', bullet: '•', arrow: '→', check: '✔', warn: '▲', rail: '┃', sep: '─' };
 function wrap(open, close) {
     return (text) => (colorEnabled ? `\x1b[${open}m${text}\x1b[${close}m` : text);
 }
 exports.color = {
     bold: wrap('1', '22'),
     dim: wrap('2', '22'),
+    italic: wrap('3', '23'),
+    inverse: wrap('7', '27'),
     red: wrap('31', '39'),
     green: wrap('32', '39'),
     yellow: wrap('33', '39'),
@@ -28,11 +42,27 @@ exports.color = {
     magenta: wrap('35', '39'),
     cyan: wrap('36', '39'),
     gray: wrap('90', '39'),
-    white: wrap('37', '39')
+    white: wrap('37', '39'),
+    brightRed: wrap('91', '39'),
+    bgRed: wrap('41;97', '49;39'),
+    bgYellow: wrap('43;30', '49;39'),
+    bgGreen: wrap('42;30', '49;39'),
+    bgCyan: wrap('46;30', '49;39'),
+    bgGray: wrap('100;97', '49;39')
 };
+const ANSI_PATTERN = /\x1b\[[0-9;]*m/g;
+/** Printable width of a string, ignoring ANSI escape codes. */
+function visibleLength(text) {
+    return [...text.replace(ANSI_PATTERN, '')].length;
+}
+function terminalWidth() {
+    const columns = process.stdout.columns || 100;
+    return Math.max(60, Math.min(columns, 100));
+}
 function severityColor(severity, text) {
     switch (severity) {
         case 'CRITICAL':
+            return exports.color.brightRed(exports.color.bold(text));
         case 'HIGH':
             return exports.color.red(text);
         case 'MEDIUM':
@@ -43,6 +73,22 @@ function severityColor(severity, text) {
             return exports.color.gray(text);
     }
 }
+function severityBadge(severity) {
+    const label = ` ${severity.padEnd(8)}`;
+    if (!colorEnabled)
+        return `[${severity}]`.padEnd(10);
+    switch (severity) {
+        case 'CRITICAL':
+        case 'HIGH':
+            return exports.color.bgRed(label);
+        case 'MEDIUM':
+            return exports.color.bgYellow(label);
+        case 'LOW':
+            return exports.color.bgCyan(label);
+        default:
+            return exports.color.bgGray(label);
+    }
+}
 function scoreColor(score, text) {
     if (score >= 8)
         return exports.color.green(text);
@@ -57,18 +103,74 @@ function scoreLabel(score) {
         return 'Good';
     if (score >= 5)
         return 'Needs work';
-    return 'Poor';
+    if (score >= 3)
+        return 'Poor';
+    return 'Critical';
+}
+function scoreGrade(score) {
+    if (score >= 9)
+        return 'A';
+    if (score >= 7)
+        return 'B';
+    if (score >= 5)
+        return 'C';
+    if (score >= 3)
+        return 'D';
+    return 'F';
 }
 function renderScoreBar(score, width = 28) {
     const filled = Math.round((Math.max(0, Math.min(10, score)) / 10) * width);
-    const bar = '█'.repeat(filled) + '░'.repeat(width - filled);
-    return scoreColor(score, bar);
+    return scoreColor(score, exports.glyph.full.repeat(filled)) + exports.color.dim(exports.glyph.empty.repeat(width - filled));
+}
+/** A single horizontal bar split into colored segments, e.g. a severity distribution. */
+function renderStackedBar(segments, width) {
+    const total = segments.reduce((sum, segment) => sum + segment.value, 0);
+    if (total === 0)
+        return exports.color.dim(exports.glyph.empty.repeat(width));
+    let used = 0;
+    return segments
+        .map((segment, index) => {
+        const isLast = index === segments.length - 1;
+        const cells = isLast ? width - used : Math.round((segment.value / total) * width);
+        const size = segment.value > 0 ? Math.max(1, Math.min(cells, width - used)) : 0;
+        used += size;
+        return segment.paint(exports.glyph.full.repeat(size));
+    })
+        .join('');
 }
 function pad(text, width) {
-    return text.length >= width ? text : text + ' '.repeat(width - text.length);
+    const length = visibleLength(text);
+    return length >= width ? text : text + ' '.repeat(width - length);
 }
 function padStart(text, width) {
-    return text.length >= width ? text : ' '.repeat(width - text.length) + text;
+    const length = visibleLength(text);
+    return length >= width ? text : ' '.repeat(width - length) + text;
+}
+function truncateMiddle(text, width) {
+    if (text.length <= width)
+        return text;
+    const keep = width - 1;
+    return `${text.slice(0, Math.ceil(keep / 3))}…${text.slice(text.length - Math.floor((keep * 2) / 3))}`;
+}
+/** A rounded box around pre-rendered lines. */
+function renderBox(content, width) {
+    const inner = width - 4;
+    return [
+        exports.color.dim(`${exports.glyph.tl}${exports.glyph.h.repeat(width - 2)}${exports.glyph.tr}`),
+        ...content.map((line) => `${exports.color.dim(exports.glyph.v)} ${pad(line, inner)} ${exports.color.dim(exports.glyph.v)}`),
+        exports.color.dim(`${exports.glyph.bl}${exports.glyph.h.repeat(width - 2)}${exports.glyph.br}`)
+    ];
+}
+function sectionHeading(title, width, detail = '') {
+    const label = ` ${exports.color.bold(title.toUpperCase())}${detail ? ` ${exports.color.dim(detail)}` : ''} `;
+    return `${exports.color.dim(exports.glyph.h.repeat(2))}${label}${exports.color.dim(exports.glyph.h.repeat(Math.max(0, width - visibleLength(label) - 2)))}`;
+}
+function formatDuration(ms) {
+    if (ms < 1000)
+        return `${ms}ms`;
+    if (ms < 60_000)
+        return `${(ms / 1000).toFixed(1)}s`;
+    return `${Math.floor(ms / 60_000)}m ${Math.round((ms % 60_000) / 1000)}s`;
 }
 function renderCodeFrame(repository, relativeFile, line, column, severity) {
     const absolutePath = node_path_1.default.join(repository, relativeFile);
@@ -83,53 +185,65 @@ function renderCodeFrame(repository, relativeFile, line, column, severity) {
     const endLine = Math.min(lines.length, line + 1);
     const gutterWidth = String(endLine).length;
     const output = [];
-    const maxWidth = 100;
+    const maxWidth = terminalWidth() - gutterWidth - 12;
     const truncate = (text) => (text.length > maxWidth ? `${text.slice(0, maxWidth)}…` : text);
     for (let current = startLine; current <= endLine; current += 1) {
-        const rawText = lines[current - 1] ?? '';
+        const rawText = (lines[current - 1] ?? '').replace(/\t/g, '    ');
         const text = truncate(rawText);
         const gutter = padStart(String(current), gutterWidth);
         const marker = current === line ? severityColor(severity, '>') : ' ';
         if (current === line) {
-            output.push(`  ${marker} ${exports.color.bold(gutter)} ${exports.color.dim('|')} ${text}`);
+            output.push(`    ${marker} ${exports.color.bold(gutter)} ${exports.color.dim(exports.glyph.v)} ${text}`);
             if (column > 0 && column - 1 < maxWidth) {
-                output.push(`  ${' '.repeat(gutterWidth + 2)} ${exports.color.dim('|')} ${' '.repeat(Math.max(0, column - 1))}${severityColor(severity, '^')}`);
+                output.push(`      ${' '.repeat(gutterWidth)} ${exports.color.dim(exports.glyph.v)} ${' '.repeat(Math.max(0, column - 1))}${severityColor(severity, '^')}`);
             }
         }
         else {
-            output.push(`  ${marker} ${exports.color.dim(gutter)} ${exports.color.dim('|')} ${exports.color.dim(text)}`);
+            output.push(`    ${marker} ${exports.color.dim(gutter)} ${exports.color.dim(exports.glyph.v)} ${exports.color.dim(text)}`);
         }
     }
     return output;
 }
-const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
-class Spinner {
-    frameIndex = 0;
-    timer;
-    text;
-    constructor(text) {
-        this.text = text;
+const SPINNER_FRAMES = ascii ? ['-', '\\', '|', '/'] : ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+/**
+ * Live scan progress on stderr. The scan itself is synchronous, so a timer-driven spinner would
+ * never get to draw; instead every progress update redraws the line directly (throttled).
+ * Writes nothing when stderr is not a TTY, so piped/CI output stays clean.
+ */
+class ProgressRenderer {
+    frame = 0;
+    lastDraw = 0;
+    lastStep = 0;
+    enabled = Boolean(process.stderr.isTTY);
+    startedAt = Date.now();
+    update(progress) {
+        if (!this.enabled)
+            return;
+        const now = Date.now();
+        const isNewStep = progress.step !== this.lastStep;
+        if (!isNewStep && now - this.lastDraw < 60)
+            return;
+        this.lastDraw = now;
+        this.lastStep = progress.step;
+        this.frame = (this.frame + 1) % SPINNER_FRAMES.length;
+        const width = 20;
+        const fraction = (progress.step - 1 + (progress.total ? (progress.current ?? 0) / progress.total : 0)) / progress.totalSteps;
+        const filled = Math.round(Math.max(0, Math.min(1, fraction)) * width);
+        const bar = exports.color.cyan(exports.glyph.full.repeat(filled)) + exports.color.dim(exports.glyph.empty.repeat(width - filled));
+        const counter = progress.total ? exports.color.dim(` ${progress.current}/${progress.total}`) : '';
+        const percent = exports.color.dim(`${String(Math.round(fraction * 100)).padStart(3)}%`);
+        const elapsed = exports.color.dim(formatDuration(now - this.startedAt));
+        process.stderr.write(`\r\x1b[K${exports.color.cyan(SPINNER_FRAMES[this.frame])} ${bar} ${percent}  ${progress.label}${counter}  ${elapsed}`);
     }
-    start() {
-        // Written to stderr so it never pollutes piped/redirected stdout (--format json, etc.).
-        if (!process.stderr.isTTY) {
-            process.stderr.write(`${this.text}\n`);
+    finish(message) {
+        if (!this.enabled)
             return;
-        }
-        this.timer = setInterval(() => {
-            process.stderr.write(`\r${exports.color.cyan(SPINNER_FRAMES[this.frameIndex])} ${this.text}`);
-            this.frameIndex = (this.frameIndex + 1) % SPINNER_FRAMES.length;
-        }, 80);
+        process.stderr.write(`\r\x1b[K${exports.color.green(exports.glyph.check)} ${message} ${exports.color.dim(`in ${formatDuration(Date.now() - this.startedAt)}`)}\n`);
     }
-    stop() {
-        if (!this.timer)
+    fail() {
+        if (!this.enabled)
             return;
-        clearInterval(this.timer);
-        this.timer = undefined;
         process.stderr.write('\r\x1b[K');
     }
 }
-exports.Spinner = Spinner;
-function waitForNextTick() {
-    return new Promise((resolve) => setImmediate(resolve));
-}
+exports.ProgressRenderer = ProgressRenderer;

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "devkit-quality",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Deterministic repository quality scanner for JavaScript and TypeScript projects",
   "bin": {
-    "devkit-quality": "bin/devkit.js"
+    "devkit": "bin/devkit.js"
   },
   "main": "dist/cli.js",
   "files": [
     "dist",
     "bin",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -24,6 +25,10 @@
     "type": "git",
     "url": "git+https://github.com/Karan071/devkit-cli.git"
   },
+  "homepage": "https://github.com/Karan071/devkit-cli#readme",
+  "bugs": {
+    "url": "https://github.com/Karan071/devkit-cli/issues"
+  },
   "keywords": [
     "cli",
     "typescript",
@@ -34,6 +39,9 @@
   "license": "MIT",
   "author": "Karan Chourasia",
   "type": "commonjs",
+  "engines": {
+    "node": "^22.12.0 || ^24.0.0 || >=26.0.0"
+  },
   "dependencies": {
     "commander": "^12.1.0",
     "typescript": "^5.7.2"