@microtronics/studio-cli 0.51.0 → 0.52.0

package/out/dde/fileGenerators/dlo.js

@@ -139,7 +139,7 @@ function generateAutoIncFromMap(ddeMap, globalDefines, manifest) {
     /**
      * generate global dlo defines if there are any
      */
-    pwn_section('GLOBAL DEFINES - parsed from /dlo/main.ini');
+    pwn_section('GLOBAL DEFINES');
     for (const [define, value] of Object.entries(globalDefines)) {
         const valueIsDefine = Object.hasOwn(globalDefines, value);
         addDefinition(define, `${value}`, valueIsDefine);

package/out/defaultFiles.js

@@ -72,7 +72,8 @@ var DefaultFiles;
             dfilesPath: `${deployDirectoryName}dfiles`,
             dfilesProperties: `${deployDirectoryName}dfiles/properties.json`,
             bloPath: `${deployDirectoryName}blo`,
-            reportTemplate: `${deployDirectoryName}/${DefaultFiles.fileNames.reportTemplate}`
+            reportTemplate: `${deployDirectoryName}/${DefaultFiles.fileNames.reportTemplate}`,
+            definesTs: `${deployDirectoryName}defines.ts`
         },
         dlo: {
             path: dloDirectoryName,
@@ -86,7 +87,9 @@ var DefaultFiles;
         dfiles: {
             path: dfilesDirectoryName,
             mainDFILES: `${dfilesDirectoryName}/main.dfiles`
-        }
+        },
+        appIni: 'app.ini',
+        defaultsIni: 'defaults.ini'
     };
     /**
      * Changelog.md

package/out/globals.js

@@ -44,49 +44,311 @@ var Globals;
         ENV["production"] = "production";
     })(ENV = Globals.ENV || (Globals.ENV = {}));
     /**
-     * Read all ini files from the project directory
-     * @param cwd
-     * @param fs
+     * Read all ini files from the project directory and its dependencies.
+     *
+     * Merge order (lowest → highest priority):
+     *   Library dlo/<name>.ini & defaults.ini (from each installed dependency)
+     *   Project dlo/<name>.ini (library projects only)
+     *   Project dlo/main.ini (or manifest dlo.iniFile override)
+     *   Project defaults.ini (library) or app.ini (app/addon/analytics)
+     *
+     * @param cwd - project root URI
+     * @param fs - filesystem abstraction
+     * @param logger
      */
-    async function read(cwd, fs) {
+    async function read(cwd, fs, logger) {
         const manifest = await manifest_1.Manifest.read(cwd, fs);
         const allDependencies = await dependencies_1.Dependencies.getAll(manifest);
         const allDefines = {};
+        const sections = {};
+        const definesWithSource = {};
+        // Library dlo/<name>.ini and default.ini files
         for (const dependencyId in allDependencies) {
             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`);
-            const hasIni = await fs.stat(libIniPath);
-            if (hasIni) {
-                const iniContent = await readIniFile(fs, libIniPath);
-                Object.assign(allDefines, iniContent);
-            }
+            await mergeIniFile(fs, libIniPath, allDefines, sections, definesWithSource);
+            // defaults.ini files
+            const libDefaultsPath = vscode_uri_1.Utils.joinPath(depPath, defaultFiles_1.DefaultFiles.filePaths.defaultsIni);
+            await mergeIniFile(fs, libDefaultsPath, allDefines, sections, definesWithSource);
         }
-        // load the library projects specific ini file
+        // Load the library project's specific ini file (deprecated location)
         if (manifest_1.Manifest.isLibrary(manifest)) {
             const libIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dlo.path, `${manifest.name}.ini`);
-            if (await fs.stat(libIni)) {
-                const iniContent = await readIniFile(fs, libIni);
-                Object.assign(allDefines, iniContent);
+            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);
+        }
+        // Load the project's main.ini and overwrite existing defines (deprecated location)
+        const mainIniRelPath = manifest.dlo?.iniFile || defaultFiles_1.DefaultFiles.filePaths.dlo.mainINI;
+        const mainIni = vscode_uri_1.Utils.joinPath(cwd, mainIniRelPath);
+        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);
+        // 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);
         }
-        // load the projects main.ini and overwrite existing defines
-        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);
+        else {
+            const appIni = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.appIni);
+            await mergeIniFile(fs, appIni, allDefines, sections, definesWithSource);
         }
-        return allDefines;
+        return { flat: allDefines, sections, definesWithSource };
     }
     Globals.read = read;
+    /**
+     * Generate a dist/defines.ts file from the resolved config.
+     * The generated file creates/extends globalThis.STUDIO_DEFINES.
+     *
+     * @param cwd - project root URI
+     * @param fs - filesystem abstraction
+     * @param resolvedConfig - the resolved config from Globals.read()
+     */
+    async function exportDefinesTs(cwd, fs, resolvedConfig) {
+        const entries = Object.entries(resolvedConfig.flat);
+        // Build the StudioDefines interface members
+        const interfaceLines = [];
+        for (const [key, value] of entries) {
+            const entry = resolvedConfig.definesWithSource[key];
+            if (entry?.comment) {
+                const jsDoc = formatJsDoc(entry.comment);
+                for (const docLine of jsDoc.split('\n')) {
+                    interfaceLines.push(`\t\t${docLine}`);
+                }
+            }
+            const tsType = isNumericValue(value) ? 'number' : 'string';
+            interfaceLines.push(`\t\t${key}: ${tsType};`);
+        }
+        const lines = [
+            '// Auto-generated by @microtronics/studio-cli \u2014 DO NOT EDIT',
+            'declare global {',
+            '\tinterface StudioDefines {',
+            ...interfaceLines,
+            '\t}',
+            '\tvar STUDIO_DEFINES: StudioDefines;',
+            '}',
+            '',
+            'globalThis.STUDIO_DEFINES ??= {} as StudioDefines;',
+            ''
+        ];
+        for (const [key, value] of entries) {
+            const entry = resolvedConfig.definesWithSource[key];
+            if (entry?.comment) {
+                lines.push(formatJsDoc(entry.comment));
+            }
+            if (isNumericValue(value)) {
+                lines.push(`globalThis.STUDIO_DEFINES['${key}'] = ${Number(value)};`);
+            }
+            else {
+                const escapedValue = value.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
+                lines.push(`globalThis.STUDIO_DEFINES['${key}'] = '${escapedValue}';`);
+            }
+        }
+        lines.push('');
+        lines.push('export {};');
+        lines.push('');
+        const definesPath = vscode_uri_1.Utils.joinPath(cwd, defaultFiles_1.DefaultFiles.filePaths.dist.definesTs);
+        await fs.writeFile(definesPath, lines.join('\n'));
+    }
+    Globals.exportDefinesTs = exportDefinesTs;
+    /**
+     * Replace {{KEY}} template tokens in a string with their resolved values.
+     *
+     * @param content - the content string with {{KEY}} tokens
+     * @param defines - the flat defines map
+     * @returns the substituted string and list of unresolved keys
+     */
+    function replaceDefineTemplates(content, defines) {
+        const unresolvedKeys = [];
+        const result = content.replace(/\{\{([^}]+)\}\}/g, (_match, key) => {
+            const trimmedKey = key.trim();
+            if (Object.hasOwn(defines, trimmedKey)) {
+                return defines[trimmedKey];
+            }
+            unresolvedKeys.push(trimmedKey);
+            return _match;
+        });
+        return { result, unresolvedKeys };
+    }
+    Globals.replaceDefineTemplates = replaceDefineTemplates;
 })(Globals || (exports.Globals = Globals = {}));
 /**
- * Read given ini file from disk
- * @param filePath
- * @param fs
+ * Classify a trimmed ini-file line into one of the known kinds.
+ * Moves boolean-operator branching out of the main loop to reduce cognitive complexity.
+ */
+function classifyIniLine(trimmed) {
+    if (trimmed === '') {
+        return { kind: 'empty' };
+    }
+    if (trimmed.startsWith('#') || trimmed.startsWith(';')) {
+        return { kind: 'comment', text: trimmed.replace(/^[#;]\s?/, '') };
+    }
+    if (trimmed.startsWith('[') && trimmed.endsWith(']')) {
+        return { kind: 'section', name: trimmed.slice(1, -1) };
+    }
+    const eqIndex = trimmed.indexOf('=');
+    if (eqIndex > 0) {
+        return { kind: 'keyValue', key: trimmed.slice(0, eqIndex).trim() };
+    }
+    return { kind: 'other' };
+}
+/**
+ * Extract comment-to-key associations from raw ini text.
+ * Comments are lines starting with `#` or `;`. Consecutive comment lines
+ * are joined with `\n`. An empty line between a comment block and a key
+ * breaks the association. Section headers (`[Name]`) do NOT break a pending
+ * comment — the comment carries over to the first key inside the section.
+ *
+ * Returns a map of flattened key → comment text (with `#`/`;` prefix stripped).
  */
-async function readIniFile(fs, filePath) {
+function extractComments(rawText) {
+    const result = {};
+    const lines = rawText.split(/\r?\n/);
+    let pendingCommentLines = [];
+    let currentSection = null;
+    for (const line of lines) {
+        const classified = classifyIniLine(line.trim());
+        if (classified.kind === 'empty' || classified.kind === 'other') {
+            pendingCommentLines = [];
+            continue;
+        }
+        if (classified.kind === 'comment') {
+            pendingCommentLines.push(classified.text);
+            continue;
+        }
+        if (classified.kind === 'section') {
+            currentSection = classified.name;
+            // Don't reset pendingCommentLines — comment carries to first key
+            continue;
+        }
+        // keyValue
+        const flatKey = currentSection ? `${currentSection}_${classified.key}` : classified.key;
+        if (pendingCommentLines.length > 0) {
+            result[flatKey] = pendingCommentLines.join('\n');
+        }
+        pendingCommentLines = [];
+    }
+    return result;
+}
+/**
+ * Format a comment string as a JSDoc block.
+ * Single-line: \/** comment*\/
+ * Multi-line: \/**\n * line1\n * line2\n *\/
+ */
+function formatJsDoc(comment) {
+    const commentLines = comment.split('\n');
+    if (commentLines.length === 1) {
+        return `/** ${commentLines[0]} */`;
+    }
+    const body = commentLines.map(l => ` * ${l}`).join('\n');
+    return `/**\n${body}\n */`;
+}
+/**
+ * Check whether a string value represents a valid number.
+ * Empty strings are NOT considered numeric.
+ */
+function isNumericValue(value) {
+    return value !== '' && !isNaN(Number(value));
+}
+/**
+ * Create a DefineEntry, attaching a comment from the comment map if available.
+ */
+function createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap) {
+    const flatKey = sectionName ? `${sectionName}_${key}` : key;
+    const entry = {
+        value: stringValue,
+        sourceUri: fileUri,
+        sourceLine: findLineNumber(lines, key, sectionName)
+    };
+    if (commentMap[flatKey]) {
+        entry.comment = 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) {
+    if (!sections[sectionName]) {
+        sections[sectionName] = {};
+    }
+    for (const [key, sectionValue] of Object.entries(sectionData)) {
+        const flatKey = `${sectionName}_${key}`;
+        const stringValue = `${sectionValue}`;
+        allDefines[flatKey] = stringValue;
+        sections[sectionName][key] = stringValue;
+        definesWithSource[flatKey] = createDefineEntry(stringValue, fileUri, lines, key, sectionName, commentMap);
+    }
+}
+/**
+ * Read and merge a single ini file into the accumulated defines, sections, and source tracking.
+ * Supports sections: keys under [SectionName] are flattened as SectionName_keyname.
+ *
+ * @param fs - filesystem abstraction
+ * @param filePath - URI to the ini file
+ * @param allDefines - accumulated flat defines (mutated)
+ * @param sections - accumulated sectioned config (mutated)
+ * @param definesWithSource - accumulated source tracking (mutated)
+ */
+async function mergeIniFile(fs, filePath, allDefines, sections, definesWithSource) {
+    // early return if the file doesn't exist
+    if (!(await fs.stat(filePath))) {
+        return;
+    }
     const iniContent = await fs.readFile(filePath);
-    return ini.parse(convertBlobToString(iniContent));
+    const rawText = convertBlobToString(iniContent);
+    const parsed = ini.parse(rawText);
+    const fileUri = filePath.toString();
+    const lines = rawText.split(/\r?\n/);
+    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);
+        }
+        else {
+            const stringValue = `${value}`;
+            allDefines[sectionOrKey] = stringValue;
+            definesWithSource[sectionOrKey] = createDefineEntry(stringValue, fileUri, lines, sectionOrKey, null, commentMap);
+        }
+    }
+}
+/**
+ * Find the line number (0-based) of a key within an ini file's text lines.
+ * If a sectionName is provided, only searches within that section.
+ *
+ * @param lines - the file split by newlines
+ * @param key - the ini key to find
+ * @param sectionName - the section to search within, or null for top-level
+ * @returns 0-based line number, or 0 if not found
+ */
+function findLineNumber(lines, key, sectionName) {
+    let inTargetSection = sectionName === null;
+    const sectionHeader = sectionName ? `[${sectionName}]` : null;
+    const keyPattern = new RegExp(`^\\s*${escapeRegex(key)}\\s*=`);
+    for (let i = 0; i < lines.length; i++) {
+        const trimmed = lines[i].trim();
+        if (sectionHeader && trimmed === sectionHeader) {
+            inTargetSection = true;
+            continue;
+        }
+        if (inTargetSection && trimmed.startsWith('[') && trimmed.endsWith(']') && sectionName !== null) {
+            // Entered a different section
+            inTargetSection = false;
+            continue;
+        }
+        if (inTargetSection && keyPattern.test(lines[i])) {
+            return i;
+        }
+    }
+    return 0;
+}
+/**
+ * Escape a string for use in a RegExp
+ */
+function escapeRegex(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 }
 //# sourceMappingURL=globals.js.map

package/out/package/package.js

@@ -13,6 +13,7 @@ const compiler_1 = require("../dlo/compiler");
 const scriptRunner_1 = require("../scriptRunner");
 const registryAPI_1 = require("../registryAPI");
 const manifest_1 = require("../manifest");
+const globals_1 = require("../globals");
 const library_1 = require("./library");
 const dfiles_1 = require("../dfiles/dfiles");
 const tarjs_1 = require("@gera2ld/tarjs");
@@ -42,6 +43,15 @@ var Package;
     async function buildAll(cwd, fs, logger, env, apiToken, selectedParts = true, errorWithDiagnostics) {
         selectedParts = normalizeSelectedParts(logger, selectedParts);
         await preBuild(cwd, fs, logger, env, apiToken, selectedParts);
+        // Generate dist/defines.ts before POV/BLO builds
+        try {
+            const resolvedConfig = await globals_1.Globals.read(cwd, fs, logger);
+            await globals_1.Globals.exportDefinesTs(cwd, fs, resolvedConfig);
+            logger.log('Generated', defaultFiles_1.DefaultFiles.filePaths.dist.definesTs);
+        }
+        catch (e) {
+            logger.warn('Could not generate defines.ts:', e);
+        }
         const mergedDiagnostics = {
             [apm_1.APM.Part.dde]: [],
             [apm_1.APM.Part.dlo]: [],

package/package.json

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