@asyncapi/generator 1.17.20 → 1.17.21

package/README.md

@@ -82,6 +82,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="33.33%"><a href="https://github.com/swastiksuvam55"><img src="https://avatars.githubusercontent.com/u/90003260?v=4?s=100" width="100px;" alt="swastik suvam singh"/><br /><sub><b>swastik suvam singh</b></sub></a><br /><a href="https://github.com/asyncapi/generator/commits?author=swastiksuvam55" title="Code">💻</a></td>
       <td align="center" valign="top" width="33.33%"><a href="https://blog.orzzh.icu/"><img src="https://avatars.githubusercontent.com/u/33168669?v=4?s=100" width="100px;" alt="GavinZhengOI"/><br /><sub><b>GavinZhengOI</b></sub></a><br /><a href="https://github.com/asyncapi/generator/commits?author=GavinZhengOI" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="33.33%"><a href="https://github.com/lmgyuan"><img src="https://avatars.githubusercontent.com/u/16447041?v=4?s=100" width="100px;" alt="lmgyuan"/><br /><sub><b>lmgyuan</b></sub></a><br /><a href="https://github.com/asyncapi/generator/commits?author=lmgyuan" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

package/docs/generator-template.md

@@ -67,10 +67,22 @@ components:
 
 1. Create a new directory for your template named **python-mqtt-client-template**.
 2. Install the AsyncAPI CLI using the command `npm install -g @asyncapi/cli`.
-3. Create a new folder **test/fixtures** with a file named **asyncapi.yml** in your fixtures directory. This file is used to define the **structure** of your template. 
-4. Create a new file named **package.json** in your template directory. This file is used to define the **dependencies** for your template.
-5. Create a new file named **index.js** in your **template** directory. This file is used to define the **logic** for your template.
-6. Create a **test.py** file to validate the logic of your application.
+3. Create a new folder **test/fixtures** with a file named **asyncapi.yml** in your fixtures directory. This file is used to define the **structure** of your template. You can copy the above example and paste it in your **asyncapi.yml** document.
+4. Create a new file named **package.json** in your **python-mqtt-client-template** directory. This file is used to define the **dependencies** for your template.
+5. Create a new folder **python-mqtt-client-template/template**. Create a new file named **index.js** in your **template** directory. This file is used to define the **logic** for your template.
+6. Create a **test.py** file to validate the logic of your application. Don't worry about this file for now. The tutorial will tell you how to create it later.
+
+Now your directory should look like this:
+
+```
+python-mqtt-client-template 
+├── template
+│   └── index.js
+├── test
+│   └── fixtures
+│       └── asyncapi.yml
+└── package.json
+```
 
 Lets break it down:
 
@@ -110,7 +122,7 @@ Here's what is contained in the code snippet above:
   - **supportedProtocols** - A list that specifies which protocols are supported by your template.
 - **dependencies** - specifies which version of [`@asyncapi/generator-react-sdk`](https://github.com/asyncapi/generator-react-sdk) should be used.
 
-Run the command `npm install` on your terminal to install the dependencies specified in **package.json**.
+Navigate to the ****python-mqtt-client-template** directory. Run the command `npm install` on your terminal to install the dependencies specified in **package.json**.
 
 ### index.js file
 
@@ -143,7 +155,7 @@ The `asyncapi.info().title()` returns `Temperature Service`.
 
 ### Test using AsyncAPI CLI
 
-To see this in action, run `asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ -o test/project` command on your terminal. If successful, you'll see the message below on your terminal:
+To see this in action, navigate to the **python-mqtt-client-template** directory. Then, run `asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ -o test/project` command on your terminal. If successful, you'll see the message below on your terminal:
 
 ``` cmd
 Generation in progress. Keep calm and wait a bit... done
@@ -173,7 +185,7 @@ In this section, you'll:
 
 ### 1. Create the client
 
-The following is the sample code of the Python client you generated [above](#test-using-asyncapi-cli) using the Paho-MQTT library after running the `asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ -o test/project` command.
+Here is the sample code to be pasted in the client.py you generated above running the `asyncapi generate fromTemplate test/fixtures/asyncapi.yml ./ -o test/project` command. It uses the `paho-mqtt` package.
 
 ``` python
 # 1
@@ -213,6 +225,20 @@ In summary, this code sets up an MQTT client using the Paho-MQTT library. It con
 You'll interact with the Temperature Service using the client module you created above. You'll create an instance of the client using `client = TemperatureServiceClient()` and then use `client.sendTemperatureChange` function to publish messages that Temperature Service is subscribed to.
 Create a **test/project/test.py** file in your project and add the code snippet below:
 
+Now your directory should look like this:
+
+```
+python-mqtt-client-template
+├── template
+│   └── index.js
+└── test
+    ├── fixtures
+    │   └── asyncapi.yml
+    └── project
+        ├── client.py
+        └── test.py
+```
+
 ``` python
 from client import TemperatureServiceClient
 from random import randrange
@@ -435,7 +461,7 @@ You'll then need to template to dynamically generate `sendTemperatureDrop` and `
 </Text>
 ```
 
-It's recommended to put reusable components outside template directory in a new directory called **components**. You'll create a component that will dynamically generate functions in the output for as many channels as there are in your AsyncAPI document that contain a `publish` operation. Add the following code in **components/TopicFunction.js** file:
+It's recommended to put reusable components outside the template directory in a new directory called components. You'll create a component that will dynamically generate functions in the output for as many channels as there are in your AsyncAPI document that contains a `publish` operation. Add the following code in the **python-mqtt-client-template/components/TopicFunction.js** file, after creating the **python-mqtt-client-template/components/** directory:
 
 ```js
 /*
@@ -512,6 +538,23 @@ export default function ({ asyncapi, params }) {
 
 ```
 
+Now your directory should look like this:
+
+```
+python-mqtt-client-template
+├── components
+│   └── TopicFunction.js
+├── template
+│   └── index.js
+└── test
+    ├── fixtures
+    │   └── asyncapi.yml
+    └── project
+        ├── client.py
+        └── test.py
+```
+
+
 Run `npm test` on your terminal to ensure everything works as expected.
 
 In the next section, you'll add another channel to **asyncapi.yml** file called `temperature/dropped` and `temperature/risen` then run the template again to make sure it still works as expected.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "1.17.20",
+  "version": "1.17.21",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -49,7 +49,7 @@
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
     "@asyncapi/generator-react-sdk": "^1.0.16",
-    "@asyncapi/parser": "^3.0.12",
+    "@asyncapi/parser": "^3.0.13",
     "@npmcli/arborist": "5.6.3",
     "@smoya/multi-parser": "^5.0.0",
     "ajv": "^8.12.0",