Saas 1123 1336 zsh and file-dir completion (#268)

yaroslav-codefresh · web-flow · commit 74bd6b0e379f · 2019-01-10T17:53:25.000+02:00
* saas-1336 zsh completion + files completion

* tests added + small fixes

* fix scripts

* update version
diff --git a/lib/interface/cli/commands/completion/bash.sh.hbs b/lib/interface/cli/commands/completion/bash.sh.hbs
@@ -7,15 +7,19 @@
 #
 _codefresh_completions()
 {
-    local cur_word args type_list
+    local cur args type_list
 
-    cur_word="${COMP_WORDS[COMP_CWORD]}"
+    cur="${COMP_WORDS[COMP_CWORD]}"
     args=("${COMP_WORDS[@]}")
 
     # ask codefresh to generate completions.
-    type_list=$({{app_path}} --get-yargs-completions "${args[@]}")
+    type_list=$(codefresh --get-yargs-completions "${args[@]}")
 
-    COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )
+    if [[ ${type_list} == '__files_completion__' ]]; then
+        _filedir "@(yaml|yml|json)"
+    else
+        COMPREPLY=( $(compgen -W "${type_list}" -- ${cur}) )
+    fi
 
     return 0
 }
diff --git a/lib/interface/cli/commands/completion/completion.cmd.js b/lib/interface/cli/commands/completion/completion.cmd.js
@@ -6,9 +6,9 @@ const fs = require('fs');
 /**
  * yargs script generation file redone
  * */
-function _generateCompletionScript(appPath, appName, completionCommand) {
+function _generateCompletionScript(appPath, appName, completionCommand, shell) {
     let script = fs.readFileSync(
-        path.resolve(__dirname, 'completion.sh.hbs'),
+        path.resolve(__dirname, `${shell}.sh.hbs`),
         'utf-8',
     );
     const name = appName || path.basename(appPath);
@@ -20,7 +20,8 @@ function _generateCompletionScript(appPath, appName, completionCommand) {
 
 const command = new Command({
     root: true,
-    command: 'completion',
+    command: 'completion [shell-name]',
+    aliases: ['completions'],
     description: 'Generate codefresh completion',
     usage: 'Prints completion script with specified or default path to executable and command alias',
     webDocs: {
@@ -31,6 +32,11 @@ const command = new Command({
     },
     builder: (yargs) => {
         return yargs
+            .positional('shellName', {
+                description: 'Name of the shell to generate completion for',
+                choices: ['bash', 'zsh'],
+                default: 'bash',
+            })
             .option('executable', {
                 alias: 'e',
                 description: 'Name or path to your codefresh executable (default same as alias)',
@@ -40,14 +46,18 @@ const command = new Command({
                 description: 'Alias used for calling codefresh executable',
                 default: 'codefresh',
             })
-            .example('codefresh completion', 'Print completion script')
+            .example('codefresh completion', 'Print bash completion script')
+            .example('codefresh completion zsh', 'Print zsh completion script')
+            .example('codefresh completion zsh >> ~/.zshrc', 'Install zsh completion script')
+            .example('codefresh completion bash >> ~/.bashrc', 'Install bash completion script')
+            .example('codefresh completion bash >> ~/.bash_profile', 'Install bash completion script (on OSX)')
             .example('cf completion --alias cf', 'Print completion script for codefresh aliased as "cf"')
-            .example('/some/path/codefresh completion --e /some/path/codefresh', 'Print completion script with specified path to codefresh executable');
+            .example('/some/path/codefresh completion -e /some/path/codefresh', 'Print completion script with specified path to codefresh executable');
     },
     handler: async (argv) => {
-        const { executable, alias: appName } = argv;
+        const { executable, alias: appName, shellName } = argv;
         const appPath = executable || appName;
-        const script = _generateCompletionScript(appPath, appName, 'completion');
+        const script = _generateCompletionScript(appPath, appName, 'completion', shellName);
         console.log(script);
     },
 });
diff --git a/lib/interface/cli/commands/completion/zsh.sh.hbs b/lib/interface/cli/commands/completion/zsh.sh.hbs
@@ -0,0 +1,20 @@
+###-begin-{{app_name}}-completions-###
+#
+# codefresh command completion script
+#
+# Installation: {{app_name}} {{completion_command}} zsh >> ~/.zshrc
+#
+_codefresh_completions()
+{
+    type_list=($({{app_path}} --impl-zsh-file-dir --get-yargs-completions "${words[@]}"))
+
+    if [[ ${type_list[1]} == '__files_completion__' ]]; then
+        compadd -- "${type_list[@]:1}"
+    else
+        compadd -- "${type_list[@]}"
+    fi
+
+    return 0
+}
+compdef _codefresh_completions {{app_name}}
+###-end-{{app_name}}-completions-###
diff --git a/lib/interface/cli/commands/pipeline/run.completion.js b/lib/interface/cli/commands/pipeline/run.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['--variable-file', '--var-file', '--yaml', '-y'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/apply.completion.js b/lib/interface/cli/commands/root/apply.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/create.completion.js b/lib/interface/cli/commands/root/create.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/delete.completion.js b/lib/interface/cli/commands/root/delete.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/diff.completion.js b/lib/interface/cli/commands/root/diff.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/get.completion.js b/lib/interface/cli/commands/root/get.completion.js
@@ -1,10 +1,19 @@
-const { handleOptions } = require('../../completion/helpers');
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+const OUTPUT_OPTIONS = ['-o', '--output'];
 
 function optionHandler({ word, argv, option }) {
-    return ['json', 'yaml', 'wide', 'name', 'id'];
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    if (OUTPUT_OPTIONS.includes(option)) {
+        return ['json', 'yaml', 'wide', 'name', 'id'];
+    }
+    return [];
 }
 
 module.exports = {
-    optionHandler: handleOptions(['-o', '--output'], optionHandler),
+    optionHandler: handleOptions([...FILENAME_OPTIONS, ...OUTPUT_OPTIONS], optionHandler),
 };
 
diff --git a/lib/interface/cli/commands/root/replace.completion.js b/lib/interface/cli/commands/root/replace.completion.js
@@ -0,0 +1,15 @@
+const { handleOptions, fileDir } = require('../../completion/helpers');
+
+const FILENAME_OPTIONS = ['-f', '--filename'];
+
+function optionHandler({ word, argv, option }) {
+    if (FILENAME_OPTIONS.includes(option)) {
+        return fileDir(word);
+    }
+    return [];
+}
+
+module.exports = {
+    optionHandler: handleOptions([...FILENAME_OPTIONS], optionHandler),
+};
+
diff --git a/lib/interface/cli/commands/root/validate.completion.js b/lib/interface/cli/commands/root/validate.completion.js
@@ -0,0 +1,10 @@
+const { fileDir } = require('../../completion/helpers');
+
+function positionalHandler({ word, argv}) {
+    return fileDir(word);
+}
+
+module.exports = {
+    positionalHandler,
+};
+
diff --git a/lib/interface/cli/completion/completion.spec.js b/lib/interface/cli/completion/completion.spec.js
diff --git a/lib/interface/cli/completion/helpers.js b/lib/interface/cli/completion/helpers.js
diff --git a/lib/interface/cli/completion/index.js b/lib/interface/cli/completion/index.js
diff --git a/package.json b/package.json
