@kubohiroya/sb3-toolchain 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/LICENSE +373 -0
- package/README.md +187 -0
- package/bin/sb3-toolchain.mjs +9 -0
- package/docs/extension-id-migration.md +59 -0
- package/docs/source-format-v1.md +119 -0
- package/package.json +62 -0
- package/src/archive.js +35 -0
- package/src/build.js +151 -0
- package/src/cli.js +465 -0
- package/src/constants.js +4 -0
- package/src/extension-dependencies.js +86 -0
- package/src/extension-id-migration.js +425 -0
- package/src/extension-sync.js +496 -0
- package/src/import.js +381 -0
- package/src/index.js +34 -0
- package/src/output-safety.js +322 -0
- package/src/source.js +386 -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.md
ADDED
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# sb3-toolchain
|
|
2
|
+
|
|
3
|
+
Scratch 3/TurboWarpの`.sb3`をGit差分可能な展開ソースとして管理し、同じ入力から
|
|
4
|
+
bit-for-bitで同一のSB3を再生成するNode.jsツールチェーンです。
|
|
5
|
+
|
|
6
|
+
## 主な機能
|
|
7
|
+
|
|
8
|
+
- SB3を整形済み`project.source.json`、アセット、埋め込み拡張へ安全に展開
|
|
9
|
+
- アセット参照、MD5、ZIPエントリ、埋め込み拡張対応を検証
|
|
10
|
+
- GitHub由来の埋め込み拡張についてcommitとSHA-256を記録し、オフラインで検証
|
|
11
|
+
- ZIPエントリ順、タイムスタンプ、圧縮条件を固定した決定的ビルド
|
|
12
|
+
- Git管理中の未コミット変更を保護したimport
|
|
13
|
+
- 既存出力を保護する原子的な置換とロールバック
|
|
14
|
+
- CLIとJavaScript API
|
|
15
|
+
|
|
16
|
+
TMPose紙芝居の台本変換、特定作品のデータ、TurboWarp PackagerによるWebアプリ生成は
|
|
17
|
+
このパッケージの対象外です。
|
|
18
|
+
|
|
19
|
+
## 必要な環境
|
|
20
|
+
|
|
21
|
+
- Node.js 22.12.0以上
|
|
22
|
+
- pnpm 11
|
|
23
|
+
|
|
24
|
+
## インストール
|
|
25
|
+
|
|
26
|
+
リリースタグを固定してインストールします。公開前の例では`VERSION`を利用するタグへ
|
|
27
|
+
置き換えてください。
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm add --save-dev github:kubohiroya/sb3-toolchain#VERSION
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## CLI
|
|
34
|
+
|
|
35
|
+
TurboWarpで保存したSB3を展開します。
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
sb3-toolchain import tmp/project.sb3 --output app
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
展開ソースを検証します。
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
sb3-toolchain check app
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
決定的なSB3を生成します。
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
sb3-toolchain build app --output dist/project.sb3
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
管理対象の埋め込み拡張について、追跡中のGitHub refに更新があるか確認します。
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
sb3-toolchain extensions status app
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
記録済みの固定commitから実ファイルを復元します。refは解決せず、メタデータも変更しません。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
sb3-toolchain extensions sync app
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
追跡中のrefを最新commitへ解決し、成果物と`resolvedCommit`/`integrity`を更新します。
|
|
66
|
+
IDを省略すると、すべての管理対象拡張を一つのtransactionとして更新します。
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
sb3-toolchain extensions update app
|
|
70
|
+
sb3-toolchain extensions update app example
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
読み込み済みの拡張IDを変更する場合は、まずdry-runで分類済みの変更件数と、変更しない
|
|
74
|
+
未分類参照を確認します。`--yes`を付けたときだけ適用します。
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
sb3-toolchain extensions migrate-id app --from oldId --to newid
|
|
78
|
+
sb3-toolchain extensions migrate-id app --from oldId --to newid --yes
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
GitHub管理対象では、新IDを宣言する新しい成果物の取得とID移行を一つのtransactionにします。
|
|
82
|
+
リモートの成果物パスも変わる場合は`--artifact`で明示します。
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
sb3-toolchain extensions update app oldId \
|
|
86
|
+
--migrate-id newid \
|
|
87
|
+
--artifact dist/newid.js
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
既存出力と内容が同じ場合は更新時刻を変えません。異なる既存出力の置換には対話確認
|
|
91
|
+
または`--yes`が必要です。import先に未コミット変更がある場合、`--yes`だけでは置換せず、
|
|
92
|
+
明示的な`--discard-local-changes`も要求します。
|
|
93
|
+
|
|
94
|
+
## JavaScript API
|
|
95
|
+
|
|
96
|
+
```js
|
|
97
|
+
import {readFile} from 'node:fs/promises';
|
|
98
|
+
|
|
99
|
+
import {
|
|
100
|
+
buildSb3,
|
|
101
|
+
createDeterministicSb3,
|
|
102
|
+
extensionIntegrity,
|
|
103
|
+
extensionStatus,
|
|
104
|
+
importSb3,
|
|
105
|
+
migrateExtensionId,
|
|
106
|
+
planExtensionIdMigration,
|
|
107
|
+
syncExtensions,
|
|
108
|
+
updateExtensions,
|
|
109
|
+
validateSb3Source,
|
|
110
|
+
} from '@kubohiroya/sb3-toolchain';
|
|
111
|
+
|
|
112
|
+
await importSb3({
|
|
113
|
+
inputPath: 'tmp/project.sb3',
|
|
114
|
+
outputDirectory: 'app',
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
await validateSb3Source('app');
|
|
118
|
+
|
|
119
|
+
await buildSb3({
|
|
120
|
+
sourceDirectory: 'app',
|
|
121
|
+
outputPath: 'dist/project.sb3',
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
const {archive} = await createDeterministicSb3('app');
|
|
125
|
+
|
|
126
|
+
const integrity = extensionIntegrity(await readFile('app/extensions/example.js'));
|
|
127
|
+
|
|
128
|
+
const statuses = await extensionStatus('app');
|
|
129
|
+
const migration = await planExtensionIdMigration({
|
|
130
|
+
sourceDirectory: 'app',
|
|
131
|
+
fromId: 'oldId',
|
|
132
|
+
toId: 'newid',
|
|
133
|
+
});
|
|
134
|
+
await migrateExtensionId({
|
|
135
|
+
sourceDirectory: 'app',
|
|
136
|
+
fromId: 'oldId',
|
|
137
|
+
toId: 'newid',
|
|
138
|
+
yes: true,
|
|
139
|
+
});
|
|
140
|
+
await syncExtensions({sourceDirectory: 'app', yes: true});
|
|
141
|
+
await updateExtensions({
|
|
142
|
+
sourceDirectory: 'app',
|
|
143
|
+
extensionId: 'oldId',
|
|
144
|
+
migrateToId: 'newid',
|
|
145
|
+
sourceArtifact: 'dist/newid.js',
|
|
146
|
+
yes: true,
|
|
147
|
+
});
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## 管理対象の埋め込み拡張
|
|
151
|
+
|
|
152
|
+
`embedded-extensions.json`の拡張エントリには、任意の`source`メタデータとして
|
|
153
|
+
GitHubリポジトリ、追跡するref、解決済みcommit、成果物パス、SHA-256を記録できます。
|
|
154
|
+
`check`と`build`はネットワークへ接続せず、ローカルのJavaScriptが記録済みハッシュおよび
|
|
155
|
+
`// ID: <extensionId>`ヘッダーと一致することを検証します。
|
|
156
|
+
|
|
157
|
+
既存の展開ディレクトリへSB3を再importする場合、同じIDとパスを持つ拡張の`source`は
|
|
158
|
+
維持されます。SB3内の実ファイルが記録済みの内容から変わっている場合は、既存出力を
|
|
159
|
+
変更せずにimportを拒否します。メタデータ形式は
|
|
160
|
+
[`docs/source-format-v1.md`](docs/source-format-v1.md)を参照してください。
|
|
161
|
+
|
|
162
|
+
`extensions sync`は`resolvedCommit`だけから取得するため、mutableなbranchやtagを
|
|
163
|
+
再現処理に使いません。`extensions update`だけが`ref`を解決します。取得先はGitHubの
|
|
164
|
+
HTTPS endpointに限定し、redirectと5 MiBを超える成果物を拒否します。取得したJavaScriptは
|
|
165
|
+
実行せず、IDとSHA-256を検証してから展開ディレクトリを置換します。複数拡張の一部だけが
|
|
166
|
+
失敗した場合は、ファイルもメタデータも変更しません。
|
|
167
|
+
|
|
168
|
+
ID移行はTurboWarp公式形式の`[a-z0-9]+`を新IDに要求し、任意の文字列置換を行いません。
|
|
169
|
+
対象schema、dry-run、未分類参照の詳細は
|
|
170
|
+
[`docs/extension-id-migration.md`](docs/extension-id-migration.md)を参照してください。
|
|
171
|
+
|
|
172
|
+
展開形式の詳細は[`docs/source-format-v1.md`](docs/source-format-v1.md)を参照してください。
|
|
173
|
+
|
|
174
|
+
## 開発
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
pnpm install
|
|
178
|
+
pnpm check
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
## ライセンス
|
|
182
|
+
|
|
183
|
+
[Mozilla Public License 2.0](LICENSE)
|
|
184
|
+
|
|
185
|
+
本実装は
|
|
186
|
+
[`kubohiroya/tmpose-kamishibai`](https://github.com/kubohiroya/tmpose-kamishibai)
|
|
187
|
+
で開発したSB3ソース管理機構を、作品およびTMPose固有処理から分離したものです。
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# 埋め込み拡張IDの移行
|
|
2
|
+
|
|
3
|
+
TurboWarpで読み込み済みの拡張IDは、project内のopcodeやmonitorにも保存されます。
|
|
4
|
+
`extensions migrate-id`はJSON全体の文字列置換を行わず、SB3 source format v1で意味が
|
|
5
|
+
確定している参照だけを変更します。
|
|
6
|
+
|
|
7
|
+
## dry-runと適用
|
|
8
|
+
|
|
9
|
+
単独の移行コマンドは既定でdry-runです。
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
sb3-toolchain extensions migrate-id app --from twOld --to newext
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
出力される分類済み変更件数と`Unclassified`参照を確認し、新IDを宣言するJavaScript成果物を
|
|
16
|
+
`extensions/twOld.js`へ用意してから明示的に適用します。
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
sb3-toolchain extensions migrate-id app --from twOld --to newext --yes
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
新IDはTurboWarp公式形式の`[a-z0-9]+`でなければなりません。既存のmanifest、
|
|
23
|
+
`extensionURLs`、または`project.extensions`に新IDが存在する場合はcollisionとして
|
|
24
|
+
拒否します。
|
|
25
|
+
|
|
26
|
+
## 分類して変更する参照
|
|
27
|
+
|
|
28
|
+
- `project.source.json`の`extensions[]`にある完全一致ID
|
|
29
|
+
- `extensionURLs`の完全一致keyと埋め込み拡張value
|
|
30
|
+
- `targets[*].blocks[*].opcode`の`<oldId>_`完全prefix
|
|
31
|
+
- menu blockのopcode(通常のblockと同じschema)
|
|
32
|
+
- `monitors[*].opcode`の`<oldId>_`完全prefix
|
|
33
|
+
- `embedded-extensions.json`の`id`と`path`
|
|
34
|
+
- `extensions/<oldId>.js`から`extensions/<newId>.js`へのファイル名変更
|
|
35
|
+
|
|
36
|
+
変数名、list名、blockのliteral、metadata、別拡張のopcodeなどに旧IDを含む文字列は
|
|
37
|
+
変更しません。これらはJSON Pointer付きの未分類参照としてdry-run結果へ出すため、人が
|
|
38
|
+
意味を確認できます。
|
|
39
|
+
|
|
40
|
+
## GitHub管理対象
|
|
41
|
+
|
|
42
|
+
管理対象拡張では、上流リポジトリが新IDを宣言する成果物を公開したあと、更新と移行を
|
|
43
|
+
一体で実行する方法を推奨します。
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
sb3-toolchain extensions update app twOld \
|
|
47
|
+
--migrate-id newext \
|
|
48
|
+
--artifact dist/newext.js
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
`--artifact`は上流の成果物パスも変わる場合だけ指定します。ツールは追跡refを固定commitへ
|
|
52
|
+
解決し、そのcommitから新成果物を取得します。`// ID: newext`を宣言しない成果物、
|
|
53
|
+
collision、不正な新IDは、ローカルファイルを変更する前に拒否します。
|
|
54
|
+
|
|
55
|
+
## 検証とロールバック
|
|
56
|
+
|
|
57
|
+
適用候補について通常のsource検証と決定的SB3 buildを完了してから、展開ディレクトリを
|
|
58
|
+
transactionalに置換します。途中失敗時は元ディレクトリを自動復旧します。マージ後に
|
|
59
|
+
戻す場合は、作品側の移行commitをrevertし、旧ID・旧成果物・旧provenanceを同時に戻します。
|