@turbowarp/sb3fix 0.3.2 → 0.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbowarp/sb3fix",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Fix corrupted Scratch projects",
   "main": "src/sb3fix.js",
   "scripts": {
@@ -21,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

@@ -199,6 +199,29 @@ const fixJSON = (data, options = {}) => {
     }
   };
 
+  /**
+   * @param {string} id
+   * @param {unknown} comment
+   */
+  const fixCommentInPlace = (id, comment) => {
+    if (!isObject(comment)) {
+      throw new Error('comment is not an object');
+    }
+
+    if (typeof comment.text !== 'string') {
+      throw new Error('comment text is not a string');
+    }
+
+    // Scratch requires comments to not exceed 8000 characters.
+    // We'll store the excess in .extraText so the text won't be truncated if opened in TurboWarp.
+    const MAX_LENGTH = 8000;
+    if (comment.text.length > MAX_LENGTH) {
+      log(`comment ${id} had length ${comment.text.length}`);
+      comment.extraText = comment.text.substring(MAX_LENGTH);
+      comment.text = comment.text.substring(0, MAX_LENGTH);
+    }
+  };
+
   /**
    * @param {unknown} target
    */
@@ -287,6 +310,14 @@ const fixJSON = (data, options = {}) => {
       fixBlockInPlace(blockId, block);
     }
 
+    // Comments are not required
+    const comments = target.comments;
+    if (comments) {
+      for (const [commentId, comment] of Object.entries(comments)) {
+        fixCommentInPlace(commentId, comment);
+      }
+    }
+
     const variables = target.variables;
     if (!isObject(variables)) {
       throw new Error('variables is not an object');
@@ -314,6 +345,16 @@ const fixJSON = (data, options = {}) => {
         target.layerOrder = 1;
       }
     }
+
+    const ROTATION_STYLES = [
+      'all around',
+      'don\'t rotate',
+      'left-right'
+    ];
+    if (!target.isStage && !ROTATION_STYLES.includes(target.rotationStyle)) {
+      log(`sprite had invalid rotation style ${target.rotationStyle}`);
+      target.rotationStyle = 'all around';
+    }
   };
 
   /**
@@ -351,11 +392,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: {},
@@ -380,22 +420,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}`);