@asyncapi/generator 2.5.0 → 2.7.0

package/lib/conditionalGeneration.js

@@ -0,0 +1,162 @@
+const log = require('loglevel');
+const logMessage = require('./logMessages');
+const jmespath = require('jmespath');
+
+/**
+ * Determines whether the generation of a file or folder should be skipped
+ * based on conditions defined in the template configuration.
+ *
+ * @param {Object} templateConfig - The template configuration containing conditional logic.
+ * @param {string} matchedConditionPath - The matched path used to find applicable conditions.
+ * @param {Object} templateParams - Parameters passed to the template.
+ * @param {AsyncAPIDocument} asyncapiDocument - The AsyncAPI document used for evaluating conditions.
+ * @returns {Promise<boolean>} A promise that resolves to `true` if the condition is met, allowing the file or folder to render; otherwise, resolves to `false`. 
+ */
+async function isGenerationConditionMet (
+  templateConfig,
+  matchedConditionPath,
+  templateParams,
+  asyncapiDocument 
+) {
+  const conditionFilesGeneration = templateConfig?.conditionalFiles?.[matchedConditionPath] || {};
+  const conditionalGeneration = templateConfig?.conditionalGeneration?.[matchedConditionPath] || {};
+
+  const config = Object.keys(conditionFilesGeneration).length > 0 
+    ? conditionFilesGeneration 
+    : conditionalGeneration;
+
+  const subject = config?.subject;
+
+  // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+  // TODO: https://github.com/asyncapi/generator/issues/1553
+  if (Object.keys(conditionFilesGeneration).length > 0 && subject) {
+    return conditionalFilesGenerationDeprecatedVersion(
+      asyncapiDocument,
+      templateConfig,
+      matchedConditionPath,
+      templateParams
+    );
+  } else if (Object.keys(conditionalGeneration).length > 0) {
+    // Case when the subject is present in conditionalGeneration
+    if (subject) {
+      return conditionalSubjectGeneration(
+        asyncapiDocument,
+        templateConfig,
+        matchedConditionPath
+      );
+    }
+    return conditionalParameterGeneration(templateConfig,matchedConditionPath,templateParams);
+  }
+};
+
+/**
+ * Evaluates whether a template path should be conditionally generated 
+ * based on a parameter defined in the template configuration.
+ * @private
+ * @async
+ * @function conditionalParameterGeneration
+ * @param {Object} templateConfig - The full template configuration object.
+ * @param {string} matchedConditionPath - The path of the file/folder being conditionally generated.
+ * @param {Object} templateParams - The parameters passed to the generator, usually user input or default values.
+ * @returns {Promise<boolean>} - Resolves to `true` if the parameter passes validation, `false` otherwise.
+ */
+async function conditionalParameterGeneration(templateConfig, matchedConditionPath, templateParams) {
+  const conditionalGenerationConfig = templateConfig.conditionalGeneration?.[matchedConditionPath];
+  const parameterName = conditionalGenerationConfig.parameter;
+  const parameterValue = templateParams[parameterName];
+  return validateStatus(parameterValue, matchedConditionPath, templateConfig);
+}
+
+/**
+ * Determines whether a file should be conditionally included based on the provided subject expression
+ * and optional validation logic defined in the template configuration.
+ * @private
+ * @param {Object} asyncapiDocument - The parsed AsyncAPI document instance used for context evaluation.
+ * @param {Object} templateConfig - The configuration object that contains `conditionalFiles` rules.
+ * @param {string} matchedConditionPath - The path of the file/folder being conditionally generated.
+ * @param {Object} templateParams - The parameters passed to the generator, usually user input or default values.
+ * @returns {Boolean} - Returns `true` if the file should be included; `false` if it should be skipped.
+ */
+async function conditionalFilesGenerationDeprecatedVersion (
+  asyncapiDocument,
+  templateConfig,
+  matchedConditionPath,
+  templateParams
+) {
+  return conditionalSubjectGeneration(asyncapiDocument, templateConfig, matchedConditionPath, templateParams);
+};
+
+/**
+ * Determines whether a file should be conditionally included based on the provided subject expression
+ * and optional validation logic defined in the template configuration.
+ * @private
+ * @param {Object} asyncapiDocument - The parsed AsyncAPI document instance used for context evaluation.
+ * @param {Object} templateConfig - The configuration object that contains `conditionalFiles` rules.
+ * @param {String} matchedConditionPath - The relative path to the directory of the source file.
+ * @param {Object} templateParams - Parameters passed to the template.
+ * @returns {Boolean} - Returns `true` if the file should be included; `false` if it should be skipped.
+ */
+async function conditionalSubjectGeneration (
+  asyncapiDocument,
+  templateConfig,
+  matchedConditionPath,
+  templateParams
+
+) {
+  const fileCondition = templateConfig.conditionalGeneration?.[matchedConditionPath] || templateConfig.conditionalFiles?.[matchedConditionPath];
+  if (!fileCondition || !fileCondition.subject) {
+    return true; 
+  }
+  const { subject } = fileCondition;
+  const server = templateParams.server && asyncapiDocument.servers().get(templateParams.server);
+  const source = jmespath.search({
+    ...asyncapiDocument.json(),
+    ...{
+      server: server ? server.json() : undefined,
+    },
+  }, subject);
+
+  if (!source) {
+    log.debug(logMessage.relativeSourceFileNotGenerated(matchedConditionPath, subject));
+    return false;
+  } 
+  return validateStatus(source, matchedConditionPath, templateConfig);
+}
+
+/**
+ * Validates the argument value based on the provided validation schema.
+ *
+ * @param {any} argument The value to validate.
+ * @param {String} matchedConditionPath The matched condition path.
+ * @param {Object} templateConfig - The template configuration containing conditional logic.
+ * @return {Promise<Boolean>} A promise that resolves to false if the generation should be skipped, true otherwise.
+ */
+async function validateStatus(
+  argument,
+  matchedConditionPath,
+  templateConfig
+) {
+  const validation = templateConfig.conditionalGeneration?.[matchedConditionPath]?.validate || templateConfig.conditionalFiles?.[matchedConditionPath]?.validate;
+  if (!validation) {
+    return false; 
+  }
+ 
+  const isValid = validation(argument);
+
+  if (!isValid) {
+    if (templateConfig.conditionalGeneration?.[matchedConditionPath]) {
+      log.debug(logMessage.conditionalGenerationMatched(matchedConditionPath));
+    } else {
+      // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+      // TODO: https://github.com/asyncapi/generator/issues/1553
+      log.debug(logMessage.conditionalFilesMatched(matchedConditionPath));
+    }
+ 
+    return false;
+  }
+  return true;
+}
+
+module.exports = {
+  isGenerationConditionMet
+};

package/lib/filtersRegistry.js

@@ -6,6 +6,7 @@ const nunjucksFilters = require('@asyncapi/nunjucks-filters');
 
 /**
  * Registers all template filters.
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @param {Object} nunjucks Nunjucks environment.
  * @param {Object} templateConfig Template configuration.
  * @param {String} templateDir Directory where template is located.
@@ -15,12 +16,13 @@ module.exports.registerFilters = async (nunjucks, templateConfig, templateDir, f
   await registerLocalFilters(nunjucks, templateDir, filtersDir);
   registerConfigFilters(nunjucks, templateDir, templateConfig);
 
-  // Register Nunjucks filters from the 'nunjucks-filters' module without needing to list them explicitly in package.json
+  // Register Nunjucks filters from the 'nunjucks-filters' module without needing to list them in package.json or .ageneratorrc file.
   addFilters(nunjucks, nunjucksFilters);
 };
 
 /**
  * Registers the local template filters.
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @private
  * @param {Object} nunjucks Nunjucks environment.
  * @param {String} templateDir Directory where template is located.
@@ -68,6 +70,7 @@ function registerLocalFilters(nunjucks, templateDir, filtersDir) {
 
 /**
  * Registers the additionally configured filters.
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @private
  * @param {Object} nunjucks Nunjucks environment.
  * @param {String} templateDir Directory where template is located.
@@ -112,6 +115,7 @@ async function registerConfigFilters(nunjucks, templateDir, templateConfig) {
 
 /**
  * Add filter functions to Nunjucks environment. Only owned functions from the module are added.
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @private
  * @param {Object} nunjucks Nunjucks environment.
  * @param {Object} filters Module with functions.

package/lib/generator.js

@@ -2,7 +2,6 @@ const path = require('path');
 const fs = require('fs');
 const xfs = require('fs.extra');
 const minimatch = require('minimatch');
-const jmespath = require('jmespath');
 const filenamify = require('filenamify');
 const git = require('simple-git');
 const log = require('loglevel');
@@ -10,12 +9,12 @@ const Arborist = require('@npmcli/arborist');
 const Config = require('@npmcli/config');
 const requireg = require('requireg');
 const npmPath = requireg.resolve('npm').replace('index.js','');
-
 const { isAsyncAPIDocument } = require('@asyncapi/parser/cjs/document');
 
 const { configureReact, renderReact, saveRenderedReactContent } = require('./renderer/react');
 const { configureNunjucks, renderNunjucks } = require('./renderer/nunjucks');
 const { validateTemplateConfig } = require('./templateConfigValidator');
+const { isGenerationConditionMet } = require('./conditionalGeneration');
 const {
   convertMapToObject,
   isFileSystemPath,
@@ -135,7 +134,7 @@ class Generator {
         enumerable: true,
         get() {
           if (!self.templateConfig.parameters?.[key]) {
-            throw new Error(`Template parameter "${key}" has not been defined in the package.json file under generator property. Please make sure it's listed there before you use it in your template.`);
+            throw new Error(`Template parameter "${key}" has not been defined in the Generator Configuration. Please make sure it's listed there before you use it in your template.`);
           }
           return templateParams[key];
         }
@@ -436,7 +435,7 @@ class Generator {
    * @param  {String} asyncapiString AsyncAPI string to use as source.
    * @param  {Object} [parseOptions={}] AsyncAPI Parser parse options. Check out {@link https://www.github.com/asyncapi/parser-js|@asyncapi/parser} for more information.
    * @deprecated Use the `generate` function instead. Just change the function name and it works out of the box.
-   * @return {Promise}
+   * @return {Promise<TemplateRenderResult|undefined>}
    */
   async generateFromString(asyncapiString, parseOptions = {}) {
     const isParsableCompatible = asyncapiString && typeof asyncapiString === 'string';
@@ -466,7 +465,7 @@ class Generator {
    * }
    *
    * @param  {String} asyncapiURL Link to AsyncAPI file
-   * @return {Promise}
+   * @return {Promise<TemplateRenderResult|undefined>}
    */
   async generateFromURL(asyncapiURL) {
     const doc = await fetchSpec(asyncapiURL);
@@ -493,7 +492,7 @@ class Generator {
    * }
    *
    * @param  {String} asyncapiFile AsyncAPI file to use as source.
-   * @return {Promise}
+   * @return {Promise<TemplateRenderResult|undefined>}
    */
   async generateFromFile(asyncapiFile) {
     const doc = await readFile(asyncapiFile, { encoding: 'utf8' });
@@ -620,7 +619,7 @@ class Generator {
         path: packagePath,
       };
     } catch (err) {
-      throw new Error('Installation failed', err);
+      throw new Error(`Installation failed: ${ err.message }`);
     }
   }
 
@@ -687,7 +686,7 @@ class Generator {
 
       walker.on('directory', async (root, stats, next) => {
         try {
-          this.ignoredDirHandler(root, stats, next);
+          await this.ignoredDirHandler(root, stats, next);
         } catch (e) {
           reject(e);
         }
@@ -711,10 +710,23 @@ class Generator {
    * @param  {String} stats Information about the file.
    * @param  {Function} next Callback function
    */
-  ignoredDirHandler(root, stats, next) {
+  async ignoredDirHandler(root, stats, next) {
     const relativeDir = path.relative(this.templateContentDir, path.resolve(root, stats.name));
     const dirPath = path.resolve(this.targetDir, relativeDir);
-    if (!shouldIgnoreDir(relativeDir)) {
+    const conditionalEntry = this.templateConfig?.conditionalGeneration?.[relativeDir];
+    let shouldGenerate =  true;
+    if (conditionalEntry) {
+      shouldGenerate = await isGenerationConditionMet(
+        this.templateConfig,
+        relativeDir,
+        this.templateParams,
+        this.asyncapiDocument
+      );
+      if (!shouldGenerate) {
+        log.debug(logMessage.conditionalGenerationMatched(relativeDir));
+      }
+    }  
+    if (!shouldIgnoreDir(relativeDir) && shouldGenerate) {
       xfs.mkdirpSync(dirPath);
     }
     next();
@@ -854,7 +866,7 @@ class Generator {
       await writeFile(outputpath, renderContent);
     }
   }
-
+  
   /**
    * Generates a file.
    *
@@ -867,34 +879,61 @@ class Generator {
   async generateFile(asyncapiDocument, fileName, baseDir) {
     const sourceFile = path.resolve(baseDir, fileName);
     const relativeSourceFile = path.relative(this.templateContentDir, sourceFile);
+    const relativeSourceDirectory = relativeSourceFile.split(path.sep)[0] || '.';
+  
     const targetFile = path.resolve(this.targetDir, this.maybeRenameSourceFile(relativeSourceFile));
     const relativeTargetFile = path.relative(this.targetDir, targetFile);
-
+    let shouldGenerate = true;
+  
     if (shouldIgnoreFile(relativeSourceFile)) return;
+    
+    if (!(await this.shouldOverwriteFile(relativeTargetFile))) return;
+
+    // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+    // TODO: https://github.com/asyncapi/generator/issues/1553
+    let conditionalPath = '';
+    if (
+      this.templateConfig.conditionalFiles &&
+      this.templateConfig.conditionalGeneration
+    ) {
+      log.debug(
+        'Both \'conditionalFiles\' and \'conditionalGeneration\' are defined. Ignoring \'conditionalFiles\' and using \'conditionalGeneration\' only.'
+      );
+    }
 
-    const shouldOverwriteFile = await this.shouldOverwriteFile(relativeTargetFile);
-    if (!shouldOverwriteFile) return;
-
-    if (this.templateConfig.conditionalFiles?.[relativeSourceFile]) {
-      const server = this.templateParams.server && asyncapiDocument.servers().get(this.templateParams.server);
-      const source = jmespath.search({
-        ...asyncapiDocument.json(),
-        ...{
-          server: server ? server.json() : undefined,
-        },
-      }, this.templateConfig.conditionalFiles[relativeSourceFile].subject);
-
-      if (!source) return log.debug(logMessage.relativeSourceFileNotGenerated(relativeSourceFile, this.templateConfig.conditionalFiles[relativeSourceFile].subject));
-
-      if (source) {
-        const validate = this.templateConfig.conditionalFiles[relativeSourceFile].validate;
-        const valid = validate(source);
-        if (!valid) return log.debug(logMessage.conditionalFilesMatched(relativeSourceFile));
+    if (this.templateConfig.conditionalGeneration?.[relativeSourceDirectory]) {
+      conditionalPath = relativeSourceDirectory;
+    } else if (this.templateConfig.conditionalGeneration?.[relativeSourceFile]) {
+      conditionalPath = relativeSourceFile;
+    } else
+    if (this.templateConfig.conditionalFiles?.[relativeSourceFile]) {  
+      // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+      // TODO: https://github.com/asyncapi/generator/issues/1553
+      conditionalPath = relativeSourceDirectory;
+    }
+   
+    if (conditionalPath) {
+      shouldGenerate = await isGenerationConditionMet(
+        this.templateConfig,
+        conditionalPath,
+        this.templateParams,
+        asyncapiDocument
+      );
+    }
+    
+    if (!shouldGenerate) {
+      if (this.templateConfig.conditionalFiles?.[relativeSourceFile]) {
+        // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+        // TODO: https://github.com/asyncapi/generator/issues/1553
+        return log.debug(logMessage.conditionalFilesMatched(relativeSourceFile));
       }
+      
+      return log.debug(logMessage.conditionalGenerationMatched(conditionalPath));
     }
-
+    
     if (this.isNonRenderableFile(relativeSourceFile)) return await copyFile(sourceFile, targetFile);
     await this.renderAndWriteToFile(asyncapiDocument, sourceFile, targetFile);
+    log.debug(`Successfully rendered template and wrote file ${relativeSourceFile} to location: ${targetFile}`);
   }
 
   /**
@@ -942,10 +981,9 @@ class Generator {
    */
   isNonRenderableFile(fileName) {
     const nonRenderableFiles = this.templateConfig.nonRenderableFiles || [];
-    if (!Array.isArray(nonRenderableFiles)) return false;
-    if (nonRenderableFiles.some(globExp => minimatch(fileName, globExp))) return true;
-    if (isReactTemplate(this.templateConfig) && !isJsFile(fileName)) return true;
-    return false;
+    return Array.isArray(nonRenderableFiles) &&
+    (nonRenderableFiles.some(globExp => minimatch(fileName, globExp)) ||
+    (isReactTemplate(this.templateConfig) && !isJsFile(fileName)));
   }
 
   /**
@@ -968,19 +1006,34 @@ class Generator {
    * @private
    */
   async loadTemplateConfig() {
+    this.templateConfig = {};
+    
+    // Try to load config from .ageneratorrc
+    try {
+      const rcConfigPath = path.resolve(this.templateDir, '.ageneratorrc');
+      const yaml = await readFile(rcConfigPath, { encoding: 'utf8' });
+      const yamlConfig = require('js-yaml').load(yaml);
+      this.templateConfig = yamlConfig || {};
+      
+      await this.loadDefaultValues();
+      return;
+    } catch (rcError) {
+      // console.error('Could not load .ageneratorrc file:', rcError);
+      log.debug('Could not load .ageneratorrc file:', rcError);
+      // Continue to try package.json if .ageneratorrc fails
+    }
+    
+    // Try to load config from package.json
     try {
       const configPath = path.resolve(this.templateDir, CONFIG_FILENAME);
-      if (!fs.existsSync(configPath)) {
-        this.templateConfig = {};
-        return;
-      }
-
       const json = await readFile(configPath, { encoding: 'utf8' });
       const generatorProp = JSON.parse(json).generator;
       this.templateConfig = generatorProp || {};
-    } catch (e) {
-      this.templateConfig = {};
+    } catch (packageError) {
+      // console.error('Could not load generator config from package.json:', packageError);
+      log.debug('Could not load generator config from package.json:', packageError);
     }
+    
     await this.loadDefaultValues();
   }
 
@@ -1085,4 +1138,4 @@ class Generator {
 Generator.DEFAULT_TEMPLATES_DIR = DEFAULT_TEMPLATES_DIR;
 Generator.TRANSPILED_TEMPLATE_LOCATION = TRANSPILED_TEMPLATE_LOCATION;
 
-module.exports = Generator;
+module.exports = Generator;

package/lib/hooksRegistry.js

@@ -9,7 +9,7 @@ const { exists, registerTypeScript } = require('./utils');
  * @param {String} templateDir Directory where template is located.
  * @param {String} hooksDir Directory where local hooks are located.
  */
-module.exports.registerHooks = async (hooks, templateConfig, templateDir, hooksDir) => {
+async function registerHooks (hooks, templateConfig, templateDir, hooksDir) {
   await registerLocalHooks(hooks, templateDir, hooksDir);
 
   if (templateConfig && Object.keys(templateConfig).length > 0) await registerConfigHooks(hooks, templateDir, templateConfig);
@@ -122,3 +122,10 @@ function addHook(hooks, mod, config) {
   });
   return hooks;
 }
+
+module.exports = {
+  registerHooks,
+  registerLocalHooks,
+  registerConfigHooks,
+  addHook
+};

package/lib/logMessages.js

@@ -22,7 +22,6 @@ function packageNotAvailable(packageDetails) {
   if (packageDetails?.pkgPath) {
     return `Unable to resolve template location at ${packageDetails.pkgPath}. Package is not available locally.`;
   }
-
   return `Template is not available locally and expected location is undefined. Known details are: ${JSON.stringify(packageDetails, null, 2)}`;
 }
 
@@ -42,6 +41,11 @@ function skipOverwrite(testFilePath) {
   return `Skipping overwrite for: ${testFilePath}`;
 }
 
+function conditionalGenerationMatched(conditionalPath) {
+  return `${conditionalPath} was not generated because condition specified for this location in template configuration in conditionalGeneration matched.`;
+}
+// conditionalFiles becomes deprecated with this PR, and soon will be removed.
+// TODO: https://github.com/asyncapi/generator/issues/1553
 function conditionalFilesMatched(relativeSourceFile) {
   return `${relativeSourceFile} was not generated because condition specified for this file in template configuration in conditionalFiles matched.`;
 }
@@ -62,6 +66,7 @@ module.exports = {
   installationDebugMessage,
   templateSuccessfullyInstalled,
   relativeSourceFileNotGenerated,
+  conditionalGenerationMatched,
   conditionalFilesMatched,
   compileEnabled,
   skipOverwrite

package/lib/parser.js

@@ -50,6 +50,14 @@ parser.getProperApiDocument = (asyncapiDocument, templateConfig = {}) => {
   return ConvertDocumentParserAPIVersion(asyncapiDocument, apiVersion);
 };
 
+/**
+ * Converts old parser options to the new format.
+ * 
+ * @private - This function should not be used outside this module.
+ * @param {object} oldOptions - The old options to convert.
+ * @param {object} generator - The generator instance.
+ * @returns {object} The converted options.
+ */
 // The new options for the v2 Parser are different from those for the v1 version, but in order not to release Generator v2, we are converting the old options of Parser to the new ones.
 function convertOldOptionsToNew(oldOptions, generator) {
   if (!oldOptions) return;
@@ -143,3 +151,5 @@ function canReadFn(uri, canRead) {
   }
   return false;
 }
+
+module.exports.convertOldOptionsToNew = convertOldOptionsToNew;

package/lib/renderer/nunjucks.js

@@ -3,7 +3,7 @@ const nunjucksExport = module.exports;
 
 /**
  * Configures Nunjucks templating system
- * 
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @private
  * @param {boolean} debug flag
  * @param {string} templateDir path
@@ -17,7 +17,7 @@ nunjucksExport.configureNunjucks = (debug, templateDir) => {
 
 /**
  * Renders the template with nunjucks and returns a string.
- * 
+ * @deprecated This method is deprecated. For more details, see the release notes: https://github.com/asyncapi/generator/releases/tag/%40asyncapi%2Fgenerator%402.6.0
  * @param {import('@asyncapi/parser').AsyncAPIDocument} asyncapiDocument 
  * @param {string} templateString template filecontent to be rendered with nunjucks
  * @param {string} filePath path to the template file

package/lib/templateConfigValidator.js

@@ -24,9 +24,14 @@ const supportedParserAPIMajorVersions = [
  * @return {Boolean}
  */
 module.exports.validateTemplateConfig = (templateConfig, templateParams, asyncapiDocument) => {
-  const { parameters, supportedProtocols, conditionalFiles, generator, apiVersion } = templateConfig;
+  // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+  // TODO: https://github.com/asyncapi/generator/issues/1553
+  const { parameters, supportedProtocols, conditionalFiles, conditionalGeneration, generator, apiVersion } = templateConfig;
 
+  // conditionalFiles becomes deprecated with this PR, and soon will be removed.
+  // TODO: https://github.com/asyncapi/generator/issues/1553
   validateConditionalFiles(conditionalFiles);
+  validateConditionalGeneration(conditionalGeneration);
   isTemplateCompatible(generator, apiVersion);
   isRequiredParamProvided(parameters, templateParams);
   isProvidedTemplateRendererSupported(templateConfig);
@@ -148,6 +153,8 @@ function isServerProvidedInDocument(server, paramsServerName) {
   if (typeof paramsServerName === 'string' && !server) throw new Error(`Couldn't find server with name ${paramsServerName}.`);
 }
 
+// conditionalFiles becomes deprecated with this PR, and soon will be removed.
+// TODO: https://github.com/asyncapi/generator/issues/1553
 /**
  * Checks if conditional files are specified properly in the template
  * @private
@@ -165,3 +172,25 @@ function validateConditionalFiles(conditionalFiles) {
     });
   }
 }
+
+/**
+ * Validates conditionalGeneration settings in the template config.
+ * @private
+ * @param {Object} conditionalGeneration - The conditions specified in the template config.
+ */
+function validateConditionalGeneration(conditionalGeneration) {
+  if (!conditionalGeneration || typeof conditionalGeneration !== 'object') return;
+  
+  for (const [fileName, def] of Object.entries(conditionalGeneration)) {
+    const { subject, parameter, validation } = def;
+    if (subject && typeof subject !== 'string')
+      throw new Error(`Invalid 'subject' for ${fileName}: ${subject}`);
+    if (parameter && typeof parameter !== 'string')
+      throw new Error(`Invalid 'parameter' for ${fileName}: ${parameter}`);
+    if (subject && parameter)
+      throw new Error(`Both 'subject' and 'parameter' cannot be defined for ${fileName}`);
+    if (typeof validation !== 'object')
+      throw new Error(`Invalid 'validation' object for ${fileName}: ${validation}`);
+    def.validate = ajv.compile(validation);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -12,17 +12,15 @@
     "npm": ">=8.19.0"
   },
   "scripts": {
-    "test": "npm run test:unit && npm run test:integration && npm run test:cli",
+    "test": "npm run test:unit && npm run test:integration",
     "test:unit": "jest --coverage --testPathIgnorePatterns=integration --testPathIgnorePatterns=test-project",
     "test:dev": "npm run test:unit -- --watchAll",
     "test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
     "test:integration:update": "jest --updateSnapshot --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
-    "test:cli": "node cli.js ./test/docs/dummy.yml ./test/test-templates/react-template -o test/output --force-write --debug && test -e test/output/test-file.md",
     "test:cleanup": "rimraf \"test/temp\"",
     "docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/docs.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs --files lib/generator.js > docs/api.md",
     "docker:build": "docker build -t asyncapi/generator:latest .",
     "lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
-    "lint:tpl:validator": "eslint --fix --config ../../.eslintrc ../../.github/templates-list-validator",
     "generate:readme:toc": "markdown-toc -i README.md",
     "generate:assets": "npm run docs && npm run generate:readme:toc",
     "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION"
@@ -49,10 +47,10 @@
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/generator",
   "dependencies": {
+    "@asyncapi/generator-hooks": "*",
     "@asyncapi/generator-react-sdk": "^1.1.2",
     "@asyncapi/multi-parser": "^2.1.1",
     "@asyncapi/nunjucks-filters": "*",
-    "@asyncapi/generator-hooks": "*",
     "@asyncapi/parser": "^3.0.14",
     "@npmcli/arborist": "5.6.3",
     "@npmcli/config": "^8.0.2",
@@ -82,7 +80,7 @@
     "eslint-plugin-jest": "^23.8.2",
     "eslint-plugin-react": "^7.34.1",
     "eslint-plugin-sonarjs": "^0.5.0",
-    "fs-extra": "9.1.0",
+    "fs-extra": "11.2.0",
     "jest": "^27.3.1",
     "jsdoc-to-markdown": "^7.1.1",
     "markdown-toc": "^1.2.0",

package/test/generator.test.js

@@ -51,7 +51,7 @@ describe('Generator', () => {
       expect(gen.forceWrite).toStrictEqual(true);
       expect(gen.install).toStrictEqual(true);
       expect(gen.compile).toStrictEqual(false);
-      expect(() => gen.templateParams.test).toThrow('Template parameter "test" has not been defined in the package.json file under generator property. Please make sure it\'s listed there before you use it in your template.');
+      expect(() => gen.templateParams.test).toThrow('Template parameter "test" has not been defined in the Generator Configuration. Please make sure it\'s listed there before you use it in your template.');
 
       // Mock params on templateConfig so it doesn't fail.
       gen.templateConfig.parameters = { test: {} };