@taqueria/plugin-archetype 0.8.0 → 0.10.0

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 (3) hide show
  1. package/README.md +37 -6
  2. package/_readme.eta +37 -6
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -22,13 +22,15 @@ No additional configuration is available
22
22
 
23
23
  ## Usage
24
24
 
25
- The Archetype plugin exposes a `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
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
+
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
26
28
 
27
29
  ### Running the Compile Task
28
30
 
29
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>`
30
32
 
31
- Running the `compile` task with no options will result in all source Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
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
32
34
 
33
35
  > ### :warning: CAUTION
34
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`
@@ -37,16 +39,45 @@ Running the `compile` task with no options will result in all source Archetype s
37
39
 
38
40
  There are no additional options available for this plugin
39
41
 
40
- ## Plugin Architecture
42
+ ## Tasks
41
43
 
42
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
44
+ ### The `taq compile` Task
45
+
46
+ The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
47
+
48
+ ```shell
49
+ taq compile [contractName]
50
+ ```
43
51
 
44
- 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
52
+ The task takes a filename as an optional argument. If no filename is provided, Taqueria will compile all Archetype files in the `contracts` directory
45
53
 
46
- The plugin provides a single task `compile`, used for compiling Archetype smart contracts to Michelson:
54
+ #### Task Properties
47
55
 
48
56
  | attribute | value |
49
57
  |------------|:-----------------------------:|
50
58
  | task | 'compile' |
51
59
  | command | 'compile [sourceFile] |
52
60
  | aliases | ['c', 'compile-archetype'] |
61
+
62
+ ### The `create archetypeContract` Task
63
+
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
+
66
+ ```shell
67
+ taq create archetypeContract <contractName>
68
+ ```
69
+
70
+ The task takes a filename and a required positional argument. The filename must end with `.arl`
71
+
72
+ #### Task Properties
73
+
74
+ | attribute | value |
75
+ |------------|:----------------------------------------------:|
76
+ | task | 'create archetypeContract' |
77
+ | command | 'create archetypeContract [sourceFile] |
78
+
79
+ ## Plugin Architecture
80
+
81
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
82
+
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
@@ -24,13 +24,15 @@ No additional configuration is available
24
24
 
25
25
  ## Usage
26
26
 
27
- The Archetype plugin exposes a `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
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
+
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
28
30
 
29
31
  ### Running the Compile Task
30
32
 
31
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>`
32
34
 
33
- Running the `compile` task with no options will result in all source Archetype smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only Archetype contracts matching the specified filename in the `contracts` folder will be compiled
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
34
36
 
35
37
  <%~ it.cautionOpenAdmonition %>
36
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`
@@ -40,16 +42,45 @@ The `compile` task can be implemented by more than one compiler plugin installed
40
42
 
41
43
  There are no additional options available for this plugin
42
44
 
43
- ## Plugin Architecture
45
+ ## Tasks
44
46
 
45
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
47
+ ### The `taq compile` Task
48
+
49
+ The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
50
+
51
+ ```shell
52
+ taq compile [contractName]
53
+ ```
46
54
 
47
- 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
55
+ The task takes a filename as an optional argument. If no filename is provided, Taqueria will compile all Archetype files in the `contracts` directory
48
56
 
49
- The plugin provides a single task `compile`, used for compiling Archetype smart contracts to Michelson:
57
+ #### Task Properties
50
58
 
51
59
  | attribute | value |
52
60
  |------------|:-----------------------------:|
53
61
  | task | 'compile' |
54
62
  | command | 'compile [sourceFile] |
55
63
  | aliases | ['c', 'compile-archetype'] |
64
+
65
+ ### The `create archetypeContract` Task
66
+
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
+
69
+ ```shell
70
+ taq create archetypeContract <contractName>
71
+ ```
72
+
73
+ The task takes a filename and a required positional argument. The filename must end with `.arl`
74
+
75
+ #### Task Properties
76
+
77
+ | attribute | value |
78
+ |------------|:----------------------------------------------:|
79
+ | task | 'create archetypeContract' |
80
+ | command | 'create archetypeContract [sourceFile] |
81
+
82
+ ## Plugin Architecture
83
+
84
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
85
+
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
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-archetype",
3
- "version": "0.8.0",
3
+ "version": "0.10.0",
4
4
  "description": "A taqueria plugin for compiling Archetype smart contracts",
5
5
  "targets": {
6
6
  "default": {
@@ -40,7 +40,7 @@
40
40
  },
41
41
  "homepage": "https://github.com/ecadlabs/taqueria#readme",
42
42
  "dependencies": {
43
- "@taqueria/node-sdk": "^0.8.0",
43
+ "@taqueria/node-sdk": "^0.10.0",
44
44
  "fast-glob": "^3.2.11"
45
45
  },
46
46
  "devDependencies": {