Turn any idea, plan, or codebase into a beautiful interactive diagram. An agent skill for Claude Code, Codex, and more.
HTML agent-skillsai-agentsarchitecture-diagramclaude-codeclaude-skillscodexcoding-agentsdeepseek-harnessdeveloper-toolsdiagramsdiagrams-as-codedsh-pluginflowchartllmmermaidopencodesequence-diagramsoftware-architecturesystem-designvisualization
import assert from 'node:assert/strict';
import { spawnSync } from 'node:child_process';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import test from 'node:test';
import { fileURLToPath } from 'node:url';
const here = path.dirname(fileURLToPath(import.meta.url));
const skillRoot = path.resolve(here, '..', 'archify');
const cli = path.join(skillRoot, 'bin/archify.mjs');
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'archify-repair-receipt-'));
function run(args) {
return spawnSync(process.execPath, [cli, ...args], {
cwd: skillRoot,
encoding: 'utf8',
});
}
function writeFixture(name, source) {
const file = path.join(tmp, name);
if (source?.meta && source.meta.output === undefined) source.meta.output = 'fixture.html';
fs.writeFileSync(file, JSON.stringify(source, null, 2));
return file;
}
function receipt(result) {
assert.doesNotThrow(() => JSON.parse(result.stdout), result.stdout || result.stderr);
return JSON.parse(result.stdout);
}
test('repair receipt: malformed JSON is one clean machine object without a Node stack', () => {
const input = path.join(tmp, 'malformed.workflow.json');
fs.writeFileSync(input, '{broken json');
const result = run(['validate', 'workflow', input, '--json']);
assert.equal(result.status, 1);
assert.equal(result.stderr, '');
const failure = receipt(result);
assert.equal(failure.schemaVersion, 1);
assert.equal(failure.ok, false);
assert.equal(failure.command, 'validate');
assert.equal(failure.stage, 'input');
assert.equal(failure.diagnostics.length, 1);
assert.deepEqual(failure.diagnostics[0].subject, { input });
assert.equal(failure.diagnostics[0].code, 'input/json-parse');
assert.equal(failure.diagnostics[0].severity, 'error');
assert.match(failure.diagnostics[0].evidence.reason, /JSON/);
assert.deepEqual(failure.diagnostics[0].supportedFixes, ['repair the JSON syntax and run validation again']);
assert.doesNotMatch(result.stdout, /\n\s+at\s|file:\/\//);
});
test('repair receipt: all five modes identify schema subjects and supported fixes', () => {
const cases = {
architecture: ['web-app.architecture.json', 'components'],
workflow: ['agent-tool-call.workflow.json', 'nodes'],
sequence: ['cache-miss-request.sequence.json', 'participants'],
dataflow: ['product-analytics.dataflow.json', 'nodes'],
lifecycle: ['agent-run.lifecycle.json', 'states'],
};
for (const [type, [example, collection]] of Object.entries(cases)) {
const source = JSON.parse(fs.readFileSync(path.join(skillRoot, 'examples', example), 'utf8'));
source[collection][0].unexpected = true;
const identity = source[collection][0].id;
const input = writeFixture(`schema-${type}.json`, source);
const result = run(['validate', type, input, '--json']);
assert.equal(result.status, 1, `${type}: ${result.stderr || result.stdout}`);
assert.equal(result.stderr, '', type);
const failure = receipt(result);
const repair = failure.diagnostics.find((entry) => entry.code === 'schema/additionalProperties');
assert.ok(repair, type);
assert.deepEqual(repair.subject, {
diagramType: type,
path: `/${collection}/0`,
identity,
});
assert.equal(repair.evidence.additionalProperty, 'unexpected');
assert.deepEqual(repair.supportedFixes, ['remove unsupported property "unexpected"']);
}
});
test('repair receipt: human validation formats the same rule without a stack', () => {
const source = JSON.parse(fs.readFileSync(path.join(skillRoot, 'examples/agent-tool-call.workflow.json'), 'utf8'));
source.nodes[0].unexpected = true;
const input = writeFixture('human-schema.workflow.json', source);
const result = run(['validate', 'workflow', input]);
assert.equal(result.status, 1);
assert.equal(result.stdout, '');
assert.match(result.stderr, /\[schema\/additionalProperties\]/);
assert.match(result.stderr, /Fix: remove unsupported property "unexpected"/);
assert.doesNotMatch(result.stderr, /\n\s+at\s|file:\/\//);
});
test('repair receipt: validate and deliver share exact Clean Flow evidence while delivery preserves the trusted artifact', () => {
const source = JSON.parse(fs.readFileSync(path.join(skillRoot, 'examples/web-app.architecture.json'), 'utf8'));
source.connections[0] = {
...source.connections[0],
fromSide: 'right',
toSide: 'left',
via: [[100, 140], [220, 140]],
};
const input = writeFixture('blocked-route.architecture.json', source);
const output = path.join(tmp, 'trusted.html');
const trusted = '<!doctype html><title>trusted prior artifact</title>\n';
fs.writeFileSync(output, trusted);
const validated = run(['validate', 'architecture', input, '--quality', 'showcase', '--json']);
const delivered = run(['deliver', 'architecture', input, output, '--quality', 'showcase', '--json']);
assert.equal(validated.status, 1, validated.stderr || validated.stdout);
assert.equal(delivered.status, 1, delivered.stderr || delivered.stdout);
assert.equal(validated.stderr, '');
assert.equal(delivered.stderr, '');
const validateRepair = receipt(validated).diagnostics.find((entry) => entry.code === 'clean-flow/edge-through-node');
const deliverRepair = receipt(delivered).diagnostics.find((entry) => entry.code === 'clean-flow/edge-through-node');
assert.ok(validateRepair);
assert.ok(deliverRepair);
assert.deepEqual(deliverRepair, validateRepair);
assert.equal(validateRepair.subject.id, 'users-to-cdn');
assert.equal(validateRepair.evidence.obstacleId, 'auth');
assert.equal(validateRepair.evidence.segmentIndex, 0);
assert.equal(validateRepair.evidence.clearancePx, 2);
assert.ok(validateRepair.supportedFixes.some((fix) => fix.includes('route/via')));
assert.equal(fs.readFileSync(output, 'utf8'), trusted);
assert.deepEqual(fs.readdirSync(tmp).filter((name) => name.startsWith('.archify-delivery-')), []);
});
test('repair receipt: repository evidence failures retain a stable rule and exact repair', () => {
const source = JSON.parse(fs.readFileSync(path.join(skillRoot, 'examples/web-app.architecture.json'), 'utf8'));
source.meta.repository = {
url: 'https://github.com/example/repository',
revision: '0123456789abcdef0123456789abcdef01234567',
};
source.components[0].sources = [{ path: 'src/index.js', line: 1 }];
const input = writeFixture('evidence-root-required.architecture.json', source);
const result = run(['validate', 'architecture', input, '--json']);
assert.equal(result.status, 1);
assert.equal(result.stderr, '');
const repair = receipt(result).diagnostics[0];
assert.equal(repair.code, 'repository-evidence/root-required');
assert.deepEqual(repair.subject, { surface: 'repository-evidence', path: '/meta/repository' });
assert.deepEqual(repair.supportedFixes, ['pass --repo-root with the matching local Git checkout']);
});
test('repair receipt: public validate reports borderline desktop readability with a supported fix', () => {
const input = writeFixture('borderline-readability.architecture.json', {
schema_version: 1,
diagram_type: 'architecture',
meta: {
title: 'Borderline desktop readability',
quality_profile: 'showcase',
viewBox: [1826, 804],
},
components: [{
id: 'tool-runtime',
type: 'security',
label: 'ToolRuntime',
sublabel: 'OpenAI · Anthropic · provider gateways',
pos: [100, 100],
size: [194, 70],
}],
connections: [],
});
const result = run(['validate', 'architecture', input, '--quality', 'showcase', '--json']);
assert.equal(result.status, 1, result.stderr || result.stdout);
assert.equal(result.stderr, '');
const repair = receipt(result).diagnostics.find(
(entry) => entry.code === 'composition/desktop-readability',
);
assert.ok(repair);
assert.deepEqual(repair.subject, { check: 'composition', nodeId: 'tool-runtime' });
assert.ok(repair.evidence.projectedFontPx < repair.evidence.minimumProjectedFontPx);
const fix = repair.supportedFixes.join(' ');
assert.match(fix, /complete viewBox width is at most \d+px/);
assert.match(fix, /desktop budget/);
assert.doesNotMatch(fix, /labelAt|labelDx|labelDy|labelSegment/);
});
process.on('exit', () => fs.rmSync(tmp, { recursive: true, force: true }));
test('repair receipt: readability identifies the failing node despite repeated copy', () => {
for (const command of ['validate', 'deliver']) {
for (const failingIndex of [0, 1]) {
const ids = ['billing-worker', 'email-worker'];
const input = writeFixture(`readability-${command}-${failingIndex}.json`, {
schema_version: 1, diagram_type: 'architecture',
meta: { title: 'Worker pools', viewBox: [1200, 400] },
components: ids.map((id, i) => ({
id, type: 'backend', label: 'Worker', sublabel: 'Processes queued jobs',
pos: [80 + i * 420, 100], size: [i === failingIndex ? 100 : 300, 70],
})),
connections: [],
});
const output = path.join(tmp, `readability-${command}-${failingIndex}.html`);
const result = run([command, 'architecture', input,
...(command === 'deliver' ? [output] : []), '--quality', 'showcase', '--json']);
assert.equal(result.status, 1);
const failure = receipt(result);
assert.equal(failure.stage, 'check');
const diagnostics = failure.diagnostics.filter(d => d.code === 'composition/desktop-readability');
assert.equal(diagnostics.length, 1);
assert.deepEqual(diagnostics[0].subject, { check: 'composition', nodeId: ids[failingIndex] });
assert.equal(diagnostics[0].evidence.text, 'Processes queued jobs');
assert.equal(diagnostics[0].evidence.projectedFontPx, 5.6575);
assert.equal(fs.existsSync(output), false);
}
}
});
test('repair receipt: edge readability advises a projection-changing reflow, not label positioning', () => {
const input = writeFixture('edge-readability.architecture.json', {
schema_version: 1,
diagram_type: 'architecture',
meta: { title: 'Edge readability', quality_profile: 'showcase', viewBox: [1438, 800] },
components: [
{ id: 'listener', type: 'backend', label: 'Listener', pos: [120, 260], size: [180, 80] },
{ id: 'handler', type: 'backend', label: 'Handler', pos: [760, 260], size: [180, 80] },
],
connections: [{ id: 'request', from: 'listener', to: 'handler', label: 'method path body' }],
});
const result = run(['validate', 'architecture', input, '--quality', 'showcase', '--json']);
assert.equal(result.status, 1, result.stderr || result.stdout);
const repair = receipt(result).diagnostics.find((entry) => entry.code === 'composition/desktop-readability');
assert.ok(repair);
assert.equal(repair.evidence.owner.kind, 'edge');
assert.equal(repair.evidence.owner.id, 'request');
assert.equal(repair.evidence.sourceFontPx, 8);
assert.equal(repair.evidence.availableDiagramWidth, 930);
assert.equal(repair.evidence.viewBoxWidth, 1438);
const fix = repair.supportedFixes.join(' ');
assert.match(fix, /complete viewBox width is at most 1240px/);
assert.match(fix, /8px source text at 930px desktop budget/);
assert.match(fix, /Preserve the semantic text and any supplied coordinates, routes, sides, channels, and labels/);
assert.doesNotMatch(fix, /labelAt|labelDx|labelDy|labelSegment|reposition/i);
});