@taqueria/plugin-archetype 0.0.0-pr-1044-56bbc0c0 → 0.0.0-pr-1038-6c3bc5ce
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 +12 -13
- package/_readme.eta +12 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,13 +24,13 @@ No additional configuration is available
|
|
|
24
24
|
|
|
25
25
|
The Archetype plugin exposes a `taq compile` task in Taqueria which can target one, or all the Archetype contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
|
|
26
26
|
|
|
27
|
-
The Archetype plugin also exposes a contract template via the `taq create
|
|
27
|
+
The Archetype plugin also exposes a contract template via the `taq create archetypeContract <contractName>` task. This task will create a new Archetype contract in the `contracts` directory, insert archetype contract boilerplate, and register the contract with Taqueria
|
|
28
28
|
|
|
29
29
|
### Running the Compile Task
|
|
30
30
|
|
|
31
31
|
The Archetype plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
|
|
32
32
|
|
|
33
|
-
Running the `compile` task with no options will result in all
|
|
33
|
+
Running the `compile` task with no options will result in all registered Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you specify an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
|
|
34
34
|
|
|
35
35
|
> ### :warning: CAUTION
|
|
36
36
|
> The `compile` task can be implemented by more than one compiler plugin installed on a project (Archetype, LIGO, SmartPY). If this is the case, you must use the `--plugin Archetype` flag to specify a particular compiler. For example `taq compile --plugin archetype`
|
|
@@ -43,7 +43,7 @@ There are no additional options available for this plugin
|
|
|
43
43
|
|
|
44
44
|
### The `taq compile` Task
|
|
45
45
|
|
|
46
|
-
The `compile` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
|
|
46
|
+
The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
|
|
47
47
|
|
|
48
48
|
```shell
|
|
49
49
|
taq compile [contractName]
|
|
@@ -59,26 +59,25 @@ The task takes a filename as an optional argument. If no filename is provided, T
|
|
|
59
59
|
| command | 'compile [sourceFile] |
|
|
60
60
|
| aliases | ['c', 'compile-archetype'] |
|
|
61
61
|
|
|
62
|
-
### The `create
|
|
62
|
+
### The `create archetypeContract` Task
|
|
63
63
|
|
|
64
|
-
The `create
|
|
64
|
+
The `create archetypeContract` task is used to create a new Archetype contract from a template. Running this task will create a new Archetype smart contract in the `contracts` directory and will register that contract with Taqueria
|
|
65
65
|
|
|
66
66
|
```shell
|
|
67
|
-
taq create
|
|
67
|
+
taq create archetypeContract <contractName>
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
The task takes a filename a required positional argument. The filename must end with `.arl`
|
|
70
|
+
The task takes a filename and a required positional argument. The filename must end with `.arl`
|
|
71
71
|
|
|
72
72
|
#### Task Properties
|
|
73
73
|
|
|
74
|
-
| attribute | value
|
|
75
|
-
|
|
76
|
-
| task | '
|
|
77
|
-
| command | '
|
|
78
|
-
| aliases | ['c', 'compile-archetype'] |
|
|
74
|
+
| attribute | value |
|
|
75
|
+
|------------|:----------------------------------------------:|
|
|
76
|
+
| task | 'create archetypeContract' |
|
|
77
|
+
| command | 'create archetypeContract [sourceFile] |
|
|
79
78
|
|
|
80
79
|
## Plugin Architecture
|
|
81
80
|
|
|
82
81
|
This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
|
|
83
82
|
|
|
84
|
-
Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine
|
|
83
|
+
Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine.
|
package/_readme.eta
CHANGED
|
@@ -26,13 +26,13 @@ No additional configuration is available
|
|
|
26
26
|
|
|
27
27
|
The Archetype plugin exposes a `taq compile` task in Taqueria which can target one, or all the Archetype contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
|
|
28
28
|
|
|
29
|
-
The Archetype plugin also exposes a contract template via the `taq create
|
|
29
|
+
The Archetype plugin also exposes a contract template via the `taq create archetypeContract <contractName>` task. This task will create a new Archetype contract in the `contracts` directory, insert archetype contract boilerplate, and register the contract with Taqueria
|
|
30
30
|
|
|
31
31
|
### Running the Compile Task
|
|
32
32
|
|
|
33
33
|
The Archetype plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
|
|
34
34
|
|
|
35
|
-
Running the `compile` task with no options will result in all
|
|
35
|
+
Running the `compile` task with no options will result in all registered Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you specify an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
|
|
36
36
|
|
|
37
37
|
<%~ it.cautionOpenAdmonition %>
|
|
38
38
|
The `compile` task can be implemented by more than one compiler plugin installed on a project (Archetype, LIGO, SmartPY). If this is the case, you must use the `--plugin Archetype` flag to specify a particular compiler. For example `taq compile --plugin archetype`
|
|
@@ -46,7 +46,7 @@ There are no additional options available for this plugin
|
|
|
46
46
|
|
|
47
47
|
### The `taq compile` Task
|
|
48
48
|
|
|
49
|
-
The `compile` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
|
|
49
|
+
The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
|
|
50
50
|
|
|
51
51
|
```shell
|
|
52
52
|
taq compile [contractName]
|
|
@@ -62,26 +62,25 @@ The task takes a filename as an optional argument. If no filename is provided, T
|
|
|
62
62
|
| command | 'compile [sourceFile] |
|
|
63
63
|
| aliases | ['c', 'compile-archetype'] |
|
|
64
64
|
|
|
65
|
-
### The `create
|
|
65
|
+
### The `create archetypeContract` Task
|
|
66
66
|
|
|
67
|
-
The `create
|
|
67
|
+
The `create archetypeContract` task is used to create a new Archetype contract from a template. Running this task will create a new Archetype smart contract in the `contracts` directory and will register that contract with Taqueria
|
|
68
68
|
|
|
69
69
|
```shell
|
|
70
|
-
taq create
|
|
70
|
+
taq create archetypeContract <contractName>
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
The task takes a filename a required positional argument. The filename must end with `.arl`
|
|
73
|
+
The task takes a filename and a required positional argument. The filename must end with `.arl`
|
|
74
74
|
|
|
75
75
|
#### Task Properties
|
|
76
76
|
|
|
77
|
-
| attribute | value
|
|
78
|
-
|
|
79
|
-
| task | '
|
|
80
|
-
| command | '
|
|
81
|
-
| aliases | ['c', 'compile-archetype'] |
|
|
77
|
+
| attribute | value |
|
|
78
|
+
|------------|:----------------------------------------------:|
|
|
79
|
+
| task | 'create archetypeContract' |
|
|
80
|
+
| command | 'create archetypeContract [sourceFile] |
|
|
82
81
|
|
|
83
82
|
## Plugin Architecture
|
|
84
83
|
|
|
85
84
|
This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
|
|
86
85
|
|
|
87
|
-
Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine
|
|
86
|
+
Docker is used under the hood to provide a self contained environment for Archetype to prevent the need for it to be installed on the user's local machine.
|