@markw65/monkeyc-optimizer 1.0.7 → 1.0.10

package/README.md

@@ -56,4 +56,47 @@ More fixes found via open source projects.
 - Add support for a 'pick-one' device to aid testing
 - Add a flag to remote projects to prevent trying to build them (some projects are broken to start with)
 
----
+### 1.0.8
+
+- Improvements
+
+  - Update to @markw65/prettier-plugin-monkeyc:1.0.14
+  - Parse and respect \<build\> instructions in resource files
+  - Add minimal barrel support
+  - Better checking for whether the optimized source is up to date
+  - Rename locals which would be marked re-declaring
+
+- Bug Fixes
+
+  - Generate the default jungle dynamically, since sdk/bin/default.jungle is generated lazily, and may not exist in newly installed sdks, or may be out of date after device installations.
+  - Fix a bug generating language settings in optimized jungle
+  - Fix a bug introduced by pick-one: don't modify a shared array
+  - Don't allow src paths to navigate out of the optimized directory
+  - Fix some windows paths issues
+
+- Tests
+  - More parallelism while fetching remote projects for testing
+  - Add option to build the original project, rather than the optimized one
+  - Add support for overriding build options on a per project basis
+  - Add an option so we only 'fix' the manifest when running remote projects
+  - Check the manifest's application id, and throw in a valid one if necessary
+  - Allow project specific overrides for the generated monkey.jungle files, and use it to fix some projects
+  - Add patches for some broken projects
+
+### 1.0.9
+
+- Only generate the parts of the jungle we're going to use
+- Also publish sdk-util.cjs
+- Bump to @markw65/prettier-plugin-monkeyc:1.0.15
+  - Fixes a bug that dropped attributes on modules
+- LiteralIntegerRe should be case insensitive
+- Proper fix for promiseAll
+- Auto-include barrels.jungle when its present
+
+### 1.0.10
+
+- Add --execute option to test.js to run the projects after building them
+- Add support for optimizing barrels
+- Add some typing via jsdoc, and turn on ts validation in vscode
+- Bump to @markw65/prettier-plugin-monkeyc:1.0.16 so ts recognizes its exports
+- Add [garmin/connectiq-apps](https://github.com/garmin/connectiq-apps) and fix some minor issues it revealed

package/build/api.cjs

@@ -54,66 +54,10 @@ const prettier_plugin_monkeyc_namespaceObject = require("@markw65/prettier-plugi
 const promises_namespaceObject = require("fs/promises");
 ;// CONCATENATED MODULE: external "prettier/standalone.js"
 const standalone_js_namespaceObject = require("prettier/standalone.js");
-;// CONCATENATED MODULE: external "./util.cjs"
-const external_util_cjs_namespaceObject = require("./util.cjs");
-;// CONCATENATED MODULE: ./src/negative-fixups.js
-/*
- * This is strange. It pretty much has to be a bug in the sdk,
- * but its the same in every sdk.
- *
- * ${sdk}/bin/api.mir describes the Toybox api down to every module,
- * class, function, enum and constant, together with the enum
- * and constant values.
- *
- * The problem is that every enum or constant with a negative
- * value, appears with the corresponding positive value in api.mir.
- * So eg Graphics.COLOR_TRANSPARENT should be -1, but instead, it has
- * the value 1.
- *
- * This is a (currently somewhat ad-hoc) list of the negative constants
- * so we can fix them after reading api.mir.
- */
-const negativeFixups = [
-  "Toybox.Communications.BLE_CONNECTION_UNAVAILABLE",
-  "Toybox.Communications.INVALID_HTTP_BODY_IN_REQUEST",
-  "Toybox.Communications.REQUEST_CANCELLED",
-  "Toybox.Communications.UNSUPPORTED_CONTENT_TYPE_IN_RESPONSE",
-  "Toybox.Communications.UNABLE_TO_PROCESS_IMAGE",
-  "Toybox.Communications.NETWORK_RESPONSE_OUT_OF_MEMORY",
-  "Toybox.Communications.BLE_REQUEST_CANCELLED",
-  "Toybox.Communications.INVALID_HTTP_METHOD_IN_REQUEST",
-  "Toybox.Communications.BLE_NO_DATA",
-  "Toybox.Communications.INVALID_HTTP_HEADER_FIELDS_IN_REQUEST",
-  "Toybox.Communications.BLE_ERROR",
-  "Toybox.Communications.NETWORK_RESPONSE_TOO_LARGE",
-  "Toybox.Communications.INVALID_HTTP_BODY_IN_NETWORK_RESPONSE",
-  "Toybox.Communications.BLE_REQUEST_TOO_LARGE",
-  "Toybox.Communications.UNABLE_TO_PROCESS_MEDIA",
-  "Toybox.Communications.REQUEST_CONNECTION_DROPPED",
-  "Toybox.Communications.BLE_UNKNOWN_SEND_ERROR",
-  "Toybox.Communications.BLE_QUEUE_FULL",
-  "Toybox.Communications.STORAGE_FULL",
-  "Toybox.Communications.BLE_SERVER_TIMEOUT",
-  "Toybox.Communications.INVALID_HTTP_HEADER_FIELDS_IN_NETWORK_RESPONSE",
-  "Toybox.Communications.SECURE_CONNECTION_REQUIRED",
-  "Toybox.Communications.NETWORK_REQUEST_TIMED_OUT",
-  "Toybox.Communications.BLE_HOST_TIMEOUT",
-  "Toybox.Communications.UNABLE_TO_PROCESS_HLS",
-  "Toybox.Graphics.COLOR_TRANSPARENT",
-  "Toybox.AntPlus.INVALID_SPEED",
-  "Toybox.AntPlus.INVALID_CADENCE",
-  "Toybox.WatchUi.LAYOUT_VALIGN_START",
-  "Toybox.WatchUi.LAYOUT_VALIGN_TOP",
-  "Toybox.WatchUi.LAYOUT_VALIGN_BOTTOM",
-  "Toybox.WatchUi.LAYOUT_VALIGN_CENTER",
-  "Toybox.WatchUi.LAYOUT_HALIGN_RIGHT",
-  "Toybox.WatchUi.LAYOUT_HALIGN_CENTER",
-  "Toybox.WatchUi.LAYOUT_HALIGN_START",
-  "Toybox.WatchUi.LAYOUT_HALIGN_LEFT",
-];
-
 ;// CONCATENATED MODULE: external "./api.cjs"
 const external_api_cjs_namespaceObject = require("./api.cjs");
+;// CONCATENATED MODULE: external "./util.cjs"
+const external_util_cjs_namespaceObject = require("./util.cjs");
 ;// CONCATENATED MODULE: ./src/mc-rewrite.js
 
 
@@ -168,12 +112,8 @@ function collectClassInfo(state) {
   });
 }
 
-async function analyze(fileNames, buildConfig) {
-  const excludeAnnotations =
-    buildConfig && buildConfig.excludeAnnotations
-      ? Object.fromEntries(buildConfig.excludeAnnotations.map((a) => [a, true]))
-      : {};
-
+async function analyze(fnMap) {
+  let excludeAnnotations;
   const allImports = [];
   const state = {
     allFunctions: [],
@@ -181,11 +121,11 @@ async function analyze(fileNames, buildConfig) {
     shouldExclude(node) {
       if (node.attrs && node.attrs.attrs) {
         if (
-          node.attrs.attrs.filter((attr) => {
+          node.attrs.attrs.some((attr) => {
             if (attr.type != "UnaryExpression") return false;
             if (attr.argument.type != "Identifier") return false;
             return hasProperty(excludeAnnotations, attr.argument.name);
-          }).length
+          })
         ) {
           return true;
         }
@@ -228,25 +168,29 @@ async function analyze(fileNames, buildConfig) {
   };
   markApi(state.stack[0]);
 
+  const getAst = (source, monkeyCSource, exclude) => {
+    excludeAnnotations = exclude;
+    const ast = MonkeyC.parsers.monkeyc.parse(monkeyCSource, {
+      grammarSource: source,
+    });
+    ast.source = source;
+    ast.monkeyCSource = monkeyCSource;
+    collectNamespaces(ast, state);
+    return ast;
+  };
   const files = await Promise.all(
-    fileNames.map(async (name) => ({
-      name,
-      monkeyCSource: (await fs.readFile(name))
-        .toString()
-        .replace(/\r\n/g, "\n"),
-    }))
+    Object.entries(fnMap).map(([name, { excludeAnnotations }]) =>
+      fs.readFile(name).then((data) => ({
+        name,
+        ast: getAst(
+          name,
+          data.toString().replace(/\r\n/g, "\n"),
+          excludeAnnotations
+        ),
+      }))
+    )
   );
 
-  files.forEach((f) => {
-    f.ast = MonkeyC.parsers.monkeyc.parse(f.monkeyCSource, {
-      grammarSource: f.name,
-    });
-    f.ast.source = f.name;
-    f.ast.monkeyCSource = f.monkeyCSource;
-    delete f.monkeyCSource;
-    collectNamespaces(f.ast, state);
-  });
-
   delete state.shouldExclude;
   delete state.post;
 
@@ -467,8 +411,8 @@ function evaluateFunction(func, args) {
   }
 }
 
-async function optimizeMonkeyC(fileNames, buildConfig) {
-  const { files, state } = await analyze(fileNames, buildConfig);
+async function optimizeMonkeyC(fnMap) {
+  const { files, state } = await analyze(fnMap);
   const replace = (node, obj) => {
     for (const k of Object.keys(node)) {
       delete node[k];
@@ -529,6 +473,7 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
         (sc.superClass && checkInherited(sc, name))
     );
 
+  state.localsStack = [{}];
   state.exposed = {};
   state.calledFunctions = {};
   state.pre = (node) => {
@@ -578,8 +523,74 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
 
       case "EnumDeclaration":
         return false;
-      case "VariableDeclarator":
+      case "ForStatement": {
+        const map = state.localsStack.slice(-1).pop().map;
+        if (map) {
+          state.localsStack.push({ node, map: { ...map } });
+        }
+        break;
+      }
+      case "VariableDeclarator": {
+        const locals = state.localsStack.slice(-1).pop();
+        const { map } = locals;
+        if (map) {
+          if (hasProperty(map, node.id.name)) {
+            // We already have a variable with this name in scope
+            // Recent monkeyc compilers complain, so rename it
+            let suffix = 0;
+            let node_name = node.id.name;
+            const match = node_name.match(/^pmcr_(.*)_(\d+)$/);
+            if (match) {
+              node_name = match[1];
+              suffix = parseInt(match[2], 10) + 1;
+            }
+            if (!locals.inners) {
+              // find all the names declared in this scope, to avoid
+              // more conflicts
+              locals.inners = {};
+              traverseAst(locals.node, (node) => {
+                if (node.type === "VariableDeclarator") {
+                  locals.inners[node.id.name] = true;
+                }
+              });
+            }
+            let name;
+            while (true) {
+              name = `pmcr_${node_name}_${suffix}`;
+              if (
+                !hasProperty(map, name) &&
+                !hasProperty(locals.inners, name)
+              ) {
+                // we also need to ensure that we don't hide the name of
+                // an outer module, class, function, enum or variable,
+                // since someone might want to access it from this scope.
+                let ok = false;
+                let i;
+                for (i = state.stack.length; i--; ) {
+                  const elm = state.stack[i];
+                  if (ok) {
+                    if (hasProperty(elm.decls, name)) {
+                      break;
+                    }
+                  } else if (elm.node.type === "FunctionDeclaration") {
+                    ok = true;
+                  }
+                }
+                if (i < 0) {
+                  break;
+                }
+              }
+              suffix++;
+            }
+            map[node.id.name] = name;
+            map[name] = true;
+            node.id.name = name;
+          } else {
+            map[node.id.name] = true;
+          }
+        }
         return ["init"];
+      }
       case "UnaryExpression":
         if (node.operator == ":") {
           // If we produce a Symbol, for a given name,
@@ -594,6 +605,15 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
         }
         break;
       case "Identifier": {
+        const map = state.localsStack.slice(-1).pop().map;
+        if (map) {
+          if (hasProperty(map, node.name)) {
+            const name = map[node.name];
+            if (name !== true) {
+              node.name = name;
+            }
+          }
+        }
         if (hasProperty(state.index, node.name)) {
           if (!lookupAndReplace(node)) {
             state.exposed[node.name] = true;
@@ -614,7 +634,20 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
           return ["object"];
         }
         break;
+      case "BlockStatement": {
+        const map = state.localsStack.slice(-1).pop().map;
+        if (map) {
+          state.localsStack.push({
+            node,
+            map: { ...map },
+          });
+        }
+        break;
+      }
       case "FunctionDeclaration": {
+        const map = {};
+        node.params && node.params.forEach((p) => (map[p.name] = true));
+        state.localsStack.push({ node, map });
         const [parent] = state.stack.slice(-2);
         if (parent.type == "ClassDeclaration" && !maybeCalled(node)) {
           let used = false;
@@ -634,6 +667,9 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
     }
   };
   state.post = (node) => {
+    if (state.localsStack.slice(-1).pop().node === node) {
+      state.localsStack.pop();
+    }
     const opt = optimizeNode(node);
     if (opt) {
       replace(node, opt);
@@ -769,6 +805,64 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
   return files;
 }
 
+;// CONCATENATED MODULE: ./src/negative-fixups.js
+/*
+ * This is strange. It pretty much has to be a bug in the sdk,
+ * but its the same in every sdk.
+ *
+ * ${sdk}/bin/api.mir describes the Toybox api down to every module,
+ * class, function, enum and constant, together with the enum
+ * and constant values.
+ *
+ * The problem is that every enum or constant with a negative
+ * value, appears with the corresponding positive value in api.mir.
+ * So eg Graphics.COLOR_TRANSPARENT should be -1, but instead, it has
+ * the value 1.
+ *
+ * This is a (currently somewhat ad-hoc) list of the negative constants
+ * so we can fix them after reading api.mir.
+ */
+const negativeFixups = [
+  "Toybox.Communications.BLE_CONNECTION_UNAVAILABLE",
+  "Toybox.Communications.INVALID_HTTP_BODY_IN_REQUEST",
+  "Toybox.Communications.REQUEST_CANCELLED",
+  "Toybox.Communications.UNSUPPORTED_CONTENT_TYPE_IN_RESPONSE",
+  "Toybox.Communications.UNABLE_TO_PROCESS_IMAGE",
+  "Toybox.Communications.NETWORK_RESPONSE_OUT_OF_MEMORY",
+  "Toybox.Communications.BLE_REQUEST_CANCELLED",
+  "Toybox.Communications.INVALID_HTTP_METHOD_IN_REQUEST",
+  "Toybox.Communications.BLE_NO_DATA",
+  "Toybox.Communications.INVALID_HTTP_HEADER_FIELDS_IN_REQUEST",
+  "Toybox.Communications.BLE_ERROR",
+  "Toybox.Communications.NETWORK_RESPONSE_TOO_LARGE",
+  "Toybox.Communications.INVALID_HTTP_BODY_IN_NETWORK_RESPONSE",
+  "Toybox.Communications.BLE_REQUEST_TOO_LARGE",
+  "Toybox.Communications.UNABLE_TO_PROCESS_MEDIA",
+  "Toybox.Communications.REQUEST_CONNECTION_DROPPED",
+  "Toybox.Communications.BLE_UNKNOWN_SEND_ERROR",
+  "Toybox.Communications.BLE_QUEUE_FULL",
+  "Toybox.Communications.STORAGE_FULL",
+  "Toybox.Communications.BLE_SERVER_TIMEOUT",
+  "Toybox.Communications.INVALID_HTTP_HEADER_FIELDS_IN_NETWORK_RESPONSE",
+  "Toybox.Communications.SECURE_CONNECTION_REQUIRED",
+  "Toybox.Communications.NETWORK_REQUEST_TIMED_OUT",
+  "Toybox.Communications.BLE_HOST_TIMEOUT",
+  "Toybox.Communications.UNABLE_TO_PROCESS_HLS",
+  "Toybox.Graphics.COLOR_TRANSPARENT",
+  "Toybox.AntPlus.INVALID_SPEED",
+  "Toybox.AntPlus.INVALID_CADENCE",
+  "Toybox.WatchUi.LAYOUT_VALIGN_START",
+  "Toybox.WatchUi.LAYOUT_VALIGN_TOP",
+  "Toybox.WatchUi.LAYOUT_VALIGN_BOTTOM",
+  "Toybox.WatchUi.LAYOUT_VALIGN_CENTER",
+  "Toybox.WatchUi.LAYOUT_HALIGN_RIGHT",
+  "Toybox.WatchUi.LAYOUT_HALIGN_CENTER",
+  "Toybox.WatchUi.LAYOUT_HALIGN_START",
+  "Toybox.WatchUi.LAYOUT_HALIGN_LEFT",
+];
+
+;// CONCATENATED MODULE: external "./sdk-util.cjs"
+const external_sdk_util_cjs_namespaceObject = require("./sdk-util.cjs");
 ;// CONCATENATED MODULE: ./src/api.js
 
 
@@ -777,7 +871,8 @@ async function optimizeMonkeyC(fileNames, buildConfig) {
 
 
 
-const api_LiteralIntegerRe = /^(0x[0-9a-f]+|\d+)(l)?$/;
+
+const api_LiteralIntegerRe = /^(0x[0-9a-f]+|\d+)(l)?$/i;
 /*
  * This is an unfortunate hack. I want to be able to extract things
  * like the types of all of a Class's variables (in particular the type
@@ -793,7 +888,7 @@ async function api_getApiMapping(state) {
   // get the path to the currently active sdk
   const parser = prettier_plugin_monkeyc_namespaceObject.parsers.monkeyc;
 
-  const sdk = await (0,external_util_cjs_namespaceObject.getSdkPath)();
+  const sdk = await (0,external_sdk_util_cjs_namespaceObject.getSdkPath)();
 
   const api = (await promises_namespaceObject.readFile(`${sdk}bin/api.mir`))
     .toString()