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

package/docs/changelog.md

@@ -1,5 +1,283 @@
 # @twin.org/cli-core - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.3-next.0...cli-core-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add CLIParam.arrayOneOf ([18f0815](https://github.com/twinfoundation/framework/commit/18f08157e5305cddf65d09b36a51a91a0873e396))
+* add context id features ([#206](https://github.com/twinfoundation/framework/issues/206)) ([ef0d4ee](https://github.com/twinfoundation/framework/commit/ef0d4ee11a4f5fc6cc6f52a4958ce905c04ee13b))
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+* eslint migration to flat config ([74427d7](https://github.com/twinfoundation/framework/commit/74427d78d342167f7850e49ab87269326355befe))
+* improve error display in CLI ([94b6ca8](https://github.com/twinfoundation/framework/commit/94b6ca8bdcfe3ca7671c4095b436ea7bddaae98e))
+* locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
+* relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
+* update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
+* use cause instead of inner for errors ([1f4acc4](https://github.com/twinfoundation/framework/commit/1f4acc4d7a6b71a134d9547da9bf40de1e1e49da))
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+
+### Bug Fixes
+
+* cli display output for JSON to allow infinite depth ([2a06f52](https://github.com/twinfoundation/framework/commit/2a06f52c92dbc51a4969d651486a0c3548529929))
+* 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.3-next.0 to 0.0.3-next.1
+    * @twin.org/nameof bumped from 0.0.3-next.0 to 0.0.3-next.1
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.0 to 0.0.3-next.1
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.22](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.21...cli-core-v0.0.2-next.22) (2025-10-10)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof bumped from 0.0.2-next.21 to 0.0.2-next.22
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.21 to 0.0.2-next.22
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/crypto bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/nameof bumped from 0.0.2-next.18 to 0.0.2-next.19
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.18 to 0.0.2-next.19
+
+## [0.0.2-next.18](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.17...cli-core-v0.0.2-next.18) (2025-09-29)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/crypto bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/nameof bumped from 0.0.2-next.17 to 0.0.2-next.18
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.17 to 0.0.2-next.18
+
+## [0.0.2-next.17](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.16...cli-core-v0.0.2-next.17) (2025-09-29)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.16 to 0.0.2-next.17
+    * @twin.org/crypto bumped from 0.0.2-next.16 to 0.0.2-next.17
+    * @twin.org/nameof bumped from 0.0.2-next.16 to 0.0.2-next.17
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.16 to 0.0.2-next.17
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.16 to 0.0.2-next.17
+
+## [0.0.2-next.16](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.15...cli-core-v0.0.2-next.16) (2025-09-28)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.15 to 0.0.2-next.16
+    * @twin.org/crypto bumped from 0.0.2-next.15 to 0.0.2-next.16
+    * @twin.org/nameof bumped from 0.0.2-next.15 to 0.0.2-next.16
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.15 to 0.0.2-next.16
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.15 to 0.0.2-next.16
+
+## [0.0.2-next.15](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.14...cli-core-v0.0.2-next.15) (2025-09-22)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.14 to 0.0.2-next.15
+    * @twin.org/crypto bumped from 0.0.2-next.14 to 0.0.2-next.15
+    * @twin.org/nameof bumped from 0.0.2-next.14 to 0.0.2-next.15
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.14 to 0.0.2-next.15
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.14 to 0.0.2-next.15
+
+## [0.0.2-next.14](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.13...cli-core-v0.0.2-next.14) (2025-09-22)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.13 to 0.0.2-next.14
+    * @twin.org/crypto bumped from 0.0.2-next.13 to 0.0.2-next.14
+    * @twin.org/nameof bumped from 0.0.2-next.13 to 0.0.2-next.14
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.13 to 0.0.2-next.14
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.13 to 0.0.2-next.14
+
+## [0.0.2-next.13](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.12...cli-core-v0.0.2-next.13) (2025-09-22)
+
+
+### Miscellaneous Chores
+
+* **cli-core:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.2-next.12 to 0.0.2-next.13
+    * @twin.org/crypto bumped from 0.0.2-next.12 to 0.0.2-next.13
+    * @twin.org/nameof bumped from 0.0.2-next.12 to 0.0.2-next.13
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.12 to 0.0.2-next.13
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [0.0.2-next.12](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.2-next.11...cli-core-v0.0.2-next.12) (2025-09-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.11 to 0.0.2-next.12
+    * @twin.org/crypto bumped from 0.0.2-next.11 to 0.0.2-next.12
+    * @twin.org/nameof bumped from 0.0.2-next.11 to 0.0.2-next.12
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.11 to 0.0.2-next.12
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [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)
 
 

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

@@ -16,7 +16,7 @@ Parameter utilities for the CLI.
 
 ### env()
 
-> `static` **env**(`optionName`, `optionValue`, `allowEnvVar`): `undefined` \| `string`
+> `static` **env**(`optionName`, `optionValue`, `allowEnvVar`): `string` \| `undefined`
 
 Check the option to see if it exists.
 
@@ -32,7 +32,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -42,7 +42,7 @@ Allow the option to be read from an env var.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The final option value.
 
@@ -70,7 +70,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -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.
+
+`string` | `undefined`
+
+##### 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`
@@ -108,7 +158,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -146,7 +196,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -196,7 +246,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -246,7 +296,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -296,7 +346,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -334,7 +384,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -372,7 +422,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -410,7 +460,7 @@ The name of the option.
 
 The option value.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### allowEnvVar
 
@@ -427,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/docs/reference/classes/CLIUtils.md

@@ -104,7 +104,7 @@ True if the dir exists.
 
 ### readJsonFile()
 
-> `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`undefined` \| `T`\>
+> `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`T` \| `undefined`\>
 
 Read a JSON file and parse it.
 
@@ -124,7 +124,7 @@ The filename to read.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The parsed JSON.
 
@@ -132,7 +132,7 @@ The parsed JSON.
 
 ### readJsonFileSync()
 
-> `static` **readJsonFileSync**\<`T`\>(`filename`): `undefined` \| `T`
+> `static` **readJsonFileSync**\<`T`\>(`filename`): `T` \| `undefined`
 
 Read a JSON file and parse it, synchronously.
 
@@ -152,7 +152,7 @@ The filename to read.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The parsed JSON.
 
@@ -160,7 +160,7 @@ The parsed JSON.
 
 ### readLinesFile()
 
-> `static` **readLinesFile**(`filename`): `Promise`\<`undefined` \| `string`[]\>
+> `static` **readLinesFile**(`filename`): `Promise`\<`string`[] \| `undefined`\>
 
 Read a file as lines.
 
@@ -174,7 +174,7 @@ The filename to read.
 
 #### Returns
 
-`Promise`\<`undefined` \| `string`[]\>
+`Promise`\<`string`[] \| `undefined`\>
 
 The lines.
 
@@ -182,7 +182,7 @@ The lines.
 
 ### readLinesFileSync()
 
-> `static` **readLinesFileSync**(`filename`): `undefined` \| `string`[]
+> `static` **readLinesFileSync**(`filename`): `string`[] \| `undefined`
 
 Read a file as lines, synchronously.
 
@@ -196,7 +196,7 @@ The filename to read.
 
 #### Returns
 
-`undefined` \| `string`[]
+`string`[] \| `undefined`
 
 The lines.
 
@@ -310,7 +310,7 @@ Write a JSON file.
 
 The filename to write.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### data
 
@@ -342,7 +342,7 @@ Write an env file.
 
 The filename to write.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### data
 

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.9",
+	"version": "0.0.3-next.1",
 	"description": "Core classes for building a CLI",
 	"repository": {
 		"type": "git",
@@ -14,28 +14,39 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.2-next.9",
-		"@twin.org/crypto": "0.0.2-next.9",
-		"@twin.org/nameof": "0.0.2-next.9",
-		"chalk": "5.6.0",
-		"commander": "14.0.0",
-		"dotenv": "17.2.1"
+		"@twin.org/core": "0.0.3-next.1",
+		"@twin.org/nameof": "0.0.3-next.1",
+		"chalk": "5.6.2",
+		"commander": "14.0.2",
+		"dotenv": "17.2.3"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"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"
 }