@kubohiroya/turbowarp-diagnostic-overlay 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/LICENSE +4 -0
- package/README.md +163 -0
- package/dist/diagnostic-overlay.js +574 -0
- package/dist/lib/block-definitions.json +58 -0
- package/dist/lib/composition.d.ts +22 -0
- package/dist/lib/composition.d.ts.map +1 -0
- package/dist/lib/composition.js +20 -0
- package/dist/lib/composition.js.map +1 -0
- package/dist/lib/config.d.ts +10 -0
- package/dist/lib/config.d.ts.map +1 -0
- package/dist/lib/config.js +10 -0
- package/dist/lib/config.js.map +1 -0
- package/dist/lib/diagnostic.d.ts +30 -0
- package/dist/lib/diagnostic.d.ts.map +1 -0
- package/dist/lib/diagnostic.js +120 -0
- package/dist/lib/diagnostic.js.map +1 -0
- package/dist/lib/extension.d.ts +24 -0
- package/dist/lib/extension.d.ts.map +1 -0
- package/dist/lib/extension.js +94 -0
- package/dist/lib/extension.js.map +1 -0
- package/dist/lib/index.d.ts +2 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/lib/index.js +8 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/overlay.d.ts +39 -0
- package/dist/lib/overlay.d.ts.map +1 -0
- package/dist/lib/overlay.js +140 -0
- package/dist/lib/overlay.js.map +1 -0
- package/dist/lib/scratch.d.ts +32 -0
- package/dist/lib/scratch.d.ts.map +1 -0
- package/dist/lib/scratch.js +2 -0
- package/dist/lib/scratch.js.map +1 -0
- package/dist/lib/svg-renderer.d.ts +12 -0
- package/dist/lib/svg-renderer.d.ts.map +1 -0
- package/dist/lib/svg-renderer.js +180 -0
- package/dist/lib/svg-renderer.js.map +1 -0
- package/docs/specification.md +67 -0
- package/package.json +90 -0
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
import { normalizeDiagnostic } from './diagnostic.js';
|
|
2
|
+
const DEFAULT_OPTIONS = {
|
|
3
|
+
width: 480,
|
|
4
|
+
height: 360,
|
|
5
|
+
maxMessageLines: 3,
|
|
6
|
+
maxDetailLines: 4,
|
|
7
|
+
maxExcerptLines: 4
|
|
8
|
+
};
|
|
9
|
+
const THEMES = {
|
|
10
|
+
info: { accent: '#4CA6FF', label: 'INFO' },
|
|
11
|
+
warning: { accent: '#F0C24B', label: 'WARNING' },
|
|
12
|
+
error: { accent: '#FF6B6B', label: 'ERROR' },
|
|
13
|
+
fatal: { accent: '#FF3B5C', label: 'FATAL' }
|
|
14
|
+
};
|
|
15
|
+
// XML 1.0 permits tab, line feed, and carriage return while rejecting other control characters.
|
|
16
|
+
// eslint-disable-next-line no-control-regex
|
|
17
|
+
const INVALID_XML_CHARACTER = /[^\u0009\u000A\u000D\u0020-\uD7FF\uE000-\uFFFD\u{10000}-\u{10FFFF}]/gu;
|
|
18
|
+
export function renderDiagnosticSvg(input, options = {}) {
|
|
19
|
+
const diagnostic = normalizeDiagnostic(input);
|
|
20
|
+
const resolved = resolveOptions(options);
|
|
21
|
+
const theme = THEMES[diagnostic.severity];
|
|
22
|
+
const padding = Math.max(18, Math.round(resolved.width * 0.055));
|
|
23
|
+
const panelX = Math.max(8, Math.round(resolved.width * 0.025));
|
|
24
|
+
const panelY = Math.max(8, Math.round(resolved.height * 0.035));
|
|
25
|
+
const panelWidth = resolved.width - panelX * 2;
|
|
26
|
+
const panelHeight = resolved.height - panelY * 2;
|
|
27
|
+
const textX = panelX + padding;
|
|
28
|
+
const textWidth = panelWidth - padding * 2;
|
|
29
|
+
const titleSize = clamp(Math.round(resolved.height * 0.047), 13, 18);
|
|
30
|
+
const messageSize = clamp(Math.round(resolved.height * 0.054), 15, 21);
|
|
31
|
+
const bodySize = clamp(Math.round(resolved.height * 0.038), 12, 16);
|
|
32
|
+
const smallSize = clamp(Math.round(resolved.height * 0.033), 11, 14);
|
|
33
|
+
let cursorY = panelY + padding + titleSize;
|
|
34
|
+
const parts = [];
|
|
35
|
+
parts.push(`<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${resolved.width} ${resolved.height}" role="img" aria-labelledby="diagnostic-title diagnostic-description">`, `<title id="diagnostic-title">${escapeXml(`${theme.label} ${diagnostic.code}`)}</title>`, `<desc id="diagnostic-description">${escapeXml(accessibleDiagnosticText(diagnostic))}</desc>`, `<rect width="${resolved.width}" height="${resolved.height}" fill="#05070A" fill-opacity="0.42"/>`, `<rect x="${panelX}" y="${panelY}" width="${panelWidth}" height="${panelHeight}" rx="12" fill="#151922" fill-opacity="0.97" stroke="${theme.accent}" stroke-width="2"/>`, `<rect x="${panelX}" y="${panelY}" width="6" height="${panelHeight}" rx="3" fill="${theme.accent}"/>`, textElement([`${theme.label} ${diagnostic.code}`], textX, cursorY, titleSize, theme.accent, 700));
|
|
36
|
+
cursorY += Math.round(messageSize * 1.7);
|
|
37
|
+
const messageLines = truncateLines(wrapText(diagnostic.message, maxUnits(textWidth, messageSize)), resolved.maxMessageLines, maxUnits(textWidth, messageSize));
|
|
38
|
+
parts.push(textElement(messageLines, textX, cursorY, messageSize, '#FFFFFF', 700));
|
|
39
|
+
cursorY += lineBlockHeight(messageLines.length, messageSize) + Math.round(bodySize * 0.85);
|
|
40
|
+
if (diagnostic.detail) {
|
|
41
|
+
const detailLines = truncateLines(wrapText(diagnostic.detail, maxUnits(textWidth, bodySize)), resolved.maxDetailLines, maxUnits(textWidth, bodySize));
|
|
42
|
+
parts.push(textElement(detailLines, textX, cursorY, bodySize, '#DCE2EE', 400));
|
|
43
|
+
cursorY += lineBlockHeight(detailLines.length, bodySize) + Math.round(smallSize * 0.9);
|
|
44
|
+
}
|
|
45
|
+
const sourceLabel = formatSource(diagnostic);
|
|
46
|
+
if (sourceLabel) {
|
|
47
|
+
parts.push(textElement([sourceLabel], textX, cursorY, smallSize, '#AEB8CA', 600));
|
|
48
|
+
cursorY += Math.round(smallSize * 1.65);
|
|
49
|
+
}
|
|
50
|
+
if (diagnostic.source?.excerpt) {
|
|
51
|
+
const excerptY = cursorY - Math.round(smallSize * 0.78);
|
|
52
|
+
const availableHeight = panelY + panelHeight - padding - excerptY;
|
|
53
|
+
const possibleLines = Math.max(1, Math.floor(availableHeight / (smallSize * 1.35)));
|
|
54
|
+
const excerptLineLimit = Math.min(resolved.maxExcerptLines, possibleLines);
|
|
55
|
+
const excerptPadding = Math.max(8, Math.round(smallSize * 0.8));
|
|
56
|
+
const excerptWidth = textWidth - excerptPadding * 2;
|
|
57
|
+
const excerptLines = truncateLines(wrapText(diagnostic.source.excerpt, maxUnits(excerptWidth, smallSize)), excerptLineLimit, maxUnits(excerptWidth, smallSize));
|
|
58
|
+
const excerptHeight = lineBlockHeight(excerptLines.length, smallSize) + excerptPadding * 2;
|
|
59
|
+
parts.push(`<rect x="${textX}" y="${excerptY}" width="${textWidth}" height="${excerptHeight}" rx="5" fill="#090C12" stroke="#303848"/>`, textElement(excerptLines, textX + excerptPadding, excerptY + excerptPadding + smallSize, smallSize, '#E7ECF5', 400, 'ui-monospace, SFMono-Regular, Menlo, Consolas, monospace'));
|
|
60
|
+
}
|
|
61
|
+
parts.push('</svg>');
|
|
62
|
+
return parts.join('');
|
|
63
|
+
}
|
|
64
|
+
export function accessibleDiagnosticText(diagnostic) {
|
|
65
|
+
return [
|
|
66
|
+
diagnostic.severity.toUpperCase(),
|
|
67
|
+
diagnostic.code,
|
|
68
|
+
diagnostic.message,
|
|
69
|
+
diagnostic.detail,
|
|
70
|
+
formatSource(diagnostic),
|
|
71
|
+
diagnostic.source?.excerpt
|
|
72
|
+
].filter((part) => Boolean(part)).join('. ');
|
|
73
|
+
}
|
|
74
|
+
export function escapeXml(value) {
|
|
75
|
+
return value
|
|
76
|
+
.replace(INVALID_XML_CHARACTER, '\uFFFD')
|
|
77
|
+
.replaceAll('&', '&')
|
|
78
|
+
.replaceAll('<', '<')
|
|
79
|
+
.replaceAll('>', '>')
|
|
80
|
+
.replaceAll('"', '"')
|
|
81
|
+
.replaceAll("'", ''');
|
|
82
|
+
}
|
|
83
|
+
function resolveOptions(options) {
|
|
84
|
+
return {
|
|
85
|
+
width: positiveInteger(options.width, DEFAULT_OPTIONS.width, 160, 4096),
|
|
86
|
+
height: positiveInteger(options.height, DEFAULT_OPTIONS.height, 120, 4096),
|
|
87
|
+
maxMessageLines: positiveInteger(options.maxMessageLines, DEFAULT_OPTIONS.maxMessageLines, 1, 12),
|
|
88
|
+
maxDetailLines: positiveInteger(options.maxDetailLines, DEFAULT_OPTIONS.maxDetailLines, 1, 20),
|
|
89
|
+
maxExcerptLines: positiveInteger(options.maxExcerptLines, DEFAULT_OPTIONS.maxExcerptLines, 1, 20)
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
function positiveInteger(value, fallback, min, max) {
|
|
93
|
+
if (value === undefined)
|
|
94
|
+
return fallback;
|
|
95
|
+
if (!Number.isFinite(value))
|
|
96
|
+
return fallback;
|
|
97
|
+
return clamp(Math.round(value), min, max);
|
|
98
|
+
}
|
|
99
|
+
function textElement(lines, x, y, size, fill, weight, family = 'system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif') {
|
|
100
|
+
const lineHeight = Math.round(size * 1.35);
|
|
101
|
+
const tspans = lines.map((line, index) => `<tspan x="${x}" dy="${index === 0 ? 0 : lineHeight}">${escapeXml(line)}</tspan>`).join('');
|
|
102
|
+
return `<text x="${x}" y="${y}" fill="${fill}" font-family="${escapeXml(family)}" font-size="${size}" font-weight="${weight}" xml:space="preserve">${tspans}</text>`;
|
|
103
|
+
}
|
|
104
|
+
function wrapText(value, limit) {
|
|
105
|
+
const lines = [];
|
|
106
|
+
for (const paragraph of value.replaceAll('\r\n', '\n').replaceAll('\r', '\n').split('\n')) {
|
|
107
|
+
if (!paragraph) {
|
|
108
|
+
lines.push(' ');
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
let current = '';
|
|
112
|
+
let units = 0;
|
|
113
|
+
for (const character of Array.from(paragraph)) {
|
|
114
|
+
const nextUnits = characterUnits(character);
|
|
115
|
+
if (current && units + nextUnits > limit) {
|
|
116
|
+
lines.push(current.trimEnd());
|
|
117
|
+
current = character.trimStart();
|
|
118
|
+
units = current ? nextUnits : 0;
|
|
119
|
+
}
|
|
120
|
+
else {
|
|
121
|
+
current += character;
|
|
122
|
+
units += nextUnits;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
if (current || lines.length === 0)
|
|
126
|
+
lines.push(current.trimEnd());
|
|
127
|
+
}
|
|
128
|
+
return lines;
|
|
129
|
+
}
|
|
130
|
+
function truncateLines(lines, limit, lineUnits) {
|
|
131
|
+
if (lines.length <= limit)
|
|
132
|
+
return lines;
|
|
133
|
+
const result = lines.slice(0, limit);
|
|
134
|
+
const lastIndex = result.length - 1;
|
|
135
|
+
const last = result[lastIndex] ?? '';
|
|
136
|
+
result[lastIndex] = appendEllipsis(last, lineUnits);
|
|
137
|
+
return result;
|
|
138
|
+
}
|
|
139
|
+
function appendEllipsis(value, limit) {
|
|
140
|
+
const ellipsis = '…';
|
|
141
|
+
let result = value.trimEnd();
|
|
142
|
+
while (result && textUnits(result) + characterUnits(ellipsis) > limit) {
|
|
143
|
+
result = Array.from(result).slice(0, -1).join('').trimEnd();
|
|
144
|
+
}
|
|
145
|
+
return `${result}${ellipsis}`;
|
|
146
|
+
}
|
|
147
|
+
function characterUnits(character) {
|
|
148
|
+
if (/\p{Mark}/u.test(character))
|
|
149
|
+
return 0;
|
|
150
|
+
if (/\s/u.test(character))
|
|
151
|
+
return 0.35;
|
|
152
|
+
if (/^[\u0020-\u007e]$/u.test(character))
|
|
153
|
+
return 0.58;
|
|
154
|
+
return 1;
|
|
155
|
+
}
|
|
156
|
+
function textUnits(value) {
|
|
157
|
+
return Array.from(value).reduce((total, character) => total + characterUnits(character), 0);
|
|
158
|
+
}
|
|
159
|
+
function maxUnits(width, fontSize) {
|
|
160
|
+
return Math.max(8, width / fontSize);
|
|
161
|
+
}
|
|
162
|
+
function lineBlockHeight(lineCount, fontSize) {
|
|
163
|
+
return fontSize + Math.max(0, lineCount - 1) * Math.round(fontSize * 1.35);
|
|
164
|
+
}
|
|
165
|
+
function formatSource(diagnostic) {
|
|
166
|
+
const source = diagnostic.source;
|
|
167
|
+
if (!source)
|
|
168
|
+
return undefined;
|
|
169
|
+
const position = [
|
|
170
|
+
source.line === undefined ? undefined : `line ${source.line}`,
|
|
171
|
+
source.column === undefined ? undefined : `column ${source.column}`
|
|
172
|
+
].filter((part) => part !== undefined).join(', ');
|
|
173
|
+
if (source.name && position)
|
|
174
|
+
return `${source.name} — ${position}`;
|
|
175
|
+
return source.name ?? (position || undefined);
|
|
176
|
+
}
|
|
177
|
+
function clamp(value, min, max) {
|
|
178
|
+
return Math.min(max, Math.max(min, value));
|
|
179
|
+
}
|
|
180
|
+
//# sourceMappingURL=svg-renderer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"svg-renderer.js","sourceRoot":"","sources":["../../src/svg-renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,iBAAiB,CAAC;AAwBpD,MAAM,eAAe,GAAoB;IACvC,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,GAAG;IACX,eAAe,EAAE,CAAC;IAClB,cAAc,EAAE,CAAC;IACjB,eAAe,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,GAA8C;IACxD,IAAI,EAAE,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAC;IACxC,OAAO,EAAE,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAC;IAC9C,KAAK,EAAE,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAC;IAC1C,KAAK,EAAE,EAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAC;CAC3C,CAAC;AAEF,gGAAgG;AAChG,4CAA4C;AAC5C,MAAM,qBAAqB,GAAG,uEAAuE,CAAC;AAEtG,MAAM,UAAU,mBAAmB,CACjC,KAAmC,EACnC,UAAgC,EAAE;IAElC,MAAM,UAAU,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACzC,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAChE,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;IAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;IAC/B,MAAM,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACrE,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACvE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAErE,IAAI,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAC3C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,CAAC,IAAI,CACR,wDAAwD,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,yEAAyE,EAClK,gCAAgC,SAAS,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,UAAU,EACxF,qCAAqC,SAAS,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,SAAS,EAC7F,gBAAgB,QAAQ,CAAC,KAAK,aAAa,QAAQ,CAAC,MAAM,wCAAwC,EAClG,YAAY,MAAM,QAAQ,MAAM,YAAY,UAAU,aAAa,WAAW,wDAAwD,KAAK,CAAC,MAAM,sBAAsB,EACxK,YAAY,MAAM,QAAQ,MAAM,uBAAuB,WAAW,kBAAkB,KAAK,CAAC,MAAM,KAAK,EACrG,WAAW,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAClG,CAAC;IAEF,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,aAAa,CAChC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,EAC9D,QAAQ,CAAC,eAAe,EACxB,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CACjC,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;IACnF,OAAO,IAAI,eAAe,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAE3F,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,aAAa,CAC/B,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,EAC1D,QAAQ,CAAC,cAAc,EACvB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAC9B,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/E,OAAO,IAAI,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;QAClF,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QACxD,MAAM,eAAe,GAAG,MAAM,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,CAAC;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpF,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAC3E,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,YAAY,GAAG,SAAS,GAAG,cAAc,GAAG,CAAC,CAAC;QACpD,MAAM,YAAY,GAAG,aAAa,CAChC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,EACtE,gBAAgB,EAChB,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,CAClC,CAAC;QACF,MAAM,aAAa,GAAG,eAAe,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,cAAc,GAAG,CAAC,CAAC;QAC3F,KAAK,CAAC,IAAI,CACR,YAAY,KAAK,QAAQ,QAAQ,YAAY,SAAS,aAAa,aAAa,4CAA4C,EAC5H,WAAW,CACT,YAAY,EACZ,KAAK,GAAG,cAAc,EACtB,QAAQ,GAAG,cAAc,GAAG,SAAS,EACrC,SAAS,EACT,SAAS,EACT,GAAG,EACH,0DAA0D,CAC3D,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrB,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,UAAsB;IAC7D,OAAO;QACL,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE;QACjC,UAAU,CAAC,IAAI;QACf,UAAU,CAAC,OAAO;QAClB,UAAU,CAAC,MAAM;QACjB,YAAY,CAAC,UAAU,CAAC;QACxB,UAAU,CAAC,MAAM,EAAE,OAAO;KAC3B,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK;SACT,OAAO,CAAC,qBAAqB,EAAE,QAAQ,CAAC;SACxC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC;SACxB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;SACvB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;SACvB,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC;SACzB,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,cAAc,CAAC,OAA6B;IACnD,OAAO;QACL,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC;QACvE,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC;QAC1E,eAAe,EAAE,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC;QACjG,cAAc,EAAE,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9F,eAAe,EAAE,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC;KAClG,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAAyB,EAAE,QAAgB,EAAE,GAAW,EAAE,GAAW;IAC5F,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,WAAW,CAClB,KAAwB,EACxB,CAAS,EACT,CAAS,EACT,IAAY,EACZ,IAAY,EACZ,MAAc,EACd,MAAM,GAAG,sEAAsE;IAE/E,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACvC,aAAa,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,UAAU,CAClF,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACX,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,IAAI,kBAAkB,SAAS,CAAC,MAAM,CAAC,gBAAgB,IAAI,kBAAkB,MAAM,0BAA0B,MAAM,SAAS,CAAC;AACvK,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,KAAa;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChB,SAAS;QACX,CAAC;QACD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,OAAO,IAAI,KAAK,GAAG,SAAS,GAAG,KAAK,EAAE,CAAC;gBACzC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9B,OAAO,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;gBAChC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,SAAS,CAAC;gBACrB,KAAK,IAAI,SAAS,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,KAAe,EAAE,KAAa,EAAE,SAAiB;IACtE,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACrC,MAAM,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,KAAa,EAAE,KAAa;IAClD,MAAM,QAAQ,GAAG,GAAG,CAAC;IACrB,IAAI,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;IAC7B,OAAO,MAAM,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,CAAC;QACtE,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;IACD,OAAO,GAAG,MAAM,GAAG,QAAQ,EAAE,CAAC;AAChC,CAAC;AAED,SAAS,cAAc,CAAC,SAAiB;IACvC,IAAI,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC;QAAE,OAAO,CAAC,CAAC;IAC1C,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IACvC,IAAI,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IACtD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,KAAK,GAAG,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,QAAgB;IAC/C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,eAAe,CAAC,SAAiB,EAAE,QAAgB;IAC1D,OAAO,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,YAAY,CAAC,UAAsB;IAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IACjC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,MAAM,QAAQ,GAAG;QACf,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,MAAM,CAAC,IAAI,EAAE;QAC7D,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,MAAM,EAAE;KACpE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClE,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ;QAAE,OAAO,GAAG,MAAM,CAAC,IAAI,MAAM,QAAQ,EAAE,CAAC;IACnE,OAAO,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW;IACpD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;AAC7C,CAAC"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Diagnostic Overlay 0.1 仕様
|
|
2
|
+
|
|
3
|
+
## 1. 目的
|
|
4
|
+
|
|
5
|
+
Diagnostic Overlayは、アプリケーションから受け取った一件の構造化診断をTurboWarpステージ上に表示するpresentation componentである。診断を発見せず、実行を停止せず、紙芝居固有の型やコマンドを知らない。
|
|
6
|
+
|
|
7
|
+
## 2. 診断モデル
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type DiagnosticSeverity = 'info' | 'warning' | 'error' | 'fatal';
|
|
11
|
+
|
|
12
|
+
interface DiagnosticSource {
|
|
13
|
+
name?: string;
|
|
14
|
+
line?: number;
|
|
15
|
+
column?: number;
|
|
16
|
+
excerpt?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
interface Diagnostic {
|
|
20
|
+
severity: DiagnosticSeverity;
|
|
21
|
+
code: string;
|
|
22
|
+
message: string;
|
|
23
|
+
detail?: string;
|
|
24
|
+
source?: DiagnosticSource;
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`code`と`message`は空にできない。`line`と`column`は1から始まる安全な整数である。JSON入力には65,536文字の上限を設け、各文字列にも個別の上限を設ける。
|
|
29
|
+
|
|
30
|
+
## 3. SVG renderer
|
|
31
|
+
|
|
32
|
+
`renderDiagnosticSvg`は同じ入力とoptionsに対して同じSVG文字列を返す純粋関数である。Scratch、DOM、TurboWarp VMを参照しない。
|
|
33
|
+
|
|
34
|
+
- SVGの`text`と`tspan`のみで文字を描画する。
|
|
35
|
+
- `foreignObject`を使用しない。
|
|
36
|
+
- 入力由来の文字列を要素名、属性名、色、URLとして使用しない。
|
|
37
|
+
- `& < > " '`をXML entityへ変換し、XML 1.0で無効な制御文字や不正なサロゲートを`U+FFFD`へ置換する。
|
|
38
|
+
- 日本語など空白を含まない文字列も折り返す。
|
|
39
|
+
- 表示可能行数を超えた場合は末尾を`…`にする。
|
|
40
|
+
|
|
41
|
+
## 4. Overlay host
|
|
42
|
+
|
|
43
|
+
`BrowserStageOverlayHost`はrenderer canvasと同じ位置・大きさのDOM要素をcanvasの親要素に追加する。表示要素は`pointer-events: none`である。canvasのサイズ変更を`ResizeObserver`とwindowの`resize`イベントで追従する。
|
|
44
|
+
|
|
45
|
+
親要素がstatic positioningの場合だけ一時的に`position: relative`を設定し、dispose時に自分が行った変更を復元する。disposeは複数回呼び出せる。
|
|
46
|
+
|
|
47
|
+
## 5. ライフサイクル
|
|
48
|
+
|
|
49
|
+
- 新しい診断を表示すると現在の表示を置換する。
|
|
50
|
+
- `clear`は表示と最後の診断を消去する。
|
|
51
|
+
- `PROJECT_LOADED`では古いプロジェクトの表示を消去する。
|
|
52
|
+
- `RUNTIME_DISPOSED`ではDOM、observer、event listenerを解放する。
|
|
53
|
+
- `PROJECT_STOP_ALL`では表示を消去しない。停止原因となった診断を利用者が読めるようにするためである。
|
|
54
|
+
|
|
55
|
+
## 6. Composition
|
|
56
|
+
|
|
57
|
+
`@kubohiroya/turbowarp-diagnostic-overlay/composition`のimportにはTurboWarp登録などの副作用がない。`createDiagnosticOverlayComposition(scratch, options)`を呼び出したときだけhost、controller、extensionを生成する。
|
|
58
|
+
|
|
59
|
+
利用側は返された`extension`を自身のcomposition rootで登録できる。また`host`を差し替えることでDOM以外の表示先を利用できる。
|
|
60
|
+
|
|
61
|
+
## 7. 非責務
|
|
62
|
+
|
|
63
|
+
- DSL、アセット、式などの検証
|
|
64
|
+
- 複数診断のキューや履歴
|
|
65
|
+
- Scratch thread、VM、プロジェクトの停止
|
|
66
|
+
- 診断の自動表示
|
|
67
|
+
- ログの永続化や外部送信
|
package/package.json
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@kubohiroya/turbowarp-diagnostic-overlay",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Render structured diagnostics as safe SVG overlays on the TurboWarp stage.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"turbowarp",
|
|
7
|
+
"scratch",
|
|
8
|
+
"extension",
|
|
9
|
+
"diagnostics",
|
|
10
|
+
"svg",
|
|
11
|
+
"overlay"
|
|
12
|
+
],
|
|
13
|
+
"author": "Hiroya Kubo <hiroya@cuc.ac.jp>",
|
|
14
|
+
"license": "MPL-2.0",
|
|
15
|
+
"type": "module",
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "git+https://github.com/kubohiroya/turbowarp-diagnostic-overlay.git"
|
|
19
|
+
},
|
|
20
|
+
"bugs": {
|
|
21
|
+
"url": "https://github.com/kubohiroya/turbowarp-diagnostic-overlay/issues"
|
|
22
|
+
},
|
|
23
|
+
"homepage": "https://github.com/kubohiroya/turbowarp-diagnostic-overlay#readme",
|
|
24
|
+
"files": [
|
|
25
|
+
"dist/",
|
|
26
|
+
"docs/",
|
|
27
|
+
"CHANGELOG.md",
|
|
28
|
+
"LICENSE",
|
|
29
|
+
"README.md"
|
|
30
|
+
],
|
|
31
|
+
"main": "./dist/lib/composition.js",
|
|
32
|
+
"types": "./dist/lib/composition.d.ts",
|
|
33
|
+
"exports": {
|
|
34
|
+
".": {
|
|
35
|
+
"types": "./dist/lib/composition.d.ts",
|
|
36
|
+
"import": "./dist/lib/composition.js"
|
|
37
|
+
},
|
|
38
|
+
"./composition": {
|
|
39
|
+
"types": "./dist/lib/composition.d.ts",
|
|
40
|
+
"import": "./dist/lib/composition.js"
|
|
41
|
+
},
|
|
42
|
+
"./diagnostic": {
|
|
43
|
+
"types": "./dist/lib/diagnostic.d.ts",
|
|
44
|
+
"import": "./dist/lib/diagnostic.js"
|
|
45
|
+
},
|
|
46
|
+
"./svg-renderer": {
|
|
47
|
+
"types": "./dist/lib/svg-renderer.d.ts",
|
|
48
|
+
"import": "./dist/lib/svg-renderer.js"
|
|
49
|
+
},
|
|
50
|
+
"./dist/diagnostic-overlay.js": "./dist/diagnostic-overlay.js",
|
|
51
|
+
"./package.json": "./package.json"
|
|
52
|
+
},
|
|
53
|
+
"unpkg": "./dist/diagnostic-overlay.js",
|
|
54
|
+
"jsdelivr": "./dist/diagnostic-overlay.js",
|
|
55
|
+
"publishConfig": {
|
|
56
|
+
"access": "public",
|
|
57
|
+
"registry": "https://registry.npmjs.org/"
|
|
58
|
+
},
|
|
59
|
+
"packageManager": "pnpm@11.11.0",
|
|
60
|
+
"engines": {
|
|
61
|
+
"node": ">=22.12.0"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"dev": "vite build --watch",
|
|
65
|
+
"typecheck": "tsc --noEmit",
|
|
66
|
+
"build": "vite build && tsc -p tsconfig.build.json",
|
|
67
|
+
"lint": "eslint src tests scripts vite.config.ts vitest.config.ts",
|
|
68
|
+
"test": "vitest run",
|
|
69
|
+
"test:coverage": "vitest run --coverage",
|
|
70
|
+
"audit": "pnpm audit --prod --audit-level high",
|
|
71
|
+
"docs": "node scripts/generate-readme.mjs",
|
|
72
|
+
"docs:check": "node scripts/generate-readme.mjs --check",
|
|
73
|
+
"check:dist": "pnpm run build && git diff --exit-code -- dist",
|
|
74
|
+
"pack:check": "npm pack --dry-run --ignore-scripts",
|
|
75
|
+
"release:check": "npm publish --dry-run --access public --ignore-scripts",
|
|
76
|
+
"check": "pnpm run audit && pnpm run typecheck && pnpm run lint && pnpm run test && pnpm run build && pnpm run docs:check && pnpm run check:dist && pnpm run pack:check",
|
|
77
|
+
"prepublishOnly": "pnpm run check"
|
|
78
|
+
},
|
|
79
|
+
"devDependencies": {
|
|
80
|
+
"@eslint/js": "^10.0.1",
|
|
81
|
+
"@kubohiroya/vite-plugin-turbowarp-extension": "0.1.1",
|
|
82
|
+
"@types/node": "^26.1.2",
|
|
83
|
+
"eslint": "^10.8.0",
|
|
84
|
+
"jsdom": "^30.0.1",
|
|
85
|
+
"typescript": "^5.9.3",
|
|
86
|
+
"typescript-eslint": "^8.65.0",
|
|
87
|
+
"vite": "^7.3.6",
|
|
88
|
+
"vitest": "^4.1.10"
|
|
89
|
+
}
|
|
90
|
+
}
|