@kubohiroya/sb3-toolchain 0.25.0 → 0.26.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.
Files changed (46) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.ja.md +5 -3
  3. package/README.md +5 -3
  4. package/dist/block-palette.d.ts +1 -1
  5. package/dist/browser.d.ts +7 -7
  6. package/dist/browser.js +12 -9
  7. package/dist/browser.js.map +1 -1
  8. package/dist/build.d.ts +1 -1
  9. package/dist/clean-up-sb3.d.ts +2 -2
  10. package/dist/cli.d.ts +2 -2
  11. package/dist/constants.d.ts +1 -1
  12. package/dist/constants.js +1 -1
  13. package/dist/constants.js.map +1 -1
  14. package/dist/expand-archive.d.ts +4 -5
  15. package/dist/expand-archive.js +9 -17
  16. package/dist/expand-archive.js.map +1 -1
  17. package/dist/extension-api-manifest.d.ts +1 -1
  18. package/dist/extension-bundle-configuration.d.ts +4 -4
  19. package/dist/extension-bundle-metadata.d.ts +1 -1
  20. package/dist/extension-bundle.d.ts +3 -3
  21. package/dist/extension-dependencies.d.ts +1 -1
  22. package/dist/extension-id-migration.d.ts +2 -2
  23. package/dist/extension-module-bundle.d.ts +2 -2
  24. package/dist/extension-sb3-replacement.d.ts +2 -2
  25. package/dist/extension-sync.d.ts +6 -6
  26. package/dist/import.d.ts +4 -4
  27. package/dist/import.js +1 -1
  28. package/dist/import.js.map +1 -1
  29. package/dist/index.d.ts +42 -42
  30. package/dist/index.js +2 -2
  31. package/dist/npm-extension-source.d.ts +1 -1
  32. package/dist/project-asset-additions.d.ts +1 -1
  33. package/dist/release-snapshot.d.ts +1 -1
  34. package/dist/source-format.d.ts +8 -1
  35. package/dist/source-format.js +8 -1
  36. package/dist/source-format.js.map +1 -1
  37. package/dist/source.d.ts +7 -5
  38. package/dist/source.js +22 -4
  39. package/dist/source.js.map +1 -1
  40. package/dist/turbowarp-clean-up.d.ts +1 -1
  41. package/docs/index.html +2 -2
  42. package/docs/ja/source-format-v1.md +5 -1
  43. package/docs/ja/source-format-v2.md +2 -0
  44. package/docs/source-format-v1.md +11 -2
  45. package/docs/source-format-v2.md +4 -0
  46. package/package.json +1 -1
@@ -2,8 +2,8 @@
2
2
 
3
3
  [日本語版](ja/source-format-v1.md)
4
4
 
5
- Projects with block palette settings use [format v2](source-format-v2.md), which adds
6
- `block-palette.json` to this layout. Projects without them keep using v1.
5
+ Import and unpack always write v1. Folders in [format v2](source-format-v2.md), which 0.25 wrote for
6
+ projects with block palette comments, are still read and built.
7
7
 
8
8
  ## Layout
9
9
 
@@ -12,12 +12,21 @@ SOURCE_DIR/
12
12
  ├── sb3-source.json
13
13
  ├── project.source.json
14
14
  ├── embedded-extensions.json
15
+ ├── .tw-plus/
16
+ │ └── workspace.json (optional)
15
17
  ├── assets/
16
18
  │ └── <assetId>.<dataFormat>
17
19
  └── extensions/
18
20
  └── <extensionId>.js
19
21
  ```
20
22
 
23
+ `.tw-plus/workspace.json` is the screen state TurboWarp Plus Editor saves with a project: its tab layout,
24
+ the block groups each sprite shows in the palette, and so on. An SB3 carries it as the ZIP entry
25
+ `tw-plus/workspace.json`, which Scratch and TurboWarp ignore. Import copies the entry to this file byte for
26
+ byte and lists it in `archiveEntries`; build puts the file back in the same place. The Editor writes the file
27
+ itself when it saves a project folder; such a file, not listed in `archiveEntries`, becomes the last entry of
28
+ the SB3. The toolchain only checks that it is JSON, and a folder without it builds without the entry.
29
+
21
30
  `sb3-source.json` records the format version, paths to each component, and the ZIP entry order of the
22
31
  original SB3.
23
32
 
@@ -2,6 +2,10 @@
2
2
 
3
3
  [日本語版](ja/source-format-v2.md)
4
4
 
5
+ > **No longer written.** Since 0.26, import and unpack write [format v1](source-format-v1.md) and keep
6
+ > palette comments as plain comments. TurboWarp Plus Editor now saves block palette settings in its screen
7
+ > state (`.tw-plus/workspace.json`), not in comments. Folders in this format are still read and built.
8
+
5
9
  Format v2 is [format v1](source-format-v1.md) plus block palette settings: which block groups the
6
10
  block palette shows for each sprite and for the stage. Everything not described here is the same as
7
11
  in v1.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubohiroya/sb3-toolchain",
3
- "version": "0.25.0",
3
+ "version": "0.26.0",
4
4
  "description": "Git-friendly source management and deterministic builds for Scratch 3 and TurboWarp SB3 projects",
5
5
  "type": "module",
6
6
  "license": "MPL-2.0",