@microtronics/studio-cli 0.32.2 → 0.33.0

package/CHANGELOG.md

@@ -1,10 +1,21 @@
+# Changelog
 
-
-## 0.32.2 (2025-06-02)
-
+## 0.33.0 (2025-09-01)
 
-### Bug Fixes
+### Features
 
+* **cli:** add description to CLI tool usage ([97e8562](https://bitbucket.org/microtronics-core/vscode-studio/commits/97e85625a7c6d11070e2713f3ec3d2c24691854a))
+* **cli:** add support for parsing unknown long options ([fa6523c](https://bitbucket.org/microtronics-core/vscode-studio/commits/fa6523caef791d508b31ed5d563452b616e99ae0))
+* **cli:** support custom ini file in manifest ([5ae2741](https://bitbucket.org/microtronics-core/vscode-studio/commits/5ae2741ad379258fee95311fd28acc8b3dd1bdb6))
+* **cli:** support manifest overwrites with deep merge ([10b69e2](https://bitbucket.org/microtronics-core/vscode-studio/commits/10b69e29c9426bec08022610b66e85b86cee79c9))
+
+## 0.32.3 (2025-06-11)
+
+## 0.32.2 (2025-06-02)
+
+
+### Bug Fixes
+
 * **studio-cli:** improve semver validation in dependency check ([2238827](https://bitbucket.org/microtronics-core/vscode-studio/commits/2238827380cdbe56fa5798c6de50c284df4da4c7))
 
 ## 0.32.1 (2025-06-02)
@@ -183,7 +194,7 @@
 
 ## 0.19.1 (2025-02-20)
 
-# Changelog
+
 
 ## 0.19.0 (2025-02-19)
 

package/dist/studio-cli.d.ts

@@ -2196,6 +2196,7 @@ export declare namespace Manifest {
         dlo?: {
             mainFile: string;
             compileOptions: string[];
+            iniFile?: string;
         };
         registry?: {
             id?: string;
@@ -2234,6 +2235,8 @@ export declare namespace Manifest {
         embedded = "$embedded",
         pure = "$pure"
     }
+    export function setOverwrites(manifest: Partial<Manifest.Manifest> | null): void;
+    export function clearOverwrites(): void;
     /**
      * Read the studio.json manifest and parse it
      * @param cwd

package/out/argumentParser.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseUnknownLongOptions = parseUnknownLongOptions;
+/**
+ * Set a nested value in an object by a dot-separated path.
+ * Example: setByDotPath(obj, 'dlo.mainFile', 'x') => obj = { dlo: { mainFile: 'x' } }
+ */
+function setByDotPath(target, path, value) {
+    const parts = path.split('.').filter(Boolean);
+    let cur = target;
+    for (let i = 0; i < parts.length; i++) {
+        const key = parts[i];
+        const isLeaf = i === parts.length - 1;
+        if (isLeaf) {
+            cur[key] = value;
+        }
+        else {
+            if (typeof cur[key] !== 'object' || cur[key] === null || Array.isArray(cur[key])) {
+                cur[key] = {};
+            }
+            cur = cur[key];
+        }
+    }
+}
+/**
+ * Parse unknown long options (starting with `--`) into a key/value object.
+ * - Supports `--key=value` and `--key value`
+ */
+function parseUnknownLongOptions(command) {
+    const argv = command.args;
+    const result = {};
+    for (let i = 0; i < argv.length; i++) {
+        const token = argv[i];
+        // Only process long options that start with `--`
+        if (!token || !token.startsWith('--')) {
+            continue;
+        }
+        // Split inline assignment: --key=value
+        const [flag, inlineVal] = token.split('=', 2);
+        // Unknown option: collect it
+        const key = flag.slice(2); // remove leading '--'
+        let value = true;
+        if (inlineVal !== undefined) {
+            value = inlineVal;
+        }
+        else {
+            // If next token exists and doesn't look like another flag, use it as the value
+            const next = argv[i + 1];
+            if (next && !next.startsWith('-')) {
+                value = next;
+                i++; // consume the value
+            }
+        }
+        // Dot-notation => nested object
+        if (key.includes('.')) {
+            setByDotPath(result, key, value);
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=argumentParser.js.map

package/out/globals.js

@@ -71,7 +71,7 @@ var Globals;
             }
         }
         // load the projects main.ini and overwrite existing defines
-        const mainIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dlo.mainINI);
+        const mainIni = vscode_uri_1.Utils.joinPath(cwd, manifest.dlo?.iniFile || defaultFiles_1.DefaultFiles.filePaths.dlo.mainINI);
         if (await fs.stat(mainIni)) {
             const iniContent = await readIniFile(fs, mainIni);
             Object.assign(allDefines, iniContent);

package/out/main.js

@@ -12,6 +12,7 @@ const globals_1 = require("./globals");
 const update_notifier_1 = __importDefault(require("update-notifier"));
 const api_1 = require("./api");
 const log_1 = require("./log");
+const argumentParser_1 = require("./argumentParser");
 const program = new commander_1.Command();
 const notifier = (0, update_notifier_1.default)({ pkg: package_json_1.default });
 const logger = new log_1.Log.Logger();
@@ -30,14 +31,21 @@ const devPath = () => {
 };
 const cwd = vscode_uri_1.Utils.joinPath(vscode_uri_1.URI.file(process.cwd()), devPath());
 program.version(package_json_1.default.version).usage('<command>');
+program.description('This tool is used to manage the project dependencies, build, package and publish the project.\n' +
+    'The manifest options can be overwritten with the --option=value syntax.\n' +
+    'Example: "studio build --dlo.mainFile="./dlo/test.dlo" will overwrite the dlo.mainFile option of the manifest.\n' +
+    '\nUse "studio --help" for more information.');
 /**
  * Executes a task and ensures that the update available notification is sent after the task completes,
  * regardless of whether it succeeds or fails.
  *
+ * @param command
  * @param {Promise<void>} task - A promise representing the task to be executed.
  * @return {void} This function does not return a value.
  */
-function main(task) {
+function main(command, task) {
+    const manifestOptions = (0, argumentParser_1.parseUnknownLongOptions)(command);
+    api_1.Manifest.setOverwrites(manifestOptions);
     // todo add task catch handler like: https://github.com/microsoft/vscode-vsce/blob/5518f2f242983d23f1983f6dd0350474f2011543/src/main.ts#L51
     task.finally(() => {
         notifier.notify();
@@ -94,9 +102,10 @@ program
     .allowExcessArguments(true)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
-    .action((dependencies, opts) => {
+    .allowUnknownOption(true)
+    .action((dependencies, opts, command) => {
     const { env, token } = getDefaultOptions(opts);
-    main((0, api_1.install)(cwd, cliFS_1.cliFS, env, token, dependencies));
+    main(command, (0, api_1.install)(cwd, cliFS_1.cliFS, env, token, dependencies));
 });
 program
     .command('build')
@@ -104,9 +113,10 @@ program
     .allowExcessArguments(true)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
-    .action(opts => {
+    .allowUnknownOption(true)
+    .action((opts, command) => {
     const { env, token } = getDefaultOptions(opts);
-    main((0, api_1.build)(cwd, cliFS_1.cliFS, logger, env, token, opts.part));
+    main(command, (0, api_1.build)(cwd, cliFS_1.cliFS, logger, env, token, opts.part));
 });
 program
     .command('publish')
@@ -114,10 +124,11 @@ program
     .addOption(optionAllowedBackends)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
+    .allowUnknownOption(true)
     .option('-i, --packagePath <path>', 'Publish the provided library or app package. Use "*" for autodetection.')
-    .action(async (opts) => {
+    .action(async (opts, command) => {
     const { env, token } = getDefaultOptions(opts);
-    main((0, api_1.publish)(cwd, cliFS_1.cliFS, logger, env, token, opts.allowedBackends, opts.phase, opts.packagePath));
+    main(command, (0, api_1.publish)(cwd, cliFS_1.cliFS, logger, env, token, opts.allowedBackends, opts.phase, opts.packagePath));
 });
 program
     .command('package')
@@ -126,9 +137,10 @@ program
     .addOption(optionReleasePhase)
     .addOption(optionStudioEnv)
     .addOption(optionStudioToken)
-    .action(async (opts) => {
+    .allowUnknownOption(true)
+    .action(async (opts, command) => {
     const { env, token } = getDefaultOptions(opts);
-    main((0, api_1.pack)(cwd, cliFS_1.cliFS, logger, env, token, opts.phase));
+    main(command, (0, api_1.pack)(cwd, cliFS_1.cliFS, logger, env, token, opts.phase));
 });
 module.exports = function (argv) {
     program.parse(argv);

package/out/manifest.js

@@ -10,9 +10,9 @@ const image_dimensions_1 = require("image-dimensions");
 const file_type_checker_1 = require("file-type-checker");
 const registryAPI_1 = require("./registryAPI");
 const preload_1 = __importDefault(require("semver/preload"));
-const DeviceProfiles_1 = require("./DeviceProfiles");
 const apm_1 = require("./package/apm");
 var isNumeric = helper_1.Helper.isNumeric;
+const deepmerge_ts_1 = require("deepmerge-ts");
 const PRODUCT_ID_SUPPORTED = '52v007';
 const SEMVER_SUPPORTED = '53v001';
 const ADDON_SUPPORTED = '54v001';
@@ -20,13 +20,17 @@ const ADDON_SUPPORTED = '54v001';
 const manifestCache = {
     _manifest: null,
     _stat: null,
+    _overwrites: null,
     get manifest() {
         // clone the cached object to prevent any reference changes
-        return structuredClone(this._manifest);
+        return (0, deepmerge_ts_1.deepmerge)(structuredClone(this._manifest), manifestCache._overwrites || {});
     },
     set manifest(manifest) {
         this._manifest = manifest;
     },
+    set overwrites(manifest) {
+        this._overwrites = manifest;
+    },
     get stat() {
         return this._stat;
     },
@@ -73,6 +77,14 @@ var Manifest;
         PovLocation["embedded"] = "$embedded";
         PovLocation["pure"] = "$pure";
     })(PovLocation = Manifest.PovLocation || (Manifest.PovLocation = {}));
+    function setOverwrites(manifest) {
+        manifestCache.overwrites = manifest;
+    }
+    Manifest.setOverwrites = setOverwrites;
+    function clearOverwrites() {
+        manifestCache.overwrites = null;
+    }
+    Manifest.clearOverwrites = clearOverwrites;
     /**
      * Read the studio.json manifest and parse it
      * @param cwd
@@ -112,8 +124,6 @@ var Manifest;
      */
     async function write(cwd, fs, manifest) {
         manifestCache.clear();
-        // patch the options if they are not valid for a specific device profile
-        patchDloCompileOptionsBasedOnDpid(manifest);
         removeDeprecatedOptions(manifest);
         return fs.writeFile(vscode_uri_1.Utils.joinPath(cwd, Manifest.fileName), JSON.stringify(manifest, null, '\t'));
     }
@@ -425,32 +435,6 @@ function validateProjectVersion(manifest) {
         }
     }
 }
-/**
- * Some devices doesn't support compression. this function does patch the option if it's not supported
- * @param manifest
- */
-function patchDloCompileOptionsBasedOnDpid(manifest) {
-    if (!manifest.dpid) {
-        return;
-    }
-    const deviceProfile = DeviceProfiles_1.DeviceProfiles[manifest.dpid];
-    const compileRestrictions = deviceProfile?.dlo?.compileRestrictions || {};
-    const { compileOptions } = manifest.dlo || {};
-    if (compileOptions) {
-        compileOptions.forEach((param, idx) => {
-            try {
-                const paramType = param.substring(0, 2);
-                const paramValue = param.substring(2);
-                if (Object.hasOwn(compileRestrictions, paramType) && `${paramValue}` !== `${compileRestrictions[paramType]}`) {
-                    compileOptions[idx] = `${paramType}${compileRestrictions[paramType]}`;
-                }
-            }
-            catch (e) {
-                // todo?
-            }
-        });
-    }
-}
 function removeDeprecatedOptions(manifest) {
     if (manifest.registry) {
         delete manifest.registry.allowedBackends;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.32.2",
+	"version": "0.33.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",
@@ -25,12 +25,14 @@
 	"author": "Microtronics",
 	"license": "ISC",
 	"dependencies": {
+		"@gera2ld/tarjs": "^0.3.1",
 		"ajv": "^8.17.1",
 		"ajv-formats": "^3.0.1",
 		"ajv-keywords": "^5.1.0",
 		"chalk": "^5.4.1",
 		"commander": "^12.1.0",
 		"cross-fetch": "^4.0.0",
+		"deepmerge-ts": "^7.1.5",
 		"dotenv": "^16.4.7",
 		"file-type-checker": "^1.1.2",
 		"glob": "^11.0.1",
@@ -41,7 +43,6 @@
 		"openapi-fetch": "^0.13.0",
 		"pako": "^2.1.0",
 		"semver": "^7.7.2",
-		"@gera2ld/tarjs": "^0.3.1",
 		"tinytar-fix": "^0.1.1",
 		"update-notifier": "^7.3.1",
 		"vscode-uri": "^3.0.8",