@taqueria/plugin-archetype 0.42.3 → 0.42.6

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 +5 -3
  2. package/package.json +2 -2
  3. package/_readme.eta +0 -89
package/README.md CHANGED
@@ -1,11 +1,13 @@
1
1
  # Archetype Plugin
2
2
 
3
- The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
3
+ The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files.
4
+
5
+ For more information, please see our documentation for the [Archetype plugin](https://taqueria.io/docs/plugins/plugin-archetype/)
4
6
 
5
7
  ## Requirements
6
8
 
7
- - Taqueria v0.26.0 or later
8
- - Node.js v16.16 or later. (v17.x.x or later is not supported)
9
+ - Taqueria v0.42.0 or later
10
+ - Node.js v18.18.0 or later
9
11
  - Docker v20.10.12 or later
10
12
 
11
13
  ## Installation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-archetype",
3
- "version": "0.42.3",
3
+ "version": "0.42.6",
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/pinnacle-labs/taqueria#readme",
42
42
  "dependencies": {
43
- "@taqueria/node-sdk": "^0.42.3",
43
+ "@taqueria/node-sdk": "^0.42.6",
44
44
  "fast-glob": "^3.3.1",
45
45
  "ts-pattern": "^5.0.5"
46
46
  },
package/_readme.eta DELETED
@@ -1,89 +0,0 @@
1
- <% if (it.output == "github") { %>
2
- # Archetype Plugin
3
- <% } %>
4
-
5
- The Archetype plugin provides a task to compile Archetype smart contracts (`.arl`) to Michelson `.tz` files
6
-
7
- ## Requirements
8
-
9
- - Taqueria v0.26.0 or later
10
- - Node.js v16.16 or later. (v17.x.x or later is not supported)
11
- - Docker v20.10.12 or later
12
-
13
- ## Installation
14
-
15
- To install the Archetype plugin on a Taqueria project, navigate to the project folder and run:
16
- ```shell
17
- taq install @taqueria/plugin-archetype
18
- ```
19
-
20
- <%~ it.noteOpenAdmonition %>
21
- You can override the Archetype version used by the plugin by creating the environment variable `TAQ_ARCHETYPE_IMAGE` and setting it to your desired Ligo Docker image
22
- <%= it.closeAdmonition %>
23
-
24
- ## Configuration
25
-
26
- No additional configuration is available
27
-
28
- ## Usage
29
-
30
- 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
31
-
32
- 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
33
-
34
- ### Running the Compile Task
35
-
36
- The Archetype plugin's `taq compile` task requires at least one argument. The basic syntax for the task is `taq compile <contractName>`
37
-
38
- Running the `compile` task with no arguments will result in no Archetype smart contracts being compiled to Michelson files in the `artifacts` folder
39
-
40
- <%~ it.cautionOpenAdmonition %>
41
- 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`
42
- <%~ it.closeAdmonition %>
43
-
44
- ### Options
45
-
46
- There are no additional options available for this plugin
47
-
48
- ## Tasks
49
-
50
- ### The `taq compile` Task
51
-
52
- The `compile` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
53
-
54
- ```shell
55
- taq compile <contractName>
56
- ```
57
-
58
- The task takes a filename as a required argument. If no filename is provided, Taqueria will compile no Archetype files from the `contracts` directory
59
-
60
- #### Task Properties
61
-
62
- | attribute | value |
63
- |------------|:-----------------------------:|
64
- | task | 'compile' |
65
- | command | 'compile < contractName >' |
66
- | aliases | ['c', 'compile-archetype'] |
67
-
68
- ### The `create archetypeContract` Task
69
-
70
- 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
71
-
72
- ```shell
73
- taq create archetypeContract <contractName>
74
- ```
75
-
76
- The task takes a filename and a required positional argument. The filename must end with `.arl`
77
-
78
- #### Task Properties
79
-
80
- | attribute | value |
81
- |------------|:----------------------------------------------:|
82
- | task | 'create archetypeContract' |
83
- | command | 'create archetypeContract < contractName >' |
84
-
85
- ## Plugin Architecture
86
-
87
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
88
-
89
- 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