@powerlines/plugin-asyncapi 0.1.682 → 0.1.683

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 (2) hide show
  1. package/README.md +34 -0
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -74,6 +74,40 @@ A Powerlines plugin to generate project code with [AsyncAPI](https://www.asyncap
74
74
 
75
75
  <!-- END doctoc -->
76
76
 
77
+ ## Features
78
+
79
+ - Generates project code from AsyncAPI specifications (schema file or URL)
80
+ - Renders output with a configurable AsyncAPI template into a token-expanded output path
81
+ - Loads the schema document at `configResolved` and delegates generation to the Power Plant plugin
82
+ - Typed options via `./types/plugin` (`AsyncAPIPluginOptions`, user/resolved config, context)
83
+
84
+ ## Usage
85
+
86
+ Install the plugin:
87
+
88
+ ```bash
89
+ pnpm add @powerlines/plugin-asyncapi
90
+ ```
91
+
92
+ Register it in `powerlines.config.ts`:
93
+
94
+ ```ts
95
+ import { defineConfig } from "powerlines";
96
+ import { plugin as asyncapi } from "@powerlines/plugin-asyncapi";
97
+
98
+ export default defineConfig({
99
+ plugins: [
100
+ asyncapi({
101
+ schema: "./schema.yaml",
102
+ templateName: "@asyncapi/html-template",
103
+ outputPath: "{builtinPath}/asyncapi"
104
+ })
105
+ ]
106
+ });
107
+ ```
108
+
109
+ Run the Powerlines build for your project to activate the plugin.
110
+
77
111
  ## Installing
78
112
 
79
113
  Using [pnpm](http://pnpm.io):
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-asyncapi",
3
- "version": "0.1.682",
3
+ "version": "0.1.683",
4
4
  "type": "module",
5
5
  "description": "A Powerlines plugin to generate project code from AsyncAPI specifications.",
6
6
  "repository": {
@@ -91,17 +91,17 @@
91
91
  "dependencies": {
92
92
  "@power-plant/asyncapi": "^0.0.94",
93
93
  "@power-plant/core": "^0.0.98",
94
- "@powerlines/plugin-power-plant": "^0.1.73",
94
+ "@powerlines/plugin-power-plant": "^0.1.74",
95
95
  "@stryke/fs": "^0.33.118",
96
96
  "@stryke/path": "^0.29.43",
97
97
  "defu": "^6.1.7",
98
- "powerlines": "^0.47.216"
98
+ "powerlines": "^0.47.217"
99
99
  },
100
100
  "devDependencies": {
101
- "@powerlines/plugin-plugin": "^0.12.629",
101
+ "@powerlines/plugin-plugin": "^0.12.630",
102
102
  "@types/node": "^25.9.9"
103
103
  },
104
104
  "publishConfig": { "access": "public" },
105
105
  "types": "./dist/index.d.cts",
106
- "gitHead": "75efa1cc4eb8bc90093202669065576aa70fbfef"
106
+ "gitHead": "bb4e1f2b32a8bb9d20559ca7c3df3a2f30a0d14e"
107
107
  }