@twin.org/cli-core 0.0.2-next.8 → 0.0.3-next.1

package/dist/es/cliUtils.js

@@ -0,0 +1,235 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { exec, spawn } from "node:child_process";
+import { accessSync, readFileSync, statSync } from "node:fs";
+import { access, mkdir, readFile, stat, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { Coerce, I18n, Is, ObjectHelper } from "@twin.org/core";
+import { CLIDisplay } from "./cliDisplay.js";
+/**
+ * Utilities function for helping in the CLI.
+ */
+export class CLIUtils {
+    /**
+     * Does the specified file exist.
+     * @param filename The filename to check for existence.
+     * @returns True if the file exists.
+     */
+    static async fileExists(filename) {
+        try {
+            const stats = await stat(filename);
+            return stats.isFile();
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Does the specified file exist, synchronously.
+     * @param filename The filename to check for existence.
+     * @returns True if the file exists.
+     */
+    static fileExistsSync(filename) {
+        try {
+            const stats = statSync(filename);
+            return stats.isFile();
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Check if the dir exists.
+     * @param dir The directory to check.
+     * @returns True if the dir exists.
+     */
+    static async dirExists(dir) {
+        try {
+            await access(dir);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Check if the dir exists, synchronously.
+     * @param dir The directory to check.
+     * @returns True if the dir exists.
+     */
+    static dirExistsSync(dir) {
+        try {
+            accessSync(dir);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Read a JSON file and parse it.
+     * @param filename The filename to read.
+     * @returns The parsed JSON.
+     */
+    static async readJsonFile(filename) {
+        if (await CLIUtils.fileExists(filename)) {
+            const content = await readFile(filename, "utf8");
+            return JSON.parse(content);
+        }
+    }
+    /**
+     * Read a JSON file and parse it, synchronously.
+     * @param filename The filename to read.
+     * @returns The parsed JSON.
+     */
+    static readJsonFileSync(filename) {
+        if (CLIUtils.fileExistsSync(filename)) {
+            const content = readFileSync(filename, "utf8");
+            return JSON.parse(content);
+        }
+    }
+    /**
+     * Read a file as lines.
+     * @param filename The filename to read.
+     * @returns The lines.
+     */
+    static async readLinesFile(filename) {
+        if (await CLIUtils.fileExists(filename)) {
+            const content = await readFile(filename, "utf8");
+            return content.split("\n");
+        }
+    }
+    /**
+     * Read a file as lines, synchronously.
+     * @param filename The filename to read.
+     * @returns The lines.
+     */
+    static readLinesFileSync(filename) {
+        if (CLIUtils.fileExistsSync(filename)) {
+            const content = readFileSync(filename, "utf8");
+            return content.split("\n");
+        }
+    }
+    /**
+     * Find the NPM root based on a package.json path.
+     * @param rootFolder The path to the package.json.
+     * @returns The root path.
+     */
+    static async findNpmRoot(rootFolder) {
+        return new Promise((resolve, reject) => {
+            exec("npm root", { cwd: rootFolder }, (error, stdout, stderr) => {
+                if (error) {
+                    reject(error);
+                }
+                else {
+                    resolve(stdout.trim());
+                }
+            });
+        });
+    }
+    /**
+     * Run a shell command.
+     * @param command The app to run in the shell.
+     * @param args The args for the app.
+     * @param cwd The working directory to execute the command in.
+     * @returns Promise to wait for command execution to complete.
+     */
+    static async runShellCmd(command, args, cwd) {
+        const osCommand = process.platform.startsWith("win") ? `${command}.cmd` : command;
+        return CLIUtils.runShellApp(osCommand, args, cwd);
+    }
+    /**
+     * Run a shell app.
+     * @param app The app to run in the shell.
+     * @param args The args for the app.
+     * @param cwd The working directory to execute the command in.
+     * @returns Promise to wait for command execution to complete.
+     */
+    static async runShellApp(app, args, cwd) {
+        return new Promise((resolve, reject) => {
+            const sp = spawn(app, args, {
+                shell: true,
+                cwd
+            });
+            sp.stdout?.on("data", data => {
+                CLIDisplay.write(data);
+            });
+            sp.stderr?.on("data", data => {
+                CLIDisplay.writeError(data);
+            });
+            sp.on("exit", (exitCode, signals) => {
+                if (Coerce.number(exitCode) !== 0 || signals?.length) {
+                    // eslint-disable-next-line no-restricted-syntax
+                    reject(new Error("Run failed"));
+                }
+                else {
+                    resolve();
+                }
+            });
+        });
+    }
+    /**
+     * Write a JSON file.
+     * @param jsonFilename The filename to write.
+     * @param data The data to write.
+     * @param append Append to the file.
+     */
+    static async writeJsonFile(jsonFilename, data, append) {
+        if (Is.stringValue(jsonFilename)) {
+            const filename = path.resolve(jsonFilename);
+            let currentJson = {};
+            if (append) {
+                CLIDisplay.task(I18n.formatMessage("cli.progress.readingJsonFile"), filename);
+                currentJson = (await CLIUtils.readJsonFile(filename)) ?? {};
+            }
+            CLIDisplay.task(I18n.formatMessage("cli.progress.writingJsonFile"), filename);
+            CLIDisplay.break();
+            await mkdir(path.dirname(filename), { recursive: true });
+            await writeFile(filename, `${JSON.stringify(ObjectHelper.merge(currentJson, data), undefined, "\t")}\n`);
+        }
+    }
+    /**
+     * Write an env file.
+     * @param envFilename The filename to write.
+     * @param data The data to write.
+     * @param append Append to the file.
+     */
+    static async writeEnvFile(envFilename, data, append) {
+        if (Is.stringValue(envFilename)) {
+            const filename = path.resolve(envFilename);
+            const outputKeys = [];
+            const outputDict = {};
+            if (append) {
+                CLIDisplay.task(I18n.formatMessage("cli.progress.readingEnvFile"), filename);
+                const lines = await CLIUtils.readLinesFile(filename);
+                if (Is.arrayValue(lines)) {
+                    for (const line of lines) {
+                        const parts = line.split("=");
+                        outputKeys.push(parts[0]);
+                        outputDict[parts[0]] = parts.slice(1).join("=");
+                    }
+                }
+            }
+            CLIDisplay.task(I18n.formatMessage("cli.progress.writingEnvFile"), filename);
+            CLIDisplay.break();
+            if (Is.arrayValue(data)) {
+                for (const line of data) {
+                    const parts = line.split("=");
+                    const currentIndex = outputKeys.indexOf(parts[0]);
+                    if (currentIndex !== -1) {
+                        outputKeys.splice(currentIndex, 1);
+                    }
+                    outputKeys.push(parts[0]);
+                    outputDict[parts[0]] = parts.slice(1).join("=");
+                }
+            }
+            const output = [];
+            for (const outputKey of outputKeys) {
+                output.push(`${outputKey}=${outputDict[outputKey]}`);
+            }
+            await mkdir(path.dirname(filename), { recursive: true });
+            await writeFile(filename, output.join("\n"));
+        }
+    }
+}
+//# sourceMappingURL=cliUtils.js.map

package/dist/es/cliUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cliUtils.js","sourceRoot":"","sources":["../../src/cliUtils.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC5E,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,QAAQ;IACpB;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC9C,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,QAAgB;QAC5C,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACjC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,GAAW;QACxC,IAAI,CAAC;YACJ,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,GAAW;QACtC,IAAI,CAAC;YACJ,UAAU,CAAC,GAAG,CAAC,CAAC;YAChB,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAc,QAAgB;QAC7D,IAAI,MAAM,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAc,QAAgB;QAC3D,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAgB;QACjD,IAAI,MAAM,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,QAAgB;QAC/C,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAkB;QACjD,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,CAAC,UAAU,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBAC/D,IAAI,KAAK,EAAE,CAAC;oBACX,MAAM,CAAC,KAAK,CAAC,CAAC;gBACf,CAAC;qBAAM,CAAC;oBACP,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxB,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,IAAc,EAAE,GAAW;QAC3E,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;QAElF,OAAO,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,IAAc,EAAE,GAAW;QACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE;gBAC3B,KAAK,EAAE,IAAI;gBACX,GAAG;aACH,CAAC,CAAC;YAEH,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC5B,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC5B,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;gBACnC,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;oBACtD,gDAAgD;oBAChD,MAAM,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACP,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAChC,YAAgC,EAChC,IAAO,EACP,MAAe;QAEf,IAAI,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5C,IAAI,WAAW,GAAG,EAAE,CAAC;YACrB,IAAI,MAAM,EAAE,CAAC;gBACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC9E,WAAW,GAAG,CAAC,MAAM,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YAC7D,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC9E,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACzD,MAAM,SAAS,CACd,QAAQ,EACR,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAC7E,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAC/B,WAA+B,EAC/B,IAAc,EACd,MAAe;QAEf,IAAI,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAE3C,MAAM,UAAU,GAAa,EAAE,CAAC;YAChC,MAAM,UAAU,GAA8B,EAAE,CAAC;YAEjD,IAAI,MAAM,EAAE,CAAC;gBACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC7E,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBACrD,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;wBAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAC9B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;wBAC1B,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjD,CAAC;gBACF,CAAC;YACF,CAAC;YAED,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC7E,UAAU,CAAC,KAAK,EAAE,CAAC;YAEnB,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;oBACzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC9B,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAClD,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;wBACzB,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;oBACpC,CAAC;oBACD,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1B,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjD,CAAC;YACF,CAAC;YAED,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACpC,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;YAED,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACzD,MAAM,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { exec, spawn } from \"node:child_process\";\nimport { accessSync, readFileSync, statSync } from \"node:fs\";\nimport { access, mkdir, readFile, stat, writeFile } from \"node:fs/promises\";\nimport path from \"node:path\";\nimport { Coerce, I18n, Is, ObjectHelper } from \"@twin.org/core\";\nimport { CLIDisplay } from \"./cliDisplay.js\";\n\n/**\n * Utilities function for helping in the CLI.\n */\nexport class CLIUtils {\n\t/**\n\t * Does the specified file exist.\n\t * @param filename The filename to check for existence.\n\t * @returns True if the file exists.\n\t */\n\tpublic static async fileExists(filename: string): Promise<boolean> {\n\t\ttry {\n\t\t\tconst stats = await stat(filename);\n\t\t\treturn stats.isFile();\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Does the specified file exist, synchronously.\n\t * @param filename The filename to check for existence.\n\t * @returns True if the file exists.\n\t */\n\tpublic static fileExistsSync(filename: string): boolean {\n\t\ttry {\n\t\t\tconst stats = statSync(filename);\n\t\t\treturn stats.isFile();\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Check if the dir exists.\n\t * @param dir The directory to check.\n\t * @returns True if the dir exists.\n\t */\n\tpublic static async dirExists(dir: string): Promise<boolean> {\n\t\ttry {\n\t\t\tawait access(dir);\n\t\t\treturn true;\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Check if the dir exists, synchronously.\n\t * @param dir The directory to check.\n\t * @returns True if the dir exists.\n\t */\n\tpublic static dirExistsSync(dir: string): boolean {\n\t\ttry {\n\t\t\taccessSync(dir);\n\t\t\treturn true;\n\t\t} catch {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t/**\n\t * Read a JSON file and parse it.\n\t * @param filename The filename to read.\n\t * @returns The parsed JSON.\n\t */\n\tpublic static async readJsonFile<T = unknown>(filename: string): Promise<T | undefined> {\n\t\tif (await CLIUtils.fileExists(filename)) {\n\t\t\tconst content = await readFile(filename, \"utf8\");\n\t\t\treturn JSON.parse(content);\n\t\t}\n\t}\n\n\t/**\n\t * Read a JSON file and parse it, synchronously.\n\t * @param filename The filename to read.\n\t * @returns The parsed JSON.\n\t */\n\tpublic static readJsonFileSync<T = unknown>(filename: string): T | undefined {\n\t\tif (CLIUtils.fileExistsSync(filename)) {\n\t\t\tconst content = readFileSync(filename, \"utf8\");\n\t\t\treturn JSON.parse(content);\n\t\t}\n\t}\n\n\t/**\n\t * Read a file as lines.\n\t * @param filename The filename to read.\n\t * @returns The lines.\n\t */\n\tpublic static async readLinesFile(filename: string): Promise<string[] | undefined> {\n\t\tif (await CLIUtils.fileExists(filename)) {\n\t\t\tconst content = await readFile(filename, \"utf8\");\n\t\t\treturn content.split(\"\\n\");\n\t\t}\n\t}\n\n\t/**\n\t * Read a file as lines, synchronously.\n\t * @param filename The filename to read.\n\t * @returns The lines.\n\t */\n\tpublic static readLinesFileSync(filename: string): string[] | undefined {\n\t\tif (CLIUtils.fileExistsSync(filename)) {\n\t\t\tconst content = readFileSync(filename, \"utf8\");\n\t\t\treturn content.split(\"\\n\");\n\t\t}\n\t}\n\n\t/**\n\t * Find the NPM root based on a package.json path.\n\t * @param rootFolder The path to the package.json.\n\t * @returns The root path.\n\t */\n\tpublic static async findNpmRoot(rootFolder: string): Promise<string> {\n\t\treturn new Promise<string>((resolve, reject) => {\n\t\t\texec(\"npm root\", { cwd: rootFolder }, (error, stdout, stderr) => {\n\t\t\t\tif (error) {\n\t\t\t\t\treject(error);\n\t\t\t\t} else {\n\t\t\t\t\tresolve(stdout.trim());\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t}\n\n\t/**\n\t * Run a shell command.\n\t * @param command The app to run in the shell.\n\t * @param args The args for the app.\n\t * @param cwd The working directory to execute the command in.\n\t * @returns Promise to wait for command execution to complete.\n\t */\n\tpublic static async runShellCmd(command: string, args: string[], cwd: string): Promise<void> {\n\t\tconst osCommand = process.platform.startsWith(\"win\") ? `${command}.cmd` : command;\n\n\t\treturn CLIUtils.runShellApp(osCommand, args, cwd);\n\t}\n\n\t/**\n\t * Run a shell app.\n\t * @param app The app to run in the shell.\n\t * @param args The args for the app.\n\t * @param cwd The working directory to execute the command in.\n\t * @returns Promise to wait for command execution to complete.\n\t */\n\tpublic static async runShellApp(app: string, args: string[], cwd: string): Promise<void> {\n\t\treturn new Promise((resolve, reject) => {\n\t\t\tconst sp = spawn(app, args, {\n\t\t\t\tshell: true,\n\t\t\t\tcwd\n\t\t\t});\n\n\t\t\tsp.stdout?.on(\"data\", data => {\n\t\t\t\tCLIDisplay.write(data);\n\t\t\t});\n\n\t\t\tsp.stderr?.on(\"data\", data => {\n\t\t\t\tCLIDisplay.writeError(data);\n\t\t\t});\n\n\t\t\tsp.on(\"exit\", (exitCode, signals) => {\n\t\t\t\tif (Coerce.number(exitCode) !== 0 || signals?.length) {\n\t\t\t\t\t// eslint-disable-next-line no-restricted-syntax\n\t\t\t\t\treject(new Error(\"Run failed\"));\n\t\t\t\t} else {\n\t\t\t\t\tresolve();\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t}\n\n\t/**\n\t * Write a JSON file.\n\t * @param jsonFilename The filename to write.\n\t * @param data The data to write.\n\t * @param append Append to the file.\n\t */\n\tpublic static async writeJsonFile<T = unknown>(\n\t\tjsonFilename: string | undefined,\n\t\tdata: T,\n\t\tappend: boolean\n\t): Promise<void> {\n\t\tif (Is.stringValue(jsonFilename)) {\n\t\t\tconst filename = path.resolve(jsonFilename);\n\t\t\tlet currentJson = {};\n\t\t\tif (append) {\n\t\t\t\tCLIDisplay.task(I18n.formatMessage(\"cli.progress.readingJsonFile\"), filename);\n\t\t\t\tcurrentJson = (await CLIUtils.readJsonFile(filename)) ?? {};\n\t\t\t}\n\t\t\tCLIDisplay.task(I18n.formatMessage(\"cli.progress.writingJsonFile\"), filename);\n\t\t\tCLIDisplay.break();\n\n\t\t\tawait mkdir(path.dirname(filename), { recursive: true });\n\t\t\tawait writeFile(\n\t\t\t\tfilename,\n\t\t\t\t`${JSON.stringify(ObjectHelper.merge(currentJson, data), undefined, \"\\t\")}\\n`\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Write an env file.\n\t * @param envFilename The filename to write.\n\t * @param data The data to write.\n\t * @param append Append to the file.\n\t */\n\tpublic static async writeEnvFile(\n\t\tenvFilename: string | undefined,\n\t\tdata: string[],\n\t\tappend: boolean\n\t): Promise<void> {\n\t\tif (Is.stringValue(envFilename)) {\n\t\t\tconst filename = path.resolve(envFilename);\n\n\t\t\tconst outputKeys: string[] = [];\n\t\t\tconst outputDict: { [key: string]: string } = {};\n\n\t\t\tif (append) {\n\t\t\t\tCLIDisplay.task(I18n.formatMessage(\"cli.progress.readingEnvFile\"), filename);\n\t\t\t\tconst lines = await CLIUtils.readLinesFile(filename);\n\t\t\t\tif (Is.arrayValue(lines)) {\n\t\t\t\t\tfor (const line of lines) {\n\t\t\t\t\t\tconst parts = line.split(\"=\");\n\t\t\t\t\t\toutputKeys.push(parts[0]);\n\t\t\t\t\t\toutputDict[parts[0]] = parts.slice(1).join(\"=\");\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tCLIDisplay.task(I18n.formatMessage(\"cli.progress.writingEnvFile\"), filename);\n\t\t\tCLIDisplay.break();\n\n\t\t\tif (Is.arrayValue(data)) {\n\t\t\t\tfor (const line of data) {\n\t\t\t\t\tconst parts = line.split(\"=\");\n\t\t\t\t\tconst currentIndex = outputKeys.indexOf(parts[0]);\n\t\t\t\t\tif (currentIndex !== -1) {\n\t\t\t\t\t\toutputKeys.splice(currentIndex, 1);\n\t\t\t\t\t}\n\t\t\t\t\toutputKeys.push(parts[0]);\n\t\t\t\t\toutputDict[parts[0]] = parts.slice(1).join(\"=\");\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tconst output: string[] = [];\n\t\t\tfor (const outputKey of outputKeys) {\n\t\t\t\toutput.push(`${outputKey}=${outputDict[outputKey]}`);\n\t\t\t}\n\n\t\t\tawait mkdir(path.dirname(filename), { recursive: true });\n\t\t\tawait writeFile(filename, output.join(\"\\n\"));\n\t\t}\n\t}\n}\n"]}

package/dist/es/commands/global.js

@@ -0,0 +1,61 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import path from "node:path";
+import { I18n, Is } from "@twin.org/core";
+import * as dotenv from "dotenv";
+import { CLIDisplay } from "../cliDisplay.js";
+import { CLIUtils } from "../cliUtils.js";
+let localesDir;
+/**
+ * Initialize the global options.
+ * @param localesDirectory The path to load the locales from.
+ */
+export function initGlobalOptions(localesDirectory) {
+    localesDir = localesDirectory;
+}
+/**
+ * Add the global options.
+ * @param program The program to add the options to.
+ * @param supportsLang Whether the CLI supports different languages.
+ * @param supportsEnvFiles Whether the CLI supports loading env files
+ */
+export function addGlobalOptions(program, supportsLang, supportsEnvFiles) {
+    if (supportsLang) {
+        program.option(I18n.formatMessage("cli.options.lang.param"), I18n.formatMessage("cli.options.lang.description"), "en");
+    }
+    if (supportsEnvFiles) {
+        program.option(I18n.formatMessage("cli.options.load-env.param"), I18n.formatMessage("cli.options.load-env.description"));
+    }
+}
+/**
+ * Handle the global options.
+ * @param command The command to use for context.
+ * @internal
+ */
+export function handleGlobalOptions(command) {
+    const globalOpts = command.optsWithGlobals();
+    if (Is.stringValue(globalOpts?.lang)) {
+        initLocales(globalOpts.lang);
+    }
+    const loadEnv = globalOpts?.loadEnv;
+    if (Is.arrayValue(loadEnv)) {
+        const resolvedEnv = loadEnv.map(e => path.resolve(e));
+        CLIDisplay.task(I18n.formatMessage("cli.progress.loadingEnvFiles"), resolvedEnv.join(", "));
+        CLIDisplay.break();
+        dotenv.config({ path: resolvedEnv, quiet: true });
+    }
+}
+/**
+ * Initialize the locales for the CLI.
+ * @param locale The locale to use.
+ * @internal
+ */
+export function initLocales(locale) {
+    const localePath = path.join(localesDir, `${locale}.json`);
+    const localeContent = CLIUtils.readJsonFileSync(localePath);
+    if (Is.objectValue(localeContent)) {
+        I18n.addDictionary(locale, localeContent);
+        I18n.setLocale(locale);
+    }
+}
+//# sourceMappingURL=global.js.map

package/dist/es/commands/global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.js","sourceRoot":"","sources":["../../../src/commands/global.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,EAAE,EAA0B,MAAM,gBAAgB,CAAC;AAElE,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,IAAI,UAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,gBAAwB;IACzD,UAAU,GAAG,gBAAgB,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC/B,OAAgB,EAChB,YAAqB,EACrB,gBAAyB;IAEzB,IAAI,YAAY,EAAE,CAAC;QAClB,OAAO,CAAC,MAAM,CACb,IAAI,CAAC,aAAa,CAAC,wBAAwB,CAAC,EAC5C,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC,EAClD,IAAI,CACJ,CAAC;IACH,CAAC;IAED,IAAI,gBAAgB,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,CACb,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAChD,IAAI,CAAC,aAAa,CAAC,kCAAkC,CAAC,CACtD,CAAC;IACH,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IACnD,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAE7C,IAAI,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;QACtC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,OAAO,GAAa,UAAU,EAAE,OAAO,CAAC;IAC9C,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACtD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5F,UAAU,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC;IAC3D,MAAM,aAAa,GAAG,QAAQ,CAAC,gBAAgB,CAAoB,UAAU,CAAC,CAAC;IAC/E,IAAI,EAAE,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;AACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport path from \"node:path\";\nimport { I18n, Is, type ILocaleDictionary } from \"@twin.org/core\";\nimport type { Command } from \"commander\";\nimport * as dotenv from \"dotenv\";\nimport { CLIDisplay } from \"../cliDisplay.js\";\nimport { CLIUtils } from \"../cliUtils.js\";\n\nlet localesDir: string;\n\n/**\n * Initialize the global options.\n * @param localesDirectory The path to load the locales from.\n */\nexport function initGlobalOptions(localesDirectory: string): void {\n\tlocalesDir = localesDirectory;\n}\n\n/**\n * Add the global options.\n * @param program The program to add the options to.\n * @param supportsLang Whether the CLI supports different languages.\n * @param supportsEnvFiles Whether the CLI supports loading env files\n */\nexport function addGlobalOptions(\n\tprogram: Command,\n\tsupportsLang: boolean,\n\tsupportsEnvFiles: boolean\n): void {\n\tif (supportsLang) {\n\t\tprogram.option(\n\t\t\tI18n.formatMessage(\"cli.options.lang.param\"),\n\t\t\tI18n.formatMessage(\"cli.options.lang.description\"),\n\t\t\t\"en\"\n\t\t);\n\t}\n\n\tif (supportsEnvFiles) {\n\t\tprogram.option(\n\t\t\tI18n.formatMessage(\"cli.options.load-env.param\"),\n\t\t\tI18n.formatMessage(\"cli.options.load-env.description\")\n\t\t);\n\t}\n}\n\n/**\n * Handle the global options.\n * @param command The command to use for context.\n * @internal\n */\nexport function handleGlobalOptions(command: Command): void {\n\tconst globalOpts = command.optsWithGlobals();\n\n\tif (Is.stringValue(globalOpts?.lang)) {\n\t\tinitLocales(globalOpts.lang);\n\t}\n\n\tconst loadEnv: string[] = globalOpts?.loadEnv;\n\tif (Is.arrayValue(loadEnv)) {\n\t\tconst resolvedEnv = loadEnv.map(e => path.resolve(e));\n\t\tCLIDisplay.task(I18n.formatMessage(\"cli.progress.loadingEnvFiles\"), resolvedEnv.join(\", \"));\n\t\tCLIDisplay.break();\n\t\tdotenv.config({ path: resolvedEnv, quiet: true });\n\t}\n}\n\n/**\n * Initialize the locales for the CLI.\n * @param locale The locale to use.\n * @internal\n */\nexport function initLocales(locale: string): void {\n\tconst localePath = path.join(localesDir, `${locale}.json`);\n\tconst localeContent = CLIUtils.readJsonFileSync<ILocaleDictionary>(localePath);\n\tif (Is.objectValue(localeContent)) {\n\t\tI18n.addDictionary(locale, localeContent);\n\t\tI18n.setLocale(locale);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,14 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./cliBase.js";
+export * from "./cliDisplay.js";
+export * from "./cliOptions.js";
+export * from "./cliParam.js";
+export * from "./cliUtils.js";
+export * from "./commands/global.js";
+export * from "./models/cliOutputOptions.js";
+export * from "./models/ICliOptions.js";
+export * from "./models/ICliOutputOptionsConsole.js";
+export * from "./models/ICliOutputOptionsEnv.js";
+export * from "./models/ICliOutputOptionsJson.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./cliBase.js\";\nexport * from \"./cliDisplay.js\";\nexport * from \"./cliOptions.js\";\nexport * from \"./cliParam.js\";\nexport * from \"./cliUtils.js\";\nexport * from \"./commands/global.js\";\nexport * from \"./models/cliOutputOptions.js\";\nexport * from \"./models/ICliOptions.js\";\nexport * from \"./models/ICliOutputOptionsConsole.js\";\nexport * from \"./models/ICliOutputOptionsEnv.js\";\nexport * from \"./models/ICliOutputOptionsJson.js\";\n"]}

package/dist/es/models/ICliOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICliOptions.js.map

package/dist/es/models/ICliOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICliOptions.js","sourceRoot":"","sources":["../../../src/models/ICliOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/**\n * Options for the CLI.\n */\nexport interface ICliOptions {\n\t/**\n\t * The title of the CLI.\n\t */\n\ttitle: string;\n\n\t/**\n\t * The name of the app used to execute it.\n\t */\n\tappName: string;\n\n\t/**\n\t * The version of the app.\n\t */\n\tversion: string;\n\n\t/**\n\t * The icon for the CLI as an emoji character.\n\t */\n\ticon: string;\n\n\t/**\n\t * Supports different languages.\n\t */\n\tsupportsLang?: boolean;\n\n\t/**\n\t * Supports the loading of env files.\n\t */\n\tsupportsEnvFiles?: boolean;\n\n\t/**\n\t * Override the default output width.\n\t */\n\toverrideOutputWidth?: number;\n\n\t/**\n\t * Show a warning that this is a dev tool and not for production use.\n\t */\n\tshowDevToolWarning?: boolean;\n}\n"]}

package/dist/es/models/ICliOutputOptionsConsole.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICliOutputOptionsConsole.js.map

package/dist/es/models/ICliOutputOptionsConsole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICliOutputOptionsConsole.js","sourceRoot":"","sources":["../../../src/models/ICliOutputOptionsConsole.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/**\n * Options for the CLI Output for console.\n */\nexport interface ICliOutputOptionsConsole {\n\t/**\n\t * Flag to display on the console.\n\t */\n\tconsole: boolean;\n}\n"]}

package/dist/es/models/ICliOutputOptionsEnv.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICliOutputOptionsEnv.js.map

package/dist/es/models/ICliOutputOptionsEnv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICliOutputOptionsEnv.js","sourceRoot":"","sources":["../../../src/models/ICliOutputOptionsEnv.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/**\n * Options for the CLI Output for env.\n */\nexport interface ICliOutputOptionsEnv {\n\t/**\n\t * Output the data to an environment file.\n\t */\n\tenv?: string;\n\n\t/**\n\t * Merge the data to an environment file.\n\t */\n\tmergeEnv: boolean;\n}\n"]}

package/dist/es/models/ICliOutputOptionsJson.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICliOutputOptionsJson.js.map

package/dist/es/models/ICliOutputOptionsJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICliOutputOptionsJson.js","sourceRoot":"","sources":["../../../src/models/ICliOutputOptionsJson.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/**\n * Options for the CLI Output for JSON.\n */\nexport interface ICliOutputOptionsJson {\n\t/**\n\t * Output the data to an JSON file.\n\t */\n\tjson?: string;\n\n\t/**\n\t * Merge the data to a JSON file.\n\t */\n\tmergeJson: boolean;\n}\n"]}

package/dist/es/models/cliOutputOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cliOutputOptions.js.map

package/dist/es/models/cliOutputOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cliOutputOptions.js","sourceRoot":"","sources":["../../../src/models/cliOutputOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ICliOutputOptionsConsole } from \"./ICliOutputOptionsConsole.js\";\nimport type { ICliOutputOptionsEnv } from \"./ICliOutputOptionsEnv.js\";\nimport type { ICliOutputOptionsJson } from \"./ICliOutputOptionsJson.js\";\n\n/**\n * Options for the CLI Output.\n */\nexport type CliOutputOptions = ICliOutputOptionsConsole &\n\tICliOutputOptionsEnv &\n\tICliOutputOptionsJson;\n"]}

package/dist/types/cliBase.d.ts

@@ -1,5 +1,5 @@
 import { Command } from "commander";
-import type { ICliOptions } from "./models/ICliOptions";
+import type { ICliOptions } from "./models/ICliOptions.js";
 /**
  * The main entry point for the CLI.
  */

package/dist/types/cliDisplay.d.ts

@@ -29,6 +29,11 @@ export declare class CLIDisplay {
      * @param lineBreaks Whether to add a line break after the error.
      */
     static error(error: unknown, lineBreaks?: boolean): void;
+    /**
+     * Display an error message in simple form.
+     * @param error The error to display.
+     */
+    static errorMessage(error: string): void;
     /**
      * Display a section.
      * @param label The label for the section.

package/dist/types/cliParam.d.ts

@@ -20,6 +20,16 @@ export declare class CLIParam {
      * @throws An error if the option is invalid.
      */
     static stringValue(optionName: string, optionValue: string | undefined, allowEnvVar?: boolean): string;
+    /**
+     * Check the option to see if the value exists in the specific array.
+     * @param optionName The name of the option.
+     * @param optionValue The option value.
+     * @param validValues The valid values.
+     * @param allowEnvVar Allow the option to be read from an env var.
+     * @returns The final option value.
+     * @throws An error if the option is invalid.
+     */
+    static arrayOneOf<T = string>(optionName: string, optionValue: string | undefined, validValues: T[], allowEnvVar?: boolean): T;
     /**
      * Check the option to see if it is a url.
      * @param optionName The name of the option.
@@ -98,13 +108,4 @@ export declare class CLIParam {
      * @throws An error if the option is invalid.
      */
     static hexBase64(optionName: string, optionValue: string | undefined, allowEnvVar?: boolean): Uint8Array;
-    /**
-     * Check the option to see if it exists and is bech32.
-     * @param optionName The name of the option.
-     * @param optionValue The option value.
-     * @param allowEnvVar Allow the option to be read from an env var.
-     * @returns The final option value.
-     * @throws An error if the option is invalid.
-     */
-    static bech32(optionName: string, optionValue: string | undefined, allowEnvVar?: boolean): string;
 }

package/dist/types/index.d.ts

@@ -1,11 +1,11 @@
-export * from "./cliBase";
-export * from "./cliDisplay";
-export * from "./cliOptions";
-export * from "./cliParam";
-export * from "./cliUtils";
-export * from "./commands/global";
-export * from "./models/cliOutputOptions";
-export * from "./models/ICliOptions";
-export * from "./models/ICliOutputOptionsConsole";
-export * from "./models/ICliOutputOptionsEnv";
-export * from "./models/ICliOutputOptionsJson";
+export * from "./cliBase.js";
+export * from "./cliDisplay.js";
+export * from "./cliOptions.js";
+export * from "./cliParam.js";
+export * from "./cliUtils.js";
+export * from "./commands/global.js";
+export * from "./models/cliOutputOptions.js";
+export * from "./models/ICliOptions.js";
+export * from "./models/ICliOutputOptionsConsole.js";
+export * from "./models/ICliOutputOptionsEnv.js";
+export * from "./models/ICliOutputOptionsJson.js";

package/dist/types/models/cliOutputOptions.d.ts

@@ -1,6 +1,6 @@
-import type { ICliOutputOptionsConsole } from "./ICliOutputOptionsConsole";
-import type { ICliOutputOptionsEnv } from "./ICliOutputOptionsEnv";
-import type { ICliOutputOptionsJson } from "./ICliOutputOptionsJson";
+import type { ICliOutputOptionsConsole } from "./ICliOutputOptionsConsole.js";
+import type { ICliOutputOptionsEnv } from "./ICliOutputOptionsEnv.js";
+import type { ICliOutputOptionsJson } from "./ICliOutputOptionsJson.js";
 /**
  * Options for the CLI Output.
  */