@twin.org/cli-core 0.0.1-next.50 → 0.0.1-next.52
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/docs/changelog.md +30 -0
- package/docs/reference/classes/CLIBase.md +3 -3
- package/docs/reference/classes/CLIDisplay.md +4 -4
- package/docs/reference/classes/CLIOptions.md +3 -3
- package/docs/reference/classes/CLIParam.md +6 -6
- package/docs/reference/classes/CLIUtils.md +12 -6
- package/docs/reference/type-aliases/CliOutputOptions.md +1 -1
- package/package.json +4 -4
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @twin.org/cli-core - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.51...cli-core-v0.0.1-next.52) (2025-04-17)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
|
|
16
|
+
* @twin.org/crypto bumped from 0.0.1-next.51 to 0.0.1-next.52
|
|
17
|
+
|
|
18
|
+
## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.50...cli-core-v0.0.1-next.51) (2025-03-27)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Miscellaneous Chores
|
|
22
|
+
|
|
23
|
+
* **cli-core:** Synchronize repo versions
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
|
|
31
|
+
* @twin.org/crypto bumped from 0.0.1-next.50 to 0.0.1-next.51
|
|
32
|
+
|
|
3
33
|
## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/cli-core-v0.0.1-next.49...cli-core-v0.0.1-next.50) (2025-03-26)
|
|
4
34
|
|
|
5
35
|
|
|
@@ -4,13 +4,13 @@ The main entry point for the CLI.
|
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new CLIBase**():
|
|
9
|
+
> **new CLIBase**(): `CLIBase`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
`CLIBase`
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
@@ -4,13 +4,13 @@ Display utilities for the CLI.
|
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new CLIDisplay**():
|
|
9
|
+
> **new CLIDisplay**(): `CLIDisplay`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
`CLIDisplay`
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
@@ -178,7 +178,7 @@ The level of indentation.
|
|
|
178
178
|
|
|
179
179
|
### task()
|
|
180
180
|
|
|
181
|
-
> `static` **task**(`label`, `task
|
|
181
|
+
> `static` **task**(`label`, `task?`): `void`
|
|
182
182
|
|
|
183
183
|
Display a task with a label.
|
|
184
184
|
|
|
@@ -4,13 +4,13 @@ Utilities for getting standard options.
|
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new CLIOptions**():
|
|
9
|
+
> **new CLIOptions**(): `CLIOptions`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
`CLIOptions`
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
@@ -4,13 +4,13 @@ Parameter utilities for the CLI.
|
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new CLIParam**():
|
|
9
|
+
> **new CLIParam**(): `CLIParam`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
`CLIParam`
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
@@ -130,7 +130,7 @@ An error if the option is invalid.
|
|
|
130
130
|
|
|
131
131
|
### number()
|
|
132
132
|
|
|
133
|
-
> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue
|
|
133
|
+
> `static` **number**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
|
|
134
134
|
|
|
135
135
|
Check the option to see if it exists and is a number.
|
|
136
136
|
|
|
@@ -180,7 +180,7 @@ An error if the option is invalid.
|
|
|
180
180
|
|
|
181
181
|
### integer()
|
|
182
182
|
|
|
183
|
-
> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue
|
|
183
|
+
> `static` **integer**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `number`
|
|
184
184
|
|
|
185
185
|
Check the option to see if it exists and is an integer.
|
|
186
186
|
|
|
@@ -230,7 +230,7 @@ An error if the option is invalid.
|
|
|
230
230
|
|
|
231
231
|
### bigint()
|
|
232
232
|
|
|
233
|
-
> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue
|
|
233
|
+
> `static` **bigint**(`optionName`, `optionValue`, `allowEnvVar`, `minValue`, `maxValue?`): `bigint`
|
|
234
234
|
|
|
235
235
|
Check the option to see if it exists and is a big number.
|
|
236
236
|
|
|
@@ -4,13 +4,13 @@ Utilities function for helping in the CLI.
|
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new CLIUtils**():
|
|
9
|
+
> **new CLIUtils**(): `CLIUtils`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
`CLIUtils`
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
@@ -110,7 +110,9 @@ Read a JSON file and parse it.
|
|
|
110
110
|
|
|
111
111
|
#### Type Parameters
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
##### T
|
|
114
|
+
|
|
115
|
+
`T` = `unknown`
|
|
114
116
|
|
|
115
117
|
#### Parameters
|
|
116
118
|
|
|
@@ -136,7 +138,9 @@ Read a JSON file and parse it, synchronously.
|
|
|
136
138
|
|
|
137
139
|
#### Type Parameters
|
|
138
140
|
|
|
139
|
-
|
|
141
|
+
##### T
|
|
142
|
+
|
|
143
|
+
`T` = `unknown`
|
|
140
144
|
|
|
141
145
|
#### Parameters
|
|
142
146
|
|
|
@@ -296,7 +300,9 @@ Write a JSON file.
|
|
|
296
300
|
|
|
297
301
|
#### Type Parameters
|
|
298
302
|
|
|
299
|
-
|
|
303
|
+
##### T
|
|
304
|
+
|
|
305
|
+
`T` = `unknown`
|
|
300
306
|
|
|
301
307
|
#### Parameters
|
|
302
308
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: CliOutputOptions
|
|
2
2
|
|
|
3
|
-
> **CliOutputOptions
|
|
3
|
+
> **CliOutputOptions** = [`ICliOutputOptionsConsole`](../interfaces/ICliOutputOptionsConsole.md) & [`ICliOutputOptionsEnv`](../interfaces/ICliOutputOptionsEnv.md) & [`ICliOutputOptionsJson`](../interfaces/ICliOutputOptionsJson.md)
|
|
4
4
|
|
|
5
5
|
Options for the CLI Output.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/cli-core",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.52",
|
|
4
4
|
"description": "Core classes for building a CLI",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/core": "0.0.1-next.
|
|
18
|
-
"@twin.org/crypto": "0.0.1-next.
|
|
17
|
+
"@twin.org/core": "0.0.1-next.52",
|
|
18
|
+
"@twin.org/crypto": "0.0.1-next.52",
|
|
19
19
|
"@twin.org/nameof": "next",
|
|
20
20
|
"chalk": "5.4.1",
|
|
21
21
|
"commander": "13.1.0",
|
|
22
|
-
"dotenv": "16.
|
|
22
|
+
"dotenv": "16.5.0"
|
|
23
23
|
},
|
|
24
24
|
"main": "./dist/cjs/index.cjs",
|
|
25
25
|
"module": "./dist/esm/index.mjs",
|