@kubohiroya/turbowarp-plus-editor-workbench 0.0.0-stage → 0.3.1

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.
Files changed (61) hide show
  1. package/LICENSE +373 -0
  2. package/README.ja.md +72 -0
  3. package/README.md +69 -2
  4. package/dist/debugger-panel.d.ts +22 -0
  5. package/dist/debugger-panel.js +110 -0
  6. package/dist/dockview-stage.d.ts +20 -0
  7. package/dist/dockview-stage.js +45 -0
  8. package/dist/dockview-styles.d.ts +1 -0
  9. package/dist/dockview-styles.js +1 -0
  10. package/dist/document-workspace.d.ts +27 -0
  11. package/dist/document-workspace.js +46 -0
  12. package/dist/extension-file-menu.d.ts +31 -0
  13. package/dist/extension-file-menu.js +56 -0
  14. package/dist/index.d.ts +46 -0
  15. package/dist/index.js +166 -0
  16. package/dist/monitor-drag.d.ts +4 -0
  17. package/dist/monitor-drag.js +78 -0
  18. package/dist/project-messages.d.ts +1 -0
  19. package/dist/project-messages.js +3 -0
  20. package/dist/sprite-layout-menu.d.ts +16 -0
  21. package/dist/sprite-layout-menu.js +134 -0
  22. package/dist/sprite-tabs.d.ts +209 -0
  23. package/dist/sprite-tabs.js +1163 -0
  24. package/dist/stage-input.d.ts +24 -0
  25. package/dist/stage-input.js +50 -0
  26. package/dist/stage-launcher.d.ts +44 -0
  27. package/dist/stage-launcher.js +103 -0
  28. package/dist/stage-surface.d.ts +40 -0
  29. package/dist/stage-surface.js +128 -0
  30. package/dist/standard-layout.d.ts +67 -0
  31. package/dist/standard-layout.js +324 -0
  32. package/dist/targets.d.ts +25 -0
  33. package/dist/targets.js +87 -0
  34. package/dist/workspace-layout.d.ts +59 -0
  35. package/dist/workspace-layout.js +215 -0
  36. package/dist/workspace-zoom.d.ts +39 -0
  37. package/dist/workspace-zoom.js +68 -0
  38. package/package.json +76 -4
  39. package/src/debugger-panel.css +131 -0
  40. package/src/debugger-panel.ts +124 -0
  41. package/src/dockview-css.d.ts +1 -0
  42. package/src/dockview-stage.ts +53 -0
  43. package/src/dockview-styles.ts +1 -0
  44. package/src/document-workspace.ts +61 -0
  45. package/src/editor.css +945 -0
  46. package/src/extension-file-menu.ts +71 -0
  47. package/src/index.ts +177 -0
  48. package/src/monitor-drag.ts +80 -0
  49. package/src/project-messages.ts +3 -0
  50. package/src/sprite-layout-menu.css +58 -0
  51. package/src/sprite-layout-menu.ts +142 -0
  52. package/src/sprite-tabs.ts +1279 -0
  53. package/src/stage-input.ts +59 -0
  54. package/src/stage-launcher.ts +146 -0
  55. package/src/stage-surface.ts +168 -0
  56. package/src/standard-layout.ts +358 -0
  57. package/src/targets.css +132 -0
  58. package/src/targets.ts +95 -0
  59. package/src/workspace-layout.ts +214 -0
  60. package/src/workspace-zoom.ts +92 -0
  61. package/tsconfig.json +23 -0
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
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 https://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.ja.md ADDED
@@ -0,0 +1,72 @@
1
+ # TurboWarp Plus Editor Workbench
2
+
3
+ TurboWarp Plus Editor の作業画面。分割レイアウト、Plus 標準配置、Dockview のスプライトタブとワークスペース、ステージ、デバッガーのタブ、ファイルメニューを担う。スプライトタブの中のペインは `@kubohiroya/turbowarp-plus-editor-sprite-panes`、ページ内の窓は `@kubohiroya/turbowarp-plus-editor-windows`、作品データの読み取りは `@kubohiroya/turbowarp-plus-editor-project-model` から使う。
4
+
5
+ このパッケージは 0.3.0 まで `@kubohiroya/turbowarp-plus-editor-layout` として公開していた。
6
+
7
+ ## 分割レイアウト
8
+
9
+ 同じ document 内で「編集領域/ステージ列」と「ステージ/対象領域」の境界を調整する。ホストは `createLayout(React)` に既存の React を渡し、`render` に渡される境界・スタイル・表示サイズを既存コンポーネントに接続する。ホストがストレージとキーを指定し、このパッケージが設定を保存・復元する。
10
+
11
+ 境界はドラッグ、矢印キー、Home/End で移動できる。Enter またはダブルクリックで、その境界を既定の位置に戻す。
12
+
13
+ ## Editor での配分
14
+
15
+ | 境界 | 最小サイズ |
16
+ | --- | --- |
17
+ | 編集領域/ステージ列 | 編集領域 500 px、ステージ列 350 px |
18
+ | ステージ/対象領域 | ステージ 135 px、対象領域 175 px |
19
+
20
+ 境界の幅は 8 px。分割比率は各領域の最小サイズまでに制限する。最小サイズを両立できない表示領域では通常配分に戻し、表示領域を広げると保存した比率で分割を再開する。プロパティと一覧はスプライト選択ペイン内にまとまっており、バックパックは開閉式のトレイなので、この段階では既存の操作で扱う。メニューバーは分割領域の外にある。
21
+
22
+ Scratch 配置では分割を既定で有効にする。既存のステージサイズボタンを押すと、指定したプリセットで配分を初期化する。設定は作品や SB3 と別に保存する。分割だけを無効にする場合は Web の起動 URL に `twPlusSplitter=0` を指定するか、Desktop を `TW_PLUS_DESKTOP_SPLITTER=0` で起動する。
23
+
24
+ ## Plus 標準配置
25
+
26
+ `createStandardLayout(React, {styles, targetStyles, context})` は、⚓️ での配置切り替え、ステージの表示と計測、スプライト一覧の2列配置を担当する。`editor.css` と `targets.css` をクラス名マップとして渡す。ホストは起動設定、ストレージ、ウィンドウ操作部品、パレット表示のコールバックと描画先を渡す。配置メニューの描画を差し替える場合は、任意の `LayoutMenu` コンポーネントをファクトリーに渡す。ステージを隠しても同じ描画先を使う。
27
+
28
+ 試験用ホストの `/example/?standard=1` で Plus と Scratch の往復を確認できる。`standard=0` は起動時の切り戻しを再現する。
29
+
30
+ Editor はこのパッケージを npm から固定して使う。
31
+
32
+ ## 検証
33
+
34
+ `npm test` で配分・縦横比・設定の読み書きを、`npm run test:browser` で独立した試験用ホストを検証する。試験用ホストを手動で開くには、このディレクトリで `npm install` と `python3 -m http.server` を実行し、`/example/` を表示する。
35
+
36
+ Editor のルートから、`site/source.json` の GUI を `npm run build:pages` でビルドし、`E2E_GUI_ROOT=/absolute/gui-checkout E2E_PATH_PREFIX=/turbowarp-plus-editor/ node --test test/editor-layout.browser.ts` を実行する。同じ GUI をホスト接続なしでビルドしたディレクトリを `E2E_LAYOUT_BARE_BUILD` に渡すと、GUI 単体の動作も検証する。
37
+ ## 別窓ステージ
38
+
39
+ `attachStageInput` は、ホストから渡された別ウィンドウの document とキャンバスを使って、入力の購読と解放を管理する。ポインター処理とドラッグ状態の解除はホストのコールバックを使用する。
40
+
41
+ スプライト編集タブの中のペイン(素材と変数、メッセージ、設定フォーム、セクション切り替えのツールバー)は `@kubohiroya/turbowarp-plus-editor-sprite-panes` に移った。このパッケージはそれらをタブや分割に並べる。以前の配布アーカイブのソース `b0390c3` から移設したウィンドウ部品は、`@kubohiroya/turbowarp-plus-editor-windows` に移った。Scratch GUI の本家実装はこのパッケージに取り込んでいないため、GPL のコードを含まず、GPL のモジュールも import しない。ライセンスは MPL-2.0 とする。MPL-2.0 は GPL を二次ライセンスとして認めるので、GPL-3.0 の Editor に組み込んで配信できる。ソースに「Incompatible With Secondary Licenses」の表示は付けない。付けると Editor に組み込めなくなる。
42
+
43
+ ## デバッガーのタブ
44
+
45
+ `attachDebuggerPanel(debugger, {document, vm})` は、デバッガーアドオンのウィンドウを Dockview のタブとして開く。ホストはアドオンのウィンドウ要素、アドオン自身の表示切り替え関数、GUI の言語を返す関数を渡す。ワークスペースがパネルを受け付けるときは「デバッガー」タブで開き、タブとデバッガーの開閉を連動させる。受け付けないときは従来どおり浮動ウィンドウのままにする。タブは一時パネルとして扱い、保存するレイアウトには含めない。
46
+
47
+ `debugger-panel.css` はアドオンのクラス名を上書きするため、ホストはグローバルなスタイルシートとして読み込む。タブと浮動ウィンドウの両方で、アドオン固有の青緑の代わりに GUI のテーマ変数を使う。
48
+
49
+ ## Editor と組み合わせたローカル検証
50
+
51
+ `npm test` でタブの状態管理、ファイルメニューの操作、既存レイアウトを検証する。
52
+ `TW_PLUS_LAYOUT_EDITOR_URL` に、固定済み Scratch GUI と組み合わせた Editor の URL を指定して
53
+ `npm run test:browser` を実行すると、既存のタブ列・編集パネル接続で Dockview を検証する。
54
+ ファイルメニューの任意接続を備えた GUI を確認する場合は、同じコマンドに
55
+ `TW_PLUS_LAYOUT_FILE_MENU_URL` を指定する。
56
+
57
+ npm への公開は `.github/workflows/release.yml` が行う。`main` への push で `package.json` の版が
58
+ npm にまだ無いときだけ、テストを通したうえで公開する。すでにある版では何もしない。認証はトークン
59
+ ではなく npm の Trusted Publisher(OIDC)で、`id-token: write` の権限を使う。npm 側の設定には
60
+ このワークフローのファイル名をそのまま登録するため、改名するときは npm の設定も合わせる。
61
+
62
+ Plus 標準配置ではスプライト編集タブを既定で表示する。`twPlusDockviewSpriteTabs=0` で従来の編集表示に戻る。
63
+ Editor がファイルメニューの接続口を提供している場合は、各項目のアイコンと「機能拡張の追加」を表示する。
64
+ `twPlusExtensionFileMenu=0` で左下のボタンに戻る。起動時のパラメーターを変更したら再読み込みする。
65
+
66
+ Web 版の Plus 標準配置で `twPlusDockview=1` を付けて起動すると、スプライト編集ペインを左右・上下に分割できます。同じスプライトを複数のペインで開いた場合、表示セクション、コスチュームと音の選択、素材一覧のスクロール位置をペインごとに保持します。変数の値はプロジェクト内で共有され、編集中のペインで変更できます。URL から `twPlusDockview=1` を外して再読み込みすると、通常のスプライトタブに戻ります。
67
+
68
+ スプライトと背景の編集タブには「コード」「コスチューム / 背景」「音」「変数など」に続いて「メッセージ」がある。
69
+ 表示は `@kubohiroya/turbowarp-plus-editor-sprite-panes` の `SpriteMessagePane` が担う。
70
+ `broadcast_msg` はステージ所有なので、メッセージ名の変更は作品全体に及ぶ。
71
+ 送受信の判定は `@kubohiroya/turbowarp-plus-editor-project-model` の `messageReference` だけが持ち、Editor の作品内検索も同じ関数を使う。
72
+ このパッケージの `./project-messages` は、既存の import のためにそれを再 export している。
package/README.md CHANGED
@@ -1,3 +1,70 @@
1
- # Temporary Holding Version
1
+ # TurboWarp Plus Editor Workbench
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [日本語](README.ja.md)
4
+
5
+ The workbench of TurboWarp Plus Editor: the resizable layout, the Plus standard layout, the Dockview sprite tabs and workspace, the stage surface, the debugger tab and the file menu. The panes inside a sprite tab come from `@kubohiroya/turbowarp-plus-editor-sprite-panes`, the in-page windows from `@kubohiroya/turbowarp-plus-editor-windows`, and project data from `@kubohiroya/turbowarp-plus-editor-project-model`.
6
+
7
+ This package was published as `@kubohiroya/turbowarp-plus-editor-layout` up to 0.3.0.
8
+
9
+ ## Resizable layout
10
+
11
+ Resize the divider between the editor and the stage column, or the divider between the stage and the target pane, within a single document. The host passes its React instance to `createLayout(React)` and connects the dividers, styles, and display dimensions provided by the `render` callback to its existing components. The host supplies a storage provider and key, and this package saves and restores the layout settings.
12
+
13
+ Drag a divider or use the arrow keys, Home, or End to move it. Press Enter or double-click to reset that divider to its default position.
14
+
15
+ ## Editor layout sizing
16
+
17
+ | Divider | Minimum sizes |
18
+ | --- | --- |
19
+ | Editor / stage column | Editor 500 px, stage column 350 px |
20
+ | Stage / target pane | Stage 135 px, target pane 175 px |
21
+
22
+ Dividers are 8 px wide. Each split is constrained by the minimum size of its panes. If the available space is too small to satisfy both minimums, the editor falls back to its usual sizing. The split resumes at the saved ratio when the available space grows. The sprite properties and list stay together in the sprite selector, and the backpack remains a collapsible tray. The menu bar sits outside the split area.
23
+
24
+ Dividers are enabled by default in the Scratch layout. Selecting a stage size preset resets the split to that preset. Layout settings are stored separately from projects and SB3 files. To disable the dividers, add `twPlusSplitter=0` to the Web launch URL or start Desktop with `TW_PLUS_DESKTOP_SPLITTER=0`.
25
+
26
+ ## Plus standard layout
27
+
28
+ `createStandardLayout(React, {styles, targetStyles, context})` handles layout switching via the anchor control (⚓️), stage visibility and measurement, and the two-column sprite list. Pass `editor.css` and `targets.css` as class-name maps. The host provides startup settings, storage, window controls, and the callback and mount point for the palette. Pass an optional `LayoutMenu` component to the factory to customize the layout menu. The stage keeps the same mount point while hidden.
29
+
30
+ Use `/example/?standard=1` in the test host to try the Plus layout. Use `standard=0` to try the startup fallback to the Scratch layout.
31
+
32
+ The Editor pins this package from npm.
33
+
34
+ ## Verification
35
+
36
+ Run `npm test` to verify split sizing, aspect ratios, and settings persistence. Run `npm run test:browser` to test the standalone host. To open the test host manually, run `npm install` and `python3 -m http.server` in this directory, then open `/example/`.
37
+
38
+ From the Editor root, build the GUI pinned in `site/source.json` with `npm run build:pages`, then run `E2E_GUI_ROOT=/absolute/gui-checkout E2E_PATH_PREFIX=/turbowarp-plus-editor/ node --test test/editor-layout.browser.ts`. To verify the GUI on its own, set `E2E_LAYOUT_BARE_BUILD` to the directory where the same GUI was built without the host integration.
39
+
40
+ ## Separate stage window
41
+
42
+ `attachStageInput` manages input subscriptions and cleanup using the separate window's document and canvas provided by the host. Pointer handling and drag cleanup use the host's callbacks.
43
+
44
+ The panes inside a sprite editing tab (assets and variables, messages, the properties form and the section toolbar) now live in `@kubohiroya/turbowarp-plus-editor-sprite-panes`; this package arranges them into tabs and splits. The window components, which came from the source of the previous release archive at `b0390c3`, now live in `@kubohiroya/turbowarp-plus-editor-windows`. The extraction kept the upstream Scratch GUI implementation in its original repository, so this package carries no GPL code and imports no GPL module. It is licensed MPL-2.0, which the GPL-3.0 Editor can still bundle because MPL-2.0 treats the GPL as a Secondary License. The source files carry no “Incompatible With Secondary Licenses” notice, and must not: that notice would make the package unusable in the Editor.
45
+
46
+ ## Debugger tab
47
+
48
+ `attachDebuggerPanel(debugger, {document, vm})` opens the debugger add-on's window as a Dockview tab. The host passes the add-on's window element, the add-on's own visibility setter, and a function returning the GUI's language. While the workspace takes panels the debugger opens as a "Debugger" tab, and closing either the tab or the debugger closes the other. Otherwise it stays the floating window it was. The tab is transient and is left out of the saved layout.
49
+
50
+ `debugger-panel.css` restyles the add-on's own class names, so the host loads it as a global stylesheet. In the tab and the floating window alike it replaces the add-on's fixed teal with the GUI's theme variables.
51
+
52
+ ## Local verification with the Editor
53
+
54
+ Run `npm test` to check tab state, file menu actions, and the existing layout. Set `TW_PLUS_LAYOUT_EDITOR_URL` to an Editor URL built with the pinned Scratch GUI and run `npm run test:browser` to verify Dockview through the existing tab strip and editor panel integration. Set `TW_PLUS_LAYOUT_FILE_MENU_URL` for the same command to check a GUI build with the optional file menu integration.
55
+
56
+ `.github/workflows/release.yml` publishes to npm. On a push to `main` it publishes only when the
57
+ version in `package.json` is not on npm yet, and only after the tests pass; an existing version
58
+ publishes nothing. It authenticates with npm's trusted publisher (OIDC) through the `id-token: write`
59
+ permission instead of a token, so npm's configuration records this workflow's filename: rename the
60
+ file and the npm setting has to follow.
61
+
62
+ Sprite editing tabs are enabled by default in the Plus standard layout. Set `twPlusDockviewSpriteTabs=0` to restore the previous editing view. When the Editor exposes the file menu integration, the menu shows item icons and the Add Extension command. Set `twPlusExtensionFileMenu=0` to use the button at the bottom left again. Reload the editor after changing startup parameters.
63
+
64
+ In the Plus web editor, add `twPlusDockview=1` to enable split sprite panes. Each pane remembers its section, costume and sound selections, and asset-list scroll position. Variable values are shared across panes and can be changed in the active pane. Remove the startup parameter and reload to return to the regular sprite tabs.
65
+
66
+ The sprite and stage editor tabs carry a Messages section after Code, Costumes or Backdrops, Sounds and
67
+ Variables, drawn by `SpriteMessagePane` from `@kubohiroya/turbowarp-plus-editor-sprite-panes`. The stage owns
68
+ `broadcast_msg` variables, so a rename applies project-wide. `messageReference` in `@kubohiroya/turbowarp-plus-editor-project-model` is the only place that decides what
69
+ sends or receives a message, and the editor's project search calls the same function. This package's
70
+ `./project-messages` re-exports it for existing imports.
@@ -0,0 +1,22 @@
1
+ export interface DebuggerInterface {
2
+ element: HTMLElement;
3
+ setVisible(visible: boolean): void;
4
+ /** The GUI's language. The page's `lang` is not kept up to date in every layout. */
5
+ getLocale?(): string | undefined;
6
+ }
7
+ interface DebuggerPanelOptions {
8
+ document: Document;
9
+ /** The project whose workspace takes the tab. */
10
+ vm: object;
11
+ getLocale?(): string | undefined;
12
+ }
13
+ export declare const dockedClass = "tw-plus-debugger-docked";
14
+ export declare const debuggerReference: Readonly<{
15
+ providerId: "turbowarp-plus";
16
+ documentId: "debugger";
17
+ }>;
18
+ export declare const debuggerTitle: (locale: string) => "デバッガー" | "Debugger";
19
+ export declare function attachDebuggerPanel(debuggerInterface: DebuggerInterface, options: DebuggerPanelOptions): {
20
+ dispose(): void;
21
+ };
22
+ export {};
@@ -0,0 +1,110 @@
1
+ /**
2
+ * Show the editor add-on's debugger as a workspace tab rather than a card floating over the editor.
3
+ *
4
+ * The add-on builds the debugger, keeps its state, and opens or closes it by setting the element's
5
+ * inline `display`; the build hands that element and the add-on's own visibility setter to the
6
+ * host instead of appending it to the body. This module decides where the element lives:
7
+ *
8
+ * - While the workspace accepts a panel, opening the debugger opens a tab there and the element
9
+ * moves into it. Closing the tab closes the debugger through the add-on, and closing the debugger
10
+ * (its own button, or a mode switch) closes the tab, so the two never disagree.
11
+ * - Otherwise it stays the add-on's floating card in the body, as it was before.
12
+ *
13
+ * Its looks follow the editor's theme in both places; `debugger-panel.css` owns that. The host imports
14
+ * it as a global stylesheet, since it restyles the add-on's own class names.
15
+ */
16
+ import { getDocumentWorkspace } from "./document-workspace.js";
17
+ export const dockedClass = 'tw-plus-debugger-docked';
18
+ export const debuggerReference = Object.freeze({ providerId: 'turbowarp-plus', documentId: 'debugger' });
19
+ const buttonSelector = '.sa-debugger-container';
20
+ export const debuggerTitle = (locale) => (/^ja(?:-|$)/i.test(locale) ? 'デバッガー' : 'Debugger');
21
+ export function attachDebuggerPanel(debuggerInterface, options) {
22
+ const { element, setVisible } = debuggerInterface;
23
+ const { document } = options;
24
+ const workspace = getDocumentWorkspace(options.vm);
25
+ const getLocale = () => debuggerInterface.getLocale?.() || options.getLocale?.() ||
26
+ document.documentElement.lang || 'en';
27
+ // The panel's close callback while the debugger is docked, and null while it floats.
28
+ let close = null;
29
+ let opening = false;
30
+ const isVisible = () => element.style.display !== '' && element.style.display !== 'none';
31
+ const request = () => {
32
+ const title = debuggerTitle(getLocale());
33
+ return {
34
+ reference: debuggerReference,
35
+ filename: title,
36
+ title,
37
+ transient: true,
38
+ mount(slot, closePanel) {
39
+ close = closePanel;
40
+ element.classList.add(dockedClass);
41
+ slot.append(element);
42
+ return {
43
+ requestClose() {
44
+ // The add-on hides the element, and the observer then closes the tab.
45
+ if (isVisible())
46
+ setVisible(false);
47
+ else
48
+ closePanel();
49
+ },
50
+ dispose() {
51
+ if (close !== closePanel)
52
+ return;
53
+ close = null;
54
+ element.classList.remove(dockedClass);
55
+ document.body.append(element);
56
+ if (isVisible())
57
+ setVisible(false);
58
+ }
59
+ };
60
+ }
61
+ };
62
+ };
63
+ const dock = () => {
64
+ if (opening)
65
+ return;
66
+ opening = true;
67
+ try {
68
+ // A workspace that already has the tab only activates it. Without one, the debugger floats.
69
+ workspace.open(request());
70
+ }
71
+ finally {
72
+ opening = false;
73
+ }
74
+ };
75
+ const observer = new document.defaultView.MutationObserver(() => {
76
+ if (isVisible()) {
77
+ if (!close)
78
+ dock();
79
+ }
80
+ else if (close) {
81
+ close();
82
+ }
83
+ });
84
+ observer.observe(element, { attributes: true, attributeFilter: ['style'] });
85
+ // Opening an already open debugger leaves its style as it is, so the tab is brought forward here.
86
+ const handleButton = (event) => {
87
+ if (close && event.target?.closest?.(buttonSelector))
88
+ dock();
89
+ };
90
+ document.addEventListener('click', handleButton);
91
+ // The add-on drags its card by the header. In a tab there is nothing to drag, and the drag would
92
+ // write a stale position onto the element.
93
+ const handlePointerDown = (event) => {
94
+ const header = element.firstElementChild;
95
+ if (close && header?.contains(event.target))
96
+ event.stopPropagation();
97
+ };
98
+ element.addEventListener('pointerdown', handlePointerDown, { capture: true });
99
+ document.body.append(element);
100
+ if (isVisible())
101
+ dock();
102
+ return {
103
+ dispose() {
104
+ observer.disconnect();
105
+ document.removeEventListener('click', handleButton);
106
+ element.removeEventListener('pointerdown', handlePointerDown, { capture: true });
107
+ close?.();
108
+ }
109
+ };
110
+ }