@twin.org/cli-core 0.0.1-next.1

package/docs/reference/classes/CLIUtils.md

@@ -0,0 +1,289 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Class: CLIUtils
+
+Utilities function for helping in the CLI.
+
+## Constructors
+
+### new CLIUtils()
+
+> **new CLIUtils**(): [`CLIUtils`](CLIUtils.md)
+
+#### Returns
+
+[`CLIUtils`](CLIUtils.md)
+
+## Methods
+
+### fileExists()
+
+> `static` **fileExists**(`filename`): `Promise`\<`boolean`\>
+
+Does the specified file exist.
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to check for existence.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the file exists.
+
+***
+
+### fileExistsSync()
+
+> `static` **fileExistsSync**(`filename`): `boolean`
+
+Does the specified file exist, synchronously.
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to check for existence.
+
+#### Returns
+
+`boolean`
+
+True if the file exists.
+
+***
+
+### dirExists()
+
+> `static` **dirExists**(`dir`): `Promise`\<`boolean`\>
+
+Check if the dir exists.
+
+#### Parameters
+
+• **dir**: `string`
+
+The directory to check.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the dir exists.
+
+***
+
+### dirExistsSync()
+
+> `static` **dirExistsSync**(`dir`): `boolean`
+
+Check if the dir exists, synchronously.
+
+#### Parameters
+
+• **dir**: `string`
+
+The directory to check.
+
+#### Returns
+
+`boolean`
+
+True if the dir exists.
+
+***
+
+### readJsonFile()
+
+> `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`undefined` \| `T`\>
+
+Read a JSON file and parse it.
+
+#### Type parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to read.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The parsed JSON.
+
+***
+
+### readJsonFileSync()
+
+> `static` **readJsonFileSync**\<`T`\>(`filename`): `undefined` \| `T`
+
+Read a JSON file and parse it, synchronously.
+
+#### Type parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to read.
+
+#### Returns
+
+`undefined` \| `T`
+
+The parsed JSON.
+
+***
+
+### readLinesFile()
+
+> `static` **readLinesFile**(`filename`): `Promise`\<`undefined` \| `string`[]\>
+
+Read a file as lines.
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to read.
+
+#### Returns
+
+`Promise`\<`undefined` \| `string`[]\>
+
+The lines.
+
+***
+
+### readLinesFileSync()
+
+> `static` **readLinesFileSync**(`filename`): `undefined` \| `string`[]
+
+Read a file as lines, synchronously.
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to read.
+
+#### Returns
+
+`undefined` \| `string`[]
+
+The lines.
+
+***
+
+### findNpmRoot()
+
+> `static` **findNpmRoot**(`rootFolder`): `Promise`\<`string`\>
+
+Find the NPM root based on a package.json path.
+
+#### Parameters
+
+• **rootFolder**: `string`
+
+The path to the package.json.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The root path.
+
+***
+
+### runShellCmd()
+
+> `static` **runShellCmd**(`app`, `args`, `cwd`): `Promise`\<`void`\>
+
+Run a shell app.
+
+#### Parameters
+
+• **app**: `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.
+
+***
+
+### writeJsonFile()
+
+> `static` **writeJsonFile**\<`T`\>(`jsonFilename`, `data`, `append`): `Promise`\<`void`\>
+
+Write a JSON file.
+
+#### Type parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **jsonFilename**: `undefined` \| `string`
+
+The filename to write.
+
+• **data**: `T`
+
+The data to write.
+
+• **append**: `boolean`
+
+Append to the file.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### writeEnvFile()
+
+> `static` **writeEnvFile**(`envFilename`, `data`, `append`): `Promise`\<`void`\>
+
+Write an env file.
+
+#### Parameters
+
+• **envFilename**: `undefined` \| `string`
+
+The filename to write.
+
+• **data**: `string`[]
+
+The data to write.
+
+• **append**: `boolean`
+
+Append to the file.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/addGlobalOptions.md

@@ -0,0 +1,27 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Function: addGlobalOptions()
+
+> **addGlobalOptions**(`program`, `supportsLang`, `supportsEnvFiles`): `void`
+
+Add the global options.
+
+## Parameters
+
+• **program**: `Command`
+
+The program to add the options to.
+
+• **supportsLang**: `boolean`
+
+Whether the CLI supports different languages.
+
+• **supportsEnvFiles**: `boolean`
+
+Whether the CLI supports loading env files
+
+## Returns
+
+`void`

package/docs/reference/functions/initGlobalOptions.md

@@ -0,0 +1,19 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Function: initGlobalOptions()
+
+> **initGlobalOptions**(`localesDirectory`): `void`
+
+Initialize the global options.
+
+## Parameters
+
+• **localesDirectory**: `string`
+
+The path to load the locales from.
+
+## Returns
+
+`void`

package/docs/reference/globals.md

@@ -0,0 +1,29 @@
+[**@twin.org/cli-core**](overview.md) • **Docs**
+
+***
+
+# @twin.org/cli-core
+
+## Classes
+
+- [CLIBase](classes/CLIBase.md)
+- [CLIDisplay](classes/CLIDisplay.md)
+- [CLIOptions](classes/CLIOptions.md)
+- [CLIParam](classes/CLIParam.md)
+- [CLIUtils](classes/CLIUtils.md)
+
+## Interfaces
+
+- [ICliOptions](interfaces/ICliOptions.md)
+- [ICliOutputOptionsConsole](interfaces/ICliOutputOptionsConsole.md)
+- [ICliOutputOptionsEnv](interfaces/ICliOutputOptionsEnv.md)
+- [ICliOutputOptionsJson](interfaces/ICliOutputOptionsJson.md)
+
+## Type Aliases
+
+- [CliOutputOptions](type-aliases/CliOutputOptions.md)
+
+## Functions
+
+- [initGlobalOptions](functions/initGlobalOptions.md)
+- [addGlobalOptions](functions/addGlobalOptions.md)

package/docs/reference/interfaces/ICliOptions.md

@@ -0,0 +1,55 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Interface: ICliOptions
+
+Options for the CLI.
+
+## Properties
+
+### title
+
+> **title**: `string`
+
+The title of the CLI.
+
+***
+
+### appName
+
+> **appName**: `string`
+
+The name of the app used to execute it.
+
+***
+
+### version
+
+> **version**: `string`
+
+The version of the app.
+
+***
+
+### icon
+
+> **icon**: `string`
+
+The icon for the CLI as an emoji character.
+
+***
+
+### supportsLang?
+
+> `optional` **supportsLang**: `boolean`
+
+Supports different languages.
+
+***
+
+### supportsEnvFiles?
+
+> `optional` **supportsEnvFiles**: `boolean`
+
+Supports the loading of env files.

package/docs/reference/interfaces/ICliOutputOptionsConsole.md

@@ -0,0 +1,15 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Interface: ICliOutputOptionsConsole
+
+Options for the CLI Output for console.
+
+## Properties
+
+### console
+
+> **console**: `boolean`
+
+Flag to display on the console.

package/docs/reference/interfaces/ICliOutputOptionsEnv.md

@@ -0,0 +1,23 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Interface: ICliOutputOptionsEnv
+
+Options for the CLI Output for env.
+
+## Properties
+
+### env?
+
+> `optional` **env**: `string`
+
+Output the data to an environment file.
+
+***
+
+### mergeEnv
+
+> **mergeEnv**: `boolean`
+
+Merge the data to an environment file.

package/docs/reference/interfaces/ICliOutputOptionsJson.md

@@ -0,0 +1,23 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Interface: ICliOutputOptionsJson
+
+Options for the CLI Output for JSON.
+
+## Properties
+
+### json?
+
+> `optional` **json**: `string`
+
+Output the data to an JSON file.
+
+***
+
+### mergeJson
+
+> **mergeJson**: `boolean`
+
+Merge the data to a JSON file.

package/docs/reference/type-aliases/CliOutputOptions.md

@@ -0,0 +1,9 @@
+[**@twin.org/cli-core**](../overview.md) • **Docs**
+
+***
+
+# Type alias: CliOutputOptions
+
+> **CliOutputOptions**: [`ICliOutputOptionsConsole`](../interfaces/ICliOutputOptionsConsole.md) & [`ICliOutputOptionsEnv`](../interfaces/ICliOutputOptionsEnv.md) & [`ICliOutputOptionsJson`](../interfaces/ICliOutputOptionsJson.md)
+
+Options for the CLI Output.

package/locales/en.json

@@ -0,0 +1,57 @@
+{
+	"error": {
+		"commands": {
+			"common": {
+				"missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+				"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}."
+			}
+		}
+	},
+	"cli": {
+		"progress": {
+			"done": "Done.",
+			"error": "Error",
+			"loadingEnvFiles": "Loading env files",
+			"pleaseWait": "Please wait...",
+			"writingJsonFile": "Writing JSON file",
+			"writingEnvFile": "Writing env file",
+			"readingJsonFile": "Reading JSON file",
+			"readingEnvFile": "Reading env file"
+		},
+		"options": {
+			"lang": {
+				"param": "--lang '<'lang'>'",
+				"description": "The language to display the output in."
+			},
+			"load-env": {
+				"param": "--load-env [env...]",
+				"description": "Load the env files to initialise any environment variables."
+			},
+			"no-console": {
+				"param": "--no-console",
+				"description": "Hides the output in the console."
+			},
+			"json": {
+				"param": "--json '<'filename'>'",
+				"description": "Creates a JSON file containing the output."
+			},
+			"env": {
+				"param": "--env '<'filename'>'",
+				"description": "Creates an env file containing the output."
+			},
+			"merge-json": {
+				"param": "--merge-json",
+				"description": "If the JSON file already exists merge the data instead of overwriting."
+			},
+			"merge-env": {
+				"param": "--merge-env",
+				"description": "If the env file already exists merge the data instead of overwriting."
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+	"name": "@twin.org/cli-core",
+	"version": "0.0.1-next.1",
+	"description": "Core classes for building a CLI",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/cli-core"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage",
+		"build": "tspc",
+		"merge-locales": "merge-locales",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "0.0.1-next.1",
+		"@twin.org/crypto": "0.0.1-next.1",
+		"@twin.org/nameof": "next",
+		"chalk": "5.3.0",
+		"commander": "12.1.0",
+		"dotenv": "16.4.5"
+	},
+	"devDependencies": {
+		"@gtsc/merge-locales": "next",
+		"@twin.org/nameof-transformer": "next",
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}