From a31d964d19950a530905bf261c2a7b769ccf43f4 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Thu, 3 Oct 2024 17:19:35 +0530
Subject: [PATCH 01/14] refactor: improve generate function structure

---
 apps/generator/cli.js | 246 +++++++++++++++++++++++++++---------------
 1 file changed, 162 insertions(+), 84 deletions(-)

diff --git a/apps/generator/cli.js b/apps/generator/cli.js
index feb12446a..437dfb920 100755
--- a/apps/generator/cli.js
+++ b/apps/generator/cli.js
@@ -1,19 +1,19 @@
 #!/usr/bin/env node
 
-const path = require('path');
-const os = require('os');
-const program = require('commander');
-const xfs = require('fs.extra');
-const { DiagnosticSeverity } = require('@asyncapi/parser/cjs');
-const packageInfo = require('./package.json');
-const Generator = require('./lib/generator');
-const Watcher = require('./lib/watcher');
-const { isLocalTemplate, isFilePath } = require('./lib/utils');
-
-const red = text => `\x1b[31m${text}\x1b[0m`;
-const magenta = text => `\x1b[35m${text}\x1b[0m`;
-const yellow = text => `\x1b[33m${text}\x1b[0m`;
-const green = text => `\x1b[32m${text}\x1b[0m`;
+const path = require("path");
+const os = require("os");
+const program = require("commander");
+const xfs = require("fs.extra");
+const { DiagnosticSeverity } = require("@asyncapi/parser/cjs");
+const packageInfo = require("./package.json");
+const Generator = require("./lib/generator");
+const Watcher = require("./lib/watcher");
+const { isLocalTemplate, isFilePath } = require("./lib/utils");
+
+const red = (text) => `\x1b[31m${text}\x1b[0m`;
+const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
+const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
+const green = (text) => `\x1b[32m${text}\x1b[0m`;
 
 let asyncapiDocPath;
 let template;
@@ -22,20 +22,26 @@ const noOverwriteGlobs = [];
 const disabledHooks = {};
 const mapBaseUrlToFolder = {};
 
-const parseOutput = dir => path.resolve(dir);
+const parseOutput = (dir) => path.resolve(dir);
 
-const paramParser = v => {
-  if (!v.includes('=')) throw new Error(`Invalid param ${v}. It must be in the format of --param name=value.`);
+const paramParser = (v) => {
+  if (!v.includes("="))
+    throw new Error(
+      `Invalid param ${v}. It must be in the format of --param name=value.`
+    );
   const [paramName, paramValue] = v.split(/=(.+)/, 2);
   params[paramName] = paramValue;
   return v;
 };
 
-const noOverwriteParser = v => noOverwriteGlobs.push(v);
+const noOverwriteParser = (v) => noOverwriteGlobs.push(v);
 
-const disableHooksParser = v => {
+const disableHooksParser = (v) => {
   const [hookType, hookNames] = v.split(/=/);
-  if (!hookType) throw new Error('Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,...');
+  if (!hookType)
+    throw new Error(
+      "Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,..."
+    );
   if (hookNames) {
     disabledHooks[hookType] = hookNames.split(/,/);
   } else {
@@ -43,63 +49,101 @@ const disableHooksParser = v => {
   }
 };
 
-const mapBaseUrlParser = v => {
+const mapBaseUrlParser = (v) => {
   // Example value for regular expression: https://schema.example.com/crm/:./test/docs/
   // it splits on last occurrence of : into the groups all, url and folder
   const re = /(.*):(.*)/g;
   let mapping = [];
-  if ((mapping = re.exec(v))===null || mapping.length!==3) {
-    throw new Error('Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected.');
+  if ((mapping = re.exec(v)) === null || mapping.length !== 3) {
+    throw new Error(
+      "Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected."
+    );
   }
 
   // Folder is without trailing slash, so make sure that url has also no trailing slash:
-  mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, '');
+  mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, "");
   mapBaseUrlToFolder.folder = path.resolve(mapping[2]);
 
   const isURL = /^https?:/;
   if (!isURL.test(mapBaseUrlToFolder.url.toLowerCase())) {
-    throw new Error('Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`.');
+    throw new Error(
+      "Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`."
+    );
   }
 };
 
-const showError = err => {
-  console.error(red('Something went wrong:'));
+const showError = (err) => {
+  console.error(red("Something went wrong:"));
   console.error(red(err.stack || err.message));
   if (err.diagnostics) {
-    const errorDiagnostics = err.diagnostics.filter(diagnostic => diagnostic.severity === DiagnosticSeverity.Error);
-    console.error(red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`));
+    const errorDiagnostics = err.diagnostics.filter(
+      (diagnostic) => diagnostic.severity === DiagnosticSeverity.Error
+    );
+    console.error(
+      red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`)
+    );
   }
 };
-const showErrorAndExit = err => {
+const showErrorAndExit = (err) => {
   showError(err);
   process.exit(1);
 };
 
 program
   .version(packageInfo.version)
-  .arguments('<asyncapi> <template>')
+  .arguments("<asyncapi> <template>")
   .action((fileLoc, tmpl) => {
     asyncapiDocPath = fileLoc;
     template = tmpl;
   })
-  .option('-d, --disable-hook [hooks...]', 'disable a specific hook type or hooks from given hook type', disableHooksParser)
-  .option('--debug', 'enable more specific errors in the console')
-  .option('-i, --install', 'installs the template and its dependencies (defaults to false)')
-  .option('-n, --no-overwrite <glob>', 'glob or path of the file(s) to skip when regenerating', noOverwriteParser)
-  .option('-o, --output <outputDir>', 'directory where to put the generated files (defaults to current directory)', parseOutput, process.cwd())
-  .option('-p, --param <name=value>', 'additional param to pass to templates', paramParser)
-  .option('--force-write', 'force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)')
-  .option('--watch-template', 'watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development.')
-  .option('--map-base-url <url:folder>','maps all schema references from base url to local folder',mapBaseUrlParser)
+  .option(
+    "-d, --disable-hook [hooks...]",
+    "disable a specific hook type or hooks from given hook type",
+    disableHooksParser
+  )
+  .option("--debug", "enable more specific errors in the console")
+  .option(
+    "-i, --install",
+    "installs the template and its dependencies (defaults to false)"
+  )
+  .option(
+    "-n, --no-overwrite <glob>",
+    "glob or path of the file(s) to skip when regenerating",
+    noOverwriteParser
+  )
+  .option(
+    "-o, --output <outputDir>",
+    "directory where to put the generated files (defaults to current directory)",
+    parseOutput,
+    process.cwd()
+  )
+  .option(
+    "-p, --param <name=value>",
+    "additional param to pass to templates",
+    paramParser
+  )
+  .option(
+    "--force-write",
+    "force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)"
+  )
+  .option(
+    "--watch-template",
+    "watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development."
+  )
+  .option(
+    "--map-base-url <url:folder>",
+    "maps all schema references from base url to local folder",
+    mapBaseUrlParser
+  )
   .parse(process.argv);
 
 if (!asyncapiDocPath) {
-  console.error(red('> Path or URL to AsyncAPI file not provided.'));
+  console.error(red("> Path or URL to AsyncAPI file not provided."));
   program.help(); // This exits the process
 }
 const isAsyncapiDocLocal = isFilePath(asyncapiDocPath);
 
-xfs.mkdirp(program.output, async err => {
+xfs.mkdirp(program.output, async (err) => {
   if (err) return showErrorAndExit(err);
   try {
     await generate(program.output);
@@ -112,26 +156,45 @@ xfs.mkdirp(program.output, async err => {
     let watcher;
     const watchDir = path.resolve(template);
     const outputPath = path.resolve(watchDir, program.output);
-    const transpiledTemplatePath = path.resolve(watchDir, Generator.TRANSPILED_TEMPLATE_LOCATION);
+    const transpiledTemplatePath = path.resolve(
+      watchDir,
+      Generator.TRANSPILED_TEMPLATE_LOCATION
+    );
     const ignorePaths = [outputPath, transpiledTemplatePath];
     // Template name is needed as it is not always a part of the cli commad
     // There is a use case that you run generator from a root of the template with `./` path
-    const templateName = require(path.resolve(watchDir,'package.json')).name;
+    const templateName = require(path.resolve(watchDir, "package.json")).name;
 
     if (isAsyncapiDocLocal) {
-      console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`);
+      console.log(
+        `[WATCHER] Watching for changes in the template directory ${magenta(
+          watchDir
+        )} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`
+      );
       watcher = new Watcher([asyncapiDocPath, watchDir], ignorePaths);
     } else {
-      console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)}`);
+      console.log(
+        `[WATCHER] Watching for changes in the template directory ${magenta(
+          watchDir
+        )}`
+      );
       watcher = new Watcher(watchDir, ignorePaths);
     }
     // Must check template in its installation path in generator to use isLocalTemplate function
-    if (!await isLocalTemplate(path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName))) {
-      console.warn(`WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`);
+    if (
+      !(await isLocalTemplate(
+        path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName)
+      ))
+    ) {
+      console.warn(
+        `WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`
+      );
     }
 
     await watcher.watch(watcherHandler, (paths) => {
-      showErrorAndExit({ message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.` });
+      showErrorAndExit({
+        message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.`,
+      });
     });
   }
 });
@@ -140,54 +203,69 @@ xfs.mkdirp(program.output, async err => {
  * Generates the files based on the template.
  * @param {*} targetDir The path to the target directory.
  */
+/**
+ * Removed async from the promise executor function : Instead of marking the executor as async, I created an immediately invoked async function within it to handle the async operations
+ */
 function generate(targetDir) {
-  return new Promise(async (resolve, reject) => {
-    try {
-      const generator = new Generator(template, targetDir || path.resolve(os.tmpdir(), 'asyncapi-generator'), {
-        templateParams: params,
-        noOverwriteGlobs,
-        disabledHooks,
-        forceWrite: program.forceWrite,
-        install: program.install,
-        debug: program.debug,
-        mapBaseUrlToFolder
-      });
+  return new Promise((resolve, reject) => {
+    (async () => {
+      try {
+        const generator = new Generator(
+          template,
+          targetDir || path.resolve(os.tmpdir(), "asyncapi-generator"),
+          {
+            templateParams: params,
+            noOverwriteGlobs,
+            disabledHooks,
+            forceWrite: program.forceWrite,
+            install: program.install,
+            debug: program.debug,
+            mapBaseUrlToFolder,
+          }
+        );
 
-      if (isAsyncapiDocLocal) {
-        await generator.generateFromFile(path.resolve(asyncapiDocPath));
-      } else {
-        await generator.generateFromURL(asyncapiDocPath);
+        if (isAsyncapiDocLocal) {
+          await generator.generateFromFile(path.resolve(asyncapiDocPath));
+        } else {
+          await generator.generateFromURL(asyncapiDocPath);
+        }
+        console.log(green("\n\nDone! ✨"));
+        console.log(
+          `${
+            yellow("Check out your shiny new generated files at ") +
+            magenta(program.output) +
+            yellow(".")
+          }\n`
+        );
+        resolve();
+      } catch (e) {
+        reject(e);
       }
-      console.log(green('\n\nDone! ✨'));
-      console.log(`${yellow('Check out your shiny new generated files at ') + magenta(program.output) + yellow('.')}\n`);
-      resolve();
-    } catch (e) {
-      reject(e);
-    }
+    })(); //Immediately invoke the async function
   });
 }
 
 async function watcherHandler(changedFiles) {
   console.clear();
-  console.log('[WATCHER] Change detected');
+  console.log("[WATCHER] Change detected");
   for (const [, value] of Object.entries(changedFiles)) {
     let eventText;
     switch (value.eventType) {
-    case 'changed':
-      eventText = green(value.eventType);
-      break;
-    case 'removed':
-      eventText = red(value.eventType);
-      break;
-    case 'renamed':
-      eventText = yellow(value.eventType);
-      break;
-    default:
-      eventText = yellow(value.eventType);
+      case "changed":
+        eventText = green(value.eventType);
+        break;
+      case "removed":
+        eventText = red(value.eventType);
+        break;
+      case "renamed":
+        eventText = yellow(value.eventType);
+        break;
+      default:
+        eventText = yellow(value.eventType);
     }
     console.log(`\t${magenta(value.path)} was ${eventText}`);
   }
-  console.log('Generating files');
+  console.log("Generating files");
   try {
     await generate(program.output);
   } catch (e) {
@@ -195,4 +273,4 @@ async function watcherHandler(changedFiles) {
   }
 }
 
-process.on('unhandledRejection', showErrorAndExit);
+process.on("unhandledRejection", showErrorAndExit);

From eab0c2387d587c3103d4ce40684a2642d46076ab Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 10:42:00 +0530
Subject: [PATCH 02/14] Add --no-cache option to apk add command in Dockerfile

---
 apps/generator/Dockerfile | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 426ece721..d0b585f4a 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -11,9 +11,9 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.30.0 release Git is supported and required as a dependency
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
-RUN apk --update add git chromium && \
-    rm -rf /var/lib/apt/lists/* && \
-    rm /var/cache/apk/*
+# The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
+RUN apk --no-cache add git chromium && \
+    rm -rf /var/cache/apk/*
 
 # Installing latest released npm package
 RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION

From 97c3169f490c56acf5363dcdfc584289db713ab7 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 10:49:43 +0530
Subject: [PATCH 03/14] Add --no-cache option to apk add command in Dockerfile

---
 apps/generator/Dockerfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index d0b585f4a..981ad5746 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -11,7 +11,7 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.30.0 release Git is supported and required as a dependency
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
-# The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
+# The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.apps
 RUN apk --no-cache add git chromium && \
     rm -rf /var/cache/apk/*
 

From d973fbb4fcaf0fd483bff442cc5143d2227e2eae Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 14:15:18 +0530
Subject: [PATCH 04/14] Add --no-cache option to apk add command in Dockerfile
 and fix typo which I did in the comment

---
 apps/generator/Dockerfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 981ad5746..d0b585f4a 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -11,7 +11,7 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.30.0 release Git is supported and required as a dependency
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
-# The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.apps
+# The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
 RUN apk --no-cache add git chromium && \
     rm -rf /var/cache/apk/*
 

From 75367d24e151b49377d711754a64bd2cafe86913 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 15:43:12 +0530
Subject: [PATCH 05/14] combining commands which reduces layers in docker image

---
 apps/generator/Dockerfile | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index d0b585f4a..1e4c89f6d 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -12,10 +12,12 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
 # The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
+# Combining these commands reduces the number of layers created in the docker image which result better performance and smaller image sizes.
 RUN apk --no-cache add git chromium && \
+    npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION && \
+    apk del git chromium && \
     rm -rf /var/cache/apk/*
 
-# Installing latest released npm package
-RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
+
 
 ENTRYPOINT [ "ag" ]

From bea1910891b712db030ef6f40d896ca80acf2334 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 15:47:49 +0530
Subject: [PATCH 06/14] Revert "combining commands which reduces layers in
 docker image"

This reverts commit 75367d24e151b49377d711754a64bd2cafe86913.
---
 apps/generator/Dockerfile | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 1e4c89f6d..d0b585f4a 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -12,12 +12,10 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
 # The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
-# Combining these commands reduces the number of layers created in the docker image which result better performance and smaller image sizes.
 RUN apk --no-cache add git chromium && \
-    npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION && \
-    apk del git chromium && \
     rm -rf /var/cache/apk/*
 
-
+# Installing latest released npm package
+RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
 
 ENTRYPOINT [ "ag" ]

From 114064bb5b04544a9973622d983ef27132a16e81 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 16:23:24 +0530
Subject: [PATCH 07/14] combining commands which reduces layers in docker and
 quoting for precaution

---
 apps/generator/Dockerfile | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index d0b585f4a..43395dce3 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -12,10 +12,12 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
 # The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
-RUN apk --no-cache add git chromium && \
-    rm -rf /var/cache/apk/*
+# Set environment variable for AsyncAPI generator version
+ARG ASYNCAPI_GENERATOR_VERSION=latest
 
-# Installing latest released npm package
-RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
+RUN apk --no-cache add git chromium && \ 
+npm install -g "@asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION" && \
+apk del git chromium && \
+rm -rf /var/cache/apk/*
 
 ENTRYPOINT [ "ag" ]

From 8d3683c2b60b15d6a3499ef044b3517c5587e240 Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Fri, 4 Oct 2024 16:29:17 +0530
Subject: [PATCH 08/14] revert all my changes

---
 apps/generator/Dockerfile | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 43395dce3..d0b585f4a 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -12,12 +12,10 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
 # The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
-# Set environment variable for AsyncAPI generator version
-ARG ASYNCAPI_GENERATOR_VERSION=latest
+RUN apk --no-cache add git chromium && \
+    rm -rf /var/cache/apk/*
 
-RUN apk --no-cache add git chromium && \ 
-npm install -g "@asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION" && \
-apk del git chromium && \
-rm -rf /var/cache/apk/*
+# Installing latest released npm package
+RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
 
 ENTRYPOINT [ "ag" ]

From 5194e880773229e126ce73530d219aae12d895eb Mon Sep 17 00:00:00 2001
From: Bedi Gupta <Bedigupta76@gmail.com>
Date: Sat, 5 Oct 2024 02:55:27 +0530
Subject: [PATCH 09/14] Delete apps/generator/cli.js

By mistake I committed this file
---
 apps/generator/cli.js | 276 ------------------------------------------
 1 file changed, 276 deletions(-)
 delete mode 100755 apps/generator/cli.js

diff --git a/apps/generator/cli.js b/apps/generator/cli.js
deleted file mode 100755
index 437dfb920..000000000
--- a/apps/generator/cli.js
+++ /dev/null
@@ -1,276 +0,0 @@
-#!/usr/bin/env node
-
-const path = require("path");
-const os = require("os");
-const program = require("commander");
-const xfs = require("fs.extra");
-const { DiagnosticSeverity } = require("@asyncapi/parser/cjs");
-const packageInfo = require("./package.json");
-const Generator = require("./lib/generator");
-const Watcher = require("./lib/watcher");
-const { isLocalTemplate, isFilePath } = require("./lib/utils");
-
-const red = (text) => `\x1b[31m${text}\x1b[0m`;
-const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
-const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
-const green = (text) => `\x1b[32m${text}\x1b[0m`;
-
-let asyncapiDocPath;
-let template;
-const params = {};
-const noOverwriteGlobs = [];
-const disabledHooks = {};
-const mapBaseUrlToFolder = {};
-
-const parseOutput = (dir) => path.resolve(dir);
-
-const paramParser = (v) => {
-  if (!v.includes("="))
-    throw new Error(
-      `Invalid param ${v}. It must be in the format of --param name=value.`
-    );
-  const [paramName, paramValue] = v.split(/=(.+)/, 2);
-  params[paramName] = paramValue;
-  return v;
-};
-
-const noOverwriteParser = (v) => noOverwriteGlobs.push(v);
-
-const disableHooksParser = (v) => {
-  const [hookType, hookNames] = v.split(/=/);
-  if (!hookType)
-    throw new Error(
-      "Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,..."
-    );
-  if (hookNames) {
-    disabledHooks[hookType] = hookNames.split(/,/);
-  } else {
-    disabledHooks[hookType] = true;
-  }
-};
-
-const mapBaseUrlParser = (v) => {
-  // Example value for regular expression: https://schema.example.com/crm/:./test/docs/
-  // it splits on last occurrence of : into the groups all, url and folder
-  const re = /(.*):(.*)/g;
-  let mapping = [];
-  if ((mapping = re.exec(v)) === null || mapping.length !== 3) {
-    throw new Error(
-      "Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected."
-    );
-  }
-
-  // Folder is without trailing slash, so make sure that url has also no trailing slash:
-  mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, "");
-  mapBaseUrlToFolder.folder = path.resolve(mapping[2]);
-
-  const isURL = /^https?:/;
-  if (!isURL.test(mapBaseUrlToFolder.url.toLowerCase())) {
-    throw new Error(
-      "Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`."
-    );
-  }
-};
-
-const showError = (err) => {
-  console.error(red("Something went wrong:"));
-  console.error(red(err.stack || err.message));
-  if (err.diagnostics) {
-    const errorDiagnostics = err.diagnostics.filter(
-      (diagnostic) => diagnostic.severity === DiagnosticSeverity.Error
-    );
-    console.error(
-      red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`)
-    );
-  }
-};
-const showErrorAndExit = (err) => {
-  showError(err);
-  process.exit(1);
-};
-
-program
-  .version(packageInfo.version)
-  .arguments("<asyncapi> <template>")
-  .action((fileLoc, tmpl) => {
-    asyncapiDocPath = fileLoc;
-    template = tmpl;
-  })
-  .option(
-    "-d, --disable-hook [hooks...]",
-    "disable a specific hook type or hooks from given hook type",
-    disableHooksParser
-  )
-  .option("--debug", "enable more specific errors in the console")
-  .option(
-    "-i, --install",
-    "installs the template and its dependencies (defaults to false)"
-  )
-  .option(
-    "-n, --no-overwrite <glob>",
-    "glob or path of the file(s) to skip when regenerating",
-    noOverwriteParser
-  )
-  .option(
-    "-o, --output <outputDir>",
-    "directory where to put the generated files (defaults to current directory)",
-    parseOutput,
-    process.cwd()
-  )
-  .option(
-    "-p, --param <name=value>",
-    "additional param to pass to templates",
-    paramParser
-  )
-  .option(
-    "--force-write",
-    "force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)"
-  )
-  .option(
-    "--watch-template",
-    "watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development."
-  )
-  .option(
-    "--map-base-url <url:folder>",
-    "maps all schema references from base url to local folder",
-    mapBaseUrlParser
-  )
-  .parse(process.argv);
-
-if (!asyncapiDocPath) {
-  console.error(red("> Path or URL to AsyncAPI file not provided."));
-  program.help(); // This exits the process
-}
-const isAsyncapiDocLocal = isFilePath(asyncapiDocPath);
-
-xfs.mkdirp(program.output, async (err) => {
-  if (err) return showErrorAndExit(err);
-  try {
-    await generate(program.output);
-  } catch (e) {
-    return showErrorAndExit(e);
-  }
-
-  // If we want to watch for changes do that
-  if (program.watchTemplate) {
-    let watcher;
-    const watchDir = path.resolve(template);
-    const outputPath = path.resolve(watchDir, program.output);
-    const transpiledTemplatePath = path.resolve(
-      watchDir,
-      Generator.TRANSPILED_TEMPLATE_LOCATION
-    );
-    const ignorePaths = [outputPath, transpiledTemplatePath];
-    // Template name is needed as it is not always a part of the cli commad
-    // There is a use case that you run generator from a root of the template with `./` path
-    const templateName = require(path.resolve(watchDir, "package.json")).name;
-
-    if (isAsyncapiDocLocal) {
-      console.log(
-        `[WATCHER] Watching for changes in the template directory ${magenta(
-          watchDir
-        )} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`
-      );
-      watcher = new Watcher([asyncapiDocPath, watchDir], ignorePaths);
-    } else {
-      console.log(
-        `[WATCHER] Watching for changes in the template directory ${magenta(
-          watchDir
-        )}`
-      );
-      watcher = new Watcher(watchDir, ignorePaths);
-    }
-    // Must check template in its installation path in generator to use isLocalTemplate function
-    if (
-      !(await isLocalTemplate(
-        path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName)
-      ))
-    ) {
-      console.warn(
-        `WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`
-      );
-    }
-
-    await watcher.watch(watcherHandler, (paths) => {
-      showErrorAndExit({
-        message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.`,
-      });
-    });
-  }
-});
-
-/**
- * Generates the files based on the template.
- * @param {*} targetDir The path to the target directory.
- */
-/**
- * Removed async from the promise executor function : Instead of marking the executor as async, I created an immediately invoked async function within it to handle the async operations
- */
-function generate(targetDir) {
-  return new Promise((resolve, reject) => {
-    (async () => {
-      try {
-        const generator = new Generator(
-          template,
-          targetDir || path.resolve(os.tmpdir(), "asyncapi-generator"),
-          {
-            templateParams: params,
-            noOverwriteGlobs,
-            disabledHooks,
-            forceWrite: program.forceWrite,
-            install: program.install,
-            debug: program.debug,
-            mapBaseUrlToFolder,
-          }
-        );
-
-        if (isAsyncapiDocLocal) {
-          await generator.generateFromFile(path.resolve(asyncapiDocPath));
-        } else {
-          await generator.generateFromURL(asyncapiDocPath);
-        }
-        console.log(green("\n\nDone! ✨"));
-        console.log(
-          `${
-            yellow("Check out your shiny new generated files at ") +
-            magenta(program.output) +
-            yellow(".")
-          }\n`
-        );
-        resolve();
-      } catch (e) {
-        reject(e);
-      }
-    })(); //Immediately invoke the async function
-  });
-}
-
-async function watcherHandler(changedFiles) {
-  console.clear();
-  console.log("[WATCHER] Change detected");
-  for (const [, value] of Object.entries(changedFiles)) {
-    let eventText;
-    switch (value.eventType) {
-      case "changed":
-        eventText = green(value.eventType);
-        break;
-      case "removed":
-        eventText = red(value.eventType);
-        break;
-      case "renamed":
-        eventText = yellow(value.eventType);
-        break;
-      default:
-        eventText = yellow(value.eventType);
-    }
-    console.log(`\t${magenta(value.path)} was ${eventText}`);
-  }
-  console.log("Generating files");
-  try {
-    await generate(program.output);
-  } catch (e) {
-    showError(e);
-  }
-}
-
-process.on("unhandledRejection", showErrorAndExit);

From 51605283193e486032b9f3bd7d649f48d99dc810 Mon Sep 17 00:00:00 2001
From: Bedi Gupta <Bedigupta76@gmail.com>
Date: Sat, 5 Oct 2024 11:37:44 +0530
Subject: [PATCH 10/14] Update Dockerfile

try to fix the maintainability issue
---
 apps/generator/Dockerfile | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index d0b585f4a..2dde478dc 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -12,10 +12,9 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
 # The --no-cache prevents from caching of the package index which saves space by not storing the APK cache files.
+# Install dependencies and AsyncAPI Generator in a single RUN command
 RUN apk --no-cache add git chromium && \
-    rm -rf /var/cache/apk/*
-
-# Installing latest released npm package
-RUN npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
+    rm -rf /var/cache/apk/* && \
+    npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
 
 ENTRYPOINT [ "ag" ]

From 1e050fdf92437f6ceb8ca957da2e42a772530719 Mon Sep 17 00:00:00 2001
From: Bedi Gupta <Bedigupta76@gmail.com>
Date: Sat, 5 Oct 2024 11:47:51 +0530
Subject: [PATCH 11/14] Completed all changes which are suggested

1. Ensuring that the ARG is defined in the correct scope.
2. Protecting against potential issues with variable expansion.
---
 apps/generator/Dockerfile | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 2dde478dc..8d6bdb9a6 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -1,5 +1,3 @@
-ARG ASYNCAPI_GENERATOR_VERSION=1.10.9
-
 FROM node:18-alpine
 
 WORKDIR /app
@@ -8,6 +6,9 @@ WORKDIR /app
 ENV PUPPETEER_EXECUTABLE_PATH /usr/bin/chromium-browser
 ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 
+# Include the ARG instruction in this build stage
+ARG ASYNCAPI_GENERATOR_VERSION=1.10.9
+
 # Since 0.30.0 release Git is supported and required as a dependency
 # Since 0.14.0 release of html-template chromium is needed for pdf generation.
 # More custom packages for specific template should not be added to this dockerfile. Instead, we should come up with some extensibility solution.
@@ -15,6 +16,6 @@ ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 # Install dependencies and AsyncAPI Generator in a single RUN command
 RUN apk --no-cache add git chromium && \
     rm -rf /var/cache/apk/* && \
-    npm install -g @asyncapi/generator@$ASYNCAPI_GENERATOR_VERSION
+    npm install -g "@asyncapi/generator@${ASYNCAPI_GENERATOR_VERSION}"
 
 ENTRYPOINT [ "ag" ]

From 7fe02ad5aeb0183b03bcce552b0245bb334b38f6 Mon Sep 17 00:00:00 2001
From: Bedi Gupta <Bedigupta76@gmail.com>
Date: Sat, 5 Oct 2024 11:52:06 +0530
Subject: [PATCH 12/14] Omitting --ignore-scripts

made changes which was suggested in the sonarcloud
---
 apps/generator/Dockerfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apps/generator/Dockerfile b/apps/generator/Dockerfile
index 8d6bdb9a6..5ada62722 100644
--- a/apps/generator/Dockerfile
+++ b/apps/generator/Dockerfile
@@ -16,6 +16,6 @@ ARG ASYNCAPI_GENERATOR_VERSION=1.10.9
 # Install dependencies and AsyncAPI Generator in a single RUN command
 RUN apk --no-cache add git chromium && \
     rm -rf /var/cache/apk/* && \
-    npm install -g "@asyncapi/generator@${ASYNCAPI_GENERATOR_VERSION}"
+    npm install -g --ignore-scripts "@asyncapi/generator@${ASYNCAPI_GENERATOR_VERSION}"
 
 ENTRYPOINT [ "ag" ]

From 632a620b5c5d5a8b497a334497e686577431938b Mon Sep 17 00:00:00 2001
From: bedi gupta <bedigupta76@gmail.com>
Date: Tue, 8 Oct 2024 15:18:28 +0530
Subject: [PATCH 13/14] bring back cli.js file as reviewer suggested

---
 apps/generator/cli.js | 198 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 198 insertions(+)
 create mode 100644 apps/generator/cli.js

diff --git a/apps/generator/cli.js b/apps/generator/cli.js
new file mode 100644
index 000000000..0fd464b10
--- /dev/null
+++ b/apps/generator/cli.js
@@ -0,0 +1,198 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const os = require('os');
+const program = require('commander');
+const xfs = require('fs.extra');
+const { DiagnosticSeverity } = require('@asyncapi/parser/cjs');
+const packageInfo = require('./package.json');
+const Generator = require('./lib/generator');
+const Watcher = require('./lib/watcher');
+const { isLocalTemplate, isFilePath } = require('./lib/utils');
+
+const red = text => `\x1b[31m${text}\x1b[0m`;
+const magenta = text => `\x1b[35m${text}\x1b[0m`;
+const yellow = text => `\x1b[33m${text}\x1b[0m`;
+const green = text => `\x1b[32m${text}\x1b[0m`;
+
+let asyncapiDocPath;
+let template;
+const params = {};
+const noOverwriteGlobs = [];
+const disabledHooks = {};
+const mapBaseUrlToFolder = {};
+
+const parseOutput = dir => path.resolve(dir);
+
+const paramParser = v => {
+  if (!v.includes('=')) throw new Error(`Invalid param ${v}. It must be in the format of --param name=value.`);
+  const [paramName, paramValue] = v.split(/=(.+)/, 2);
+  params[paramName] = paramValue;
+  return v;
+};
+
+const noOverwriteParser = v => noOverwriteGlobs.push(v);
+
+const disableHooksParser = v => {
+  const [hookType, hookNames] = v.split(/=/);
+  if (!hookType) throw new Error('Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,...');
+  if (hookNames) {
+    disabledHooks[hookType] = hookNames.split(/,/);
+  } else {
+    disabledHooks[hookType] = true;
+  }
+};
+
+const mapBaseUrlParser = v => {
+  // Example value for regular expression: https://schema.example.com/crm/:./test/docs/
+  // it splits on last occurrence of : into the groups all, url and folder
+  const re = /(.*):(.*)/g;
+  let mapping = [];
+  if ((mapping = re.exec(v))===null || mapping.length!==3) {
+    throw new Error('Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected.');
+  }
+
+  // Folder is without trailing slash, so make sure that url has also no trailing slash:
+  mapBaseUrlToFolder.url = mapping[1].replace(/\/$/, '');
+  mapBaseUrlToFolder.folder = path.resolve(mapping[2]);
+
+  const isURL = /^https?:/;
+  if (!isURL.test(mapBaseUrlToFolder.url.toLowerCase())) {
+    throw new Error('Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`.');
+  }
+};
+
+const showError = err => {
+  console.error(red('Something went wrong:'));
+  console.error(red(err.stack || err.message));
+  if (err.diagnostics) {
+    const errorDiagnostics = err.diagnostics.filter(diagnostic => diagnostic.severity === DiagnosticSeverity.Error);
+    console.error(red(`Errors:\n${JSON.stringify(errorDiagnostics, undefined, 2)}`));
+  }
+};
+const showErrorAndExit = err => {
+  showError(err);
+  process.exit(1);
+};
+
+program
+  .version(packageInfo.version)
+  .arguments('<asyncapi> <template>')
+  .action((fileLoc, tmpl) => {
+    asyncapiDocPath = fileLoc;
+    template = tmpl;
+  })
+  .option('-d, --disable-hook [hooks...]', 'disable a specific hook type or hooks from given hook type', disableHooksParser)
+  .option('--debug', 'enable more specific errors in the console')
+  .option('-i, --install', 'installs the template and its dependencies (defaults to false)')
+  .option('-n, --no-overwrite <glob>', 'glob or path of the file(s) to skip when regenerating', noOverwriteParser)
+  .option('-o, --output <outputDir>', 'directory where to put the generated files (defaults to current directory)', parseOutput, process.cwd())
+  .option('-p, --param <name=value>', 'additional param to pass to templates', paramParser)
+  .option('--force-write', 'force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)')
+  .option('--watch-template', 'watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory. This flag should be used only for template development.')
+  .option('--map-base-url <url:folder>','maps all schema references from base url to local folder',mapBaseUrlParser)
+  .parse(process.argv);
+
+if (!asyncapiDocPath) {
+  console.error(red('> Path or URL to AsyncAPI file not provided.'));
+  program.help(); // This exits the process
+}
+const isAsyncapiDocLocal = isFilePath(asyncapiDocPath);
+
+xfs.mkdirp(program.output, async err => {
+  if (err) return showErrorAndExit(err);
+  try {
+    await generate(program.output);
+  } catch (e) {
+    return showErrorAndExit(e);
+  }
+
+  // If we want to watch for changes do that
+  if (program.watchTemplate) {
+    let watcher;
+    const watchDir = path.resolve(template);
+    const outputPath = path.resolve(watchDir, program.output);
+    const transpiledTemplatePath = path.resolve(watchDir, Generator.TRANSPILED_TEMPLATE_LOCATION);
+    const ignorePaths = [outputPath, transpiledTemplatePath];
+    // Template name is needed as it is not always a part of the cli commad
+    // There is a use case that you run generator from a root of the template with `./` path
+    const templateName = require(path.resolve(watchDir,'package.json')).name;
+
+    if (isAsyncapiDocLocal) {
+      console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)} and in the AsyncAPI file ${magenta(asyncapiDocPath)}`);
+      watcher = new Watcher([asyncapiDocPath, watchDir], ignorePaths);
+    } else {
+      console.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)}`);
+      watcher = new Watcher(watchDir, ignorePaths);
+    }
+    // Must check template in its installation path in generator to use isLocalTemplate function
+    if (!await isLocalTemplate(path.resolve(Generator.DEFAULT_TEMPLATES_DIR, templateName))) {
+      console.warn(`WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`);
+    }
+
+    await watcher.watch(watcherHandler, (paths) => {
+      showErrorAndExit({ message: `[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.` });
+    });
+  }
+});
+
+/**
+ * Generates the files based on the template.
+ * @param {*} targetDir The path to the target directory.
+ */
+function generate(targetDir) {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const generator = new Generator(template, targetDir || path.resolve(os.tmpdir(), 'asyncapi-generator'), {
+        templateParams: params,
+        noOverwriteGlobs,
+        disabledHooks,
+        forceWrite: program.forceWrite,
+        install: program.install,
+        debug: program.debug,
+        mapBaseUrlToFolder
+      });
+
+      if (isAsyncapiDocLocal) {
+        await generator.generateFromFile(path.resolve(asyncapiDocPath));
+      } else {
+        await generator.generateFromURL(asyncapiDocPath);
+      }
+      console.log(green('\n\nDone! ✨'));
+      console.log(`${yellow('Check out your shiny new generated files at ') + magenta(program.output) + yellow('.')}\n`);
+      resolve();
+    } catch (e) {
+      reject(e);
+    }
+  });
+}
+
+async function watcherHandler(changedFiles) {
+  console.clear();
+  console.log('[WATCHER] Change detected');
+  for (const [, value] of Object.entries(changedFiles)) {
+    let eventText;
+    switch (value.eventType) {
+    case 'changed':
+      eventText = green(value.eventType);
+      break;
+    case 'removed':
+      eventText = red(value.eventType);
+      break;
+    case 'renamed':
+      eventText = yellow(value.eventType);
+      break;
+    default:
+      eventText = yellow(value.eventType);
+    }
+    console.log(`\t${magenta(value.path)} was ${eventText}`);
+  }
+  console.log('Generating files');
+  try {
+    await generate(program.output);
+  } catch (e) {
+    showError(e);
+  }
+}
+
+process.on('unhandledRejection', showErrorAndExit);
\ No newline at end of file

From acecefc16314c15d0518e96dc9c6627a8c9c83a9 Mon Sep 17 00:00:00 2001
From: Bedi Gupta <Bedigupta76@gmail.com>
Date: Wed, 9 Oct 2024 10:33:17 +0530
Subject: [PATCH 14/14] removing unnecessary changes in the cli.js

---
 apps/generator/cli.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apps/generator/cli.js b/apps/generator/cli.js
index 0fd464b10..feb12446a 100644
--- a/apps/generator/cli.js
+++ b/apps/generator/cli.js
@@ -195,4 +195,4 @@ async function watcherHandler(changedFiles) {
   }
 }
 
-process.on('unhandledRejection', showErrorAndExit);
\ No newline at end of file
+process.on('unhandledRejection', showErrorAndExit);