refactor: move out the loadTemplateConfig from generator.js

apps/generator/lib/__mocks__/templateConfigValidator.js

@@ -1,3 +1,3 @@
-const templateConfigValidator = jest.genMockFromModule('../templateConfigValidator');
+const templateConfigValidator = jest.genMockFromModule('../templateConfig/validator');
 
 module.exports = templateConfigValidator;

apps/generator/lib/generator.js

@@ -13,7 +13,8 @@ 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 { validateTemplateConfig } = require('./templateConfig/validator');
+const { loadTemplateConfig } = require('./templateConfig/loader');
 const { isGenerationConditionMet } = require('./conditionalGeneration');
 const {
   convertMapToObject,
@@ -36,7 +37,6 @@ const { definitions, flatten, shorthands } = require('@npmcli/config/lib/definit
 
 const FILTERS_DIRNAME = 'filters';
 const HOOKS_DIRNAME = 'hooks';
-const CONFIG_FILENAME = 'package.json';
 const PACKAGE_JSON_FILENAME = 'package.json';
 const GIT_IGNORE_FILENAME = '{.gitignore}';
 const NPM_IGNORE_FILENAME = '{.npmignore}';
@@ -1005,55 +1005,8 @@ class Generator {
    * Loads the template configuration.
    * @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);
-      const json = await readFile(configPath, { encoding: 'utf8' });
-      const generatorProp = JSON.parse(json).generator;
-      this.templateConfig = generatorProp || {};
-    } 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();
-  }
-
-  /**
-   * Loads default values of parameters from template config. If value was already set as parameter it will not be
-   * overriden.
-   * @private
-   */
-  async loadDefaultValues() {
-    const parameters = this.templateConfig.parameters;
-    const defaultValues = Object.keys(parameters || {}).filter(key => parameters[key].default);
-
-    defaultValues.filter(dv => this.templateParams[dv] === undefined).forEach(dv =>
-      Object.defineProperty(this.templateParams, dv, {
-        enumerable: true,
-        get() {
-          return parameters[dv].default;
-        }
-      })
-    );
+  loadTemplateConfig() {
+    return loadTemplateConfig.call(this);
   }
 
   /**

apps/generator/lib/templateConfig/loader.js

@@ -0,0 +1,63 @@
+const path = require('path');
+const log = require('loglevel');
+const { readFile } = require('../utils');
+
+const CONFIG_FILENAME = 'package.json';
+
+/**
+ * Loads the template configuration.
+ * @private
+ */
+async function 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').safeLoad(yaml);
+    this.templateConfig = yamlConfig || {};
+
+    await loadDefaultValues.call(this);
+    return;
+  } catch (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);
+    const json = await readFile(configPath, { encoding: 'utf8' });
+    const generatorProp = JSON.parse(json).generator;
+    this.templateConfig = generatorProp || {};
+  } catch (packageError) {
+    log.debug('Could not load generator config from package.json:', packageError);
+  }
+
+  await loadDefaultValues.call(this);
+}
+
+/**
+ * Loads default values of parameters from template config. If value was already set as parameter it will not be
+ * overriden.
+ * @private
+ */
+async function loadDefaultValues() {
+  const parameters = this.templateConfig.parameters;
+  const defaultValues = Object.keys(parameters || {}).filter(key => parameters[key].default);
+
+  defaultValues.filter(dv => this.templateParams[dv] === undefined).forEach(dv =>
+    Object.defineProperty(this.templateParams, dv, {
+      enumerable: true,
+      get() {
+        return parameters[dv].default;
+      }
+    })
+  );
+}
+
+module.exports = {
+  loadTemplateConfig,
+  loadDefaultValues
+};

apps/generator/lib/templateConfigValidator.js → apps/generator/lib/templateConfig/validator.js

@@ -1,10 +1,10 @@
 const semver = require('semver');
 const Ajv = require('ajv');
-const { getGeneratorVersion } = require('./utils');
+const { getGeneratorVersion } = require('../utils');
 const levenshtein = require('levenshtein-edit-distance');
 // eslint-disable-next-line no-unused-vars
 const {AsyncAPIDocumentInterface, AsyncAPIDocument} = require('@asyncapi/parser');
-const { usesNewAPI } = require('./parser');
+const { usesNewAPI } = require('../parser');
 
 const ajv = new Ajv({ allErrors: true });
 

apps/generator/test/generator.test.js

@@ -5,13 +5,14 @@ const Generator = require('../lib/generator');
 const log = require('loglevel');
 const unixify = require('unixify');
 const dummyYAML = fs.readFileSync(path.resolve(__dirname, './docs/dummy.yml'), 'utf8');
+const { loadDefaultValues } = require('../lib/templateConfig/loader');
 
 const logMessage = require('./../lib/logMessages.js');
 
 jest.mock('../lib/utils');
 jest.mock('../lib/filtersRegistry');
 jest.mock('../lib/hooksRegistry');
-jest.mock('../lib/templateConfigValidator');
+jest.mock('../lib/templateConfig/validator');
 
 describe('Generator', () => {
   describe('constructor', () => {
@@ -131,7 +132,7 @@ describe('Generator', () => {
       util = require('../lib/utils');
       filtersRegistry = require('../lib/filtersRegistry');
       hooksRegistry = require('../lib/hooksRegistry');
-      templateConfigValidator = require('../lib/templateConfigValidator');
+      templateConfigValidator = require('../lib/templateConfig/validator.js');
       xfsMock = require('fs.extra');
       const { AsyncAPIDocument } = require('@asyncapi/parser/cjs/models/v2/asyncapi');
       asyncApiDocumentMock = new AsyncAPIDocument({ 'x-parser-api-version': 0 });
@@ -500,7 +501,7 @@ describe('Generator', () => {
         }
       };
 
-      await gen.loadDefaultValues();
+      await loadDefaultValues.call(gen);
 
       expect(gen.templateParams).toStrictEqual({
         test: true,
@@ -524,7 +525,7 @@ describe('Generator', () => {
         }
       };
 
-      await gen.loadDefaultValues();
+      await loadDefaultValues.call(gen);
 
       expect(gen.templateParams).toStrictEqual({
         test: true
@@ -550,7 +551,7 @@ describe('Generator', () => {
         }
       };
 
-      await gen.loadDefaultValues();
+      await loadDefaultValues.call(gen);
 
       expect(gen.templateParams).toStrictEqual({
         test: true

apps/generator/test/templateConfigValidator.test.js

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-identical-functions */
 /* eslint-disable sonarjs/no-duplicate-string */
-const { validateTemplateConfig } = require('../lib/templateConfigValidator');
+const { validateTemplateConfig } = require('../lib/templateConfig/validator');
 const fs = require('fs');
 const path = require('path');
 const { parse } = require('../lib/parser');