@twin.org/cli-core 0.0.1 → 0.0.2-next.11

package/dist/cjs/index.cjs

@@ -136,9 +136,18 @@ class CLIDisplay {
      * @param obj The object to display.
      */
     static json(obj) {
-        CLIDisplay.write(node_util.inspect(obj, false, undefined, true));
+        CLIDisplay.write(node_util.inspect(obj, false, null, true));
         CLIDisplay.write("\n");
     }
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label) {
+        CLIDisplay.write("⚠️  ");
+        CLIDisplay.write(chalk.hex("#FFA500").bold(label));
+        CLIDisplay.write("\n\n");
+    }
     /**
      * Display the processing is done.
      */
@@ -443,7 +452,7 @@ function handleGlobalOptions(command) {
         const resolvedEnv = loadEnv.map(e => path.resolve(e));
         CLIDisplay.task(core.I18n.formatMessage("cli.progress.loadingEnvFiles"), resolvedEnv.join(", "));
         CLIDisplay.break();
-        dotenv__namespace.config({ path: resolvedEnv });
+        dotenv__namespace.config({ path: resolvedEnv, quiet: true });
     }
 }
 /**
@@ -510,6 +519,9 @@ class CLIBase {
                 // eslint-disable-next-line no-restricted-syntax
                 throw new Error(err.code === "commander.help" ? "0" : err.exitCode.toString());
             });
+            if (options.showDevToolWarning ?? false) {
+                program.hook("preAction", () => CLIDisplay.warning(core.I18n.formatMessage("warn.common.devOnlyTool")));
+            }
             this.configureRoot(program);
             addGlobalOptions(program, options.supportsLang ?? true, options.supportsEnvFiles ?? false);
             // We parse the options before building the command
@@ -649,6 +661,20 @@ class CLIParam {
         core.Guards.stringValue("commands", optionName, optionValue);
         return optionValue;
     }
+    /**
+     * 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(optionName, optionValue, validValues, allowEnvVar = true) {
+        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
+        core.Guards.arrayOneOf("commands", optionName, optionValue, validValues);
+        return optionValue;
+    }
     /**
      * Check the option to see if it is a url.
      * @param optionName The name of the option.

package/dist/esm/index.mjs

@@ -115,9 +115,18 @@ class CLIDisplay {
      * @param obj The object to display.
      */
     static json(obj) {
-        CLIDisplay.write(inspect(obj, false, undefined, true));
+        CLIDisplay.write(inspect(obj, false, null, true));
         CLIDisplay.write("\n");
     }
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label) {
+        CLIDisplay.write("⚠️  ");
+        CLIDisplay.write(chalk.hex("#FFA500").bold(label));
+        CLIDisplay.write("\n\n");
+    }
     /**
      * Display the processing is done.
      */
@@ -422,7 +431,7 @@ function handleGlobalOptions(command) {
         const resolvedEnv = loadEnv.map(e => path.resolve(e));
         CLIDisplay.task(I18n.formatMessage("cli.progress.loadingEnvFiles"), resolvedEnv.join(", "));
         CLIDisplay.break();
-        dotenv.config({ path: resolvedEnv });
+        dotenv.config({ path: resolvedEnv, quiet: true });
     }
 }
 /**
@@ -489,6 +498,9 @@ class CLIBase {
                 // eslint-disable-next-line no-restricted-syntax
                 throw new Error(err.code === "commander.help" ? "0" : err.exitCode.toString());
             });
+            if (options.showDevToolWarning ?? false) {
+                program.hook("preAction", () => CLIDisplay.warning(I18n.formatMessage("warn.common.devOnlyTool")));
+            }
             this.configureRoot(program);
             addGlobalOptions(program, options.supportsLang ?? true, options.supportsEnvFiles ?? false);
             // We parse the options before building the command
@@ -628,6 +640,20 @@ class CLIParam {
         Guards.stringValue("commands", optionName, optionValue);
         return optionValue;
     }
+    /**
+     * 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(optionName, optionValue, validValues, allowEnvVar = true) {
+        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
+        Guards.arrayOneOf("commands", optionName, optionValue, validValues);
+        return optionValue;
+    }
     /**
      * Check the option to see if it is a url.
      * @param optionName The name of the option.

package/dist/types/cliDisplay.d.ts

@@ -56,6 +56,11 @@ export declare class CLIDisplay {
      * @param obj The object to display.
      */
     static json(obj: unknown): void;
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label: string): void;
     /**
      * Display the processing is done.
      */

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.

package/dist/types/index.d.ts

@@ -4,8 +4,8 @@ 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 "./models/cliOutputOptions";

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

@@ -30,4 +30,8 @@ export interface ICliOptions {
      * Override the default output width.
      */
     overrideOutputWidth?: number;
+    /**
+     * Show a warning that this is a dev tool and not for production use.
+     */
+    showDevToolWarning?: boolean;
 }

package/docs/changelog.md

@@ -1,5 +1,241 @@
 # @twin.org/cli-core - Changelog
 
+## [0.0.2-next.11](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.10...cli-core-v0.0.2-next.11) (2025-09-15)
+
+
+### Bug Fixes
+
+* cli display output for JSON to allow infinite depth ([2a06f52](https://github.com/twinfoundation/framework/commit/2a06f52c92dbc51a4969d651486a0c3548529929))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/crypto bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/nameof bumped from 0.0.2-next.10 to 0.0.2-next.11
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.9...cli-core-v0.0.2-next.10) (2025-09-11)
+
+
+### Features
+
+* add CLIParam.arrayOneOf ([18f0815](https://github.com/twinfoundation/framework/commit/18f08157e5305cddf65d09b36a51a91a0873e396))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/crypto bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/nameof bumped from 0.0.2-next.9 to 0.0.2-next.10
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.8...cli-core-v0.0.2-next.9) (2025-09-08)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/crypto bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/nameof bumped from 0.0.2-next.8 to 0.0.2-next.9
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.7...cli-core-v0.0.2-next.8) (2025-09-05)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/crypto bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/nameof bumped from 0.0.2-next.7 to 0.0.2-next.8
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.7 to 0.0.2-next.8
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.6...cli-core-v0.0.2-next.7) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([74427d7](https://github.com/twinfoundation/framework/commit/74427d78d342167f7850e49ab87269326355befe))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/crypto bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/nameof bumped from 0.0.2-next.6 to 0.0.2-next.7
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.6 to 0.0.2-next.7
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.5...cli-core-v0.0.2-next.6) (2025-08-27)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/crypto bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/nameof bumped from 0.0.2-next.5 to 0.0.2-next.6
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.5 to 0.0.2-next.6
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.4...cli-core-v0.0.2-next.5) (2025-08-19)
+
+
+### Features
+
+* use cause instead of inner for errors ([1f4acc4](https://github.com/twinfoundation/framework/commit/1f4acc4d7a6b71a134d9547da9bf40de1e1e49da))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/crypto bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/nameof bumped from 0.0.2-next.4 to 0.0.2-next.5
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.4 to 0.0.2-next.5
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.3...cli-core-v0.0.2-next.4) (2025-08-15)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/crypto bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/nameof bumped from 0.0.2-next.3 to 0.0.2-next.4
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.3 to 0.0.2-next.4
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.2...cli-core-v0.0.2-next.3) (2025-08-06)
+
+
+### 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))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.2 to 0.0.2-next.3
+    * @twin.org/crypto bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/nameof bumped from 0.0.2-next.2 to 0.0.2-next.3
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.2 to 0.0.2-next.3
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.1...cli-core-v0.0.2-next.2) (2025-08-06)
+
+
+### 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))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.1 to 0.0.2-next.2
+    * @twin.org/crypto bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/nameof bumped from 0.0.2-next.1 to 0.0.2-next.2
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.1 to 0.0.2-next.2
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.0...cli-core-v0.0.2-next.1) (2025-08-06)
+
+
+### 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))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* 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.2-next.0 to 0.0.2-next.1
+    * @twin.org/crypto bumped from 0.0.2-next.0 to 0.0.2-next.1
+    * @twin.org/nameof bumped from 0.0.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.0 to 0.0.2-next.1
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-03)
 
 

package/docs/reference/classes/CLIBase.md

@@ -1,4 +1,4 @@
-# Class: `abstract` CLIBase
+# Abstract Class: CLIBase
 
 The main entry point for the CLI.
 

package/docs/reference/classes/CLIDisplay.md

@@ -234,6 +234,26 @@ The object to display.
 
 ***
 
+### warning()
+
+> `static` **warning**(`label`): `void`
+
+Display a warning.
+
+#### Parameters
+
+##### label
+
+`string`
+
+The label for the warning.
+
+#### Returns
+
+`void`
+
+***
+
 ### done()
 
 > `static` **done**(): `void`

package/docs/reference/classes/CLIParam.md

@@ -90,6 +90,56 @@ An error if the option is invalid.
 
 ***
 
+### arrayOneOf()
+
+> `static` **arrayOneOf**\<`T`\>(`optionName`, `optionValue`, `validValues`, `allowEnvVar`): `T`
+
+Check the option to see if the value exists in the specific array.
+
+#### Type Parameters
+
+##### T
+
+`T` = `string`
+
+#### Parameters
+
+##### optionName
+
+`string`
+
+The name of the option.
+
+##### optionValue
+
+The option value.
+
+`undefined` | `string`
+
+##### validValues
+
+`T`[]
+
+The valid values.
+
+##### allowEnvVar
+
+`boolean` = `true`
+
+Allow the option to be read from an env var.
+
+#### Returns
+
+`T`
+
+The final option value.
+
+#### Throws
+
+An error if the option is invalid.
+
+***
+
 ### url()
 
 > `static` **url**(`optionName`, `optionValue`, `allowEnvVar`): `string`

package/docs/reference/interfaces/ICliOptions.md

@@ -57,3 +57,11 @@ Supports the loading of env files.
 > `optional` **overrideOutputWidth**: `number`
 
 Override the default output width.
+
+***
+
+### showDevToolWarning?
+
+> `optional` **showDevToolWarning**: `boolean`
+
+Show a warning that this is a dev tool and not for production use.

package/locales/en.json

@@ -12,6 +12,11 @@
 			}
 		}
 	},
+	"warn": {
+		"common": {
+			"devOnlyTool": "This tool is intended to be used for development purposes, it is not recommended for use in production scenarios."
+		}
+	},
 	"cli": {
 		"progress": {
 			"done": "Done.",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/cli-core",
-	"version": "0.0.1",
+	"version": "0.0.2-next.11",
 	"description": "Core classes for building a CLI",
 	"repository": {
 		"type": "git",
@@ -14,12 +14,12 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/crypto": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"chalk": "5.4.1",
+		"@twin.org/core": "0.0.2-next.11",
+		"@twin.org/crypto": "0.0.2-next.11",
+		"@twin.org/nameof": "0.0.2-next.11",
+		"chalk": "5.6.0",
 		"commander": "14.0.0",
-		"dotenv": "16.5.0"
+		"dotenv": "17.2.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",