@kubohiroya/turbowarp-diagnostic-overlay 0.1.0 → 0.2.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 CHANGED
@@ -2,6 +2,32 @@
2
2
 
3
3
  このプロジェクトの注目すべき変更を記録します。形式は[Keep a Changelog](https://keepachangelog.com/ja/1.1.0/)に基づき、[Semantic Versioning](https://semver.org/lang/ja/)に従います。
4
4
 
5
+ ## [0.2.0] - 2026-08-25
6
+
7
+ ### Changed
8
+
9
+ - ルート`LICENSE`をMozilla Public License 2.0正式全文へ更新
10
+ - repository policyと`repo:check`を追加し、license、README、bundle metadata、package archiveを検査
11
+ - README、Pages、CHANGELOGの公開version表記を`0.2.0`へ同期
12
+
13
+ ### Compatibility
14
+
15
+ - diagnostic validation、SVG生成、overlay lifecycle、Extension ID、opcodeは変更なし
16
+ - 利用側は`@kubohiroya/turbowarp-diagnostic-overlay@0.1.1`へ固定してロールバック可能
17
+
18
+ ## [0.1.1] - 2026-08-06
19
+
20
+ ### Added
21
+
22
+ - English/JapaneseのGitHub Pages利用ガイド
23
+ - ドキュメントの構造とローカルリンクを検証するsite check
24
+ - Pagesの自動deploy workflow
25
+
26
+ ### Compatibility
27
+
28
+ - runtime API、ブロック、配布JavaScriptの挙動は0.1.0から変更なし
29
+ - 利用側は`@kubohiroya/turbowarp-diagnostic-overlay@0.1.0`へ固定してロールバック可能
30
+
5
31
  ## [0.1.0] - 2026-08-03
6
32
 
7
33
  ### Added
@@ -12,4 +38,6 @@
12
38
  - 表示、JSON表示、消去、表示中判定、SVG生成、最後の診断JSONブロック
13
39
  - 副作用のない`composition`、`diagnostic`、`svg-renderer` package exports
14
40
 
41
+ [0.2.0]: https://github.com/kubohiroya/turbowarp-diagnostic-overlay/releases/tag/v0.2.0
42
+ [0.1.1]: https://github.com/kubohiroya/turbowarp-diagnostic-overlay/releases/tag/v0.1.1
15
43
  [0.1.0]: https://github.com/kubohiroya/turbowarp-diagnostic-overlay/releases/tag/v0.1.0
package/LICENSE CHANGED
@@ -1,4 +1,373 @@
1
1
  Mozilla Public License Version 2.0
2
+ ==================================
2
3
 
3
- This project is licensed under the Mozilla Public License, version 2.0.
4
- The full license text is available at https://www.mozilla.org/MPL/2.0/.
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.md CHANGED
@@ -1,39 +1,50 @@
1
- # TurboWarp Diagnostic Overlay
1
+ # TurboWarp-Diagnostic-Overlay
2
2
 
3
- 構造化された診断データを安全なSVGテキストへ変換し、TurboWarpステージ上に表示する汎用機能拡張です。紙芝居DSLなど特定のアプリケーションには依存しません。
3
+ An application-neutral TurboWarp extension that validates structured diagnostics, renders them as
4
+ safe SVG text, and displays them over the stage. It does not depend on a particular application or
5
+ DSL.
4
6
 
5
- ## 責務の境界
7
+ The [English guide](https://kubohiroya.github.io/turbowarp-diagnostic-overlay/) and
8
+ [Japanese guide](https://kubohiroya.github.io/turbowarp-diagnostic-overlay/ja/) cover installation,
9
+ the Composition API, safety, and lifecycle behavior.
6
10
 
7
- このパッケージが担当するのは、診断データの検証、SVG生成、表示、更新、消去です。診断の発見、プロジェクトやScratchスレッドの停止、ログの永続化は利用側が担当します。
11
+ ## Responsibility boundary
8
12
 
9
- 外部からSVGやHTMLを受け取らず、すべての入力文字列をXMLエスケープします。オーバーレイは`pointer-events: none`であり、ステージのマウス・タッチ入力を妨げません。
13
+ This package validates diagnostic data, generates SVG, and displays, updates, or clears the current
14
+ overlay. The caller discovers diagnostics, stops projects or Scratch threads when appropriate, and
15
+ persists logs.
10
16
 
11
- ## インストール
17
+ The renderer does not accept external SVG or HTML and XML-escapes every input string. The overlay
18
+ uses `pointer-events: none`, so it does not block mouse or touch input on the stage.
12
19
 
13
- TurboWarp Desktopで[`dist/diagnostic-overlay.js`](dist/diagnostic-overlay.js)をローカル機能拡張として読み込み、**サンドボックスなしで実行**を許可します。
20
+ ## Installation
14
21
 
15
- npmから利用する場合はバージョンを固定してください。
22
+ Load [`dist/diagnostic-overlay.js`](dist/diagnostic-overlay.js) as a local custom extension in
23
+ TurboWarp Desktop and allow it to **run without the sandbox**.
24
+
25
+ When installing from npm, pin the reviewed version:
16
26
 
17
27
  ```bash
18
- pnpm add --save-exact @kubohiroya/turbowarp-diagnostic-overlay@0.1.0
28
+ pnpm add --save-exact @kubohiroya/turbowarp-diagnostic-overlay@0.2.0
19
29
  ```
20
30
 
21
- CDN上の単独機能拡張は次のURLです。
31
+ The standalone extension is also available from this version-pinned CDN URL:
22
32
 
23
33
  ```text
24
- https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-diagnostic-overlay@0.1.0/dist/diagnostic-overlay.js
34
+ https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-diagnostic-overlay@0.2.0/dist/diagnostic-overlay.js
25
35
  ```
26
36
 
27
- ## 診断JSON
37
+ ## Diagnostic JSON
28
38
 
29
- 必須フィールドは`severity`、`code`、`message`です。`severity`は`info`、`warning`、`error`、`fatal`のいずれかです。
39
+ The required fields are `severity`, `code`, and `message`. The `severity` value must be `info`,
40
+ `warning`, `error`, or `fatal`.
30
41
 
31
42
  ```json
32
43
  {
33
44
  "severity": "error",
34
45
  "code": "DSL401",
35
- "message": "未定義のステージです",
36
- "detail": "stage2 は登録されていません。",
46
+ "message": "Stage is not defined",
47
+ "detail": "stage2 has not been registered.",
37
48
  "source": {
38
49
  "name": "story.kamishibai",
39
50
  "line": 18,
@@ -43,7 +54,8 @@ https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-diagnostic-overlay@0.1.0/dist
43
54
  }
44
55
  ```
45
56
 
46
- 行と列は1から始まる正の整数です。空の省略可能文字列は未指定として扱います。未知のフィールドは将来互換性のため無視します。
57
+ Line and column numbers are positive, one-based integers. Empty optional strings are treated as
58
+ omitted. Unknown fields are ignored for forward compatibility.
47
59
 
48
60
  ## Blocks
49
61
 
@@ -115,7 +127,8 @@ Returns the last displayed normalized diagnostic as JSON, or an empty string.
115
127
 
116
128
  ## Composition API
117
129
 
118
- パッケージのルートまたは`/composition`は、TurboWarpへの自動登録を行わない副作用のないES moduleです。
130
+ The package root and `/composition` are side-effect-free ES modules and do not register an extension
131
+ with TurboWarp automatically.
119
132
 
120
133
  ```ts
121
134
  import {
@@ -125,29 +138,31 @@ import {
125
138
 
126
139
  const {extension, controller} = createDiagnosticOverlayComposition(Scratch);
127
140
 
128
- // 集約側が一度だけ登録する。
141
+ // Register once at the composition root.
129
142
  Scratch.extensions.register(extension);
130
143
 
131
144
  controller.show({
132
145
  severity: 'error',
133
146
  code: 'APP001',
134
- message: '入力を確認してください。'
147
+ message: 'Check the input.'
135
148
  });
136
149
 
137
150
  const svg = renderDiagnosticSvg({
138
151
  severity: 'warning',
139
152
  code: 'APP002',
140
- message: 'この値は非推奨です。'
153
+ message: 'This value is deprecated.'
141
154
  });
142
155
  ```
143
156
 
144
- 純粋なrendererだけを利用する場合は`@kubohiroya/turbowarp-diagnostic-overlay/svg-renderer`からimportできます。
157
+ Import the pure renderer from `@kubohiroya/turbowarp-diagnostic-overlay/svg-renderer` when no
158
+ extension or overlay controller is needed.
145
159
 
146
- 詳しい契約は[`docs/specification.md`](docs/specification.md)を参照してください。
160
+ See the [English specification](docs/specification.md) or
161
+ [Japanese specification](docs/ja/specification.md) for the complete contract.
147
162
 
148
- ## 開発
163
+ ## Development
149
164
 
150
- Node.js 22.12以降とCorepackを使用します。
165
+ Use Node.js 22.12 or later with Corepack.
151
166
 
152
167
  ```bash
153
168
  corepack enable
@@ -156,8 +171,17 @@ pnpm run check
156
171
  pnpm run release:check
157
172
  ```
158
173
 
159
- `dist/diagnostic-overlay.js`はレビュー可能な単一ファイルとしてGitに含めます。ブロック定義を変更した場合は`pnpm run docs`でREADMEを更新します。
174
+ `dist/diagnostic-overlay.js` is committed as a single reviewable file. Run `pnpm run docs` after
175
+ changing block definitions to update this README.
176
+
177
+ ## Release
178
+
179
+ Keep the pinned version in `package.json`, this README, the public guides, and `CHANGELOG.md` in
180
+ sync in every release PR. After CI and the Pages deployment succeed on `main`, create a
181
+ `v<version>` tag on that merge commit. Pushing the tag creates the GitHub Release and standalone
182
+ extension artifact. Publish the same version to npm exactly once. Consumers can roll back by
183
+ pinning the preceding version.
160
184
 
161
- ## ライセンス
185
+ ## License
162
186
 
163
- MPL-2.0
187
+ SPDX-License-Identifier: MPL-2.0
package/docs/.nojekyll ADDED
@@ -0,0 +1 @@
1
+
@@ -0,0 +1,189 @@
1
+ :root {
2
+ color-scheme: light;
3
+ color: #172033;
4
+ background: #f4f7fb;
5
+ font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
6
+ line-height: 1.65;
7
+ }
8
+
9
+ * { box-sizing: border-box; }
10
+ html { scroll-behavior: smooth; scroll-padding-top: 5rem; }
11
+ body { margin: 0; overflow-x: clip; }
12
+ a { color: #2458a6; }
13
+ a:focus-visible { border-radius: .25rem; outline: 3px solid #73a7f2; outline-offset: 3px; }
14
+ code { font-family: ui-monospace, SFMono-Regular, Menlo, monospace; }
15
+
16
+ .skip-link {
17
+ position: absolute;
18
+ top: -5rem;
19
+ left: 1rem;
20
+ z-index: 30;
21
+ padding: .65rem .9rem;
22
+ border-radius: .5rem;
23
+ color: #172033;
24
+ background: #fff;
25
+ }
26
+
27
+ .skip-link:focus { top: .5rem; }
28
+
29
+ .app-bar {
30
+ position: sticky;
31
+ top: 0;
32
+ z-index: 20;
33
+ border-bottom: 1px solid rgba(220, 227, 238, .55);
34
+ color: #fff;
35
+ background: rgba(17, 26, 44, .92);
36
+ -webkit-backdrop-filter: blur(16px);
37
+ backdrop-filter: blur(16px);
38
+ }
39
+
40
+ .app-bar-inner,
41
+ main,
42
+ footer {
43
+ width: min(72rem, calc(100% - 2rem));
44
+ margin: 0 auto;
45
+ }
46
+
47
+ .app-bar-inner {
48
+ display: grid;
49
+ grid-template-columns: auto minmax(0, 1fr) auto;
50
+ min-height: 4.25rem;
51
+ align-items: center;
52
+ gap: 1rem;
53
+ }
54
+
55
+ .app-bar-brand {
56
+ display: inline-flex;
57
+ align-items: center;
58
+ gap: .65rem;
59
+ min-width: 0;
60
+ color: #fff;
61
+ font-weight: 800;
62
+ text-decoration: none;
63
+ white-space: nowrap;
64
+ }
65
+
66
+ .app-bar-mark {
67
+ display: grid;
68
+ width: 2rem;
69
+ height: 2rem;
70
+ flex: none;
71
+ place-items: center;
72
+ border-radius: .6rem;
73
+ color: #111a2c;
74
+ background: #9fc3f7;
75
+ box-shadow: 0 7px 18px rgba(0, 0, 0, .24);
76
+ }
77
+
78
+ .app-bar-sections {
79
+ display: flex;
80
+ align-items: center;
81
+ justify-content: center;
82
+ gap: 1rem;
83
+ min-width: 0;
84
+ overflow: hidden;
85
+ font-size: .92rem;
86
+ }
87
+
88
+ .app-bar-sections a {
89
+ color: #d8e5f7;
90
+ text-decoration: none;
91
+ white-space: nowrap;
92
+ }
93
+
94
+ .app-bar-sections a:hover { color: #fff; }
95
+
96
+ .app-bar-actions {
97
+ display: flex;
98
+ align-items: center;
99
+ justify-content: flex-end;
100
+ gap: .5rem;
101
+ min-width: 0;
102
+ }
103
+
104
+ .app-bar-github {
105
+ padding: .38rem .58rem;
106
+ border-radius: .65rem;
107
+ color: #d8e5f7;
108
+ font-size: .82rem;
109
+ font-weight: 750;
110
+ text-decoration: none;
111
+ white-space: nowrap;
112
+ }
113
+
114
+ .app-bar-github:hover { color: #fff; background: rgba(255, 255, 255, .1); }
115
+
116
+ .app-bar-languages {
117
+ display: inline-flex;
118
+ padding: .2rem;
119
+ border: 1px solid rgba(216, 229, 247, .45);
120
+ border-radius: 99rem;
121
+ background: rgba(255, 255, 255, .08);
122
+ }
123
+
124
+ .app-bar-languages a {
125
+ padding: .26rem .6rem;
126
+ border-radius: 99rem;
127
+ color: #d8e5f7;
128
+ font-size: .82rem;
129
+ font-weight: 700;
130
+ text-decoration: none;
131
+ }
132
+
133
+ .app-bar-languages a:hover,
134
+ .app-bar-languages a[aria-current="page"] { color: #111a2c; background: #d8e5f7; }
135
+
136
+ .hero { padding: 5rem 0 3rem; }
137
+ .eyebrow { color: #2e65b0; font-weight: 700; letter-spacing: .08em; text-transform: uppercase; }
138
+ h1 { max-width: 18ch; margin: .3rem 0 1.2rem; font-size: clamp(2.3rem, 7vw, 4.8rem); line-height: 1.04; }
139
+ .lead { max-width: 48rem; color: #46536a; font-size: 1.2rem; }
140
+
141
+ .grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(16rem, 1fr)); gap: 1rem; }
142
+ .card, .section {
143
+ border: 1px solid #dce3ee;
144
+ border-radius: 1rem;
145
+ background: #fff;
146
+ box-shadow: 0 .6rem 1.8rem rgba(28, 43, 69, .07);
147
+ }
148
+ .card { padding: 1.4rem; }
149
+ .section { margin: 1.2rem 0; padding: clamp(1.3rem, 4vw, 2.4rem); }
150
+ .section h2, .card h2, .card h3 { margin-top: 0; }
151
+
152
+ pre {
153
+ overflow-x: auto;
154
+ padding: 1rem;
155
+ border-radius: .7rem;
156
+ color: #e7eefc;
157
+ background: #172033;
158
+ }
159
+
160
+ .badge { display: inline-block; padding: .2rem .6rem; border-radius: 999px; color: #234f8d; background: #e5eefc; font-weight: 700; }
161
+ footer { padding: 2rem 0 3rem; color: #5a6679; }
162
+
163
+ @media (max-width: 56rem) {
164
+ .app-bar-sections { display: none; }
165
+ }
166
+
167
+ @media (max-width: 40rem) {
168
+ .app-bar-inner,
169
+ main,
170
+ footer {
171
+ width: min(100% - 1.2rem, 72rem);
172
+ }
173
+
174
+ .app-bar-inner {
175
+ grid-template-columns: auto minmax(0, 1fr);
176
+ gap: .5rem;
177
+ }
178
+
179
+ .app-bar-label { display: none; }
180
+
181
+ .app-bar-actions { grid-column: 2; }
182
+
183
+ .app-bar-languages a {
184
+ padding-inline: .5rem;
185
+ font-size: .78rem;
186
+ }
187
+
188
+ .hero { padding-top: 3rem; }
189
+ }
@@ -0,0 +1,76 @@
1
+ <!doctype html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <meta name="description" content="Guide for rendering structured diagnostics as safe SVG overlays in TurboWarp.">
7
+ <title>Diagnostic Overlay — Guide</title>
8
+ <link rel="canonical" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/">
9
+ <link rel="alternate" hreflang="en" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/">
10
+ <link rel="alternate" hreflang="ja" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/ja/">
11
+ <link rel="alternate" hreflang="x-default" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/">
12
+ <link rel="stylesheet" href="./assets/site.css">
13
+ </head>
14
+ <body>
15
+ <a class="skip-link" href="#main">Skip to the guide</a>
16
+ <header class="app-bar">
17
+ <div class="app-bar-inner">
18
+ <a class="app-bar-brand" href="./" aria-label="Diagnostic Overlay guide home">
19
+ <span class="app-bar-mark" aria-hidden="true">D</span>
20
+ <span class="app-bar-label">Diagnostic Overlay</span>
21
+ </a>
22
+ <nav class="app-bar-sections" aria-label="Guide sections">
23
+ <a href="#overview">Overview</a>
24
+ <a href="#install">Installation</a>
25
+ <a href="#composition">Composition API</a>
26
+ <a href="#lifecycle">Lifecycle</a>
27
+ </nav>
28
+ <div class="app-bar-actions">
29
+ <a class="app-bar-github" href="https://github.com/kubohiroya/turbowarp-diagnostic-overlay" aria-label="Source code and releases on GitHub">GitHub</a>
30
+ <nav class="app-bar-languages" aria-label="Language">
31
+ <a href="./" hreflang="en" lang="en" aria-current="page">English</a>
32
+ <a href="./ja/" hreflang="ja" lang="ja">日本語</a>
33
+ </nav>
34
+ </div>
35
+ </div>
36
+ </header>
37
+ <main id="main">
38
+ <section class="hero">
39
+ <p class="eyebrow">TurboWarp extension · v0.2.0</p>
40
+ <h1>Diagnostics people can read safely.</h1>
41
+ <p class="lead">Validate one structured diagnostic, render escaped SVG, and keep a non-interactive overlay aligned with the TurboWarp stage.</p>
42
+ </section>
43
+
44
+ <section class="grid" id="overview" aria-label="Responsibilities">
45
+ <article class="card"><span class="badge">Validate</span><h2>Strict input</h2><p>Severity, code, message, optional detail, and source location are normalized before rendering.</p></article>
46
+ <article class="card"><span class="badge">Render</span><h2>Safe SVG text</h2><p>Untrusted strings are XML-escaped and never become element names, attributes, colors, or URLs.</p></article>
47
+ <article class="card"><span class="badge">Display</span><h2>Stage-aligned overlay</h2><p>The host follows renderer canvas size changes and uses <code>pointer-events: none</code>.</p></article>
48
+ </section>
49
+
50
+ <section class="section" id="install">
51
+ <h2>Install the reviewed build</h2>
52
+ <pre><code>pnpm add --save-exact @kubohiroya/turbowarp-diagnostic-overlay@0.2.0</code></pre>
53
+ <p>For the standalone extension, load this pinned URL without sandboxing:</p>
54
+ <pre><code>https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-diagnostic-overlay@0.2.0/dist/diagnostic-overlay.js</code></pre>
55
+ </section>
56
+
57
+ <section class="section" id="composition">
58
+ <h2>Composition API</h2>
59
+ <p>Importing the package does not register a TurboWarp extension. The composition root explicitly creates the extension and controller, then registers it once.</p>
60
+ <pre><code>import {createDiagnosticOverlayComposition} from
61
+ '@kubohiroya/turbowarp-diagnostic-overlay/composition';
62
+
63
+ const {extension, controller} = createDiagnosticOverlayComposition(Scratch);
64
+ Scratch.extensions.register(extension);
65
+ controller.show({severity: 'error', code: 'APP001', message: 'Check the input.'});</code></pre>
66
+ <p>The pure renderer is also available from <code>/svg-renderer</code>. See the <a href="./specification.md">complete 0.1 contract</a>, also available <a href="./ja/specification.md" hreflang="ja" lang="ja">in Japanese</a>.</p>
67
+ </section>
68
+
69
+ <section class="grid" id="lifecycle" aria-label="Lifecycle and boundaries">
70
+ <article class="card"><h2>Lifecycle</h2><p>A new diagnostic replaces the current one. Project load clears it. Runtime disposal releases DOM observers and listeners. Project stop intentionally leaves it visible.</p></article>
71
+ <article class="card"><h2>Caller responsibilities</h2><p>The caller discovers diagnostics, decides whether to stop Scratch threads or the VM, and owns persistence. This package does not know any application-specific DSL.</p></article>
72
+ </section>
73
+ </main>
74
+ <footer>TurboWarp-Diagnostic-Overlay · MPL-2.0 · <a href="https://github.com/kubohiroya/turbowarp-diagnostic-overlay/releases/tag/v0.2.0">Release v0.2.0</a></footer>
75
+ </body>
76
+ </html>
@@ -0,0 +1,76 @@
1
+ <!doctype html>
2
+ <html lang="ja">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <meta name="description" content="構造化診断を安全なSVGに変換してTurboWarpステージへ表示するDiagnostic Overlayの利用ガイド。">
7
+ <title>Diagnostic Overlay — 利用ガイド</title>
8
+ <link rel="canonical" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/ja/">
9
+ <link rel="alternate" hreflang="en" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/">
10
+ <link rel="alternate" hreflang="ja" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/ja/">
11
+ <link rel="alternate" hreflang="x-default" href="https://kubohiroya.github.io/turbowarp-diagnostic-overlay/">
12
+ <link rel="stylesheet" href="../assets/site.css">
13
+ </head>
14
+ <body>
15
+ <a class="skip-link" href="#main">ガイド本文へ移動</a>
16
+ <header class="app-bar">
17
+ <div class="app-bar-inner">
18
+ <a class="app-bar-brand" href="./" aria-label="Diagnostic Overlayガイドの先頭">
19
+ <span class="app-bar-mark" aria-hidden="true">D</span>
20
+ <span class="app-bar-label">Diagnostic Overlay</span>
21
+ </a>
22
+ <nav class="app-bar-sections" aria-label="ガイドのセクション">
23
+ <a href="#overview">概要</a>
24
+ <a href="#install">インストール</a>
25
+ <a href="#composition">Composition API</a>
26
+ <a href="#lifecycle">ライフサイクル</a>
27
+ </nav>
28
+ <div class="app-bar-actions">
29
+ <a class="app-bar-github" href="https://github.com/kubohiroya/turbowarp-diagnostic-overlay" aria-label="GitHubでソースコードとリリースを見る">GitHub</a>
30
+ <nav class="app-bar-languages" aria-label="言語">
31
+ <a href="../" hreflang="en" lang="en">English</a>
32
+ <a href="./" hreflang="ja" lang="ja" aria-current="page">日本語</a>
33
+ </nav>
34
+ </div>
35
+ </div>
36
+ </header>
37
+ <main id="main">
38
+ <section class="hero">
39
+ <p class="eyebrow">TurboWarp拡張機能 · v0.2.0</p>
40
+ <h1>診断を、安全に、読みやすく。</h1>
41
+ <p class="lead">1件の構造化診断を検証してXMLエスケープ済みSVGへ変換し、TurboWarpステージに追従する非操作型overlayとして表示します。</p>
42
+ </section>
43
+
44
+ <section class="grid" id="overview" aria-label="主な責務">
45
+ <article class="card"><span class="badge">検証</span><h2>厳密な入力</h2><p>severity、code、messageと任意のdetail・source位置を表示前に正規化します。</p></article>
46
+ <article class="card"><span class="badge">描画</span><h2>安全なSVG text</h2><p>外部文字列をXMLエスケープし、要素名、属性、色、URLとしては使用しません。</p></article>
47
+ <article class="card"><span class="badge">表示</span><h2>ステージへ追従</h2><p>renderer canvasのサイズ変更を追跡し、<code>pointer-events: none</code>で入力を妨げません。</p></article>
48
+ </section>
49
+
50
+ <section class="section" id="install">
51
+ <h2>レビュー済みビルドを導入</h2>
52
+ <pre><code>pnpm add --save-exact @kubohiroya/turbowarp-diagnostic-overlay@0.2.0</code></pre>
53
+ <p>単独機能拡張は、次の固定URLをサンドボックスなしで読み込みます。</p>
54
+ <pre><code>https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-diagnostic-overlay@0.2.0/dist/diagnostic-overlay.js</code></pre>
55
+ </section>
56
+
57
+ <section class="section" id="composition">
58
+ <h2>Composition API</h2>
59
+ <p>packageをimportしただけではTurboWarpへ登録しません。composition rootがextensionとcontrollerを明示的に作成し、1度だけ登録します。</p>
60
+ <pre><code>import {createDiagnosticOverlayComposition} from
61
+ '@kubohiroya/turbowarp-diagnostic-overlay/composition';
62
+
63
+ const {extension, controller} = createDiagnosticOverlayComposition(Scratch);
64
+ Scratch.extensions.register(extension);
65
+ controller.show({severity: 'error', code: 'APP001', message: '入力を確認してください。'});</code></pre>
66
+ <p>純粋rendererは<code>/svg-renderer</code>から利用できます。詳細は<a href="./specification.md">0.1仕様</a>を参照してください。<a href="../specification.md" hreflang="en" lang="en">英語版</a>もあります。</p>
67
+ </section>
68
+
69
+ <section class="grid" id="lifecycle" aria-label="ライフサイクルと責務境界">
70
+ <article class="card"><h2>ライフサイクル</h2><p>新しい診断は現在の表示を置換します。プロジェクト読込時に消去し、runtime dispose時にDOM observerとlistenerを解放します。project stop後は原因を読めるよう表示を残します。</p></article>
71
+ <article class="card"><h2>利用側の責務</h2><p>診断の発見、Scratch threadやVMを止める判断、永続化は利用側が行います。このpackageはアプリ固有DSLを知りません。</p></article>
72
+ </section>
73
+ </main>
74
+ <footer>TurboWarp-Diagnostic-Overlay · MPL-2.0 · <a href="https://github.com/kubohiroya/turbowarp-diagnostic-overlay/releases/tag/v0.2.0">Release v0.2.0</a></footer>
75
+ </body>
76
+ </html>
@@ -0,0 +1,69 @@
1
+ # Diagnostic Overlay 0.1 仕様
2
+
3
+ [English](../specification.md) | [日本語](./specification.md)
4
+
5
+ ## 1. 目的
6
+
7
+ Diagnostic Overlayは、アプリケーションから受け取った一件の構造化診断をTurboWarpステージ上に表示するpresentation componentである。診断を発見せず、実行を停止せず、紙芝居固有の型やコマンドを知らない。
8
+
9
+ ## 2. 診断モデル
10
+
11
+ ```ts
12
+ type DiagnosticSeverity = 'info' | 'warning' | 'error' | 'fatal';
13
+
14
+ interface DiagnosticSource {
15
+ name?: string;
16
+ line?: number;
17
+ column?: number;
18
+ excerpt?: string;
19
+ }
20
+
21
+ interface Diagnostic {
22
+ severity: DiagnosticSeverity;
23
+ code: string;
24
+ message: string;
25
+ detail?: string;
26
+ source?: DiagnosticSource;
27
+ }
28
+ ```
29
+
30
+ `code`と`message`は空にできない。`line`と`column`は1から始まる安全な整数である。JSON入力には65,536文字の上限を設け、各文字列にも個別の上限を設ける。
31
+
32
+ ## 3. SVG renderer
33
+
34
+ `renderDiagnosticSvg`は同じ入力とoptionsに対して同じSVG文字列を返す純粋関数である。Scratch、DOM、TurboWarp VMを参照しない。
35
+
36
+ - SVGの`text`と`tspan`のみで文字を描画する。
37
+ - `foreignObject`を使用しない。
38
+ - 入力由来の文字列を要素名、属性名、色、URLとして使用しない。
39
+ - `& < > " '`をXML entityへ変換し、XML 1.0で無効な制御文字や不正なサロゲートを`U+FFFD`へ置換する。
40
+ - 日本語など空白を含まない文字列も折り返す。
41
+ - 表示可能行数を超えた場合は末尾を`…`にする。
42
+
43
+ ## 4. Overlay host
44
+
45
+ `BrowserStageOverlayHost`はrenderer canvasと同じ位置・大きさのDOM要素をcanvasの親要素に追加する。表示要素は`pointer-events: none`である。canvasのサイズ変更を`ResizeObserver`とwindowの`resize`イベントで追従する。
46
+
47
+ 親要素がstatic positioningの場合だけ一時的に`position: relative`を設定し、dispose時に自分が行った変更を復元する。disposeは複数回呼び出せる。
48
+
49
+ ## 5. ライフサイクル
50
+
51
+ - 新しい診断を表示すると現在の表示を置換する。
52
+ - `clear`は表示と最後の診断を消去する。
53
+ - `PROJECT_LOADED`では古いプロジェクトの表示を消去する。
54
+ - `RUNTIME_DISPOSED`ではDOM、observer、event listenerを解放する。
55
+ - `PROJECT_STOP_ALL`では表示を消去しない。停止原因となった診断を利用者が読めるようにするためである。
56
+
57
+ ## 6. Composition
58
+
59
+ `@kubohiroya/turbowarp-diagnostic-overlay/composition`のimportにはTurboWarp登録などの副作用がない。`createDiagnosticOverlayComposition(scratch, options)`を呼び出したときだけhost、controller、extensionを生成する。
60
+
61
+ 利用側は返された`extension`を自身のcomposition rootで登録できる。また`host`を差し替えることでDOM以外の表示先を利用できる。
62
+
63
+ ## 7. 非責務
64
+
65
+ - DSL、アセット、式などの検証
66
+ - 複数診断のキューや履歴
67
+ - Scratch thread、VM、プロジェクトの停止
68
+ - 診断の自動表示
69
+ - ログの永続化や外部送信
@@ -1,10 +1,14 @@
1
- # Diagnostic Overlay 0.1 仕様
1
+ # Diagnostic Overlay 0.1 Specification
2
2
 
3
- ## 1. 目的
3
+ [English](./specification.md) | [日本語](./ja/specification.md)
4
4
 
5
- Diagnostic Overlayは、アプリケーションから受け取った一件の構造化診断をTurboWarpステージ上に表示するpresentation componentである。診断を発見せず、実行を停止せず、紙芝居固有の型やコマンドを知らない。
5
+ ## 1. Purpose
6
6
 
7
- ## 2. 診断モデル
7
+ Diagnostic Overlay is a presentation component that displays one structured diagnostic supplied by
8
+ an application over the TurboWarp stage. It does not discover diagnostics, stop execution, or know
9
+ about application-specific types or commands such as the Kamishibai DSL.
10
+
11
+ ## 2. Diagnostic model
8
12
 
9
13
  ```ts
10
14
  type DiagnosticSeverity = 'info' | 'warning' | 'error' | 'fatal';
@@ -25,43 +29,53 @@ interface Diagnostic {
25
29
  }
26
30
  ```
27
31
 
28
- `code`と`message`は空にできない。`line`と`column`は1から始まる安全な整数である。JSON入力には65,536文字の上限を設け、各文字列にも個別の上限を設ける。
32
+ `code` and `message` cannot be empty. `line` and `column` are positive, one-based safe integers.
33
+ JSON input is limited to 65,536 characters, and each string has its own limit.
29
34
 
30
35
  ## 3. SVG renderer
31
36
 
32
- `renderDiagnosticSvg`は同じ入力とoptionsに対して同じSVG文字列を返す純粋関数である。Scratch、DOM、TurboWarp VMを参照しない。
37
+ `renderDiagnosticSvg` is a pure function that returns the same SVG string for the same input and
38
+ options. It does not access Scratch, the DOM, or the TurboWarp VM.
33
39
 
34
- - SVGの`text`と`tspan`のみで文字を描画する。
35
- - `foreignObject`を使用しない。
36
- - 入力由来の文字列を要素名、属性名、色、URLとして使用しない。
37
- - `& < > " '`をXML entityへ変換し、XML 1.0で無効な制御文字や不正なサロゲートを`U+FFFD`へ置換する。
38
- - 日本語など空白を含まない文字列も折り返す。
39
- - 表示可能行数を超えた場合は末尾を`…`にする。
40
+ - It draws text using only SVG `text` and `tspan` elements.
41
+ - It does not use `foreignObject`.
42
+ - It does not use input-derived strings as element names, attribute names, colors, or URLs.
43
+ - It converts `& < > " '` to XML entities and replaces XML 1.0-invalid control characters or
44
+ malformed surrogates with `U+FFFD`.
45
+ - It wraps Japanese and other strings that do not contain spaces.
46
+ - It ends text with `…` when the content exceeds the number of displayable lines.
40
47
 
41
48
  ## 4. Overlay host
42
49
 
43
- `BrowserStageOverlayHost`はrenderer canvasと同じ位置・大きさのDOM要素をcanvasの親要素に追加する。表示要素は`pointer-events: none`である。canvasのサイズ変更を`ResizeObserver`とwindowの`resize`イベントで追従する。
50
+ `BrowserStageOverlayHost` adds a DOM element with the same position and dimensions as the renderer
51
+ canvas to that canvas's parent element. The display element uses `pointer-events: none`. It follows
52
+ canvas size changes through `ResizeObserver` and the window `resize` event.
44
53
 
45
- 親要素がstatic positioningの場合だけ一時的に`position: relative`を設定し、dispose時に自分が行った変更を復元する。disposeは複数回呼び出せる。
54
+ The host temporarily sets `position: relative` only when the parent uses static positioning, and
55
+ restores only its own change during disposal. Disposal is idempotent.
46
56
 
47
- ## 5. ライフサイクル
57
+ ## 5. Lifecycle
48
58
 
49
- - 新しい診断を表示すると現在の表示を置換する。
50
- - `clear`は表示と最後の診断を消去する。
51
- - `PROJECT_LOADED`では古いプロジェクトの表示を消去する。
52
- - `RUNTIME_DISPOSED`ではDOM、observer、event listenerを解放する。
53
- - `PROJECT_STOP_ALL`では表示を消去しない。停止原因となった診断を利用者が読めるようにするためである。
59
+ - Showing a new diagnostic replaces the current display.
60
+ - `clear` removes the display and the last diagnostic.
61
+ - `PROJECT_LOADED` clears the preceding project's display.
62
+ - `RUNTIME_DISPOSED` releases the DOM, observer, and event listener.
63
+ - `PROJECT_STOP_ALL` does not clear the display, so the user can still read a diagnostic that caused
64
+ execution to stop.
54
65
 
55
66
  ## 6. Composition
56
67
 
57
- `@kubohiroya/turbowarp-diagnostic-overlay/composition`のimportにはTurboWarp登録などの副作用がない。`createDiagnosticOverlayComposition(scratch, options)`を呼び出したときだけhost、controller、extensionを生成する。
68
+ Importing `@kubohiroya/turbowarp-diagnostic-overlay/composition` has no side effects such as
69
+ TurboWarp registration. The host, controller, and extension are created only when
70
+ `createDiagnosticOverlayComposition(scratch, options)` is called.
58
71
 
59
- 利用側は返された`extension`を自身のcomposition rootで登録できる。また`host`を差し替えることでDOM以外の表示先を利用できる。
72
+ The caller can register the returned `extension` at its own composition root. It can also replace
73
+ the `host` to render somewhere other than the DOM.
60
74
 
61
- ## 7. 非責務
75
+ ## 7. Non-responsibilities
62
76
 
63
- - DSL、アセット、式などの検証
64
- - 複数診断のキューや履歴
65
- - Scratch thread、VM、プロジェクトの停止
66
- - 診断の自動表示
67
- - ログの永続化や外部送信
77
+ - Validating DSLs, assets, expressions, or other application data
78
+ - Maintaining a queue or history of multiple diagnostics
79
+ - Stopping Scratch threads, the VM, or the project
80
+ - Displaying diagnostics automatically
81
+ - Persisting or transmitting logs
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubohiroya/turbowarp-diagnostic-overlay",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "Render structured diagnostics as safe SVG overlays on the TurboWarp stage.",
5
5
  "keywords": [
6
6
  "turbowarp",
@@ -20,7 +20,7 @@
20
20
  "bugs": {
21
21
  "url": "https://github.com/kubohiroya/turbowarp-diagnostic-overlay/issues"
22
22
  },
23
- "homepage": "https://github.com/kubohiroya/turbowarp-diagnostic-overlay#readme",
23
+ "homepage": "https://kubohiroya.github.io/turbowarp-diagnostic-overlay/",
24
24
  "files": [
25
25
  "dist/",
26
26
  "docs/",
@@ -70,10 +70,12 @@
70
70
  "audit": "pnpm audit --prod --audit-level high",
71
71
  "docs": "node scripts/generate-readme.mjs",
72
72
  "docs:check": "node scripts/generate-readme.mjs --check",
73
+ "site:check": "node scripts/check-site.mjs",
73
74
  "check:dist": "pnpm run build && git diff --exit-code -- dist",
74
75
  "pack:check": "npm pack --dry-run --ignore-scripts",
75
76
  "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
+ "repo:check": "node scripts/check-repo.mjs",
78
+ "check": "pnpm run audit && pnpm run typecheck && pnpm run lint && pnpm run test && pnpm run build && pnpm run docs:check && pnpm run site:check && pnpm run check:dist && pnpm run repo:check && pnpm run pack:check",
77
79
  "prepublishOnly": "pnpm run check"
78
80
  },
79
81
  "devDependencies": {