@twin.org/cli-core 0.0.2-next.19 → 0.0.2-next.21

package/dist/cjs/index.cjs

@@ -10,7 +10,6 @@ var dotenv = require('dotenv');
 var node_child_process = require('node:child_process');
 var node_fs = require('node:fs');
 var promises = require('node:fs/promises');
-var crypto = require('@twin.org/crypto');
 
 function _interopNamespaceDefault(e) {
     var n = Object.create(null);
@@ -87,6 +86,15 @@ class CLIDisplay {
             CLIDisplay.writeError("\n");
         }
     }
+    /**
+     * Display an error message in simple form.
+     * @param error The error to display.
+     */
+    static errorMessage(error) {
+        CLIDisplay.writeError("❗ ");
+        CLIDisplay.writeError(chalk.red(error));
+        CLIDisplay.writeError("\n");
+    }
     /**
      * Display a section.
      * @param label The label for the section.
@@ -538,6 +546,10 @@ class CLIBase {
         catch (error) {
             CLIDisplay.spinnerStop();
             let exitCode;
+            // We have no control over the response from commander
+            // so we have to do some checking and coercion here
+            // to get a valid exit code.
+            // eslint-disable-next-line no-restricted-syntax
             if (error instanceof Error) {
                 // This error could be the exit code we errored with
                 // from the exitOverride so parse and resolve with it
@@ -635,6 +647,8 @@ class CLIParam {
     static env(optionName, optionValue, allowEnvVar) {
         if (allowEnvVar && optionValue?.startsWith("!")) {
             const envValueName = optionValue.slice(1);
+            // This is reading from an env var so it really has no choice
+            // eslint-disable-next-line no-restricted-syntax
             const envValue = process.env[envValueName];
             if (core.Is.empty(envValue)) {
                 throw new core.GeneralError("commands", "commands.common.missingEnv", {
@@ -861,24 +875,6 @@ class CLIParam {
             value: optionValue
         });
     }
-    /**
-     * 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, optionValue, allowEnvVar = true) {
-        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
-        if (crypto.Bech32.isBech32(optionValue)) {
-            return optionValue;
-        }
-        throw new core.GeneralError("commands", "commands.common.optionInvalidBech32", {
-            option: optionName,
-            value: optionValue
-        });
-    }
 }
 
 exports.CLIBase = CLIBase;

package/dist/esm/index.mjs

@@ -8,7 +8,6 @@ import * as dotenv from 'dotenv';
 import { exec, spawn } from 'node:child_process';
 import { statSync, accessSync, readFileSync } from 'node:fs';
 import { stat, access, readFile, mkdir, writeFile } from 'node:fs/promises';
-import { Bech32 } from '@twin.org/crypto';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -66,6 +65,15 @@ class CLIDisplay {
             CLIDisplay.writeError("\n");
         }
     }
+    /**
+     * Display an error message in simple form.
+     * @param error The error to display.
+     */
+    static errorMessage(error) {
+        CLIDisplay.writeError("❗ ");
+        CLIDisplay.writeError(chalk.red(error));
+        CLIDisplay.writeError("\n");
+    }
     /**
      * Display a section.
      * @param label The label for the section.
@@ -517,6 +525,10 @@ class CLIBase {
         catch (error) {
             CLIDisplay.spinnerStop();
             let exitCode;
+            // We have no control over the response from commander
+            // so we have to do some checking and coercion here
+            // to get a valid exit code.
+            // eslint-disable-next-line no-restricted-syntax
             if (error instanceof Error) {
                 // This error could be the exit code we errored with
                 // from the exitOverride so parse and resolve with it
@@ -614,6 +626,8 @@ class CLIParam {
     static env(optionName, optionValue, allowEnvVar) {
         if (allowEnvVar && optionValue?.startsWith("!")) {
             const envValueName = optionValue.slice(1);
+            // This is reading from an env var so it really has no choice
+            // eslint-disable-next-line no-restricted-syntax
             const envValue = process.env[envValueName];
             if (Is.empty(envValue)) {
                 throw new GeneralError("commands", "commands.common.missingEnv", {
@@ -840,24 +854,6 @@ class CLIParam {
             value: optionValue
         });
     }
-    /**
-     * 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, optionValue, allowEnvVar = true) {
-        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
-        if (Bech32.isBech32(optionValue)) {
-            return optionValue;
-        }
-        throw new GeneralError("commands", "commands.common.optionInvalidBech32", {
-            option: optionName,
-            value: optionValue
-        });
-    }
 }
 
 export { CLIBase, CLIDisplay, CLIOptions, CLIParam, CLIUtils, addGlobalOptions, handleGlobalOptions, initGlobalOptions, initLocales };

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

@@ -108,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/docs/changelog.md

@@ -1,5 +1,42 @@
 # @twin.org/cli-core - Changelog
 
+## [0.0.2-next.21](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.20...cli-core-v0.0.2-next.21) (2025-10-09)
+
+
+### Features
+
+* locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/nameof bumped from 0.0.2-next.20 to 0.0.2-next.21
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.20 to 0.0.2-next.21
+
+## [0.0.2-next.20](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.19...cli-core-v0.0.2-next.20) (2025-10-02)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.19 to 0.0.2-next.20
+    * @twin.org/crypto bumped from 0.0.2-next.19 to 0.0.2-next.20
+    * @twin.org/nameof bumped from 0.0.2-next.19 to 0.0.2-next.20
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.19 to 0.0.2-next.20
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.19 to 0.0.2-next.20
+
 ## [0.0.2-next.19](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.18...cli-core-v0.0.2-next.19) (2025-09-30)
 
 

package/docs/reference/classes/CLIDisplay.md

@@ -124,6 +124,26 @@ Whether to add a line break after the error.
 
 ***
 
+### errorMessage()
+
+> `static` **errorMessage**(`error`): `void`
+
+Display an error message in simple form.
+
+#### Parameters
+
+##### error
+
+`string`
+
+The error to display.
+
+#### Returns
+
+`void`
+
+***
+
 ### section()
 
 > `static` **section**(`label`): `void`

package/docs/reference/classes/CLIParam.md

@@ -477,41 +477,3 @@ The final option value.
 #### Throws
 
 An error if the option is invalid.
-
-***
-
-### bech32()
-
-> `static` **bech32**(`optionName`, `optionValue`, `allowEnvVar`): `string`
-
-Check the option to see if it exists and is bech32.
-
-#### Parameters
-
-##### optionName
-
-`string`
-
-The name of the option.
-
-##### optionValue
-
-The option value.
-
-`undefined` | `string`
-
-##### allowEnvVar
-
-`boolean` = `true`
-
-Allow the option to be read from an env var.
-
-#### Returns
-
-`string`
-
-The final option value.
-
-#### Throws
-
-An error if the option is invalid.

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^commander.help$

package/locales/en.json

@@ -6,7 +6,6 @@
 				"optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
 				"optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
 				"optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
-				"optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
 				"optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
 				"optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/cli-core",
-	"version": "0.0.2-next.19",
+	"version": "0.0.2-next.21",
 	"description": "Core classes for building a CLI",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.2-next.19",
-		"@twin.org/crypto": "0.0.2-next.19",
-		"@twin.org/nameof": "0.0.2-next.19",
+		"@twin.org/core": "0.0.2-next.21",
+		"@twin.org/nameof": "0.0.2-next.21",
 		"chalk": "5.6.2",
 		"commander": "14.0.1",
 		"dotenv": "17.2.2"
@@ -37,5 +36,19 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"core",
+		"foundation",
+		"utilities"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }