@platforma-sdk/block-tools 2.1.5

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 ADDED
@@ -0,0 +1,82 @@
1
+ ## Table of contents
2
+ <!-- toc -->
3
+
4
+ <!-- tocstop -->
5
+
6
+ ## Usage
7
+ <!-- usage -->
8
+ ```sh-session
9
+ $ npm install -g @milaboratory/pl-block-tools
10
+ $ block-tools COMMAND
11
+ running command...
12
+ $ block-tools (--version)
13
+ @milaboratory/pl-block-tools/2.1.2 darwin-arm64 node-v20.15.0
14
+ $ block-tools --help [COMMAND]
15
+ USAGE
16
+ $ block-tools COMMAND
17
+ ...
18
+ ```
19
+ <!-- usagestop -->
20
+
21
+ ## Commands
22
+ <!-- commands -->
23
+ * [`block-tools build-model`](#block-tools-build-model)
24
+ * [`block-tools pack`](#block-tools-pack)
25
+ * [`block-tools upload-package-v1`](#block-tools-upload-package-v1)
26
+
27
+ ## `block-tools build-model`
28
+
29
+ Extracts and outputs block model JSON from pre-built block model module
30
+
31
+ ```
32
+ USAGE
33
+ $ block-tools build-model [-i <path>] [-b <path>] [-o <path>]
34
+
35
+ FLAGS
36
+ -b, --sourceBundle=<path> [default: ./dist/bundle.js] bundled model code to embed into the model for callback-based
37
+ rendering to work
38
+ -i, --modulePath=<path> [default: .] input module path
39
+ -o, --destination=<path> [default: ./dist/model.json] output model file
40
+
41
+ DESCRIPTION
42
+ Extracts and outputs block model JSON from pre-built block model module
43
+ ```
44
+
45
+ ## `block-tools pack`
46
+
47
+ Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder
48
+
49
+ ```
50
+ USAGE
51
+ $ block-tools pack [-i <path>] [-o <path>]
52
+
53
+ FLAGS
54
+ -i, --modulePath=<path> [default: .] input module path
55
+ -o, --destinationPath=<path> [default: ./block-pack] output folder
56
+
57
+ DESCRIPTION
58
+ Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder
59
+ ```
60
+
61
+ ## `block-tools upload-package-v1`
62
+
63
+ Uploads V1 package and refreshes the registry
64
+
65
+ ```
66
+ USAGE
67
+ $ block-tools upload-package-v1 [-r <address|alias>] [-o <value>] [-p <value>] [-v <value>] [-m <value>] [-f
68
+ file_path | package_name=file_path...] [--refresh]
69
+
70
+ FLAGS
71
+ -f, --file=file_path | package_name=file_path... [default: ] package files
72
+ -m, --meta=<value> json file containing meta information to associate with tha package
73
+ -o, --organization=<value> target organisation
74
+ -p, --package=<value> target package
75
+ -r, --registry=<address|alias> full address of the registry or alias from .pl.reg
76
+ -v, --version=<value> target version
77
+ --[no-]refresh refresh repository after adding the package
78
+
79
+ DESCRIPTION
80
+ Uploads V1 package and refreshes the registry
81
+ ```
82
+ <!-- commandsstop -->
package/bin/dev.cmd ADDED
@@ -0,0 +1,3 @@
1
+ @echo off
2
+
3
+ node "%~dp0\dev" %*
package/bin/dev.js ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env node_modules/.bin/ts-node
2
+ // eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
3
+ ;(async () => {
4
+ const oclif = await import('@oclif/core')
5
+ await oclif.execute({development: true, dir: __dirname})
6
+ })()
package/bin/run.cmd ADDED
@@ -0,0 +1,3 @@
1
+ @echo off
2
+
3
+ node "%~dp0\run" %*
package/bin/run.js ADDED
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+
3
+ // eslint-disable-next-line unicorn/prefer-top-level-await
4
+ (async () => {
5
+ const oclif = await import('@oclif/core')
6
+ await oclif.execute({dir: __dirname})
7
+ })()