@twin.org/cli-core 0.0.3-next.4 → 0.0.3-next.41

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.
@@ -14,7 +14,7 @@ Utilities function for helping in the CLI.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### fileExists()
17
+ ### fileExists() {#fileexists}
18
18
 
19
19
  > `static` **fileExists**(`filename`): `Promise`\<`boolean`\>
20
20
 
@@ -36,7 +36,7 @@ True if the file exists.
36
36
 
37
37
  ***
38
38
 
39
- ### fileExistsSync()
39
+ ### fileExistsSync() {#fileexistssync}
40
40
 
41
41
  > `static` **fileExistsSync**(`filename`): `boolean`
42
42
 
@@ -58,7 +58,7 @@ True if the file exists.
58
58
 
59
59
  ***
60
60
 
61
- ### dirExists()
61
+ ### dirExists() {#direxists}
62
62
 
63
63
  > `static` **dirExists**(`dir`): `Promise`\<`boolean`\>
64
64
 
@@ -80,7 +80,7 @@ True if the dir exists.
80
80
 
81
81
  ***
82
82
 
83
- ### dirExistsSync()
83
+ ### dirExistsSync() {#direxistssync}
84
84
 
85
85
  > `static` **dirExistsSync**(`dir`): `boolean`
86
86
 
@@ -102,7 +102,7 @@ True if the dir exists.
102
102
 
103
103
  ***
104
104
 
105
- ### readJsonFile()
105
+ ### readJsonFile() {#readjsonfile}
106
106
 
107
107
  > `static` **readJsonFile**\<`T`\>(`filename`): `Promise`\<`T` \| `undefined`\>
108
108
 
@@ -130,7 +130,7 @@ The parsed JSON.
130
130
 
131
131
  ***
132
132
 
133
- ### readJsonFileSync()
133
+ ### readJsonFileSync() {#readjsonfilesync}
134
134
 
135
135
  > `static` **readJsonFileSync**\<`T`\>(`filename`): `T` \| `undefined`
136
136
 
@@ -158,7 +158,7 @@ The parsed JSON.
158
158
 
159
159
  ***
160
160
 
161
- ### readLinesFile()
161
+ ### readLinesFile() {#readlinesfile}
162
162
 
163
163
  > `static` **readLinesFile**(`filename`): `Promise`\<`string`[] \| `undefined`\>
164
164
 
@@ -180,7 +180,7 @@ The lines.
180
180
 
181
181
  ***
182
182
 
183
- ### readLinesFileSync()
183
+ ### readLinesFileSync() {#readlinesfilesync}
184
184
 
185
185
  > `static` **readLinesFileSync**(`filename`): `string`[] \| `undefined`
186
186
 
@@ -202,7 +202,7 @@ The lines.
202
202
 
203
203
  ***
204
204
 
205
- ### findNpmRoot()
205
+ ### findNpmRoot() {#findnpmroot}
206
206
 
207
207
  > `static` **findNpmRoot**(`rootFolder`): `Promise`\<`string`\>
208
208
 
@@ -224,7 +224,7 @@ The root path.
224
224
 
225
225
  ***
226
226
 
227
- ### runShellCmd()
227
+ ### runShellCmd() {#runshellcmd}
228
228
 
229
229
  > `static` **runShellCmd**(`command`, `args`, `cwd`): `Promise`\<`void`\>
230
230
 
@@ -258,7 +258,7 @@ Promise to wait for command execution to complete.
258
258
 
259
259
  ***
260
260
 
261
- ### runShellApp()
261
+ ### runShellApp() {#runshellapp}
262
262
 
263
263
  > `static` **runShellApp**(`app`, `args`, `cwd`): `Promise`\<`void`\>
264
264
 
@@ -292,7 +292,7 @@ Promise to wait for command execution to complete.
292
292
 
293
293
  ***
294
294
 
295
- ### writeJsonFile()
295
+ ### writeJsonFile() {#writejsonfile}
296
296
 
297
297
  > `static` **writeJsonFile**\<`T`\>(`jsonFilename`, `data`, `append`): `Promise`\<`void`\>
298
298
 
@@ -308,9 +308,9 @@ Write a JSON file.
308
308
 
309
309
  ##### jsonFilename
310
310
 
311
- The filename to write.
311
+ `string` \| `undefined`
312
312
 
313
- `string` | `undefined`
313
+ The filename to write.
314
314
 
315
315
  ##### data
316
316
 
@@ -330,7 +330,7 @@ Append to the file.
330
330
 
331
331
  ***
332
332
 
333
- ### writeEnvFile()
333
+ ### writeEnvFile() {#writeenvfile}
334
334
 
335
335
  > `static` **writeEnvFile**(`envFilename`, `data`, `append`): `Promise`\<`void`\>
336
336
 
@@ -340,9 +340,9 @@ Write an env file.
340
340
 
341
341
  ##### envFilename
342
342
 
343
- The filename to write.
343
+ `string` \| `undefined`
344
344
 
345
- `string` | `undefined`
345
+ The filename to write.
346
346
 
347
347
  ##### data
348
348
 
@@ -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**: `boolean`
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**: `boolean`
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**: `number`
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**: `boolean`
65
+ > `optional` **showDevToolWarning?**: `boolean`
66
66
 
67
67
  Show a warning that this is a dev tool and not for production use.
@@ -4,7 +4,7 @@ Options for the CLI Output for console.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### console
7
+ ### console {#console}
8
8
 
9
9
  > **console**: `boolean`
10
10
 
@@ -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**: `string`
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**: `string`
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,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/cli-core",
3
- "version": "0.0.3-next.4",
3
+ "version": "0.0.3-next.41",
4
4
  "description": "Core classes for building a CLI",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/framework.git",
7
+ "url": "git+https://github.com/iotaledger/framework.git",
8
8
  "directory": "packages/cli-core"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,11 +14,11 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.3-next.4",
18
- "@twin.org/nameof": "0.0.3-next.4",
17
+ "@twin.org/core": "0.0.3-next.41",
18
+ "@twin.org/nameof": "0.0.3-next.41",
19
19
  "chalk": "5.6.2",
20
- "commander": "14.0.2",
21
- "dotenv": "17.2.3"
20
+ "commander": "14.0.3",
21
+ "dotenv": "17.4.2"
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",
@@ -46,7 +47,7 @@
46
47
  "utilities"
47
48
  ],
48
49
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/framework/issues"
50
+ "url": "git+https://github.com/iotaledger/framework/issues"
50
51
  },
51
52
  "homepage": "https://twindev.org"
52
53
  }