@turbowarp/sb3fix 0.3.1 → 0.3.3

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.1",
+  "version": "0.3.3",
   "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"
   },
@@ -20,11 +21,11 @@
   },
   "homepage": "https://github.com/TurboWarp/sb3fix#readme",
   "dependencies": {
-    "@turbowarp/jszip": "^3.11.0"
+    "@turbowarp/jszip": "^3.11.1"
   },
   "devDependencies": {
     "copy-webpack-plugin": "^12.0.2",
-    "webpack": "^5.90.3",
+    "webpack": "^5.96.1",
     "webpack-cli": "^5.1.4"
   }
 }

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 = {}) => {
   /**
@@ -219,8 +219,8 @@ const fixJSON = (data, options = {}) => {
       }
 
       // https://github.com/scratchfoundation/scratch-parser/blob/665f05d739a202d565a4af70a201909393d456b2/lib/sb3_definitions.json#L51
-      const knownDataFormats = ['png', 'svg', 'jpeg', 'jpg', 'bmp', 'gif'];
-      if (!knownDataFormats.includes(costume.dataFormat)) {
+      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';
@@ -261,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);
@@ -344,11 +351,10 @@ const fixJSON = (data, options = {}) => {
       fixTargetInPlace(target);
     }
 
-    let stage;
     const allStages = targets.filter((target) => target.isStage);
     if (allStages.length === 0) {
       log('stage is missing; adding an empty one');
-      stage = {
+      targets.unshift({
         isStage: true,
         name: 'Stage',
         variables: {},
@@ -373,22 +379,31 @@ const fixJSON = (data, options = {}) => {
         videoTransparency: 50,
         videoState: "on",
         textToSpeechLanguage: null
-      };
-      targets.unshift(stage);
-    } else if (allStages.length === 1) {
-      const stageIndex = targets.findIndex((target) => target.isStage);
-      // stageIndex guaranteed to not be -1 by earlier filter check
-      stage = targets[stageIndex];
-      // stage must be the first target
-      if (stageIndex !== 0) {
-        log(`stage was at wrong index: ${stageIndex}`);
-        targets.splice(stageIndex, 1);
+      });
+    } else {
+      // We will accept the first stage in targets as the real stage
+      const firstStageIndex = targets.findIndex((target) => target.isStage);
+
+      // Stage must be the first target
+      if (firstStageIndex !== 0) {
+        log(`stage was at wrong index: ${firstStageIndex}`);
+        const stage = targets[firstStageIndex];
+        targets.splice(firstStageIndex, 1);
         targets.unshift(stage);
       }
-    } else {
-      throw new Error(`wrong number of stages: ${allStages.length}`);
+
+      // Remove all the other stages
+      for (let i = targets.length - 1; i > 0; i--) {
+        if (targets[i].isStage) {
+          log(`removing extra stage at index ${i}`);
+          targets.splice(i, 1);
+        }
+      }
     }
 
+    // Above checks ensure this invariant holds
+    const stage = targets[0];
+
     // stage's name must match exactly
     if (stage.name !== 'Stage') {
       log(`stage had wrong name: ${stage.name}`);