@taqueria/plugin-ligo 0.0.0-pr-726-b23fe87f → 0.0.0-pr-575-4bf5352b
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 +41 -12
- package/_readme.eta +64 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,6 @@
|
|
|
1
1
|
# Taqueria LIGO Plugin
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
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 code output to the artifacts folder
|
|
6
|
-
|
|
7
|
-
## Tasks
|
|
8
|
-
|
|
9
|
-
The LIGO plugin provides the following tasks to Taqueria:
|
|
10
|
-
- `compile`
|
|
3
|
+
The LIGO plugin provides a task to compile LIGO smart contracts to Michelson `.tz` files
|
|
11
4
|
|
|
12
5
|
## Requirements
|
|
13
6
|
|
|
@@ -17,15 +10,51 @@ The LIGO plugin provides the following tasks to Taqueria:
|
|
|
17
10
|
|
|
18
11
|
## Installation
|
|
19
12
|
|
|
20
|
-
The LIGO plugin is distributed as an NPM package that can be installed and uninstalled on a project from the Taqueria CLI
|
|
21
|
-
|
|
22
13
|
To install the LIGO plugin on a Taqueria project, navigate to the project folder and run:
|
|
23
14
|
```shell
|
|
24
15
|
taq install @taqueria/plugin-ligo
|
|
25
16
|
```
|
|
26
17
|
|
|
18
|
+
> ### :page_with_curl: Note
|
|
19
|
+
> At this time, all Taqueria projects must also be initialized as node projects by running `npm init -y` from the root of your project directory
|
|
20
|
+
|
|
21
|
+
## Configuration
|
|
22
|
+
|
|
23
|
+
No additional configuration is available
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
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
|
+
|
|
28
|
+
### Running the Compile Task
|
|
29
|
+
|
|
30
|
+
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>`
|
|
31
|
+
|
|
32
|
+
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
|
|
33
|
+
|
|
34
|
+
> ### :warning: CAUTION
|
|
35
|
+
> 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
|
|
36
|
+
|
|
37
|
+
### Options
|
|
38
|
+
|
|
39
|
+
The LIGO `compile` task will accept the following optional parameters:
|
|
40
|
+
|
|
41
|
+
| flag | name | description |
|
|
42
|
+
|:-----:|:------------|---------------------------------------|
|
|
43
|
+
| -e | entry-point | The entry point that will be compiled |
|
|
44
|
+
| -s | syntax | The syntax used in the contract |
|
|
45
|
+
| -i | infer | Enable type inference |
|
|
46
|
+
|
|
47
|
+
|
|
27
48
|
## Plugin Architecture
|
|
28
49
|
|
|
29
|
-
This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
|
|
50
|
+
This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
|
|
51
|
+
|
|
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:
|
|
30
55
|
|
|
31
|
-
|
|
56
|
+
| attribute | value |
|
|
57
|
+
|------------|:------------------------:|
|
|
58
|
+
| task | 'compile' |
|
|
59
|
+
| command | 'compile [sourceFile] |
|
|
60
|
+
| aliases | ['c', 'compile-ligo'] |
|
package/_readme.eta
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
<% if (it.output == "github") { %>
|
|
2
|
+
# Taqueria LIGO Plugin
|
|
3
|
+
<% } %>
|
|
4
|
+
|
|
5
|
+
The LIGO plugin provides a task to compile LIGO smart contracts to Michelson `.tz` files
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- Taqueria v0.0.6 or later
|
|
10
|
+
- Node.js v16 or later
|
|
11
|
+
- Docker v0.8.4 or later
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
To install the LIGO plugin on a Taqueria project, navigate to the project folder and run:
|
|
16
|
+
```shell
|
|
17
|
+
taq install @taqueria/plugin-ligo
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
<%~ it.noteOpenAdmonition %>
|
|
21
|
+
At this time, all Taqueria projects must also be initialized as node projects by running `npm init -y` from the root of your project directory
|
|
22
|
+
<%= it.closeAdmonition %>
|
|
23
|
+
|
|
24
|
+
## Configuration
|
|
25
|
+
|
|
26
|
+
No additional configuration is available
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
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
|
|
30
|
+
|
|
31
|
+
### Running the Compile Task
|
|
32
|
+
|
|
33
|
+
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>`
|
|
34
|
+
|
|
35
|
+
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
|
|
36
|
+
|
|
37
|
+
<%~ it.cautionOpenAdmonition %>
|
|
38
|
+
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
|
|
39
|
+
<%= it.closeAdmonition %>
|
|
40
|
+
|
|
41
|
+
### Options
|
|
42
|
+
|
|
43
|
+
The LIGO `compile` task will accept the following optional parameters:
|
|
44
|
+
|
|
45
|
+
| flag | name | description |
|
|
46
|
+
|:-----:|:------------|---------------------------------------|
|
|
47
|
+
| -e | entry-point | The entry point that will be compiled |
|
|
48
|
+
| -s | syntax | The syntax used in the contract |
|
|
49
|
+
| -i | infer | Enable type inference |
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## Plugin Architecture
|
|
53
|
+
|
|
54
|
+
This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
|
|
55
|
+
|
|
56
|
+
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
|
|
57
|
+
|
|
58
|
+
The plugin provides a single task `compile`, used for compiling LIGO smart contracts to Michelson:
|
|
59
|
+
|
|
60
|
+
| attribute | value |
|
|
61
|
+
|------------|:------------------------:|
|
|
62
|
+
| task | 'compile' |
|
|
63
|
+
| command | 'compile [sourceFile] |
|
|
64
|
+
| aliases | ['c', 'compile-ligo'] |
|