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

package/docs/reference/classes/CLIUtils.md

@@ -4,13 +4,13 @@ Utilities function for helping in the CLI.
 
 ## Constructors
 
-### new CLIUtils()
+### Constructor
 
-> **new CLIUtils**(): [`CLIUtils`](CLIUtils.md)
+> **new CLIUtils**(): `CLIUtils`
 
 #### Returns
 
-[`CLIUtils`](CLIUtils.md)
+`CLIUtils`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Does the specified file exist.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to check for existence.
 
@@ -42,7 +44,9 @@ Does the specified file exist, synchronously.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to check for existence.
 
@@ -62,7 +66,9 @@ Check if the dir exists.
 
 #### Parameters
 
-• **dir**: `string`
+##### dir
+
+`string`
 
 The directory to check.
 
@@ -82,7 +88,9 @@ Check if the dir exists, synchronously.
 
 #### Parameters
 
-• **dir**: `string`
+##### dir
+
+`string`
 
 The directory to check.
 
@@ -102,11 +110,15 @@ Read a JSON file and parse it.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -126,11 +138,15 @@ Read a JSON file and parse it, synchronously.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -150,7 +166,9 @@ Read a file as lines.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -170,7 +188,9 @@ Read a file as lines, synchronously.
 
 #### Parameters
 
-• **filename**: `string`
+##### filename
+
+`string`
 
 The filename to read.
 
@@ -190,7 +210,9 @@ Find the NPM root based on a package.json path.
 
 #### Parameters
 
-• **rootFolder**: `string`
+##### rootFolder
+
+`string`
 
 The path to the package.json.
 
@@ -204,21 +226,61 @@ The root path.
 
 ### runShellCmd()
 
-> `static` **runShellCmd**(`app`, `args`, `cwd`): `Promise`\<`void`\>
+> `static` **runShellCmd**(`command`, `args`, `cwd`): `Promise`\<`void`\>
+
+Run a shell command.
+
+#### Parameters
+
+##### command
+
+`string`
+
+The app to run in the shell.
+
+##### args
+
+`string`[]
+
+The args for the app.
+
+##### cwd
+
+`string`
+
+The working directory to execute the command in.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise to wait for command execution to complete.
+
+***
+
+### runShellApp()
+
+> `static` **runShellApp**(`app`, `args`, `cwd`): `Promise`\<`void`\>
 
 Run a shell app.
 
 #### Parameters
 
-• **app**: `string`
+##### app
+
+`string`
 
 The app to run in the shell.
 
-• **args**: `string`[]
+##### args
+
+`string`[]
 
 The args for the app.
 
-• **cwd**: `string`
+##### cwd
+
+`string`
 
 The working directory to execute the command in.
 
@@ -238,19 +300,27 @@ Write a JSON file.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **jsonFilename**: `undefined` \| `string`
+##### jsonFilename
 
 The filename to write.
 
-• **data**: `T`
+`undefined` | `string`
+
+##### data
+
+`T`
 
 The data to write.
 
-• **append**: `boolean`
+##### append
+
+`boolean`
 
 Append to the file.
 
@@ -268,15 +338,21 @@ Write an env file.
 
 #### Parameters
 
-• **envFilename**: `undefined` \| `string`
+##### envFilename
 
 The filename to write.
 
-• **data**: `string`[]
+`undefined` | `string`
+
+##### data
+
+`string`[]
 
 The data to write.
 
-• **append**: `boolean`
+##### append
+
+`boolean`
 
 Append to the file.
 

package/docs/reference/functions/addGlobalOptions.md

@@ -6,15 +6,21 @@ Add the global options.
 
 ## Parameters
 
-• **program**: `Command`
+### program
+
+`Command`
 
 The program to add the options to.
 
-• **supportsLang**: `boolean`
+### supportsLang
+
+`boolean`
 
 Whether the CLI supports different languages.
 
-• **supportsEnvFiles**: `boolean`
+### supportsEnvFiles
+
+`boolean`
 
 Whether the CLI supports loading env files
 

package/docs/reference/functions/initGlobalOptions.md

@@ -6,7 +6,9 @@ Initialize the global options.
 
 ## Parameters
 
-• **localesDirectory**: `string`
+### localesDirectory
+
+`string`
 
 The path to load the locales from.
 

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/docs/reference/type-aliases/CliOutputOptions.md

@@ -1,5 +1,5 @@
 # Type Alias: CliOutputOptions
 
-> **CliOutputOptions**: [`ICliOutputOptionsConsole`](../interfaces/ICliOutputOptionsConsole.md) & [`ICliOutputOptionsEnv`](../interfaces/ICliOutputOptionsEnv.md) & [`ICliOutputOptionsJson`](../interfaces/ICliOutputOptionsJson.md)
+> **CliOutputOptions** = [`ICliOutputOptionsConsole`](../interfaces/ICliOutputOptionsConsole.md) & [`ICliOutputOptionsEnv`](../interfaces/ICliOutputOptionsEnv.md) & [`ICliOutputOptionsJson`](../interfaces/ICliOutputOptionsJson.md)
 
 Options for the CLI Output.

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-next.9",
+	"version": "0.0.2-next.10",
 	"description": "Core classes for building a CLI",
 	"repository": {
 		"type": "git",
@@ -14,21 +14,21 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.1-next.9",
-		"@twin.org/crypto": "0.0.1-next.9",
-		"@twin.org/nameof": "next",
-		"chalk": "5.3.0",
-		"commander": "12.1.0",
-		"dotenv": "16.4.5"
+		"@twin.org/core": "0.0.2-next.10",
+		"@twin.org/crypto": "0.0.2-next.10",
+		"@twin.org/nameof": "0.0.2-next.10",
+		"chalk": "5.6.0",
+		"commander": "14.0.0",
+		"dotenv": "17.2.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [