@microtronics/studio-cli 0.54.0 → 0.55.0

package/out/dde/dde.js

@@ -396,7 +396,7 @@ var DDE;
         const manifest = await manifest_1.Manifest.read(cwd, fs);
         const dependencies = await getDependencies(cwd, fs, manifest);
         const resolvedConfig = await globals_1.Globals.read(cwd, fs, logger);
-        const autoInc = (0, dlo_1.generateAutoIncFromMap)(ddeJSON, resolvedConfig.flat, manifest);
+        const autoInc = (0, dlo_1.generateAutoIncFromMap)(ddeJSON, resolvedConfig, manifest);
         const appAutoDDE = new dlo_1.AutoDDEGenerator(manifest, ddeJSON, null);
         const appDDEInc = appAutoDDE.generate();
         // generate AutoDDe Files for the libraries:

package/out/dde/fileGenerators/dlo.js

@@ -97,7 +97,7 @@ function dloCoreSupportsFlags(manifest) {
     return semver.gte(releaseVersion, '1.1.0');
 }
 // eslint-disable-next-line sonarjs/cognitive-complexity
-function generateAutoIncFromMap(ddeMap, globalDefines, manifest) {
+function generateAutoIncFromMap(ddeMap, resolvedConfig, manifest) {
     const _pwn = []; // sample code output for pawn
     const pwn = _pwn.push.bind(_pwn);
     function pwn_section(s) {
@@ -139,8 +139,24 @@ function generateAutoIncFromMap(ddeMap, globalDefines, manifest) {
     /**
      * generate global dlo defines if there are any
      */
+    const globalDefines = resolvedConfig.flat;
+    const { definesWithSource } = resolvedConfig;
     pwn_section('GLOBAL DEFINES');
     for (const [define, value] of Object.entries(globalDefines)) {
+        const comment = definesWithSource[define]?.comment;
+        if (comment) {
+            const lines = comment.split('\n');
+            if (lines.length === 1) {
+                pwn(`/** ${lines[0]} */`);
+            }
+            else {
+                pwn('/**');
+                for (const line of lines) {
+                    pwn(` * ${line}`);
+                }
+                pwn(' */');
+            }
+        }
         const valueIsDefine = Object.hasOwn(globalDefines, value);
         addDefinition(define, `${value}`, valueIsDefine);
     }

package/out/globals.js

@@ -67,10 +67,10 @@ var Globals;
             const depPath = dependencies_1.Dependencies.dependencyToPath(cwd, dependencyId);
             const name = dependencies_1.Dependencies.dependencyIdToName(dependencyId);
             const libIniPath = vscode_uri_1.Utils.joinPath(depPath, DLO_PATH, `${name}.ini`);
-            await mergeIniFile(fs, libIniPath, allDefines, sections, definesWithSource);
+            await mergeIniFile(fs, libIniPath, allDefines, sections, definesWithSource, name);
             // defaults.ini files
             const libDefaultsPath = vscode_uri_1.Utils.joinPath(depPath, defaultFiles_1.DefaultFiles.filePaths.defaultsIni);
-            await mergeIniFile(fs, libDefaultsPath, allDefines, sections, definesWithSource);
+            await mergeIniFile(fs, libDefaultsPath, allDefines, sections, definesWithSource, name);
         }
         // Load the library project's specific ini file (deprecated location)
         if (manifest_1.Manifest.isLibrary(manifest)) {
@@ -78,7 +78,7 @@ var Globals;
             if (logger && (await fs.stat(libIni))) {
                 logger.warn(`dlo/${manifest.name}.ini is deprecated. Please migrate your defines to defaults.ini in the project root.`);
             }
-            await mergeIniFile(fs, libIni, allDefines, sections, definesWithSource);
+            await mergeIniFile(fs, libIni, allDefines, sections, definesWithSource, manifest.name);
         }
         // Load the project's main.ini and overwrite existing defines (deprecated location)
         const mainIniRelPath = manifest.dlo?.iniFile || defaultFiles_1.DefaultFiles.filePaths.dlo.mainINI;
@@ -86,17 +86,18 @@ var Globals;
         if (logger && (await fs.stat(mainIni))) {
             logger.warn(`${mainIniRelPath} is deprecated. Please migrate your defines to app.ini in the project root.`);
         }
-        await mergeIniFile(fs, mainIni, allDefines, sections, definesWithSource);
+        const mainIniLabel = iniFileLabel(mainIniRelPath);
+        await mergeIniFile(fs, mainIni, allDefines, sections, definesWithSource, mainIniLabel);
         // Project root: defaults.ini (library) or app.ini (app/addon/analytics)
         if (manifest_1.Manifest.isLibrary(manifest)) {
             const defaultsIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.defaultsIni);
-            await mergeIniFile(fs, defaultsIni, allDefines, sections, definesWithSource);
+            await mergeIniFile(fs, defaultsIni, allDefines, sections, definesWithSource, 'defaults');
         }
         // Snapshot defaults-only state before app.ini merge (for library dual-defines)
         const defaultsOnly = snapshotDefaultsOnly(manifest, allDefines, sections, definesWithSource);
         // app.ini is always loaded (provides local dev overrides for libraries, main config for apps)
         const appIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.appIni);
-        await mergeIniFile(fs, appIni, allDefines, sections, definesWithSource);
+        await mergeIniFile(fs, appIni, allDefines, sections, definesWithSource, 'app');
         return { flat: allDefines, sections, definesWithSource, defaultsOnly };
     }
     Globals.read = read;
@@ -269,10 +270,35 @@ function formatJsDoc(comment) {
 function isNumericValue(value) {
     return value !== '' && !isNaN(Number(value));
 }
+/**
+ * Derive a human-readable source label from an ini file path.
+ * Strips the directory prefix and `.ini` extension.
+ * E.g. `dlo/main.ini` → `main`, `app.ini` → `app`.
+ */
+function iniFileLabel(relPath) {
+    const filename = relPath.split('/').pop() || relPath;
+    return filename.replace(/\.ini$/i, '');
+}
+/**
+ * Merge an incoming comment with an existing one.
+ *
+ * - Both present  → join existing (already prefixed) and new (prefixed) with `\n`
+ * - Only existing → keep it
+ * - Only new      → use it (prefixed)
+ * - Neither       → undefined
+ */
+function mergeComment(existingComment, newRawComment, sourceLabel) {
+    const prefixedNew = newRawComment ? `${sourceLabel}: ${newRawComment}` : undefined;
+    if (existingComment && prefixedNew) {
+        return `${existingComment}\n${prefixedNew}`;
+    }
+    return prefixedNew || existingComment;
+}
 /**
  * Create a DefineEntry, attaching a comment from the comment map if available.
+ * The comment is prefixed with the source label for provenance tracking.
  */
-function createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap) {
+function createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap, sourceLabel) {
     const flatKey = sectionName ? `${sectionName}_${key}` : key;
     const entry = {
         value: stringValue,
@@ -280,23 +306,26 @@ function createDefineEntry(stringValue, fileUri, lines, key, sectionName, commen
         sourceLine: findLineNumber(lines, key, sectionName)
     };
     if (commentMap[flatKey]) {
-        entry.comment = commentMap[flatKey];
+        entry.comment = `${sourceLabel}: ${commentMap[flatKey]}`;
     }
     return entry;
 }
 /**
  * Merge all keys from a parsed ini section into the accumulators.
  */
-function mergeSectionEntries(sectionName, sectionData, allDefines, sections, definesWithSource, fileUri, lines, commentMap) {
+function mergeSectionEntries(sectionName, sectionData, allDefines, sections, definesWithSource, fileUri, lines, commentMap, sourceLabel) {
     if (!sections[sectionName]) {
         sections[sectionName] = {};
     }
     for (const [key, sectionValue] of Object.entries(sectionData)) {
         const flatKey = `${sectionName}_${key}`;
+        const rawComment = commentMap[flatKey];
         const stringValue = `${sectionValue}`;
         allDefines[flatKey] = stringValue;
         sections[sectionName][key] = stringValue;
-        definesWithSource[flatKey] = createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap);
+        const newEntry = createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap, sourceLabel);
+        newEntry.comment = mergeComment(definesWithSource[flatKey]?.comment, rawComment, sourceLabel);
+        definesWithSource[flatKey] = newEntry;
     }
 }
 /**
@@ -309,7 +338,7 @@ function mergeSectionEntries(sectionName, sectionData, allDefines, sections, def
  * @param sections - accumulated sectioned config (mutated)
  * @param definesWithSource - accumulated source tracking (mutated)
  */
-async function mergeIniFile(fs, filePath, allDefines, sections, definesWithSource) {
+async function mergeIniFile(fs, filePath, allDefines, sections, definesWithSource, sourceLabel) {
     // early return if the file doesn't exist
     if (!(await fs.stat(filePath))) {
         return;
@@ -322,12 +351,15 @@ async function mergeIniFile(fs, filePath, allDefines, sections, definesWithSourc
     const commentMap = extractComments(rawText);
     for (const [sectionOrKey, value] of Object.entries(parsed)) {
         if (typeof value === 'object' && value !== null) {
-            mergeSectionEntries(sectionOrKey, value, allDefines, sections, definesWithSource, fileUri, lines, commentMap);
+            mergeSectionEntries(sectionOrKey, value, allDefines, sections, definesWithSource, fileUri, lines, commentMap, sourceLabel);
         }
         else {
+            const rawComment = commentMap[sectionOrKey];
             const stringValue = `${value}`;
             allDefines[sectionOrKey] = stringValue;
-            definesWithSource[sectionOrKey] = createDefineEntry(stringValue, fileUri, lines, sectionOrKey, null, commentMap);
+            const newEntry = createDefineEntry(stringValue, fileUri, lines, sectionOrKey, null, commentMap, sourceLabel);
+            newEntry.comment = mergeComment(definesWithSource[sectionOrKey]?.comment, rawComment, sourceLabel);
+            definesWithSource[sectionOrKey] = newEntry;
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@microtronics/studio-cli",
-	"version": "0.54.0",
+	"version": "0.55.0",
 	"description": "Microtronics Studio CLI Tool",
 	"main": "./out/api.js",
 	"typings": "./dist/studio-cli.d.ts",