@taqueria/plugin-archetype 0.21.14 → 0.21.29

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 +15 -16
  2. package/_readme.eta +15 -16
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,13 +1,12 @@
1
1
  # Archetype Plugin
2
2
 
3
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
4
-
5
3
  The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
6
4
 
7
5
  ## Requirements
8
6
 
9
- - Node.js v16.3 or later
10
- - Docker v0.8.6 or later
7
+ - Taqueria v0.20.2 or later
8
+ - Node.js v16.17.1 or later
9
+ - Docker v20.10.12 or later
11
10
 
12
11
  ## Installation
13
12
 
@@ -22,18 +21,18 @@ No additional configuration is available
22
21
 
23
22
  ## Usage
24
23
 
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
24
+ The Archetype plugin exposes a `taq compile` task in Taqueria which can target a single Archetype contract in the `contracts` folder and compile it to a Michelson `.tz` file output to the `artifacts` folder
26
25
 
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
+ 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 and insert archetype contract boilerplate for you
28
27
 
29
28
  ### Running the Compile Task
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
+ The Archetype plugin's `taq compile` task requires at least one argument. The basic syntax for the task is `taq compile <contractName>`
32
31
 
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
+ Running the `compile` task with no arguments will result in no Archetype smart contracts being compiled to Michelson files in the `artifacts` folder
34
33
 
35
34
  > ### :warning: CAUTION
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`
35
+ > The `compile` task is implemented by more than one compiler plugin (Archetype, LIGO, SmartPy). If more than one of these plugins are installed on a project, you need to use the `--plugin archetype` flag to specify the particular Archetype compiler. For example `taq compile --plugin archetype`
37
36
 
38
37
  ### Options
39
38
 
@@ -43,25 +42,25 @@ There are no additional options available for this plugin
43
42
 
44
43
  ### The `taq compile` Task
45
44
 
46
- The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
45
+ The `compile` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
47
46
 
48
47
  ```shell
49
- taq compile [contractName]
48
+ taq compile <contractName>
50
49
  ```
51
50
 
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
51
+ The task takes a filename as a required argument. If no filename is provided, Taqueria will compile no Archetype files from the `contracts` directory
53
52
 
54
53
  #### Task Properties
55
54
 
56
55
  | attribute | value |
57
56
  |------------|:-----------------------------:|
58
57
  | task | 'compile' |
59
- | command | 'compile [sourceFile] |
58
+ | command | 'compile < contractName >' |
60
59
  | aliases | ['c', 'compile-archetype'] |
61
60
 
62
61
  ### The `create archetypeContract` Task
63
62
 
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
63
+ 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
65
64
 
66
65
  ```shell
67
66
  taq create archetypeContract <contractName>
@@ -74,10 +73,10 @@ The task takes a filename and a required positional argument. The filename must
74
73
  | attribute | value |
75
74
  |------------|:----------------------------------------------:|
76
75
  | task | 'create archetypeContract' |
77
- | command | 'create archetypeContract [sourceFile] |
76
+ | command | 'create archetypeContract < contractName >' |
78
77
 
79
78
  ## Plugin Architecture
80
79
 
81
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
80
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
82
81
 
83
82
  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
@@ -2,14 +2,13 @@
2
2
  # Archetype Plugin
3
3
  <% } %>
4
4
 
5
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
6
-
7
5
  The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
8
6
 
9
7
  ## Requirements
10
8
 
11
- - Node.js v16.3 or later
12
- - Docker v0.8.6 or later
9
+ - Taqueria v0.20.2 or later
10
+ - Node.js v16.17.1 or later
11
+ - Docker v20.10.12 or later
13
12
 
14
13
  ## Installation
15
14
 
@@ -24,18 +23,18 @@ No additional configuration is available
24
23
 
25
24
  ## Usage
26
25
 
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
26
+ The Archetype plugin exposes a `taq compile` task in Taqueria which can target a single Archetype contract in the `contracts` folder and compile it to a Michelson `.tz` file output to the `artifacts` folder
28
27
 
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
+ 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 and insert archetype contract boilerplate for you
30
29
 
31
30
  ### Running the Compile Task
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
+ The Archetype plugin's `taq compile` task requires at least one argument. The basic syntax for the task is `taq compile <contractName>`
34
33
 
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
+ Running the `compile` task with no arguments will result in no Archetype smart contracts being compiled to Michelson files in the `artifacts` folder
36
35
 
37
36
  <%~ it.cautionOpenAdmonition %>
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`
37
+ The `compile` task is implemented by more than one compiler plugin (Archetype, LIGO, SmartPy). If more than one of these plugins are installed on a project, you need to use the `--plugin archetype` flag to specify the particular Archetype compiler. For example `taq compile --plugin archetype`
39
38
  <%~ it.closeAdmonition %>
40
39
 
41
40
  ### Options
@@ -46,25 +45,25 @@ There are no additional options available for this plugin
46
45
 
47
46
  ### The `taq compile` Task
48
47
 
49
- The `compile` task is used for compiling registered Archetype smart contracts to Michelson and the task has the following structure:
48
+ The `compile` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
50
49
 
51
50
  ```shell
52
- taq compile [contractName]
51
+ taq compile <contractName>
53
52
  ```
54
53
 
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
54
+ The task takes a filename as a required argument. If no filename is provided, Taqueria will compile no Archetype files from the `contracts` directory
56
55
 
57
56
  #### Task Properties
58
57
 
59
58
  | attribute | value |
60
59
  |------------|:-----------------------------:|
61
60
  | task | 'compile' |
62
- | command | 'compile [sourceFile] |
61
+ | command | 'compile < contractName >' |
63
62
  | aliases | ['c', 'compile-archetype'] |
64
63
 
65
64
  ### The `create archetypeContract` Task
66
65
 
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
66
+ 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
68
67
 
69
68
  ```shell
70
69
  taq create archetypeContract <contractName>
@@ -77,10 +76,10 @@ The task takes a filename and a required positional argument. The filename must
77
76
  | attribute | value |
78
77
  |------------|:----------------------------------------------:|
79
78
  | task | 'create archetypeContract' |
80
- | command | 'create archetypeContract [sourceFile] |
79
+ | command | 'create archetypeContract < contractName >' |
81
80
 
82
81
  ## Plugin Architecture
83
82
 
84
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
83
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
85
84
 
86
85
  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.21.14",
3
+ "version": "0.21.29",
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.21.14",
43
+ "@taqueria/node-sdk": "^0.21.29",
44
44
  "fast-glob": "^3.2.11"
45
45
  },
46
46
  "devDependencies": {