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

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.
Files changed (46) hide show
  1. package/README.md +2 -2
  2. package/dist/es/cliBase.js +122 -0
  3. package/dist/es/cliBase.js.map +1 -0
  4. package/dist/es/cliDisplay.js +166 -0
  5. package/dist/es/cliDisplay.js.map +1 -0
  6. package/dist/es/cliOptions.js +36 -0
  7. package/dist/es/cliOptions.js.map +1 -0
  8. package/dist/es/cliParam.js +248 -0
  9. package/dist/es/cliParam.js.map +1 -0
  10. package/dist/es/cliUtils.js +235 -0
  11. package/dist/es/cliUtils.js.map +1 -0
  12. package/dist/es/commands/global.js +61 -0
  13. package/dist/es/commands/global.js.map +1 -0
  14. package/dist/es/index.js +14 -0
  15. package/dist/es/index.js.map +1 -0
  16. package/dist/es/models/ICliOptions.js +2 -0
  17. package/dist/es/models/ICliOptions.js.map +1 -0
  18. package/dist/es/models/ICliOutputOptionsConsole.js +2 -0
  19. package/dist/es/models/ICliOutputOptionsConsole.js.map +1 -0
  20. package/dist/es/models/ICliOutputOptionsEnv.js +2 -0
  21. package/dist/es/models/ICliOutputOptionsEnv.js.map +1 -0
  22. package/dist/es/models/ICliOutputOptionsJson.js +2 -0
  23. package/dist/es/models/ICliOutputOptionsJson.js.map +1 -0
  24. package/dist/es/models/cliOutputOptions.js +2 -0
  25. package/dist/es/models/cliOutputOptions.js.map +1 -0
  26. package/dist/types/cliBase.d.ts +1 -1
  27. package/dist/types/cliDisplay.d.ts +5 -0
  28. package/dist/types/cliParam.d.ts +10 -9
  29. package/dist/types/index.d.ts +11 -11
  30. package/dist/types/models/cliOutputOptions.d.ts +3 -3
  31. package/docs/changelog.md +1179 -72
  32. package/docs/examples.md +82 -1
  33. package/docs/reference/classes/CLIBase.md +3 -3
  34. package/docs/reference/classes/CLIDisplay.md +46 -26
  35. package/docs/reference/classes/CLIOptions.md +1 -1
  36. package/docs/reference/classes/CLIParam.md +97 -85
  37. package/docs/reference/classes/CLIUtils.md +25 -25
  38. package/docs/reference/interfaces/ICliOptions.md +12 -12
  39. package/docs/reference/interfaces/ICliOutputOptionsConsole.md +1 -1
  40. package/docs/reference/interfaces/ICliOutputOptionsEnv.md +3 -3
  41. package/docs/reference/interfaces/ICliOutputOptionsJson.md +3 -3
  42. package/locales/.validate-ignore +1 -0
  43. package/locales/en.json +0 -1
  44. package/package.json +28 -16
  45. package/dist/cjs/index.cjs +0 -878
  46. package/dist/esm/index.mjs +0 -849
package/docs/reference/interfaces/ICliOutputOptionsJson.md CHANGED
@@ -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/locales/.validate-ignore ADDED
@@ -0,0 +1 @@
1
+ ^commander.help$
package/locales/en.json CHANGED
@@ -6,7 +6,6 @@
6
6
  "optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
7
7
  "optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
8
8
  "optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
9
- "optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
10
9
  "optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
11
10
  "optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
12
11
  }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/cli-core",
3
- "version": "0.0.2-next.9",
3
+ "version": "0.0.2",
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,28 +14,40 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.2-next.9",
18
- "@twin.org/crypto": "0.0.2-next.9",
19
- "@twin.org/nameof": "0.0.2-next.9",
20
- "chalk": "5.6.0",
21
- "commander": "14.0.0",
22
- "dotenv": "17.2.1"
17
+ "@twin.org/core": "0.0.2",
18
+ "@twin.org/nameof": "0.0.2",
19
+ "chalk": "5.6.2",
20
+ "commander": "14.0.3",
21
+ "dotenv": "17.4.2"
23
22
  },
24
- "main": "./dist/cjs/index.cjs",
25
- "module": "./dist/esm/index.mjs",
23
+ "main": "./dist/es/index.js",
26
24
  "types": "./dist/types/index.d.ts",
27
25
  "exports": {
28
26
  ".": {
29
27
  "types": "./dist/types/index.d.ts",
30
- "require": "./dist/cjs/index.cjs",
31
- "import": "./dist/esm/index.mjs"
32
- }
28
+ "import": "./dist/es/index.js",
29
+ "default": "./dist/es/index.js"
30
+ },
31
+ "./locales/*.json": "./locales/*.json"
33
32
  },
34
33
  "files": [
35
- "dist/cjs",
36
- "dist/esm",
34
+ "dist/es",
37
35
  "dist/types",
38
36
  "locales",
39
37
  "docs"
40
- ]
38
+ ],
39
+ "keywords": [
40
+ "twin",
41
+ "trade",
42
+ "iota",
43
+ "framework",
44
+ "blockchain",
45
+ "core",
46
+ "foundation",
47
+ "utilities"
48
+ ],
49
+ "bugs": {
50
+ "url": "git+https://github.com/iotaledger/framework/issues"
51
+ },
52
+ "homepage": "https://twindev.org"
41
53
  }