@taqueria/plugin-metadata 0.21.14 → 0.21.23

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 +14 -14
  2. package/_readme.eta +14 -14
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -4,8 +4,8 @@ The Taqueria Metadata plugin provides an easy way to create a json file containi
4
4
 
5
5
  ## Requirements
6
6
 
7
- - Taqueria v0.13.0 or later
8
- - Node.js v16.3 or later
7
+ - Taqueria v0.20.2 or later
8
+ - Node.js v16.17.1 or later
9
9
 
10
10
  ## Installation
11
11
 
@@ -20,7 +20,7 @@ There is no configuration required to run the plugin
20
20
 
21
21
  ## Usage
22
22
 
23
- The Metadata plugin provides an interactive CLI interface that collects basic contract metadata fields as outlined in `TZIP-16` specification, and generates a compliant JSON file that can be uploaded to IPFS
23
+ The Metadata plugin provides an interactive CLI interface that collects basic contract metadata fields as outlined in `TZIP-16` [specification](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-16/tzip-16.md), and generates a compliant JSON file that can be uploaded to IPFS
24
24
 
25
25
  The metadata fields collected are:
26
26
 
@@ -34,13 +34,13 @@ The metadata fields collected are:
34
34
  | license | Type of license e. g. ISC, MIT |
35
35
  | interfaces | List of interfaces |
36
36
 
37
- To save time in multi-contract projects, `taq generate-project-metadata` can be run. This will collect project level metadata fields which are then provided as the default values for each subsequent invocation of `taq generate-metadata < contractName >`
37
+ To save time in multi-contract projects, `taq generate-project-metadata` can be run. This will collect project level metadata fields which are then provided as the default values for each subsequent invocation of `taq generate-metadata <contractName>`
38
38
 
39
39
  The plugin exposes two tasks:
40
- - `taq generate-metadata < contractName >` - Generates `TZIP-16` compliant metadata for a contract in JSON format
41
- - `taq generate-project-metadata` - Generates project level metadata that is written to `config.json`
40
+ - `taq generate-metadata <contractName>` - Generates `TZIP-16` compliant metadata for a contract in JSON format
41
+ - `taq generate-project-metadata` - Generates project level metadata that is written to `.taq/config.json`
42
42
 
43
- Contract metadata is output into a JSON file in the `./artifacts` directory, while project metadata is added to `.taq/config.json` as seen here:
43
+ Contract metadata is output into a JSON file in the `artifacts` directory, while project metadata is added to `.taq/config.json` as seen here:
44
44
 
45
45
  ```json
46
46
  "metadata": {
@@ -57,7 +57,7 @@ Contract metadata is output into a JSON file in the `./artifacts` directory, whi
57
57
 
58
58
  ## Tasks
59
59
 
60
- ### `taq generate-metadata [contractName]`
60
+ ### `taq generate-metadata <contractName>`
61
61
 
62
62
  The `generate-metadata` task starts an interactive interface that collects the relavent fields via CLI prompts and outputs a `TZIP-16` compliant metadata file in JSON format
63
63
 
@@ -67,7 +67,7 @@ The `generate-metadata` task starts an interactive interface that collects the r
67
67
  #### Command Structure
68
68
 
69
69
  ```shell
70
- taq generate-metadata < sourceFile >
70
+ taq generate-metadata <contractName>
71
71
  ```
72
72
 
73
73
  #### Options
@@ -76,7 +76,7 @@ The metadata `generate-metadata` task will accept the following required paramet
76
76
 
77
77
  | name | description |
78
78
  |:-------------|--------------------------------------------------------------------|
79
- | contractName | The contract name (the contract may exist, or not exist) |
79
+ | contractName | The contract name (the contract may exist, or may not exist) |
80
80
 
81
81
 
82
82
  #### Task Properties
@@ -84,7 +84,7 @@ The metadata `generate-metadata` task will accept the following required paramet
84
84
  | attribute | value |
85
85
  |------------|:---------------------------------------:|
86
86
  | task | 'generate-metadata' |
87
- | command | 'generate-metadata [sourceFile]' |
87
+ | command | 'generate-metadata < contractName >' |
88
88
  | aliases | N/A |
89
89
 
90
90
 
@@ -108,7 +108,7 @@ The `generate-project-metadata` task not not have any additional parameters or o
108
108
  | attribute | value |
109
109
  |:----------:|:---------------------------------------:|
110
110
  | task | 'generate-project-metadata' |
111
- | command | 'taq generate-project-metadata' |
111
+ | command | 'generate-project-metadata' |
112
112
  | aliases | N/A |
113
113
 
114
114
  ## Behaviour
@@ -124,7 +124,7 @@ The user flow for each task is outlined below
124
124
 
125
125
  ### Generating project metadata
126
126
 
127
- - Add the project metadata to .taq config.json
127
+ - Add the project metadata to `.taq/config.json`
128
128
  - Add the project metadata schema
129
129
 
130
130
  ### Default Value Priority
@@ -137,6 +137,6 @@ Summary of priority for default values:
137
137
 
138
138
  ## Plugin Architecture
139
139
 
140
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
140
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
141
141
 
142
142
 
package/_readme.eta CHANGED
@@ -6,8 +6,8 @@ The Taqueria Metadata plugin provides an easy way to create a json file containi
6
6
 
7
7
  ## Requirements
8
8
 
9
- - Taqueria v0.13.0 or later
10
- - Node.js v16.3 or later
9
+ - Taqueria v0.20.2 or later
10
+ - Node.js v16.17.1 or later
11
11
 
12
12
  ## Installation
13
13
 
@@ -22,7 +22,7 @@ There is no configuration required to run the plugin
22
22
 
23
23
  ## Usage
24
24
 
25
- The Metadata plugin provides an interactive CLI interface that collects basic contract metadata fields as outlined in `TZIP-16` specification, and generates a compliant JSON file that can be uploaded to IPFS
25
+ The Metadata plugin provides an interactive CLI interface that collects basic contract metadata fields as outlined in `TZIP-16` [specification](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-16/tzip-16.md), and generates a compliant JSON file that can be uploaded to IPFS
26
26
 
27
27
  The metadata fields collected are:
28
28
 
@@ -36,13 +36,13 @@ The metadata fields collected are:
36
36
  | license | Type of license e. g. ISC, MIT |
37
37
  | interfaces | List of interfaces |
38
38
 
39
- To save time in multi-contract projects, `taq generate-project-metadata` can be run. This will collect project level metadata fields which are then provided as the default values for each subsequent invocation of `taq generate-metadata < contractName >`
39
+ To save time in multi-contract projects, `taq generate-project-metadata` can be run. This will collect project level metadata fields which are then provided as the default values for each subsequent invocation of `taq generate-metadata <contractName>`
40
40
 
41
41
  The plugin exposes two tasks:
42
- - `taq generate-metadata < contractName >` - Generates `TZIP-16` compliant metadata for a contract in JSON format
43
- - `taq generate-project-metadata` - Generates project level metadata that is written to `config.json`
42
+ - `taq generate-metadata <contractName>` - Generates `TZIP-16` compliant metadata for a contract in JSON format
43
+ - `taq generate-project-metadata` - Generates project level metadata that is written to `.taq/config.json`
44
44
 
45
- Contract metadata is output into a JSON file in the `./artifacts` directory, while project metadata is added to `.taq/config.json` as seen here:
45
+ Contract metadata is output into a JSON file in the `artifacts` directory, while project metadata is added to `.taq/config.json` as seen here:
46
46
 
47
47
  ```json
48
48
  "metadata": {
@@ -59,7 +59,7 @@ Contract metadata is output into a JSON file in the `./artifacts` directory, whi
59
59
 
60
60
  ## Tasks
61
61
 
62
- ### `taq generate-metadata [contractName]`
62
+ ### `taq generate-metadata <contractName>`
63
63
 
64
64
  The `generate-metadata` task starts an interactive interface that collects the relavent fields via CLI prompts and outputs a `TZIP-16` compliant metadata file in JSON format
65
65
 
@@ -70,7 +70,7 @@ The contract may, or may not exist yet
70
70
  #### Command Structure
71
71
 
72
72
  ```shell
73
- taq generate-metadata < sourceFile >
73
+ taq generate-metadata <contractName>
74
74
  ```
75
75
 
76
76
  #### Options
@@ -79,7 +79,7 @@ The metadata `generate-metadata` task will accept the following required paramet
79
79
 
80
80
  | name | description |
81
81
  |:-------------|--------------------------------------------------------------------|
82
- | contractName | The contract name (the contract may exist, or not exist) |
82
+ | contractName | The contract name (the contract may exist, or may not exist) |
83
83
 
84
84
 
85
85
  #### Task Properties
@@ -87,7 +87,7 @@ The metadata `generate-metadata` task will accept the following required paramet
87
87
  | attribute | value |
88
88
  |------------|:---------------------------------------:|
89
89
  | task | 'generate-metadata' |
90
- | command | 'generate-metadata [sourceFile]' |
90
+ | command | 'generate-metadata < contractName >' |
91
91
  | aliases | N/A |
92
92
 
93
93
 
@@ -111,7 +111,7 @@ The `generate-project-metadata` task not not have any additional parameters or o
111
111
  | attribute | value |
112
112
  |:----------:|:---------------------------------------:|
113
113
  | task | 'generate-project-metadata' |
114
- | command | 'taq generate-project-metadata' |
114
+ | command | 'generate-project-metadata' |
115
115
  | aliases | N/A |
116
116
 
117
117
  ## Behaviour
@@ -127,7 +127,7 @@ The user flow for each task is outlined below
127
127
 
128
128
  ### Generating project metadata
129
129
 
130
- - Add the project metadata to .taq config.json
130
+ - Add the project metadata to `.taq/config.json`
131
131
  - Add the project metadata schema
132
132
 
133
133
  ### Default Value Priority
@@ -140,6 +140,6 @@ Summary of priority for default values:
140
140
 
141
141
  ## Plugin Architecture
142
142
 
143
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
143
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
144
144
 
145
145
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-metadata",
3
- "version": "0.21.14",
3
+ "version": "0.21.23",
4
4
  "description": "A plugin for Taqueria providing metadata creation and validation.",
5
5
  "keywords": [
6
6
  "taqueria",
@@ -31,8 +31,8 @@
31
31
  "directory": "taqueria-plugin-metadata"
32
32
  },
33
33
  "dependencies": {
34
- "@taqueria/node-sdk": "^0.21.14",
35
- "@taqueria/protocol": "^0.21.14",
34
+ "@taqueria/node-sdk": "^0.21.23",
35
+ "@taqueria/protocol": "^0.21.23",
36
36
  "prompts": "^2.4.2"
37
37
  },
38
38
  "devDependencies": {