@twin.org/cli-core 0.0.3-next.3 → 0.0.3-next.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/docs/changelog.md +518 -1
- package/docs/examples.md +82 -1
- package/docs/reference/classes/CLIBase.md +3 -3
- package/docs/reference/classes/CLIDisplay.md +27 -27
- package/docs/reference/classes/CLIOptions.md +1 -1
- package/docs/reference/classes/CLIParam.md +56 -56
- package/docs/reference/classes/CLIUtils.md +17 -17
- package/docs/reference/interfaces/ICliOptions.md +12 -12
- package/docs/reference/interfaces/ICliOutputOptionsConsole.md +1 -1
- package/docs/reference/interfaces/ICliOutputOptionsEnv.md +3 -3
- package/docs/reference/interfaces/ICliOutputOptionsJson.md +3 -3
- package/package.json +7 -6
|
@@ -4,7 +4,7 @@ Options for the CLI.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### title
|
|
7
|
+
### title {#title}
|
|
8
8
|
|
|
9
9
|
> **title**: `string`
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ The title of the CLI.
|
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
-
### appName
|
|
15
|
+
### appName {#appname}
|
|
16
16
|
|
|
17
17
|
> **appName**: `string`
|
|
18
18
|
|
|
@@ -20,7 +20,7 @@ The name of the app used to execute it.
|
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
### version
|
|
23
|
+
### version {#version}
|
|
24
24
|
|
|
25
25
|
> **version**: `string`
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ The version of the app.
|
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
31
|
-
### icon
|
|
31
|
+
### icon {#icon}
|
|
32
32
|
|
|
33
33
|
> **icon**: `string`
|
|
34
34
|
|
|
@@ -36,32 +36,32 @@ The icon for the CLI as an emoji character.
|
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### supportsLang?
|
|
39
|
+
### supportsLang? {#supportslang}
|
|
40
40
|
|
|
41
|
-
> `optional` **supportsLang
|
|
41
|
+
> `optional` **supportsLang?**: `boolean`
|
|
42
42
|
|
|
43
43
|
Supports different languages.
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
47
|
-
### supportsEnvFiles?
|
|
47
|
+
### supportsEnvFiles? {#supportsenvfiles}
|
|
48
48
|
|
|
49
|
-
> `optional` **supportsEnvFiles
|
|
49
|
+
> `optional` **supportsEnvFiles?**: `boolean`
|
|
50
50
|
|
|
51
51
|
Supports the loading of env files.
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
55
|
-
### overrideOutputWidth?
|
|
55
|
+
### overrideOutputWidth? {#overrideoutputwidth}
|
|
56
56
|
|
|
57
|
-
> `optional` **overrideOutputWidth
|
|
57
|
+
> `optional` **overrideOutputWidth?**: `number`
|
|
58
58
|
|
|
59
59
|
Override the default output width.
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
63
|
-
### showDevToolWarning?
|
|
63
|
+
### showDevToolWarning? {#showdevtoolwarning}
|
|
64
64
|
|
|
65
|
-
> `optional` **showDevToolWarning
|
|
65
|
+
> `optional` **showDevToolWarning?**: `boolean`
|
|
66
66
|
|
|
67
67
|
Show a warning that this is a dev tool and not for production use.
|
|
@@ -4,15 +4,15 @@ Options for the CLI Output for env.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### env?
|
|
7
|
+
### env? {#env}
|
|
8
8
|
|
|
9
|
-
> `optional` **env
|
|
9
|
+
> `optional` **env?**: `string`
|
|
10
10
|
|
|
11
11
|
Output the data to an environment file.
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
-
### mergeEnv
|
|
15
|
+
### mergeEnv {#mergeenv}
|
|
16
16
|
|
|
17
17
|
> **mergeEnv**: `boolean`
|
|
18
18
|
|
|
@@ -4,15 +4,15 @@ Options for the CLI Output for JSON.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### json?
|
|
7
|
+
### json? {#json}
|
|
8
8
|
|
|
9
|
-
> `optional` **json
|
|
9
|
+
> `optional` **json?**: `string`
|
|
10
10
|
|
|
11
11
|
Output the data to an JSON file.
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
-
### mergeJson
|
|
15
|
+
### mergeJson {#mergejson}
|
|
16
16
|
|
|
17
17
|
> **mergeJson**: `boolean`
|
|
18
18
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/cli-core",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.30",
|
|
4
4
|
"description": "Core classes for building a CLI",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,11 +14,11 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/core": "0.0.3-next.
|
|
18
|
-
"@twin.org/nameof": "0.0.3-next.
|
|
17
|
+
"@twin.org/core": "0.0.3-next.30",
|
|
18
|
+
"@twin.org/nameof": "0.0.3-next.30",
|
|
19
19
|
"chalk": "5.6.2",
|
|
20
|
-
"commander": "14.0.
|
|
21
|
-
"dotenv": "17.
|
|
20
|
+
"commander": "14.0.3",
|
|
21
|
+
"dotenv": "17.3.1"
|
|
22
22
|
},
|
|
23
23
|
"main": "./dist/es/index.js",
|
|
24
24
|
"types": "./dist/types/index.d.ts",
|
|
@@ -27,7 +27,8 @@
|
|
|
27
27
|
"types": "./dist/types/index.d.ts",
|
|
28
28
|
"import": "./dist/es/index.js",
|
|
29
29
|
"default": "./dist/es/index.js"
|
|
30
|
-
}
|
|
30
|
+
},
|
|
31
|
+
"./locales/*.json": "./locales/*.json"
|
|
31
32
|
},
|
|
32
33
|
"files": [
|
|
33
34
|
"dist/es",
|