add alias option (#152)

Author: ziv-codefresh

docs/index.js

@@ -132,7 +132,7 @@ const createCommandFile = async (nestedCategory,docs) => {
     // ARGUMENTS string
     docs.command.shift();
     if (docs.positionals.length) {
-        const argumentsString = `### Arguments\n\nOption | Default | Description\n--------- | ----------- | -----------\n${docs.positionals}`;
+        const argumentsString = `### Arguments\n\nOption | Alias | Default | Description\n--------- | --------- | ----------- | -----------\n${docs.positionals}`;
         if (skeletonFileExists) {
             finalFileString = finalFileString.replace('{{ARGUMENTS}}', argumentsString);
         } else {
@@ -144,7 +144,7 @@ const createCommandFile = async (nestedCategory,docs) => {
     if (docs.options) {
         let optionsString = '';
         _.forEach(docs.options, (options, group) => {
-            optionsString = `### ${group}\n\nOption | Default | Description\n--------- | ----------- | -----------\n${options}` + optionsString;
+            optionsString = `### ${group}\n\nOption | Alias | Default | Description\n--------- | --------- | ----------- | -----------\n${options}` + optionsString;
         });
         if (skeletonFileExists) {
             finalFileString = finalFileString.replace('{{OPTIONS}}', optionsString);

lib/interface/cli/Command.js

@@ -228,8 +228,16 @@ class Command {
                 });
                 description += choicesString;
             }
+            let aliases = '';
+            if (option.value.alias) {
+                let aliasString = '';
+                _.forEach(option.value.alias, (alias) => {
+                    aliasString += `- ${alias}`;
+                });
+                aliases += aliasString;
+            }
             const defaultValue = option.value.default || '';
-            res.options[group] += `--${key} | ${defaultValue} | ${description}\n`;
+            res.options[group] += `--${key} | ${aliases} | ${defaultValue} | ${description}\n`;
         });
 
         res.examples = '';