@microtronics/studio-cli 0.26.0 → 0.27.1

package/CHANGELOG.md

@@ -1,11 +1,20 @@
 
 
-## 0.26.0 (2025-03-18)
-
-
-### Features
-
-* implemented generic logger ([46b72a1](https://bitbucket.org/microtronics-core/vscode-studio/commits/46b72a1f5bcf9cfe85e58deb7e69bf3e56aa0875))
+## 0.27.1 (2025-03-25)
+
+## 0.27.0 (2025-03-20)
+
+
+### Features
+
+* **studio-core:** support to allow preview of the app version manifest ([fdfe18b](https://bitbucket.org/microtronics-core/vscode-studio/commits/fdfe18bf873de150b6870004249880a3e990a811))
+
+## 0.26.0 (2025-03-18)
+
+
+### Features
+
+* implemented generic logger ([46b72a1](https://bitbucket.org/microtronics-core/vscode-studio/commits/46b72a1f5bcf9cfe85e58deb7e69bf3e56aa0875))
 * **studio-cli:** introduced generic logger with chalk as colorization tool ([6593494](https://bitbucket.org/microtronics-core/vscode-studio/commits/65934942e2d30b3dfcc965e798ad8c508bf2ed52))
 
 ## 0.25.0 (2025-03-12)

package/dist/studio-cli.d.ts

@@ -116,15 +116,16 @@ declare interface BaseTagHeader {
 }
 
 /**
- * Builds all parts of the specified project in the given working directory.
+ * Builds the specified parts of the project located in the given directory.
  *
  * @param {URI} cwd - The current working directory where the build process will be executed.
  * @param {LocalFS} fs - The local file system instance used for file operations during the build.
  * @param {Logger} logger - Logger instance for logging details during the build process.
  * @param {APM.Part} selectedParts - The project parts to be built.
- * @return A promise that resolves when the build process is complete.
+ * @param {boolean} [errorWithDiagnostics] - If true, includes diagnostic details in case of an error.
+ * @return {Promise<Object>} A promise resolved with an object containing diagnostics information for the specified project parts: `dde`, `dlo`, and `dfiles`.
  */
-export declare function build(cwd: URI, fs: LocalFS, logger: Log.Logger, selectedParts?: APM.Part[] | boolean): Promise<{
+export declare function build(cwd: URI, fs: LocalFS, logger: Log.Logger, selectedParts?: APM.Part[] | boolean, errorWithDiagnostics?: boolean): Promise<{
     [APM.Part.dde]: Diagnostics.File[];
     [APM.Part.dlo]: Diagnostics.File[];
     [APM.Part.dfiles]: Diagnostics.File[];
@@ -372,7 +373,7 @@ declare interface components {
         ApplicationVersion: string | number;
         ApplicationVersionInSemver: boolean;
         /** @description File that can be downloaded */
-        ApplicationFileName: "release-notes.md" | "app.tar.gz";
+        ApplicationFileName: "release-notes.md" | "app.tar.gz" | "studio.json";
         /** @description User Id */
         MemberId: string;
         /** @description User Id */
@@ -1764,6 +1765,7 @@ export declare namespace DLO {
     const Compiler: typeof DloCompiler;
     export type Compiler = DloCompiler;
     const uriToMemFs: typeof uriToMemFsPath;
+    const parseCompilerWarningsAndErrors: typeof parseWarningsAndErrors;
     /**
      * Generate the dlo.cfg file and write it to the .studio/auto/dlo directory
      * @param cwd
@@ -1818,7 +1820,6 @@ declare class DloCompiler {
     memFSunlink(uri: URI): Promise<void>;
     private memFSmkdir;
     private memFSstat;
-    private parseWarningsAndErrors;
     /**
      * Get a symbol compiler instance
      */
@@ -1845,10 +1846,10 @@ declare class DloPreCompiler {
     private dloFileSequencer;
     constructor();
     get pragmaDynamicFlag(): string | null;
-    preCompileDloFile(cwd: URI, manifest: Manifest.Manifest, fileUri: URI, fileBlob: string[]): Promise<{
+    preCompileDloFile(cwd: URI, manifest: Manifest.Manifest, fileUri: URI, fileBlob: string[]): {
         diagnostics: Diagnostics.File[];
         data: string;
-    }>;
+    };
 }
 
 export declare namespace ENV {
@@ -2290,18 +2291,25 @@ export declare namespace Manifest {
 }
 
 export declare namespace Package {
+    export interface MergedDiagnostics {
+        [APM.Part.dde]: Diagnostics.File[];
+        [APM.Part.dlo]: Diagnostics.File[];
+        [APM.Part.dfiles]: Diagnostics.File[];
+    }
+    export class BuildError extends Error {
+        private readonly _mergedDiagnostics;
+        constructor(message: string, mergedDiagnostics: MergedDiagnostics);
+        get mergedDiagnostics(): MergedDiagnostics;
+    }
     /**
      * Build the whole project or only a specific part
      * @param cwd
      * @param fs
      * @param logger
      * @param selectedParts - choose a specific part that should be build or if true all parts are build
+     * @param errorWithDiagnostics
      */
-    export function buildAll(cwd: URI, fs: LocalFS, logger: Log.Logger, selectedParts?: APM.Part[] | boolean): Promise<{
-        [APM.Part.dde]: Diagnostics.File[];
-        [APM.Part.dlo]: Diagnostics.File[];
-        [APM.Part.dfiles]: Diagnostics.File[];
-    }>;
+    export function buildAll(cwd: URI, fs: LocalFS, logger: Log.Logger, selectedParts?: APM.Part[] | boolean, errorWithDiagnostics?: boolean): Promise<MergedDiagnostics>;
     /**
      * Trigger the release based on the manifest settings
      * @param cwd
@@ -2358,6 +2366,8 @@ export declare namespace Package {
     export function validatePublishSettings(cwd: URI, fs: LocalFS, token: Registry.AuthToken, env: Globals.ENV): Promise<void>;
 }
 
+declare function parseWarningsAndErrors(stderr: string[], relatedFile?: URI): Diagnostics.File[];
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -3584,6 +3594,11 @@ declare interface paths {
                         [name: string]: unknown;
                     };
                     content: {
+                        "application/json": {
+                            name?: string;
+                        } & {
+                            [key: string]: unknown;
+                        };
                         "application/gzip": string;
                         "text/markdown": string;
                     };

package/out/api.js

@@ -65,16 +65,17 @@ async function install(cwd, fs, env, apiToken, dependencies) {
     }
 }
 /**
- * Builds all parts of the specified project in the given working directory.
+ * Builds the specified parts of the project located in the given directory.
  *
  * @param {URI} cwd - The current working directory where the build process will be executed.
  * @param {LocalFS} fs - The local file system instance used for file operations during the build.
  * @param {Logger} logger - Logger instance for logging details during the build process.
  * @param {APM.Part} selectedParts - The project parts to be built.
- * @return A promise that resolves when the build process is complete.
+ * @param {boolean} [errorWithDiagnostics] - If true, includes diagnostic details in case of an error.
+ * @return {Promise<Object>} A promise resolved with an object containing diagnostics information for the specified project parts: `dde`, `dlo`, and `dfiles`.
  */
-async function build(cwd, fs, logger, selectedParts = true) {
-    return package_1.Package.buildAll(cwd, fs, logger, selectedParts);
+async function build(cwd, fs, logger, selectedParts = true, errorWithDiagnostics) {
+    return package_1.Package.buildAll(cwd, fs, logger, selectedParts, errorWithDiagnostics);
 }
 /**
  * Publishes a package to the registry with the specified settings and configurations.

package/out/dlo/compiler.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DloCompiler = void 0;
 exports.uriToMemFsPath = uriToMemFsPath;
+exports.parseWarningsAndErrors = parseWarningsAndErrors;
 exports.generateConfigFile = generateConfigFile;
 const preCompiler_1 = require("./preCompiler");
 const vscode_uri_1 = require("vscode-uri");
@@ -101,7 +102,7 @@ class DloCompiler {
             code: exitCode,
             stdout: this.stdout,
             stderr: this.stderr,
-            diagnostics: [...precompilerDiagnostics, ...this.parseWarningsAndErrors(this.stderr, mainFile)]
+            diagnostics: [...precompilerDiagnostics, ...parseWarningsAndErrors(this.stderr, mainFile)]
         };
     }
     async persistGeneratedFiles(cwd, fs, mainFile) {
@@ -154,7 +155,7 @@ class DloCompiler {
      */
     async memFSwriteFile(cwd, manifest, file, stringBlob) {
         const precompilerDiagnostics = [];
-        const preCompiled = await this.preCompiler.preCompileDloFile(cwd, manifest, file, stringBlob);
+        const preCompiled = this.preCompiler.preCompileDloFile(cwd, manifest, file, stringBlob);
         precompilerDiagnostics.push(...preCompiled.diagnostics);
         this.memFSmkdir(file);
         this.MEMFS.writeFile(uriToMemFsPath(file), iconv.encode(preCompiled.data, 'cp1252'));
@@ -213,48 +214,6 @@ class DloCompiler {
             return false;
         }
     }
-    parseWarningsAndErrors(stderr, relatedFile) {
-        const compilerDiagnostics = [];
-        const messages = stderr.filter(line => !!line.trim());
-        for (const message of messages) {
-            if ((message.includes('Assertion failed:') || message.includes('Compilation aborted.')) && relatedFile) {
-                compilerDiagnostics.push({
-                    file: relatedFile,
-                    level: 'error',
-                    line: 0,
-                    message: message
-                });
-                continue;
-            }
-            // regular error/warning - such as:
-            // 		C:\Users\aai\rmstudio\apmparts\dlo-pawn\stdlib\rm-dde.inc(392) : error 036: empty statement
-            // 		main.p(138) : warning 203: symbol is never used: "log_str"
-            //		main.p(6) : fatal error 100: cannot read from file: "oTests/module_t"
-            const i0 = message.indexOf(' : ');
-            const i1 = message.indexOf(': ', i0 + 3);
-            const fileNameAndLineNumber = message.substring(0, i0).trim();
-            const levelAndCode = message.substring(i0 + 3, i1).trim();
-            const msg = message.substring(i1 + 2).trim();
-            // ignore lines which do not contain err/warn msg (or are empty)
-            if (!fileNameAndLineNumber || !levelAndCode || !msg) {
-                continue;
-            }
-            const [fileName, lineNumber] = fileNameAndLineNumber.split(/[()(-)]/);
-            const decodeLevelAndCode = levelAndCode.split(' ');
-            const level = decodeLevelAndCode[decodeLevelAndCode.length - 2]; //lvl is always the second last
-            let posix = fileName.replace(/\\/g, '/');
-            if (posix.startsWith('/')) {
-                posix = posix.substring(1);
-            }
-            compilerDiagnostics.push({
-                file: vscode_uri_1.URI.parse(`file:///${posix}`),
-                level,
-                line: Number(lineNumber) - 1,
-                message: msg
-            });
-        }
-        return compilerDiagnostics;
-    }
     //Symbol Compiler handling
     /**
      * Get a symbol compiler instance
@@ -294,6 +253,48 @@ exports.DloCompiler = DloCompiler;
 function uriToMemFsPath(path) {
     return path.fsPath.replace(/\\/g, '/');
 }
+function parseWarningsAndErrors(stderr, relatedFile) {
+    const compilerDiagnostics = [];
+    const messages = stderr.filter(line => !!line.trim());
+    for (const message of messages) {
+        if ((message.includes('Assertion failed:') || message.includes('Compilation aborted.')) && relatedFile) {
+            compilerDiagnostics.push({
+                file: relatedFile,
+                level: 'error',
+                line: 0,
+                message: message
+            });
+            continue;
+        }
+        // regular error/warning - such as:
+        // 		C:\Users\aai\rmstudio\apmparts\dlo-pawn\stdlib\rm-dde.inc(392) : error 036: empty statement
+        // 		main.p(138) : warning 203: symbol is never used: "log_str"
+        //		main.p(6) : fatal error 100: cannot read from file: "oTests/module_t"
+        const i0 = message.indexOf(' : ');
+        const i1 = message.indexOf(': ', i0 + 3);
+        const fileNameAndLineNumber = message.substring(0, i0).trim();
+        const levelAndCode = message.substring(i0 + 3, i1).trim();
+        const msg = message.substring(i1 + 2).trim();
+        // ignore lines which do not contain err/warn msg (or are empty)
+        if (!fileNameAndLineNumber || !levelAndCode || !msg) {
+            continue;
+        }
+        const [fileName, lineNumber] = fileNameAndLineNumber.split(/[()(-)]/);
+        const decodeLevelAndCode = levelAndCode.split(' ');
+        const level = decodeLevelAndCode[decodeLevelAndCode.length - 2]; //lvl is always the second last
+        let posix = fileName.replace(/\\/g, '/');
+        if (posix.startsWith('/')) {
+            posix = posix.substring(1);
+        }
+        compilerDiagnostics.push({
+            file: vscode_uri_1.URI.parse(`file:///${posix}`),
+            level,
+            line: Number(lineNumber) - 1,
+            message: msg
+        });
+    }
+    return compilerDiagnostics;
+}
 /**
  * Generates the DLO .cfg file for the dlo compiler
  * @param cwd

package/out/dlo/dlo.js

@@ -15,6 +15,7 @@ var DLO;
      */
     DLO.Compiler = compiler_1.DloCompiler;
     DLO.uriToMemFs = compiler_1.uriToMemFsPath;
+    DLO.parseCompilerWarningsAndErrors = compiler_1.parseWarningsAndErrors;
     /**
      * Generate the dlo.cfg file and write it to the .studio/auto/dlo directory
      * @param cwd

package/out/dlo/preCompiler.js

@@ -87,7 +87,7 @@ class DloPreCompiler {
         }
     }
     // eslint-disable-next-line sonarjs/cognitive-complexity
-    async preCompileDloFile(cwd, manifest, fileUri, fileBlob) {
+    preCompileDloFile(cwd, manifest, fileUri, fileBlob) {
         this.dloFileSequencer.workspacePath = cwd;
         const fileDiagnostics = [];
         const filePath = fileUri.path;

package/out/helper.js

@@ -63,7 +63,7 @@ var Helper;
     Helper.normalizeLF = normalizeLF;
     function convertBlobToStringArray(blob) {
         try {
-            const textData = convertBlobToString(blob).trim();
+            const textData = convertBlobToString(blob);
             return normalizeLF(textData).split('\n');
         }
         catch (e) {

package/out/package/package.js

@@ -16,18 +16,28 @@ const library_1 = require("./library");
 const dfiles_1 = require("../dfiles/dfiles");
 var Package;
 (function (Package) {
+    class BuildError extends Error {
+        _mergedDiagnostics;
+        constructor(message, mergedDiagnostics) {
+            super(message);
+            this.name = 'BuildError';
+            this._mergedDiagnostics = mergedDiagnostics;
+        }
+        get mergedDiagnostics() {
+            return this._mergedDiagnostics;
+        }
+    }
+    Package.BuildError = BuildError;
     /**
      * Build the whole project or only a specific part
      * @param cwd
      * @param fs
      * @param logger
      * @param selectedParts - choose a specific part that should be build or if true all parts are build
+     * @param errorWithDiagnostics
      */
-    async function buildAll(cwd, fs, logger, selectedParts = true) {
-        if (selectedParts === true) {
-            logger.info('Building project...');
-        }
-        selectedParts = Object.values(apm_1.APM.Part);
+    async function buildAll(cwd, fs, logger, selectedParts = true, errorWithDiagnostics) {
+        selectedParts = normalizeSelectedParts(logger, selectedParts);
         const mergedDiagnostics = {
             [apm_1.APM.Part.dde]: [],
             [apm_1.APM.Part.dlo]: [],
@@ -39,20 +49,30 @@ var Package;
             [apm_1.APM.Part.dlo]: buildDLO,
             [apm_1.APM.Part.dfiles]: buildDfiles
         };
-        // Build and validate specific parts
-        for (const part of [apm_1.APM.Part.dde, apm_1.APM.Part.dlo, apm_1.APM.Part.dfiles]) {
-            if (selectedParts.includes(part)) {
-                logger.info(`Building ${part.toUpperCase()}...`);
-                const hasError = await buildAndValidatePart(logger, part, 
-                /*@ts-ignore*/
-                buildMapping[part], 
-                /*@ts-ignore*/
-                mergedDiagnostics[part], cwd, fs);
-                if (hasError) {
-                    return mergedDiagnostics; // Early exit on error
+        try {
+            // Build and validate specific parts
+            for (const part of [apm_1.APM.Part.dde, apm_1.APM.Part.dlo, apm_1.APM.Part.dfiles]) {
+                if (selectedParts.includes(part)) {
+                    logger.info(`Building ${part.toUpperCase()}...`);
+                    const hasError = await buildAndValidatePart(logger, part, 
+                    /*@ts-ignore*/
+                    buildMapping[part], 
+                    /*@ts-ignore*/
+                    mergedDiagnostics[part], cwd, fs);
+                    if (hasError) {
+                        return mergedDiagnostics; // Early exit on error
+                    }
                 }
             }
         }
+        catch (e) {
+            if (errorWithDiagnostics) {
+                throw new BuildError(e?.message, mergedDiagnostics);
+            }
+            else {
+                throw e;
+            }
+        }
         // Handle pov and blo parts that do not return diagnostics
         if (selectedParts.includes(apm_1.APM.Part.pov)) {
             await scriptRunner_1.Shell.tryBuildPov(cwd, fs, logger);
@@ -227,6 +247,23 @@ var Package;
     }
     Package.validatePublishSettings = validatePublishSettings;
 })(Package || (exports.Package = Package = {}));
+/**
+ * Normalize the selected parts parameter for building.
+ * @param logger - Logger for generic logging
+ * @param selectedParts - Can be a boolean or parts array. True selects all parts, false selects none.
+ * @returns Normalized array of parts.
+ */
+function normalizeSelectedParts(logger, selectedParts) {
+    const ALL_PARTS = Object.values(apm_1.APM.Part);
+    if (selectedParts === true) {
+        logger.info('Building project...');
+        return ALL_PARTS;
+    }
+    if (selectedParts === false) {
+        return [];
+    }
+    return selectedParts;
+}
 /**
  * Generates all needed files out of the dde declaration
  * @param cwd
@@ -289,7 +326,9 @@ async function buildAndValidatePart(logger, part, buildFn, mergedDiagnostics, cw
 }
 function logDiagnostics(logger, diagnostics) {
     diagnostics.forEach(diagnostic => {
-        const message = `${diagnostic.file.path}: ${diagnostic.message}`;
+        // diagnostic.line and startCharacter are zero based. Therefor we need to increment with 1.
+        const startChar = diagnostic.startCharacter ? `:${diagnostic.startCharacter + 1}` : '';
+        const message = `${diagnostic.file.path}:${diagnostic.line + 1}${startChar} - ${diagnostic.message}`;
         if (diagnostic.level === 'error') {
             logger.error(message);
         }

package/out/scriptRunner.js

@@ -94,7 +94,9 @@ async function execShell(cwd, cmd, logger) {
         // todo use spawn instead of exec to allow streaming to the console
         child_process.exec(cmd, { cwd: cwd.fsPath, env: process.env }, (error, stdout, stderr) => {
             logger.log(stdout);
-            logger.error(stderr);
+            if (stderr) {
+                logger.error(stderr);
+            }
             if (error) {
                 reject(error);
             }

package/package.json

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