@turbowarp/sb3fix 0.3.0 → 0.3.2

package/README.md

@@ -40,9 +40,9 @@ const run = async () => {
 
   // Both sb3fix methods take in an optional options object.
   const options = {
-    // When sb3fix runs, it'll log what it's doing and what it's found. You can monitor those
+    // While sb3fix runs, it'll log what it's doing and what it fixed. You can monitor those
     // using this callback. These messages are primarily a debugging tool, so the exact output
-    // is not considered part of the API. It may change without warning.
+    // is not stable and may change without warning.
     logCallback: (message) => {
       console.log(message);
     }
@@ -68,10 +68,10 @@ npm ci
 Source code is in the src folder. During development do:
 
 ```bash
-npm run watch
+npm start
 ```
 
-Then open dist/index.html in your favorite browser.
+Then open dist/index.html in your favorite browser (there isn't a localhost development server).
 
 For the final build:
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@turbowarp/sb3fix",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Fix corrupted Scratch projects",
   "main": "src/sb3fix.js",
   "scripts": {
     "build": "webpack -c webpack.config.js",
     "watch": "webpack --watch -c webpack.config.js",
+    "start": "webpack --watch -c webpack.config.js",
     "update": "node tests/snapshots --update",
     "test": "node tests/snapshots --validate"
   },

package/src/sb3fix.js

@@ -67,7 +67,7 @@ const getKnownExtensions = (project) => {
 /**
  * @param {string|object} data project.json as a string or as a parsed object already. If object provided, it will be modified in-place.
  * @param {Options} [options]
- * @returns {object} Fixed project.json object. If an object was provided as `data`, the return value will be `data`.
+ * @returns {object} Fixed project.json object. If the `data` argument was an object, this will point to the same object.
  */
 const fixJSON = (data, options = {}) => {
   /**
@@ -218,6 +218,20 @@ const fixJSON = (data, options = {}) => {
         costume.name = String(costume.name);
       }
 
+      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L51
+      const knownCostumeFormats = ['png', 'svg', 'jpeg', 'jpg', 'bmp', 'gif'];
+      if (!knownCostumeFormats.includes(costume.dataFormat)) {
+        if (typeof costume.md5ext === 'string' && costume.md5ext.endsWith('.svg')) {
+          log(`costume ${i} is vector, had invalid dataFormat ${costume.dataFormat}`);
+          costume.dataFormat = 'svg';
+        } else {
+          log(`costume ${i} is bitmap, had invalid dataFormat ${costume.dataFormat}`);
+          // dataFormat is only really used to detect vector or bitmap, so we don't
+          // need to set this to the real format
+          costume.dataFormat = 'png';
+        }
+      }
+
       if (!('assetId' in costume)) {
         log(`costume ${i} was missing assetId, deleted`);
         costumes.splice(i, 1);
@@ -247,6 +261,13 @@ const fixJSON = (data, options = {}) => {
         throw new Error(`sound ${i} is not an object`);
       }
 
+      // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L81
+      const knownSoundFormats = ['wav', 'wave', 'mp3'];
+      if (!knownSoundFormats.includes(sound.dataFormat)) {
+        log(`sound ${i} had invalid dataFormat ${sound.dataFormat}`);
+        sound.dataFormat = 'mp3';
+      }
+
       if (typeof sound.name !== 'string') {
         log(`sound ${i} name was not a string`);
         sound.name = String(sound.name);