feat: add version parameter to allow version override (#67)

see asyncapi/html-template#107
asyncapi · Feb 17, 2021 · 462d64b · 462d64b
1 parent e038aec
commit 462d64b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -17,9 +17,11 @@ npm install -g @asyncapi/generator
 
 ## Supported parameters
 
-|Name|Description|Required|Default|Example|
-|---|---|---|---|---|
-|outFilename|The filename of the output file.|No|`asyncapi.md`|`index.md`|
+|Name|Description|Required|Default|Allowed values|Example|
+|---|---|---|---|---|---|
+|outFilename|The filename of the output file.|No|`asyncapi.md`|*Any* with `.md` extension|`index.md`|
+|version|Override the version of your application provided under `info.version` location in the specification file.|No|Version is taken from the specification file.|Version is taken from the spec file. |`1.0.0`|
+
 
 ## Development
 

diff --git a/components/Info.js b/components/Info.js
@@ -2,12 +2,12 @@ import { Text } from "@asyncapi/generator-react-sdk";
 
 import { Header, Link, Image } from "./common";
 
-export function Info({ asyncapi }) {
+export function Info({ asyncapi, params }) {
   const info = asyncapi.info();
   return (
     <>
       <Header type={1}>
-        {info.title()} {info.version()} documentation
+        {info.title()} {params.version || info.version()} documentation
       </Header>
 
       {info.description() && (

diff --git a/package.json b/package.json
@@ -70,6 +70,10 @@
         "description": "The name of the output markdown file",
         "default": "asyncapi.md",
         "required": false
+      },
+      "version": {
+        "description": "Override the version of your application provided under `info.version` location in the specification file.",
+        "required": false
       }
     }
   }

diff --git a/template/asyncapi.js b/template/asyncapi.js
@@ -8,7 +8,7 @@ import { Channels } from "../components/Channels";
 export default function({ asyncapi, params }) {
   return (
     <File name={params.outFilename || 'asyncapi.md'}>
-      <Info asyncapi={asyncapi} />
+      <Info asyncapi={asyncapi} params={params} />
       <TableOfContents asyncapi={asyncapi} />
       <TermsOfService asyncapi={asyncapi} />
       <Servers asyncapi={asyncapi} />