rubrkit 0.1.0 → 0.3.0

package/src/formats.js

@@ -1,222 +1,239 @@
-// @ts-check
-
-import fs from 'node:fs/promises';
-
-/**
- * @param {{ payload: Record<string, any>, format?: string, output?: string | null, stdout: NodeJS.WritableStream, fsImpl?: typeof fs }} params
- */
-export async function writeFormattedResult({ payload, format = 'text', output = null, stdout, fsImpl = fs }) {
-    const rendered = renderResult(payload, format);
-
-    if (output) {
-        await fsImpl.writeFile(output, rendered, 'utf8');
-        if (format !== 'json') {
-            stdout.write(`Wrote Rubrkit ${format} report to ${output}\n`);
-        }
-        return;
-    }
-
-    stdout.write(rendered);
-    if (!rendered.endsWith('\n')) {
-        stdout.write('\n');
-    }
-}
-
-/**
- * @param {Record<string, any>} payload
- * @param {string} format
- */
-export function renderResult(payload, format = 'text') {
-    if (format === 'json') {
-        return `${JSON.stringify(payload, null, 2)}\n`;
-    }
-
-    if (format === 'junit') {
-        return renderJUnit(payload);
-    }
-
-    return renderText(payload);
-}
-
-/**
- * @param {Record<string, any>} payload
- */
-function renderText(payload) {
-    if (payload.mode === 'remote-dry-run') {
-        return [
-            `Rubrkit ${payload.command} remote dry run`,
-            `Target: ${payload.target ?? '(none)'}`,
-            `Endpoint: ${payload.endpoint}`,
-            `Method: ${payload.method}`,
-            `Polls job: ${payload.pollsJob ? 'yes' : 'no'}`,
-            payload.requiresApiKey ? 'Requires API key: yes' : 'Requires API key: no',
-        ].join('\n') + '\n';
-    }
-
-    if (payload.mode === 'remote') {
-        const job = payload.job ?? payload.data?.job ?? payload.data ?? {};
-        const state = job.state ?? 'unknown';
-        const score = scoreFromPayload(payload);
-        const lines = [
-            `Rubrkit ${payload.command} remote ${state}`,
-            `Job: ${job.id ?? payload.jobId ?? '(unknown)'}`,
-        ];
-
-        if (job.phase || job.message) {
-            lines.push(`Latest: ${[job.phase, job.message].filter(Boolean).join(' - ')}`);
-        }
-
-        if (typeof score === 'number') {
-            lines.push(`Score: ${score}`);
-        }
-
-        if (job.error?.message) {
-            lines.push(`Error: ${job.error.code ?? 'job_failed'} - ${job.error.message}`);
-        }
-
-        return `${lines.join('\n')}\n`;
-    }
-
-    if (payload.mode === 'report') {
-        const job = payload.job ?? payload.data?.job ?? payload;
-        return [
-            `Rubrkit report ${job.state ?? 'unknown'}`,
-            `Job: ${job.id ?? payload.id ?? '(unknown)'}`,
-            `Kind: ${job.kind ?? '(unknown)'}`,
-            `Latest: ${[job.phase, job.message].filter(Boolean).join(' - ') || '(none)'}`,
-        ].join('\n') + '\n';
-    }
-
-    const summary = payload.summary ?? {};
-    const status = payload.passed ? 'PASS' : 'FAIL';
-    const lines = [
-        `Rubrkit ${payload.command ?? 'validate'} ${payload.mode ?? 'local'}`,
-        `${status} ${payload.target ?? ''} (${summary.fileCount ?? 0} files, ${summary.errorCount ?? 0} errors, ${summary.warningCount ?? 0} warnings, score ${summary.score ?? 0})`,
-    ];
-
-    for (const file of payload.files ?? []) {
-        lines.push(`- ${file.passed ? 'PASS' : 'FAIL'} ${file.path}`);
-
-        for (const issue of file.issues ?? []) {
-            const location = issue.line ? ` line ${issue.line}${issue.column ? `:${issue.column}` : ''}` : '';
-            lines.push(`  ${issue.severity.toUpperCase()} ${issue.code}${location}: ${issue.message}`);
-            lines.push(`    fix: ${issue.fix}`);
-        }
-    }
-
-    for (const gate of payload.gates?.failures ?? []) {
-        lines.push(`Gate ${gate.code}: ${gate.message}`);
-    }
-
-    return `${lines.join('\n')}\n`;
-}
-
-/**
- * @param {Record<string, any>} payload
- */
-function renderJUnit(payload) {
-    const files = Array.isArray(payload.files) ? payload.files : [];
-    const tests = files.length || 1;
-    const failures = files.reduce((sum, file) => sum + Number(file.errorCount ?? 0), 0);
-    const warnings = files.reduce((sum, file) => sum + Number(file.warningCount ?? 0), 0);
-    const name = `rubrkit.${payload.command ?? 'test'}.${payload.mode ?? 'local'}`;
-    const testcases = files.length > 0 ? files.map(renderFileTestCase).join('\n') : renderRemoteTestCase(payload);
-
-    return [
-        '<?xml version="1.0" encoding="UTF-8"?>',
-        `<testsuite name="${xml(name)}" tests="${tests}" failures="${failures}" errors="0" skipped="0">`,
-        warnings > 0 ? `  <system-out>${xml(`${warnings} Rubrkit warning${warnings === 1 ? '' : 's'}`)}</system-out>` : '',
-        testcases,
-        '</testsuite>',
-        '',
-    ].filter(line => line !== '').join('\n');
-}
-
-/**
- * @param {Record<string, any>} file
- */
-function renderFileTestCase(file) {
-    const failures = (file.issues ?? []).filter(issue => issue.severity === 'error');
-    const warnings = (file.issues ?? []).filter(issue => issue.severity === 'warning');
-    const body = [];
-
-    if (failures.length > 0) {
-        body.push(
-            `    <failure message="${xml(`${failures.length} Rubrkit validation error${failures.length === 1 ? '' : 's'}`)}">${xml(
-                failures.map(formatIssue).join('\n'),
-            )}</failure>`,
-        );
-    }
-
-    if (warnings.length > 0) {
-        body.push(`    <system-out>${xml(warnings.map(formatIssue).join('\n'))}</system-out>`);
-    }
-
-    if (body.length === 0) {
-        return `  <testcase name="${xml(file.path)}" classname="RubrkitLocalChecks" />`;
-    }
-
-    return [`  <testcase name="${xml(file.path)}" classname="RubrkitLocalChecks">`, ...body, '  </testcase>'].join('\n');
-}
-
-/**
- * @param {Record<string, any>} payload
- */
-function renderRemoteTestCase(payload) {
-    const job = payload.job ?? {};
-    const failed = ['failed', 'cancelled', 'paused'].includes(job.state);
-
-    if (!failed) {
-        return `  <testcase name="${xml(job.id ?? payload.jobId ?? 'remote-job')}" classname="RubrkitRemoteJob" />`;
-    }
-
-    return [
-        `  <testcase name="${xml(job.id ?? payload.jobId ?? 'remote-job')}" classname="RubrkitRemoteJob">`,
-        `    <failure message="${xml(job.error?.message ?? 'Remote Rubrkit job did not succeed.')}">${xml(JSON.stringify(job.error ?? {}, null, 2))}</failure>`,
-        '  </testcase>',
-    ].join('\n');
-}
-
-/**
- * @param {Record<string, any>} issue
- */
-function formatIssue(issue) {
-    const location = issue.line ? `line ${issue.line}${issue.column ? `:${issue.column}` : ''}` : 'file';
-    return `${location} ${issue.severity?.toUpperCase?.() ?? 'ISSUE'} ${issue.code}: ${issue.message}\nfix: ${issue.fix}`;
-}
-
-/**
- * @param {string} value
- */
-function xml(value) {
-    return String(value)
-        .replace(/&/g, '&amp;')
-        .replace(/</g, '&lt;')
-        .replace(/>/g, '&gt;')
-        .replace(/"/g, '&quot;')
-        .replace(/'/g, '&apos;');
-}
-
-/**
- * @param {Record<string, any>} payload
- */
-export function scoreFromPayload(payload) {
-    const candidates = [
-        payload.summary?.score,
-        payload.job?.result?.overallScore,
-        payload.job?.result?.score,
-        payload.started?.auditRun?.result?.overallScore,
-        payload.started?.auditRun?.summary?.overallScore,
-        payload.started?.evalRun?.summary?.score,
-        payload.started?.result?.overallScore,
-    ];
-
-    for (const candidate of candidates) {
-        const value = Number(candidate);
-        if (Number.isFinite(value)) {
-            return value;
-        }
-    }
-
-    return null;
-}
+// @ts-check
+
+import fs from 'node:fs/promises';
+
+/**
+ * @param {{ payload: Record<string, any>, format?: string, output?: string | null, stdout: NodeJS.WritableStream, fsImpl?: typeof fs }} params
+ */
+export async function writeFormattedResult({ payload, format = 'text', output = null, stdout, fsImpl = fs }) {
+    const rendered = renderResult(payload, format);
+
+    if (output) {
+        await fsImpl.writeFile(output, rendered, 'utf8');
+        if (format !== 'json') {
+            stdout.write(`Wrote Rubrkit ${format} report to ${output}\n`);
+        }
+        return;
+    }
+
+    stdout.write(rendered);
+    if (!rendered.endsWith('\n')) {
+        stdout.write('\n');
+    }
+}
+
+/**
+ * @param {Record<string, any>} payload
+ * @param {string} format
+ */
+export function renderResult(payload, format = 'text') {
+    if (format === 'json') {
+        return `${JSON.stringify(payload, null, 2)}\n`;
+    }
+
+    if (format === 'junit') {
+        return renderJUnit(payload);
+    }
+
+    return renderText(payload);
+}
+
+/**
+ * @param {Record<string, any>} payload
+ */
+function renderText(payload) {
+    if (payload.mode === 'remote-dry-run') {
+        return [
+            `Rubrkit ${payload.command} remote dry run`,
+            `Target: ${payload.target ?? '(none)'}`,
+            `Endpoint: ${payload.endpoint}`,
+            `Method: ${payload.method}`,
+            `Polls job: ${payload.pollsJob ? 'yes' : 'no'}`,
+            payload.requiresApiKey ? 'Requires API key: yes' : 'Requires API key: no',
+        ].join('\n') + '\n';
+    }
+
+    if (payload.mode === 'remote') {
+        const job = payload.job ?? payload.data?.job ?? payload.data ?? {};
+        const state = job.state ?? 'unknown';
+        const score = scoreFromPayload(payload);
+        const lines = [
+            `Rubrkit ${payload.command} remote ${state}`,
+            `Job: ${job.id ?? payload.jobId ?? '(unknown)'}`,
+        ];
+
+        if (payload.cached) {
+            lines.push('Cached: yes (deterministic result reused; no credits charged)');
+        }
+
+        if (job.phase || job.message) {
+            lines.push(`Latest: ${[job.phase, job.message].filter(Boolean).join(' - ')}`);
+        }
+
+        if (typeof score === 'number') {
+            lines.push(`Score: ${score}`);
+        }
+
+        if (job.error?.message) {
+            lines.push(`Error: ${job.error.code ?? 'job_failed'} - ${job.error.message}`);
+        }
+
+        return `${lines.join('\n')}\n`;
+    }
+
+    if (payload.mode === 'remote-apply') {
+        const files = Array.isArray(payload.files) ? payload.files : [];
+        const count = typeof payload.appliedCount === 'number' ? payload.appliedCount : files.length;
+        const lines = [`Applied AI rewrite to ${count} file(s)`];
+
+        for (const file of files) {
+            const version = file.versionNumber != null ? ` (v${file.versionNumber})` : '';
+            lines.push(`- ${file.path ?? file.fileId ?? '(unknown)'}${version}`);
+        }
+
+        return `${lines.join('\n')}\n`;
+    }
+
+    if (payload.mode === 'report') {
+        const job = payload.job ?? payload.data?.job ?? payload;
+        return [
+            `Rubrkit report ${job.state ?? 'unknown'}`,
+            `Job: ${job.id ?? payload.id ?? '(unknown)'}`,
+            `Kind: ${job.kind ?? '(unknown)'}`,
+            `Latest: ${[job.phase, job.message].filter(Boolean).join(' - ') || '(none)'}`,
+        ].join('\n') + '\n';
+    }
+
+    const summary = payload.summary ?? {};
+    const status = payload.passed ? 'PASS' : 'FAIL';
+    const lines = [
+        `Rubrkit ${payload.command ?? 'validate'} ${payload.mode ?? 'local'}`,
+        `${status} ${payload.target ?? ''} (${summary.fileCount ?? 0} files, ${summary.errorCount ?? 0} errors, ${summary.warningCount ?? 0} warnings, score ${summary.score ?? 0})`,
+    ];
+
+    for (const file of payload.files ?? []) {
+        lines.push(`- ${file.passed ? 'PASS' : 'FAIL'} ${file.path}`);
+
+        for (const issue of file.issues ?? []) {
+            const location = issue.line ? ` line ${issue.line}${issue.column ? `:${issue.column}` : ''}` : '';
+            lines.push(`  ${issue.severity.toUpperCase()} ${issue.code}${location}: ${issue.message}`);
+            lines.push(`    fix: ${issue.fix}`);
+        }
+    }
+
+    for (const gate of payload.gates?.failures ?? []) {
+        lines.push(`Gate ${gate.code}: ${gate.message}`);
+    }
+
+    return `${lines.join('\n')}\n`;
+}
+
+/**
+ * @param {Record<string, any>} payload
+ */
+function renderJUnit(payload) {
+    const files = Array.isArray(payload.files) ? payload.files : [];
+    const tests = files.length || 1;
+    const failures = files.reduce((sum, file) => sum + Number(file.errorCount ?? 0), 0);
+    const warnings = files.reduce((sum, file) => sum + Number(file.warningCount ?? 0), 0);
+    const name = `rubrkit.${payload.command ?? 'test'}.${payload.mode ?? 'local'}`;
+    const testcases = files.length > 0 ? files.map(renderFileTestCase).join('\n') : renderRemoteTestCase(payload);
+
+    return [
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        `<testsuite name="${xml(name)}" tests="${tests}" failures="${failures}" errors="0" skipped="0">`,
+        warnings > 0 ? `  <system-out>${xml(`${warnings} Rubrkit warning${warnings === 1 ? '' : 's'}`)}</system-out>` : '',
+        testcases,
+        '</testsuite>',
+        '',
+    ].filter(line => line !== '').join('\n');
+}
+
+/**
+ * @param {Record<string, any>} file
+ */
+function renderFileTestCase(file) {
+    const failures = (file.issues ?? []).filter(issue => issue.severity === 'error');
+    const warnings = (file.issues ?? []).filter(issue => issue.severity === 'warning');
+    const body = [];
+
+    if (failures.length > 0) {
+        body.push(
+            `    <failure message="${xml(`${failures.length} Rubrkit validation error${failures.length === 1 ? '' : 's'}`)}">${xml(
+                failures.map(formatIssue).join('\n'),
+            )}</failure>`,
+        );
+    }
+
+    if (warnings.length > 0) {
+        body.push(`    <system-out>${xml(warnings.map(formatIssue).join('\n'))}</system-out>`);
+    }
+
+    if (body.length === 0) {
+        return `  <testcase name="${xml(file.path)}" classname="RubrkitLocalChecks" />`;
+    }
+
+    return [`  <testcase name="${xml(file.path)}" classname="RubrkitLocalChecks">`, ...body, '  </testcase>'].join('\n');
+}
+
+/**
+ * @param {Record<string, any>} payload
+ */
+function renderRemoteTestCase(payload) {
+    const job = payload.job ?? {};
+    const failed = ['failed', 'cancelled', 'paused'].includes(job.state);
+
+    if (!failed) {
+        return `  <testcase name="${xml(job.id ?? payload.jobId ?? 'remote-job')}" classname="RubrkitRemoteJob" />`;
+    }
+
+    return [
+        `  <testcase name="${xml(job.id ?? payload.jobId ?? 'remote-job')}" classname="RubrkitRemoteJob">`,
+        `    <failure message="${xml(job.error?.message ?? 'Remote Rubrkit job did not succeed.')}">${xml(JSON.stringify(job.error ?? {}, null, 2))}</failure>`,
+        '  </testcase>',
+    ].join('\n');
+}
+
+/**
+ * @param {Record<string, any>} issue
+ */
+function formatIssue(issue) {
+    const location = issue.line ? `line ${issue.line}${issue.column ? `:${issue.column}` : ''}` : 'file';
+    return `${location} ${issue.severity?.toUpperCase?.() ?? 'ISSUE'} ${issue.code}: ${issue.message}\nfix: ${issue.fix}`;
+}
+
+/**
+ * @param {string} value
+ */
+function xml(value) {
+    return String(value)
+        .replace(/&/g, '&amp;')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&apos;');
+}
+
+/**
+ * @param {Record<string, any>} payload
+ */
+export function scoreFromPayload(payload) {
+    const candidates = [
+        payload.summary?.score,
+        payload.job?.result?.overallScore,
+        payload.job?.result?.score,
+        payload.started?.auditRun?.result?.overallScore,
+        payload.started?.auditRun?.summary?.overallScore,
+        payload.started?.evalRun?.summary?.score,
+        payload.started?.result?.overallScore,
+    ];
+
+    for (const candidate of candidates) {
+        const value = Number(candidate);
+        if (Number.isFinite(value)) {
+            return value;
+        }
+    }
+
+    return null;
+}