@twin.org/cli-core 0.0.1-next.6 → 0.0.1-next.62

package/dist/cjs/index.cjs

@@ -81,7 +81,7 @@ class CLIDisplay {
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
         }
-        const formatted = core.ErrorHelper.formatErrors(error);
+        const formatted = core.ErrorHelper.formatErrors(error, true);
         CLIDisplay.writeError(chalk.red(formatted.map(e => `\t${e}`).join("\n")));
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
@@ -298,6 +298,17 @@ class CLIUtils {
             });
         });
     }
+    /**
+     * 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.
@@ -305,10 +316,9 @@ class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static async runShellCmd(app, args, cwd) {
+    static async runShellApp(app, args, cwd) {
         return new Promise((resolve, reject) => {
-            const osCommand = process.platform.startsWith("win") ? `${app}.cmd` : app;
-            const sp = node_child_process.spawn(osCommand, args, {
+            const sp = node_child_process.spawn(app, args, {
                 shell: true,
                 cwd
             });
@@ -346,7 +356,7 @@ class CLIUtils {
             CLIDisplay.task(core.I18n.formatMessage("cli.progress.writingJsonFile"), filename);
             CLIDisplay.break();
             await promises.mkdir(path.dirname(filename), { recursive: true });
-            await promises.writeFile(filename, JSON.stringify(core.ObjectHelper.merge(currentJson, data), undefined, "\t"));
+            await promises.writeFile(filename, `${JSON.stringify(core.ObjectHelper.merge(currentJson, data), undefined, "\t")}\n`);
         }
     }
     /**
@@ -377,7 +387,7 @@ class CLIUtils {
                 for (const line of data) {
                     const parts = line.split("=");
                     const currentIndex = outputKeys.indexOf(parts[0]);
-                    if (currentIndex >= 0) {
+                    if (currentIndex !== -1) {
                         outputKeys.splice(currentIndex, 1);
                     }
                     outputKeys.push(parts[0]);
@@ -627,7 +637,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -640,7 +650,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/esm/index.mjs

@@ -60,7 +60,7 @@ class CLIDisplay {
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
         }
-        const formatted = ErrorHelper.formatErrors(error);
+        const formatted = ErrorHelper.formatErrors(error, true);
         CLIDisplay.writeError(chalk.red(formatted.map(e => `\t${e}`).join("\n")));
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
@@ -277,6 +277,17 @@ class CLIUtils {
             });
         });
     }
+    /**
+     * 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.
@@ -284,10 +295,9 @@ class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static async runShellCmd(app, args, cwd) {
+    static async runShellApp(app, args, cwd) {
         return new Promise((resolve, reject) => {
-            const osCommand = process.platform.startsWith("win") ? `${app}.cmd` : app;
-            const sp = spawn(osCommand, args, {
+            const sp = spawn(app, args, {
                 shell: true,
                 cwd
             });
@@ -325,7 +335,7 @@ class CLIUtils {
             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"));
+            await writeFile(filename, `${JSON.stringify(ObjectHelper.merge(currentJson, data), undefined, "\t")}\n`);
         }
     }
     /**
@@ -356,7 +366,7 @@ class CLIUtils {
                 for (const line of data) {
                     const parts = line.split("=");
                     const currentIndex = outputKeys.indexOf(parts[0]);
-                    if (currentIndex >= 0) {
+                    if (currentIndex !== -1) {
                         outputKeys.splice(currentIndex, 1);
                     }
                     outputKeys.push(parts[0]);
@@ -606,7 +616,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -619,7 +629,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/types/cliParam.d.ts

@@ -12,7 +12,7 @@ export declare class CLIParam {
      */
     static env(optionName: string, optionValue: string | undefined, allowEnvVar: boolean): string | undefined;
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -21,7 +21,7 @@ export declare class CLIParam {
      */
     static stringValue(optionName: string, optionValue: string | undefined, allowEnvVar?: boolean): string;
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/types/cliUtils.d.ts

@@ -56,6 +56,14 @@ export declare class CLIUtils {
      * @returns The root path.
      */
     static findNpmRoot(rootFolder: string): Promise<string>;
+    /**
+     * 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 runShellCmd(command: string, args: string[], cwd: string): Promise<void>;
     /**
      * Run a shell app.
      * @param app The app to run in the shell.
@@ -63,7 +71,7 @@ export declare class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static runShellCmd(app: string, args: string[], cwd: string): Promise<void>;
+    static runShellApp(app: string, args: string[], cwd: string): Promise<void>;
     /**
      * Write a JSON file.
      * @param jsonFilename The filename to write.

package/docs/changelog.md

@@ -1,5 +1,207 @@
 # @twin.org/cli-core - Changelog
 
-## 0.0.1-next.6
+## [0.0.1-next.62](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.61...cli-core-v0.0.1-next.62) (2025-06-17)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* improve error display in CLI ([94b6ca8](https://github.com/twinfoundation/framework/commit/94b6ca8bdcfe3ca7671c4095b436ea7bddaae98e))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Bug Fixes
+
+* framework pr naming convention ([#142](https://github.com/twinfoundation/framework/issues/142)) ([e29acee](https://github.com/twinfoundation/framework/commit/e29acee2fbec42506091956d6ba8b8ce25a90008))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.61 to 0.0.1-next.62
+    * @twin.org/crypto bumped from 0.0.1-next.61 to 0.0.1-next.62
+
+## [0.0.1-next.61](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.60...cli-core-v0.0.1-next.61) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.60 to 0.0.1-next.61
+    * @twin.org/crypto bumped from 0.0.1-next.60 to 0.0.1-next.61
+
+## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.59...cli-core-v0.0.1-next.60) (2025-06-17)
+
+
+### Features
+
+* improve error display in CLI ([94b6ca8](https://github.com/twinfoundation/framework/commit/94b6ca8bdcfe3ca7671c4095b436ea7bddaae98e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
+    * @twin.org/crypto bumped from 0.0.1-next.59 to 0.0.1-next.60
+
+## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.58...cli-core-v0.0.1-next.59) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
+    * @twin.org/crypto bumped from 0.0.1-next.58 to 0.0.1-next.59
+
+## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.57...cli-core-v0.0.1-next.58) (2025-06-13)
+
+
+### Bug Fixes
+
+* framework pr naming convention ([#142](https://github.com/twinfoundation/framework/issues/142)) ([e29acee](https://github.com/twinfoundation/framework/commit/e29acee2fbec42506091956d6ba8b8ce25a90008))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
+    * @twin.org/crypto bumped from 0.0.1-next.57 to 0.0.1-next.58
+
+## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.56...cli-core-v0.0.1-next.57) (2025-06-10)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
+    * @twin.org/crypto bumped from 0.0.1-next.56 to 0.0.1-next.57
+
+## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.55...cli-core-v0.0.1-next.56) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
+    * @twin.org/crypto bumped from 0.0.1-next.55 to 0.0.1-next.56
+
+## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.54...cli-core-v0.0.1-next.55) (2025-05-07)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
+    * @twin.org/crypto bumped from 0.0.1-next.54 to 0.0.1-next.55
+
+## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.53...cli-core-v0.0.1-next.54) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
+    * @twin.org/crypto bumped from 0.0.1-next.53 to 0.0.1-next.54
+
+## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.52...cli-core-v0.0.1-next.53) (2025-05-01)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
+    * @twin.org/crypto bumped from 0.0.1-next.52 to 0.0.1-next.53
+
+## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.51...cli-core-v0.0.1-next.52) (2025-04-17)
+
+
+### Features
+
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
+    * @twin.org/crypto bumped from 0.0.1-next.51 to 0.0.1-next.52
+
+## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.50...cli-core-v0.0.1-next.51) (2025-03-27)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
+    * @twin.org/crypto bumped from 0.0.1-next.50 to 0.0.1-next.51
+
+## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.49...cli-core-v0.0.1-next.50) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
+    * @twin.org/crypto bumped from 0.0.1-next.49 to 0.0.1-next.50
+
+## 0.0.1-next.49
 
 - Initial Release

package/docs/reference/classes/CLIBase.md

@@ -4,13 +4,13 @@ The main entry point for the CLI.
 
 ## Constructors
 
-### new CLIBase()
+### Constructor
 
-> **new CLIBase**(): [`CLIBase`](CLIBase.md)
+> **new CLIBase**(): `CLIBase`
 
 #### Returns
 
-[`CLIBase`](CLIBase.md)
+`CLIBase`
 
 ## Methods
 
@@ -22,15 +22,21 @@ Execute the command line processing.
 
 #### Parameters
 
-• **options**: [`ICliOptions`](../interfaces/ICliOptions.md)
+##### options
+
+[`ICliOptions`](../interfaces/ICliOptions.md)
 
 The options for the CLI.
 
-• **localesDirectory**: `string`
+##### localesDirectory
+
+`string`
 
 The path to load the locales from.
 
-• **argv**: `string`[]
+##### argv
+
+`string`[]
 
 The process arguments.
 
@@ -50,7 +56,9 @@ Configure any options or actions at the root program level.
 
 #### Parameters
 
-• **program**: `Command`
+##### program
+
+`Command`
 
 The root program command.
 
@@ -68,7 +76,9 @@ Get the commands for the CLI, override in derived class to supply your own.
 
 #### Parameters
 
-• **program**: `Command`
+##### program
+
+`Command`
 
 The main program that the commands will be added to.
 

package/docs/reference/classes/CLIDisplay.md

@@ -4,13 +4,13 @@ Display utilities for the CLI.
 
 ## Constructors
 
-### new CLIDisplay()
+### Constructor
 
-> **new CLIDisplay**(): [`CLIDisplay`](CLIDisplay.md)
+> **new CLIDisplay**(): `CLIDisplay`
 
 #### Returns
 
-[`CLIDisplay`](CLIDisplay.md)
+`CLIDisplay`
 
 ## Properties
 
@@ -22,10 +22,12 @@ The default output method for writing standard messages.
 
 #### Parameters
 
-• **buffer**: `string` \| `Uint8Array`
+##### buffer
 
 The message to output.
 
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `void`
@@ -40,10 +42,12 @@ The default output method for writing error messages.
 
 #### Parameters
 
-• **buffer**: `string` \| `Uint8Array`
+##### buffer
 
 The message to output.
 
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `void`
@@ -70,15 +74,21 @@ Display the header for the CLI.
 
 #### Parameters
 
-• **title**: `string`
+##### title
+
+`string`
 
 The title of the CLI.
 
-• **version**: `string`
+##### version
+
+`string`
 
 The version of the CLI.
 
-• **icon**: `string`
+##### icon
+
+`string`
 
 The icon for the CLI.
 
@@ -96,11 +106,15 @@ Display an error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to display.
 
-• **lineBreaks**: `boolean` = `true`
+##### lineBreaks
+
+`boolean` = `true`
 
 Whether to add a line break after the error.
 
@@ -118,7 +132,9 @@ Display a section.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the section.
 
@@ -136,15 +152,21 @@ Display a value with a label.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the value.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to display.
 
-• **indentLevel**: `number` = `0`
+##### indentLevel
+
+`number` = `0`
 
 The level of indentation.
 
@@ -156,17 +178,21 @@ The level of indentation.
 
 ### task()
 
-> `static` **task**(`label`, `task`?): `void`
+> `static` **task**(`label`, `task?`): `void`
 
 Display a task with a label.
 
 #### Parameters
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label for the value.
 
-• **task?**: `string`
+##### task?
+
+`string`
 
 The task to display.
 
@@ -196,7 +222,9 @@ Display formatted and colorized JSON.
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to display.
 
@@ -226,15 +254,21 @@ Start the spinner.
 
 #### Parameters
 
-• **i18nMessage**: `string` = `"cli.progress.pleaseWait"`
+##### i18nMessage
+
+`string` = `"cli.progress.pleaseWait"`
 
 The message to display with the spinner.
 
-• **spinnerCharacters**: `string`[] = `...`
+##### spinnerCharacters
+
+`string`[] = `...`
 
 The characters to use in the spinner.
 
-• **interval**: `number` = `100`
+##### interval
+
+`number` = `100`
 
 The interval for the spinner.