@taqueria/plugin-ligo 0.0.0-pr-1027-6d1dfc5d → 0.0.0-pr-1012-58aefa83

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 +13 -31
  2. package/_readme.eta +13 -31
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -4,7 +4,7 @@ The LIGO plugin provides a task to compile LIGO smart contracts to Michelson `.t
4
4
 
5
5
  ## Requirements
6
6
 
7
- - Taqueria v0.8.0 or later
7
+ - Taqueria v0.0.6 or later
8
8
  - Node.js v16.3 or later
9
9
  - Docker v0.8.4 or later
10
10
 
@@ -18,29 +18,20 @@ taq install @taqueria/plugin-ligo
18
18
  ## Configuration
19
19
 
20
20
  No additional configuration is available
21
-
22
21
  ## Usage
23
22
 
24
23
  The LIGO plugin exposes a `compile` task in Taqueria which can target one, or all the LIGO contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
25
24
 
26
- The LIGO plugin also exposes a contract template via the `taq create contract <contractName>` task. This task will create a new LIGO contract in the `contracts` directory, and will register the contract with Taqueria
27
-
28
- ## Tasks
25
+ ### Running the Compile Task
29
26
 
30
- ### The `taq compile` Task
31
-
32
- The LIGO plugin's `taq compile` task can be run with or without arguments. The structure for the task is:
33
-
34
- ```shell
35
- taq compile <file-name>
36
- ```
27
+ The LIGO plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
37
28
 
38
29
  Running the `compile` task with no options will result in any source LIGO smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only LIGO contracts matching the specified filename in the `contracts` folder will be compiled
39
30
 
40
31
  > ### :warning: CAUTION
41
32
  > The `compile` task can be implemented by more than one compiler plugin installed on a project (LIGO, SmartPY). If this is the case, you must use the `--plugin ligo` flag to specify a particular compiler
42
33
 
43
- #### Options
34
+ ### Options
44
35
 
45
36
  The LIGO `compile` task will accept the following optional parameters:
46
37
 
@@ -50,26 +41,17 @@ The LIGO `compile` task will accept the following optional parameters:
50
41
  | -s | syntax | The syntax used in the contract |
51
42
  | -i | infer | Enable type inference |
52
43
 
53
- #### Task Properties
54
-
55
- | attribute | value |
56
- |------------|:-----------------------------:|
57
- | task | 'compile' |
58
- | command | 'compile [sourceFile] |
59
- | aliases | ['c', 'compile-archetype'] |
60
-
61
- ### The `create contract` Template
62
-
63
- The `create contract` 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
64
-
65
- ```shell
66
- taq create contract <contractName>
67
- ```
68
-
69
- The `create contract` task takes a filename a required positional argument. The filename must end with a LIGO extension (`.jsligo`, `.mligo`, etc)
70
44
 
71
45
  ## Plugin Architecture
72
46
 
73
47
  This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
74
48
 
75
- 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
49
+ Docker is used under the hood to provide a self contained environment for LIGO to prevent the need for it to be installed on the user's local machine
50
+
51
+ The plugin provides a single task `compile`, used for compiling LIGO smart contracts to Michelson:
52
+
53
+ | attribute | value |
54
+ |------------|:------------------------:|
55
+ | task | 'compile' |
56
+ | command | 'compile [sourceFile] |
57
+ | aliases | ['c', 'compile-ligo'] |
package/_readme.eta CHANGED
@@ -6,7 +6,7 @@ The LIGO plugin provides a task to compile LIGO smart contracts to Michelson `.t
6
6
 
7
7
  ## Requirements
8
8
 
9
- - Taqueria v0.8.0 or later
9
+ - Taqueria v0.0.6 or later
10
10
  - Node.js v16.3 or later
11
11
  - Docker v0.8.4 or later
12
12
 
@@ -20,22 +20,13 @@ taq install @taqueria/plugin-ligo
20
20
  ## Configuration
21
21
 
22
22
  No additional configuration is available
23
-
24
23
  ## Usage
25
24
 
26
25
  The LIGO plugin exposes a `compile` task in Taqueria which can target one, or all the LIGO contracts in the `contracts` folder and compile them to Michelson `.tz` files output to the `artifacts` folder
27
26
 
28
- The LIGO plugin also exposes a contract template via the `taq create contract <contractName>` task. This task will create a new LIGO contract in the `contracts` directory, and will register the contract with Taqueria
29
-
30
- ## Tasks
27
+ ### Running the Compile Task
31
28
 
32
- ### The `taq compile` Task
33
-
34
- The LIGO plugin's `taq compile` task can be run with or without arguments. The structure for the task is:
35
-
36
- ```shell
37
- taq compile <file-name>
38
- ```
29
+ The LIGO plugin's `taq compile` task can be run with or without arguments. The basic syntax for the task is `taq compile <file-name>`
39
30
 
40
31
  Running the `compile` task with no options will result in any source LIGO smart contracts in the `contracts` folder being compiled to Michelson files in the `artifacts` folder. If you speficy an optional filename, only LIGO contracts matching the specified filename in the `contracts` folder will be compiled
41
32
 
@@ -43,7 +34,7 @@ Running the `compile` task with no options will result in any source LIGO smart
43
34
  The `compile` task can be implemented by more than one compiler plugin installed on a project (LIGO, SmartPY). If this is the case, you must use the `--plugin ligo` flag to specify a particular compiler
44
35
  <%= it.closeAdmonition %>
45
36
 
46
- #### Options
37
+ ### Options
47
38
 
48
39
  The LIGO `compile` task will accept the following optional parameters:
49
40
 
@@ -53,26 +44,17 @@ The LIGO `compile` task will accept the following optional parameters:
53
44
  | -s | syntax | The syntax used in the contract |
54
45
  | -i | infer | Enable type inference |
55
46
 
56
- #### Task Properties
57
-
58
- | attribute | value |
59
- |------------|:-----------------------------:|
60
- | task | 'compile' |
61
- | command | 'compile [sourceFile] |
62
- | aliases | ['c', 'compile-archetype'] |
63
-
64
- ### The `create contract` Template
65
-
66
- The `create contract` 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
67
-
68
- ```shell
69
- taq create contract <contractName>
70
- ```
71
-
72
- The `create contract` task takes a filename a required positional argument. The filename must end with a LIGO extension (`.jsligo`, `.mligo`, etc)
73
47
 
74
48
  ## Plugin Architecture
75
49
 
76
50
  This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
77
51
 
78
- 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
+ Docker is used under the hood to provide a self contained environment for LIGO to prevent the need for it to be installed on the user's local machine
53
+
54
+ The plugin provides a single task `compile`, used for compiling LIGO smart contracts to Michelson:
55
+
56
+ | attribute | value |
57
+ |------------|:------------------------:|
58
+ | task | 'compile' |
59
+ | command | 'compile [sourceFile] |
60
+ | aliases | ['c', 'compile-ligo'] |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-ligo",
3
- "version": "0.0.0-pr-1027-6d1dfc5d",
3
+ "version": "0.0.0-pr-1012-58aefa83",
4
4
  "description": "A taqueria plugin for compiling LIGO smart contracts",
5
5
  "targets": {
6
6
  "default": {