@markw65/monkeyc-optimizer 1.1.62 → 1.1.63

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to the "monkeyc-optimizer" package will be documented in this file.
 
+### 1.1.63
+
+- Fixes #31 again, after the fix for #35 broke it
+- Adds some example code in the README, describing how to use the project without `@markw65/prettier-extension-monkeyc`, or `VSCode`
+
 ### 1.1.62
 
 - Update to [@markw65/prettier-plugin-monkeyc@1.0.58](https://github.com/markw65/prettier-plugin-monkeyc/blob/main/CHANGELOG.md#1058)

package/README.md

@@ -4,7 +4,7 @@ This package provides a set of utilities for working with Garmin Monkey-C projec
 
 #### Optimization and analysis
 
-Its primary purpose is to serve as the optimization and analysis engine behind [prettier-extension-monkeyc](https://marketplace.visualstudio.com/items?itemName=markw65.prettier-extension-monkeyc). Although it could be used separately to optimize and analyze Monkey-C projects, most of the API is not expected to be stable (ie it will change as required by `prettier-extension-monkeyc`).
+Its primary purpose is to serve as the optimization and analysis engine behind [prettier-extension-monkeyc](https://marketplace.visualstudio.com/items?itemName=markw65.prettier-extension-monkeyc), but it's [API](#api) can also be used to optimize code directly.
 
 #### Font analysis
 
@@ -13,3 +13,85 @@ It also provides a tool to report information about the builtin fonts on a devic
 ## Release Notes
 
 See [Change Log](CHANGELOG.md)
+
+## API
+
+First you will need to [install nodejs/npm](https://nodejs.org/en/download).
+
+Then you can install the package. From the directory where you want to use it:
+
+```
+npm install -D @markw65/monkeyc-optimizer
+```
+
+Then you need some javascript (or typescript) to invoke it. Here's a sample
+
+```js
+import { buildOptimizedProject, getConfig } from "@markw65/monkeyc-optimizer";
+import { optimizeProgram } from "@markw65/monkeyc-optimizer/sdk-util.js";
+import * as path from "node:path";
+
+const jungleFiles = process.argv[2];
+const workspace = path.dirname(jungleFiles);
+
+getConfig({
+  // These are largely the same options that can be passed to tasks in
+  // @markw65/prettier-extension-monkeyc (see the descriptions there)
+  // getConfig will read a number of options (such as developerKeyPath)
+  // from the vscode user settings, and the project settings, but anything
+  // passed in here will override those values.
+  //
+  // The root that output paths are relative to
+  // Defaults to the current directory
+  workspace,
+  // Where to put the files built by MonkeyC.
+  // Defaults to bin. Relative paths are relative to workspace
+  buildDir: "bin",
+  // Where to put the files generated by the source-to-source optimizer
+  // Defaults to bin/optimized. Relative paths are relative to workspace
+  outputPath: "bin/optimized",
+  // Semi-colon separated list of jungle files
+  jungleFiles,
+  // If true, don't actually run the MonkeyC compiler, just return the
+  // command to do so.
+  returnCommand: false,
+}).then((options) =>
+  // Passing null instead of a device id will build an .iq file
+  buildOptimizedProject("fr955", options)
+    .then((result) => {
+      // The return value includes:
+      //
+      // exe - the executable to run to build the generated code ('java')
+      // args - the arguments to pass to exe
+      // diagnostics - collection of diagnostics raised by monkeyc-optimizer
+      // program - the program that was generated by monkeyc (or that would
+      //           be generated, if returnCommand is true)
+      // product - the device that was targeted.
+      // hasTests - true if any functions marked by (:test) were found
+
+      // If you passed `returnCommand: true` above, you would want
+      // to execute (exe, args) here
+      console.log(`Built: ${result.program}`);
+      return result;
+    })
+    .then((result) =>
+      optimizeProgram(
+        // program to optimize
+        result.program,
+        options.developerKeyPath,
+        // output program. default will insert ".opt" before the input's extension
+        // so foo.prg => foo.opt.prg, and foo.iq => foo.opt.iq
+        undefined,
+        // A few of the BuildConfig options apply to the post build optimizer
+        options
+      )
+    )
+    .then(({ output }) => console.log(`Optimized: ${output}`))
+);
+```
+
+If you save the above as `optimize.mjs`, you can then optimize a project via:
+
+```
+node optimize.mjs path-to-my-project-monkey.jungle
+```

package/build/api.cjs

@@ -18,47 +18,47 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var api_exports = {};
 __export(api_exports, {
-  checkCompilerVersion: () => import_chunk_WVEFLPTH.checkCompilerVersion,
-  collectNamespaces: () => import_chunk_WVEFLPTH.collectNamespaces,
-  createDocumentationMap: () => import_chunk_WVEFLPTH.createDocumentationMap,
-  diagnostic: () => import_chunk_WVEFLPTH.diagnostic,
-  diagnosticHelper: () => import_chunk_WVEFLPTH.diagnosticHelper,
-  findNamesInScope: () => import_chunk_WVEFLPTH.findNamesInScope,
-  findUsingForNode: () => import_chunk_WVEFLPTH.findUsingForNode,
-  formatAst: () => import_chunk_WVEFLPTH.formatAst,
-  formatAstLongLines: () => import_chunk_WVEFLPTH.formatAstLongLines,
-  formatScopedName: () => import_chunk_WVEFLPTH.formatScopedName,
-  getApiFunctionInfo: () => import_chunk_WVEFLPTH.getApiFunctionInfo,
-  getApiMapping: () => import_chunk_WVEFLPTH.getApiMapping,
-  getSuperClasses: () => import_chunk_WVEFLPTH.getSuperClasses,
+  checkCompilerVersion: () => import_chunk_Y2ZRISYL.checkCompilerVersion,
+  collectNamespaces: () => import_chunk_Y2ZRISYL.collectNamespaces,
+  createDocumentationMap: () => import_chunk_Y2ZRISYL.createDocumentationMap,
+  diagnostic: () => import_chunk_Y2ZRISYL.diagnostic,
+  diagnosticHelper: () => import_chunk_Y2ZRISYL.diagnosticHelper,
+  findNamesInScope: () => import_chunk_Y2ZRISYL.findNamesInScope,
+  findUsingForNode: () => import_chunk_Y2ZRISYL.findUsingForNode,
+  formatAst: () => import_chunk_Y2ZRISYL.formatAst,
+  formatAstLongLines: () => import_chunk_Y2ZRISYL.formatAstLongLines,
+  formatScopedName: () => import_chunk_Y2ZRISYL.formatScopedName,
+  getApiFunctionInfo: () => import_chunk_Y2ZRISYL.getApiFunctionInfo,
+  getApiMapping: () => import_chunk_Y2ZRISYL.getApiMapping,
+  getSuperClasses: () => import_chunk_Y2ZRISYL.getSuperClasses,
   hasProperty: () => import_chunk_MBTLUWXR.hasProperty,
-  isClassVariable: () => import_chunk_WVEFLPTH.isClassVariable,
-  isLocal: () => import_chunk_WVEFLPTH.isLocal,
-  isLookupCandidate: () => import_chunk_WVEFLPTH.isLookupCandidate,
-  isStateNode: () => import_chunk_WVEFLPTH.isStateNode,
-  lookupByFullName: () => import_chunk_WVEFLPTH.lookupByFullName,
-  lookupNext: () => import_chunk_WVEFLPTH.lookupNext,
-  lookupResultContains: () => import_chunk_WVEFLPTH.lookupResultContains,
-  lookupWithType: () => import_chunk_WVEFLPTH.lookupWithType,
-  makeToyboxLink: () => import_chunk_WVEFLPTH.makeToyboxLink,
-  mapVarDeclsByType: () => import_chunk_WVEFLPTH.mapVarDeclsByType,
-  markInvokeClassMethod: () => import_chunk_WVEFLPTH.markInvokeClassMethod,
-  parseSdkVersion: () => import_chunk_WVEFLPTH.parseSdkVersion,
-  resolveDiagnostics: () => import_chunk_WVEFLPTH.resolveDiagnostics,
-  resolveDiagnosticsMap: () => import_chunk_WVEFLPTH.resolveDiagnosticsMap,
-  sameLookupResult: () => import_chunk_WVEFLPTH.sameLookupResult,
+  isClassVariable: () => import_chunk_Y2ZRISYL.isClassVariable,
+  isLocal: () => import_chunk_Y2ZRISYL.isLocal,
+  isLookupCandidate: () => import_chunk_Y2ZRISYL.isLookupCandidate,
+  isStateNode: () => import_chunk_Y2ZRISYL.isStateNode,
+  lookupByFullName: () => import_chunk_Y2ZRISYL.lookupByFullName,
+  lookupNext: () => import_chunk_Y2ZRISYL.lookupNext,
+  lookupResultContains: () => import_chunk_Y2ZRISYL.lookupResultContains,
+  lookupWithType: () => import_chunk_Y2ZRISYL.lookupWithType,
+  makeToyboxLink: () => import_chunk_Y2ZRISYL.makeToyboxLink,
+  mapVarDeclsByType: () => import_chunk_Y2ZRISYL.mapVarDeclsByType,
+  markInvokeClassMethod: () => import_chunk_Y2ZRISYL.markInvokeClassMethod,
+  parseSdkVersion: () => import_chunk_Y2ZRISYL.parseSdkVersion,
+  resolveDiagnostics: () => import_chunk_Y2ZRISYL.resolveDiagnostics,
+  resolveDiagnosticsMap: () => import_chunk_Y2ZRISYL.resolveDiagnosticsMap,
+  sameLookupResult: () => import_chunk_Y2ZRISYL.sameLookupResult,
   traverseAst: () => import_chunk_MBTLUWXR.traverseAst,
-  variableDeclarationName: () => import_chunk_WVEFLPTH.variableDeclarationName,
-  visitReferences: () => import_chunk_WVEFLPTH.visitReferences,
-  visit_resources: () => import_chunk_WVEFLPTH.visit_resources,
-  visitorNode: () => import_chunk_WVEFLPTH.visitorNode
+  variableDeclarationName: () => import_chunk_Y2ZRISYL.variableDeclarationName,
+  visitReferences: () => import_chunk_Y2ZRISYL.visitReferences,
+  visit_resources: () => import_chunk_Y2ZRISYL.visit_resources,
+  visitorNode: () => import_chunk_Y2ZRISYL.visitorNode
 });
 module.exports = __toCommonJS(api_exports);
-var import_chunk_WVEFLPTH = require("./chunk-WVEFLPTH.cjs");
+var import_chunk_Y2ZRISYL = require("./chunk-Y2ZRISYL.cjs");
 var import_chunk_SG7ODKRM = require("./chunk-SG7ODKRM.cjs");
 var import_chunk_MBTLUWXR = require("./chunk-MBTLUWXR.cjs");
 var import_chunk_ABYVSU2C = require("./chunk-ABYVSU2C.cjs");
-(0, import_chunk_WVEFLPTH.init_api)();
+(0, import_chunk_Y2ZRISYL.init_api)();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   checkCompilerVersion,

package/build/{chunk-WVEFLPTH.cjs → chunk-Y2ZRISYL.cjs}

@@ -26,8 +26,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var chunk_WVEFLPTH_exports = {};
-__export(chunk_WVEFLPTH_exports, {
+var chunk_Y2ZRISYL_exports = {};
+__export(chunk_Y2ZRISYL_exports, {
   EnumTagsConst: () => EnumTagsConst,
   LastTypeTag: () => LastTypeTag,
   ObjectLikeTagsConst: () => ObjectLikeTagsConst,
@@ -133,7 +133,7 @@ __export(chunk_WVEFLPTH_exports, {
   visitorNode: () => visitorNode,
   xml_util_exports: () => xml_util_exports
 });
-module.exports = __toCommonJS(chunk_WVEFLPTH_exports);
+module.exports = __toCommonJS(chunk_Y2ZRISYL_exports);
 var import_chunk_SG7ODKRM = require("./chunk-SG7ODKRM.cjs");
 var import_chunk_MBTLUWXR = require("./chunk-MBTLUWXR.cjs");
 var import_chunk_ABYVSU2C = require("./chunk-ABYVSU2C.cjs");
@@ -13627,12 +13627,6 @@ function propagateTypes(state, func, graph, optimizeEquivalencies, copyPropStore
         break;
       }
       case "def": {
-        if (uninitClassDecls?.size) {
-          (0, import_chunk_SG7ODKRM.forEach)(
-            event.decl,
-            (decl) => uninitClassDecls.has(decl) && curState.inited?.add(decl)
-          );
-        }
         const lval = event.node.type === "UpdateExpression" ? event.node.argument : event.node.type === "AssignmentExpression" ? event.node.left : null;
         if (lval) {
           if (nodeCopyProp.size && lval.type === "MemberExpression") {
@@ -13799,6 +13793,12 @@ function propagateTypes(state, func, graph, optimizeEquivalencies, copyPropStore
             locals.add(event.decl);
           }
         }
+        if (uninitClassDecls?.size) {
+          (0, import_chunk_SG7ODKRM.forEach)(
+            event.decl,
+            (decl) => uninitClassDecls.has(decl) && curState.inited?.add(decl)
+          );
+        }
         if (logThisRun) {
           (0, import_chunk_SG7ODKRM.log)(
             describeEvent(event).then(
@@ -29218,7 +29218,7 @@ async function generateOneConfig(buildConfig, manifestXML, dependencyFiles, conf
       const opt_time = await (0, import_chunk_SG7ODKRM.first_modified)(
         Object.values(fnMap).map((v) => v.output)
       );
-      if (source_time < opt_time && 1716742569780 < opt_time) {
+      if (source_time < opt_time && 1716827034287 < opt_time) {
         return {
           hasTests,
           diagnostics: prevDiagnostics,
@@ -29257,7 +29257,7 @@ async function generateOneConfig(buildConfig, manifestXML, dependencyFiles, conf
             hasTests: hasTests2,
             diagnostics,
             sdkVersion,
-            optimizerVersion: "1.1.62",
+            optimizerVersion: "1.1.63",
             ...Object.fromEntries(
               configOptionsToCheck.map((option) => [option, config[option]])
             )

package/build/optimizer.cjs

@@ -18,28 +18,28 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var optimizer_exports = {};
 __export(optimizer_exports, {
-  StateNodeAttributes: () => import_chunk_WVEFLPTH.StateNodeAttributes,
-  buildOptimizedProject: () => import_chunk_WVEFLPTH.buildOptimizedProject,
+  StateNodeAttributes: () => import_chunk_Y2ZRISYL.StateNodeAttributes,
+  buildOptimizedProject: () => import_chunk_Y2ZRISYL.buildOptimizedProject,
   copyRecursiveAsNeeded: () => import_chunk_SG7ODKRM.copyRecursiveAsNeeded,
-  defaultConfig: () => import_chunk_WVEFLPTH.defaultConfig,
-  display: () => import_chunk_WVEFLPTH.display,
-  generateOneConfig: () => import_chunk_WVEFLPTH.generateOneConfig,
-  generateOptimizedProject: () => import_chunk_WVEFLPTH.generateOptimizedProject,
-  getConfig: () => import_chunk_WVEFLPTH.getConfig,
-  getProjectAnalysis: () => import_chunk_WVEFLPTH.getProjectAnalysis,
-  get_jungle: () => import_chunk_WVEFLPTH.get_jungle,
-  isErrorWithLocation: () => import_chunk_WVEFLPTH.isErrorWithLocation,
-  launchSimulator: () => import_chunk_WVEFLPTH.launchSimulator,
-  manifestProducts: () => import_chunk_WVEFLPTH.manifestProducts,
-  mctree: () => import_chunk_WVEFLPTH.mctree,
-  simulateProgram: () => import_chunk_WVEFLPTH.simulateProgram
+  defaultConfig: () => import_chunk_Y2ZRISYL.defaultConfig,
+  display: () => import_chunk_Y2ZRISYL.display,
+  generateOneConfig: () => import_chunk_Y2ZRISYL.generateOneConfig,
+  generateOptimizedProject: () => import_chunk_Y2ZRISYL.generateOptimizedProject,
+  getConfig: () => import_chunk_Y2ZRISYL.getConfig,
+  getProjectAnalysis: () => import_chunk_Y2ZRISYL.getProjectAnalysis,
+  get_jungle: () => import_chunk_Y2ZRISYL.get_jungle,
+  isErrorWithLocation: () => import_chunk_Y2ZRISYL.isErrorWithLocation,
+  launchSimulator: () => import_chunk_Y2ZRISYL.launchSimulator,
+  manifestProducts: () => import_chunk_Y2ZRISYL.manifestProducts,
+  mctree: () => import_chunk_Y2ZRISYL.mctree,
+  simulateProgram: () => import_chunk_Y2ZRISYL.simulateProgram
 });
 module.exports = __toCommonJS(optimizer_exports);
-var import_chunk_WVEFLPTH = require("./chunk-WVEFLPTH.cjs");
+var import_chunk_Y2ZRISYL = require("./chunk-Y2ZRISYL.cjs");
 var import_chunk_SG7ODKRM = require("./chunk-SG7ODKRM.cjs");
 var import_chunk_MBTLUWXR = require("./chunk-MBTLUWXR.cjs");
 var import_chunk_ABYVSU2C = require("./chunk-ABYVSU2C.cjs");
-(0, import_chunk_WVEFLPTH.init_optimizer)();
+(0, import_chunk_Y2ZRISYL.init_optimizer)();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   StateNodeAttributes,

package/build/sdk-util.cjs

@@ -18,25 +18,25 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var sdk_util_exports = {};
 __export(sdk_util_exports, {
-  SectionKinds: () => import_chunk_WVEFLPTH.SectionKinds,
-  appSupport: () => import_chunk_WVEFLPTH.appSupport,
-  connectiq: () => import_chunk_WVEFLPTH.connectiq,
-  getDeviceInfo: () => import_chunk_WVEFLPTH.getDeviceInfo,
-  getFunctionDocumentation: () => import_chunk_WVEFLPTH.getFunctionDocumentation,
-  getLanguages: () => import_chunk_WVEFLPTH.getLanguages,
-  getSdkPath: () => import_chunk_WVEFLPTH.getSdkPath,
-  isWin: () => import_chunk_WVEFLPTH.isWin,
-  optimizeProgram: () => import_chunk_WVEFLPTH.optimizeProgram,
-  readPrg: () => import_chunk_WVEFLPTH.readPrg,
-  readPrgWithOffsets: () => import_chunk_WVEFLPTH.readPrgWithOffsets,
-  xmlUtil: () => import_chunk_WVEFLPTH.xml_util_exports
+  SectionKinds: () => import_chunk_Y2ZRISYL.SectionKinds,
+  appSupport: () => import_chunk_Y2ZRISYL.appSupport,
+  connectiq: () => import_chunk_Y2ZRISYL.connectiq,
+  getDeviceInfo: () => import_chunk_Y2ZRISYL.getDeviceInfo,
+  getFunctionDocumentation: () => import_chunk_Y2ZRISYL.getFunctionDocumentation,
+  getLanguages: () => import_chunk_Y2ZRISYL.getLanguages,
+  getSdkPath: () => import_chunk_Y2ZRISYL.getSdkPath,
+  isWin: () => import_chunk_Y2ZRISYL.isWin,
+  optimizeProgram: () => import_chunk_Y2ZRISYL.optimizeProgram,
+  readPrg: () => import_chunk_Y2ZRISYL.readPrg,
+  readPrgWithOffsets: () => import_chunk_Y2ZRISYL.readPrgWithOffsets,
+  xmlUtil: () => import_chunk_Y2ZRISYL.xml_util_exports
 });
 module.exports = __toCommonJS(sdk_util_exports);
-var import_chunk_WVEFLPTH = require("./chunk-WVEFLPTH.cjs");
+var import_chunk_Y2ZRISYL = require("./chunk-Y2ZRISYL.cjs");
 var import_chunk_SG7ODKRM = require("./chunk-SG7ODKRM.cjs");
 var import_chunk_MBTLUWXR = require("./chunk-MBTLUWXR.cjs");
 var import_chunk_ABYVSU2C = require("./chunk-ABYVSU2C.cjs");
-(0, import_chunk_WVEFLPTH.init_sdk_util)();
+(0, import_chunk_Y2ZRISYL.init_sdk_util)();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SectionKinds,

package/build/worker-thread.cjs

@@ -21,17 +21,17 @@ __export(worker_thread_exports, {
   default: () => worker_thread_default
 });
 module.exports = __toCommonJS(worker_thread_exports);
-var import_chunk_WVEFLPTH = require("./chunk-WVEFLPTH.cjs");
+var import_chunk_Y2ZRISYL = require("./chunk-Y2ZRISYL.cjs");
 var import_chunk_SG7ODKRM = require("./chunk-SG7ODKRM.cjs");
 var import_chunk_MBTLUWXR = require("./chunk-MBTLUWXR.cjs");
 var import_chunk_ABYVSU2C = require("./chunk-ABYVSU2C.cjs");
 var import_node_worker_threads = require("node:worker_threads");
 var require_worker_thread = (0, import_chunk_ABYVSU2C.__commonJS)({
   "src/worker-thread.ts"() {
-    (0, import_chunk_WVEFLPTH.init_worker_task)();
+    (0, import_chunk_Y2ZRISYL.init_worker_task)();
     if (import_node_worker_threads.parentPort) {
       import_node_worker_threads.parentPort.on("message", async (task) => {
-        return import_node_worker_threads.parentPort.postMessage(await (0, import_chunk_WVEFLPTH.performTask)(task));
+        return import_node_worker_threads.parentPort.postMessage(await (0, import_chunk_Y2ZRISYL.performTask)(task));
       });
     }
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@markw65/monkeyc-optimizer",
   "type": "commonjs",
-  "version": "1.1.62",
+  "version": "1.1.63",
   "description": "Source to source optimizer for Garmin Monkey C code",
   "main": "build/optimizer.cjs",
   "types": "build/src/optimizer.d.ts",