cluaupp 1.5.2 → 2.0.0-beta.1

package/src/compiler/diagnostics.ts

@@ -0,0 +1,163 @@
+import type { SourceFile, Span } from "./source.js";
+
+export type Severity = "error" | "warning" | "info" | "hint";
+
+/**
+ * Diagnostic codes, grouped by family:
+ * - CL1xxx syntax · CL2xxx names · CL3xxx types · CL4xxx control flow
+ * - RBX5xxx Roblox API · CTX6xxx server/client authority · PAR7xxx parallel Luau
+ * - PERF8xxx performance hints · MOD9xxx modules and links
+ */
+export interface Diagnostic {
+	code: string;
+	severity: Severity;
+	message: string;
+	file: string;
+	span: Span;
+	line: number;
+	column: number;
+	endLine: number;
+	endColumn: number;
+	/** Extra lines shown under the excerpt (hints, "did you mean"). */
+	notes?: string[];
+	/** Replacement text that fixes the problem, when there is one obvious fix. */
+	fix?: { span: Span; text: string; title: string };
+}
+
+export class DiagnosticBag {
+	readonly items: Diagnostic[] = [];
+	private readonly seen = new Set<string>();
+
+	constructor(readonly source: SourceFile) {}
+
+	add(code: string, severity: Severity, span: Span, message: string, notes?: string[], fix?: Diagnostic["fix"]): Diagnostic {
+		const start = this.source.position(span.start);
+		const end = this.source.position(Math.max(span.start, span.end));
+		const diagnostic: Diagnostic = {
+			code,
+			severity,
+			message,
+			file: this.source.path,
+			span,
+			line: start.line,
+			column: start.column,
+			endLine: end.line,
+			endColumn: end.column,
+		};
+		if (notes && notes.length > 0) {
+			diagnostic.notes = notes;
+		}
+		if (fix) {
+			diagnostic.fix = fix;
+		}
+		const key = `${code}:${span.start}:${span.end}:${message}`;
+		if (!this.seen.has(key)) {
+			this.seen.add(key);
+			this.items.push(diagnostic);
+		}
+		return diagnostic;
+	}
+
+	error(code: string, span: Span, message: string, notes?: string[], fix?: Diagnostic["fix"]): Diagnostic {
+		return this.add(code, "error", span, message, notes, fix);
+	}
+
+	warning(code: string, span: Span, message: string, notes?: string[], fix?: Diagnostic["fix"]): Diagnostic {
+		return this.add(code, "warning", span, message, notes, fix);
+	}
+
+	info(code: string, span: Span, message: string, notes?: string[]): Diagnostic {
+		return this.add(code, "info", span, message, notes);
+	}
+
+	get errorCount(): number {
+		let n = 0;
+		for (const d of this.items) {
+			if (d.severity === "error") {
+				n++;
+			}
+		}
+		return n;
+	}
+}
+
+export function hasErrors(diagnostics: readonly Diagnostic[]): boolean {
+	return diagnostics.some((d) => d.severity === "error");
+}
+
+export function sortDiagnostics(diagnostics: Diagnostic[]): Diagnostic[] {
+	return diagnostics.sort((a, b) => a.file.localeCompare(b.file) || a.span.start - b.span.start || a.code.localeCompare(b.code));
+}
+
+/** `file:line:col: error[CL3001]: message` plus a caret excerpt, like rustc/clang. */
+export function formatDiagnostic(d: Diagnostic, source?: SourceFile, color = false): string {
+	const paint = (code: string, text: string) => (color ? `\x1b[${code}m${text}\x1b[0m` : text);
+	const label = d.severity === "error" ? paint("1;31", "error") : d.severity === "warning" ? paint("1;33", "warning") : paint("1;36", d.severity);
+	const lines = [`${d.file}:${d.line}:${d.column}: ${label}[${d.code}]: ${d.message}`];
+	if (source) {
+		const text = source.lineText(d.line).replace(/\t/g, "    ");
+		const raw = source.lineText(d.line);
+		const prefix = raw.slice(0, d.column - 1).replace(/\t/g, "    ");
+		const width = d.endLine === d.line ? Math.max(1, d.endColumn - d.column) : Math.max(1, raw.length - (d.column - 1));
+		const gutter = String(d.line).length;
+		lines.push(`${" ".repeat(gutter)} |`);
+		lines.push(`${d.line} | ${text}`);
+		lines.push(`${" ".repeat(gutter)} | ${" ".repeat(prefix.length)}${paint(d.severity === "error" ? "1;31" : "1;33", "^".repeat(Math.min(width, Math.max(1, text.length - prefix.length))))}`);
+	}
+	for (const note of d.notes || []) {
+		lines.push(`  = ${note}`);
+	}
+	return lines.join("\n");
+}
+
+/** Damerau-free Levenshtein, capped; used for "did you mean" suggestions. */
+export function editDistance(a: string, b: string, cap = 4): number {
+	if (Math.abs(a.length - b.length) > cap) {
+		return cap + 1;
+	}
+	const prev = new Array<number>(b.length + 1);
+	const cur = new Array<number>(b.length + 1);
+	for (let j = 0; j <= b.length; j++) {
+		prev[j] = j;
+	}
+	for (let i = 1; i <= a.length; i++) {
+		cur[0] = i;
+		let rowMin = cur[0];
+		const ca = a.charCodeAt(i - 1);
+		for (let j = 1; j <= b.length; j++) {
+			const cost = ca === b.charCodeAt(j - 1) ? 0 : 1;
+			cur[j] = Math.min(prev[j] + 1, cur[j - 1] + 1, prev[j - 1] + cost);
+			if (cur[j] < rowMin) {
+				rowMin = cur[j];
+			}
+		}
+		if (rowMin > cap) {
+			return cap + 1;
+		}
+		for (let j = 0; j <= b.length; j++) {
+			prev[j] = cur[j];
+		}
+	}
+	return prev[b.length];
+}
+
+export function suggest(name: string, candidates: Iterable<string>, max = 2): string | null {
+	let best: string | null = null;
+	let bestScore = Infinity;
+	const lower = name.toLowerCase();
+	for (const candidate of candidates) {
+		if (candidate === name) {
+			continue;
+		}
+		if (candidate.toLowerCase() === lower) {
+			return candidate;
+		}
+		const limit = Math.min(max, Math.max(1, Math.floor(name.length / 3)));
+		const score = editDistance(lower, candidate.toLowerCase(), limit);
+		if (score <= limit && score < bestScore) {
+			best = candidate;
+			bestScore = score;
+		}
+	}
+	return best;
+}