feat: suggest possible correct parameter name (#357)

lib/templateConfigValidator.js

@@ -1,6 +1,7 @@
 const semver = require('semver');
 const Ajv = require('ajv');
 const { getGeneratorVersion } = require('./utils');
+const levenshtein = require('levenshtein-edit-distance');
 
 const ajv = new Ajv({ allErrors: true });
 
@@ -57,6 +58,21 @@ function isRequiredParamProvided(configParams, templateParams) {
   }
 }
 
+/**
+ * Provides a hint for a user about correct parameter name.
+ * @private
+ * @param {Object} wrongParams Incorrectly written parameters
+ * @param {Object} configParams Parameters specified in template configuration
+ */
+function provideAdvice(wrongParams, configParams) {
+  if (configParams) {
+    wrongParams.forEach(wp => console.warn(`Did you mean "${Object.keys(configParams)
+      .map(param => [levenshtein(wp, param), param]).sort()[0][1]}"?`));
+  } else {
+    console.warn('This template doesn\'t have any params!');
+  }
+}
+
 /**
  * Checks if parameters provided to generator is supported by the template
  * @private
@@ -68,6 +84,7 @@ function isProvidedParameterSupported(configParams, templateParams) {
 
   if (wrongParams.length) {
     console.warn(`Warning: This template doesn't have the following params: ${wrongParams}.`);
+    provideAdvice(wrongParams, configParams);
   }
 }
 

package.json

@@ -59,7 +59,8 @@
     "npmi": "^4.0.0",
     "nunjucks": "^3.2.0",
     "semver": "^7.3.2",
-    "simple-git": "^1.131.0"
+    "simple-git": "^1.131.0",
+    "levenshtein-edit-distance": "^2.0.5"
   },
   "devDependencies": {
     "@semantic-release/commit-analyzer": "^8.0.1",

test/templateConfigValidator.test.js

@@ -62,6 +62,7 @@ describe('Template Configuration Validator', () => {
     };
     validateTemplateConfig(templateConfig, templateParams);
     expect(console.warn).toHaveBeenCalledWith('Warning: This template doesn\'t have the following params: test1.');
+    expect(console.warn).toHaveBeenCalledWith('Did you mean "test"?');
   });
 
   it('Validation throw error if provided param is not supported by the template as template has no params specified', () => {
@@ -73,6 +74,7 @@ describe('Template Configuration Validator', () => {
 
     validateTemplateConfig(templateConfig, templateParams);
     expect(console.warn).toHaveBeenCalledWith('Warning: This template doesn\'t have the following params: test1.');
+    expect(console.warn).toHaveBeenCalledWith('This template doesn\'t have any params!');
   });
 
   it('Validation throw error if specified server is not in asyncapi document', () => {