@vmz/diagnostic 0.2.3 → 0.2.5

package/README.md

@@ -4,7 +4,7 @@ Diagnostic layout for structured `code + args + span` rows.
 
 - Caller injects `t` / catalog (official tables live in `@vmz/vmz`)
 - No built-in language packs; no separate i18n package
-- Deepen snippet / caret when the product CLI needs them
+- Pretty printer: rustc/miette-style snippets when `sourceText` + `span` + `position` are wired
 
 ```ts
 import { formatDiagnostic } from '@vmz/diagnostic';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * `@vmz/diagnostic` — catalog render + pretty printer (skeleton).
+ * `@vmz/diagnostic` — catalog render + pretty printer.
  *
  * Product path: N-API diagnostic wire → `t(code, args)` → layout.
  */
@@ -37,11 +37,14 @@ export type PositionContext = {
         column: number;
     };
 };
+export type PrettyStyle = 'compact' | 'pretty';
 export type FormatOptions = {
     locale: string;
     catalog: LocaleCatalog | ((locale: string) => LocaleCatalog);
     sourceText?: string;
     position?: PositionContext;
+    /** `pretty` (default) renders rustc/miette-style snippets when span + source are available. */
+    style?: PrettyStyle;
 };
 /**
  * Resolve a catalog template with `{arg}` substitution.
@@ -50,7 +53,6 @@ export type FormatOptions = {
 export declare function t(code: string, args: Record<string, string> | undefined, catalog: LocaleCatalog): string;
 /**
  * Format one diagnostic for terminal / logs.
- * Skeleton: single-line `path: severity[code]: message` — no snippet yet.
  */
 export declare function formatDiagnostic(d: DiagnosticInput, opts: FormatOptions): string;
 /**

package/dist/index.js

@@ -1,8 +1,9 @@
 /**
- * `@vmz/diagnostic` — catalog render + pretty printer (skeleton).
+ * `@vmz/diagnostic` — catalog render + pretty printer.
  *
  * Product path: N-API diagnostic wire → `t(code, args)` → layout.
  */
+import { formatDiagnosticPretty } from './pretty.js';
 /**
  * Resolve a catalog template with `{arg}` substitution.
  * Missing keys fall back to `{{code}}` so wire identity stays visible.
@@ -24,7 +25,6 @@ function resolveCatalog(locale, catalog) {
 }
 /**
  * Format one diagnostic for terminal / logs.
- * Skeleton: single-line `path: severity[code]: message` — no snippet yet.
  */
 export function formatDiagnostic(d, opts) {
     if (!d.code || typeof d.code !== 'string') {
@@ -36,9 +36,12 @@ export function formatDiagnostic(d, opts) {
         : d.message != null && String(d.message).length
             ? String(d.message)
             : t(d.code, d.args, catalog);
-    const where = formatWhere(d, opts);
-    const head = where ? `${where}: ` : '';
-    return `${head}${d.severity}[${d.code}]: ${message}`;
+    if ((opts.style ?? 'pretty') === 'compact') {
+        const where = formatWhere(d, opts);
+        const head = where ? `${where}: ` : '';
+        return `${head}${d.severity}[${d.code}]: ${message}`;
+    }
+    return formatDiagnosticPretty(d, message, opts);
 }
 /**
  * Format many diagnostics, one per line.

package/dist/pretty.d.ts

@@ -0,0 +1,5 @@
+import type { DiagnosticInput, FormatOptions } from './index.js';
+export type PrettyStyle = 'compact' | 'pretty';
+export declare function formatDiagnosticPretty(d: DiagnosticInput, message: string, opts: FormatOptions & {
+    style?: PrettyStyle;
+}): string;

package/dist/pretty.js

@@ -0,0 +1,80 @@
+import { scalarColumnToIndex, utf8LineAt } from './utf8.js';
+const ANSI = {
+    reset: '\x1b[0m',
+    bold: '\x1b[1m',
+    dim: '\x1b[2m',
+    red: '\x1b[31m',
+    yellow: '\x1b[33m',
+    cyan: '\x1b[36m',
+    blue: '\x1b[34m',
+};
+function useColor() {
+    return !process.env.NO_COLOR && Boolean(process.stderr?.isTTY);
+}
+function paint(text, ...styles) {
+    if (!useColor() || styles.length === 0)
+        return text;
+    return `${styles.join('')}${text}${ANSI.reset}`;
+}
+function severityStyle(severity) {
+    if (severity === 'error')
+        return [ANSI.bold, ANSI.red];
+    if (severity === 'warning')
+        return [ANSI.bold, ANSI.yellow];
+    return [ANSI.cyan];
+}
+function severityLabel(severity) {
+    return severity === 'warning' ? 'warning' : severity;
+}
+function formatLocation(path, line, column) {
+    const where = path ? `${path}:${line}:${column}` : `${line}:${column}`;
+    return paint(`  --> ${where}`, ANSI.bold, ANSI.blue);
+}
+function canRenderSnippet(d, opts) {
+    return (opts.style ?? 'pretty') === 'pretty' && Boolean(opts.sourceText && opts.position && d.span && d.span.end > d.span.start);
+}
+function renderSnippetLine(out, gutterWidth, lineNum, lineText, colStart, colEnd, severity) {
+    const gutter = paint(`${String(lineNum).padStart(gutterWidth)} | `, ANSI.dim);
+    out.push(`${gutter}${lineText}`);
+    const startIdx = scalarColumnToIndex(lineText, colStart);
+    const endIdx = Math.max(startIdx + 1, scalarColumnToIndex(lineText, colEnd + 1));
+    const marker = paint(`${' '.repeat(gutterWidth)} | `, ANSI.dim) +
+        ' '.repeat(startIdx) +
+        paint('^'.repeat(endIdx - startIdx), ...severityStyle(severity));
+    out.push(marker);
+}
+export function formatDiagnosticPretty(d, message, opts) {
+    const head = paint(`${severityLabel(d.severity)}[${d.code}]`, ...severityStyle(d.severity));
+    const lines = [`${head}: ${message}`];
+    if (!canRenderSnippet(d, opts)) {
+        const path = d.path || '';
+        if (d.span && opts.position) {
+            const { line, column } = opts.position.lineCol(d.span.start);
+            lines.push(formatLocation(path, line, column));
+        }
+        else if (path) {
+            lines.push(paint(`  at ${path}`, ANSI.dim));
+        }
+        return lines.join('\n');
+    }
+    const source = String(opts.sourceText);
+    const position = opts.position;
+    const span = d.span;
+    const path = d.path || '';
+    const startPos = position.lineCol(span.start);
+    const endPos = position.lineCol(Math.max(span.start, span.end - 1));
+    lines.push(formatLocation(path, startPos.line, startPos.column));
+    const startLine = utf8LineAt(source, span.start);
+    const endLine = utf8LineAt(source, Math.max(span.start, span.end - 1));
+    const gutterWidth = String(endLine.line).length;
+    if (startLine.line === endLine.line) {
+        renderSnippetLine(lines, gutterWidth, startLine.line, startLine.text, startPos.column, endPos.column, d.severity);
+    }
+    else {
+        renderSnippetLine(lines, gutterWidth, startLine.line, startLine.text, startPos.column, startLine.text.length + 1, d.severity);
+        if (endLine.line > startLine.line + 1) {
+            lines.push(paint(`${' '.repeat(gutterWidth + 3)}...`, ANSI.dim));
+        }
+    }
+    return lines.join('\n');
+}

package/dist/utf8.d.ts

@@ -0,0 +1,15 @@
+/** UTF-8 byte helpers for Rust wire spans in a JS string buffer. */
+export declare function utf8ByteLength(source: string): number;
+export declare function utf8ByteSlice(source: string, start: number, end: number): string;
+export type Utf8LineSlice = {
+    line: number;
+    lineStart: number;
+    lineEnd: number;
+    text: string;
+};
+/** Line containing `offset` (UTF-8 bytes, 1-based line number). */
+export declare function utf8LineAt(source: string, offset: number): Utf8LineSlice;
+/** 1-based Unicode scalar column within a line slice (matches compiler OffsetIndex). */
+export declare function unicodeScalarColumn(lineText: string, byteOffsetInLine: number): number;
+/** Map 1-based scalar column to JS string index for underline rendering. */
+export declare function scalarColumnToIndex(lineText: string, column: number): number;

package/dist/utf8.js

@@ -0,0 +1,56 @@
+/** UTF-8 byte helpers for Rust wire spans in a JS string buffer. */
+export function utf8ByteLength(source) {
+    return Buffer.byteLength(source, 'utf8');
+}
+export function utf8ByteSlice(source, start, end) {
+    const buf = Buffer.from(source, 'utf8');
+    const s = Math.max(0, Math.min(start, buf.length));
+    const e = Math.max(s, Math.min(end, buf.length));
+    return buf.subarray(s, e).toString('utf8');
+}
+/** Line containing `offset` (UTF-8 bytes, 1-based line number). */
+export function utf8LineAt(source, offset) {
+    const buf = Buffer.from(source, 'utf8');
+    const clamped = Math.max(0, Math.min(offset, buf.length));
+    let lineStart = clamped;
+    while (lineStart > 0 && buf[lineStart - 1] !== 0x0a) {
+        lineStart -= 1;
+    }
+    let lineEnd = clamped;
+    while (lineEnd < buf.length && buf[lineEnd] !== 0x0a) {
+        lineEnd += 1;
+    }
+    let line = 1;
+    for (let i = 0; i < lineStart; i += 1) {
+        if (buf[i] === 0x0a)
+            line += 1;
+    }
+    return {
+        line,
+        lineStart,
+        lineEnd,
+        text: buf.subarray(lineStart, lineEnd).toString('utf8'),
+    };
+}
+/** 1-based Unicode scalar column within a line slice (matches compiler OffsetIndex). */
+export function unicodeScalarColumn(lineText, byteOffsetInLine) {
+    const buf = Buffer.from(lineText, 'utf8');
+    const end = Math.max(0, Math.min(byteOffsetInLine, buf.length));
+    if (end === 0)
+        return 1;
+    return buf.subarray(0, end).toString('utf8').length > 0 ? [...buf.subarray(0, end).toString('utf8')].length : 1;
+}
+/** Map 1-based scalar column to JS string index for underline rendering. */
+export function scalarColumnToIndex(lineText, column) {
+    if (column <= 1)
+        return 0;
+    let pos = 1;
+    let index = 0;
+    for (const ch of lineText) {
+        if (pos >= column)
+            break;
+        index += ch.length;
+        pos += 1;
+    }
+    return index;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vmz/diagnostic",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "type": "module",
   "description": "Language-neutral diagnostic catalog render and pretty printer",
   "license": "MIT",