Saas 1122 new autocomplete (#251)

* basic completion

* completion generation on build phase

* dynamic completion base

* completion command + option/positional completion + completion fixes + user input handling + tests

* fix crudFilenameOption

* options handling improved

* remove yarn install + remove tree

* ignore tree.json

* virtual mock on tree.json

* throw on not existing command path registration

* common error handling

* "first time pressing tab twice" hack

* completions generation/resolution redone + tests added

* remove user input eraser

* completion command params renamed

* version updated

Author: yaroslav-codefresh

.gitignore

@@ -10,3 +10,4 @@ coverage
 public
 temp
 package-lock.json
+**/completion/tree.json

Dockerfile

@@ -10,6 +10,8 @@ RUN yarn --prod install
 
 COPY . /cf-cli
 
+RUN yarn generate-completion
+
 RUN ln -s $(pwd)/lib/interface/cli/codefresh /usr/local/bin/codefresh
 
 ENTRYPOINT ["codefresh"]

codefresh-release.yml

@@ -38,6 +38,13 @@ steps:
     tag: latest
     registry: dockerhub
 
+  generate_comletion:
+    title: "Generating commands completion tree"
+    image: codefresh/cli-build
+    commands:
+      - "yarn install"
+      - "yarn generate-completion"
+
   deploy_to_npm:
     title: "Publishing To Npm"
     image: codefresh/npm-publish:master
@@ -49,7 +56,6 @@ steps:
     image: codefresh/cli-build
     commands:
       - "rm -rf dist"
-      - "yarn install"
       - "yarn pkg"
 
   create_release:

docs/index.js

@@ -14,8 +14,9 @@ const FILES_TO_IGNORE = ['index.js'];
 const baseDir = path.resolve(TEMP_DIR, './content');
 const ALLOW_BETA_COMMANDS = process.env.ALLOW_BETA_COMMANDS;
 const categoriesOrder = {
-    authentication: 30,
-    'operate on resources' : 31,
+    completion: 30,
+    authentication: 31,
+    'operate on resources' : 32,
     pipelines : 40,
     'pipelines v2 (beta)' : 42,
     builds: 50,

lib/interface/cli/codefresh

@@ -1,70 +1,74 @@
 #!/usr/bin/env node
 
-const path = require('path');
-const _ = require('lodash');
-const yargs = require('yargs');
-const recursive = require('recursive-readdir');
-const CFError = require('cf-errors');
-const DEFAULTS = require('./defaults');
-const authManager = require('../../logic').auth.manager;
 const { printError } = require('./helpers/general');
 
-process.on('uncaughtException', function (err) {
+process.on('uncaughtException', (err) => {
     printError(err);
     process.exit(1);
 });
 
-process.on('unhandledRejection', error => {
-    printError(error);
+process.on('unhandledRejection', (err) => {
+    printError(err);
     process.exit(1);
 });
 
+if (process.argv.includes('--get-yargs-completions')) {
+    const initCompletion = require('./completion');
+    initCompletion().argv;
+} else {
+    const _ = require('lodash');
+    const yargs = require('yargs');
+    const path = require('path');
+    const recursive = require('recursive-readdir');
+    const DEFAULTS = require('./defaults');
+    const authManager = require('../../logic').auth.manager;
 
-recursive(path.resolve(__dirname, 'commands'), (err, files) => {
-    const rootCommands = [];
-    yargs
-        .env('')
-        .options('cfconfig', {
-            default: DEFAULTS.CFCONFIG,
-            global: false,
-        })
-        .config('cfconfig', 'Custom path for authentication contexts config file', (configFilePath) => {
-            try {
-                authManager.loadContexts(process.env.CF_API_KEY, process.env.CF_URL || DEFAULTS.URL , configFilePath);
-                _.forEach(files, (file) => {
-                    if (file.endsWith('.cmd.js')) {
-                        const command = require(file);
-                        if (command.isRoot()) {
-                            if (command.isBetaCommand()) {
-                                const currentContext = authManager.getCurrentContext();
-                                if (currentContext && currentContext.isBetaFeatEnabled()) {
+    recursive(path.resolve(__dirname, 'commands'), (err, files) => {
+        const rootCommands = [];
+        yargs
+            .env('')
+            .options('cfconfig', {
+                default: DEFAULTS.CFCONFIG,
+                global: false,
+            })
+            .config('cfconfig', 'Custom path for authentication contexts config file', (configFilePath) => {
+                try {
+                    authManager.loadContexts(process.env.CF_API_KEY, process.env.CF_URL || DEFAULTS.URL, configFilePath);
+                    _.forEach(files, (file) => {
+                        if (file.endsWith('.cmd.js')) {
+                            const command = require(file);
+                            if (command.isRoot()) {
+                                if (command.isBetaCommand()) {
+                                    const currentContext = authManager.getCurrentContext();
+                                    if (currentContext && currentContext.isBetaFeatEnabled()) {
+                                        rootCommands.push(command);
+                                    }
+                                } else {
                                     rootCommands.push(command);
                                 }
-                            } else {
-                                rootCommands.push(command);
                             }
                         }
-                    }
-                });
-                _.forEach(rootCommands, (command) => {
-                    yargs.command(command.toCommand());
-                });
-            } catch (err) {
-                printError(err);
-                process.exit(1);
-            }
-        });
+                    });
+                    _.forEach(rootCommands, (command) => {
+                        yargs.command(command.toCommand());
+                    });
+                } catch (err) {
+                    printError(err);
+                    process.exit(1);
+                }
+            });
 
 
-    yargs // eslint-disable-line
-        .completion()
-        .demandCommand(1, 'You need at least one command before moving on')
-        .wrap(null)
-        .version(false)
-        .help('help')
-        .epilogue('For more information, find our official documentation at http://cli.codefresh.io')
-        // .option('help', {
-        //     global: false,
-        // })
-        .argv;
-});
+        yargs // eslint-disable-line
+            .demandCommand(1, 'You need at least one command before moving on')
+            .wrap(null)
+            .version(false)
+            .help('help')
+            .epilogue('For more information, find our official documentation at http://cli.codefresh.io')
+            // .option('help', {
+            //     global: false,
+            // })
+            .argv;
+    });
+}
+

lib/interface/cli/commands/completion/completion.cmd.js

@@ -0,0 +1,55 @@
+const yargs = require('yargs');
+const Command = require('../../Command');
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * yargs script generation file redone
+ * */
+function _generateCompletionScript(appPath, appName, completionCommand) {
+    let script = fs.readFileSync(
+        path.resolve(__dirname, 'completion.sh.hbs'),
+        'utf-8',
+    );
+    const name = appName || path.basename(appPath);
+
+    script = script.replace(/{{app_name}}/g, name);
+    script = script.replace(/{{completion_command}}/g, completionCommand);
+    return script.replace(/{{app_path}}/g, appPath);
+}
+
+const command = new Command({
+    root: true,
+    command: 'completion',
+    description: 'Generate codefresh completion',
+    usage: 'Prints completion script with specified or default path to executable and command alias',
+    webDocs: {
+        category: 'Completion',
+        title: 'Codefresh Completion',
+        description: 'Generate codefresh completion. See details on [usage](codefresh-completion)',
+        weight: 30,
+    },
+    builder: (yargs) => {
+        return yargs
+            .option('executable', {
+                alias: 'e',
+                description: 'Name or path to your codefresh executable (default same as alias)',
+            })
+            .option('alias', {
+                alias: 'a',
+                description: 'Alias used for calling codefresh executable',
+                default: 'codefresh',
+            })
+            .example('codefresh completion', 'Print completion script')
+            .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');
+    },
+    handler: async (argv) => {
+        const { executable, alias: appName } = argv;
+        const appPath = executable || appName;
+        const script = _generateCompletionScript(appPath, appName, 'completion');
+        console.log(script);
+    },
+});
+
+module.exports = command;

lib/interface/cli/commands/completion/completion.sh.hbs

@@ -0,0 +1,23 @@
+###-begin-{{app_name}}-completions-###
+#
+# codefresh command completion script
+#
+# Installation: {{app_path}} {{completion_command}} >> ~/.bashrc
+#    or {{app_path}} {{completion_command}} >> ~/.bash_profile on OSX.
+#
+_codefresh_completions()
+{
+    local cur_word args type_list
+
+    cur_word="${COMP_WORDS[COMP_CWORD]}"
+    args=("${COMP_WORDS[@]}")
+
+    # ask codefresh to generate completions.
+    type_list=$({{app_path}} --get-yargs-completions "${args[@]}")
+
+    COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )
+
+    return 0
+}
+complete -F _codefresh_completions {{app_name}}
+###-end-{{app_name}}-completions-###

lib/interface/cli/commands/pipeline/get.completion.js

@@ -0,0 +1,12 @@
+const pipeline = () => require('../../../../logic').api.pipeline;
+const { authContextWrapper } = require('../../completion/helpers');
+
+const positionalHandler = async ({word, argv}) => {
+    const pips = await pipeline().getAll({ limit: 25, offset: 0 });
+    return pips.map(p => p.name);
+};
+
+module.exports = {
+    positionalHandler: authContextWrapper(positionalHandler),
+};
+

lib/interface/cli/commands/root/get.completion.js

@@ -0,0 +1,10 @@
+const { handleOptions } = require('../../completion/helpers');
+
+function optionHandler({ word, argv, option }) {
+    return ['json', 'yaml', 'wide', 'name', 'id'];
+}
+
+module.exports = {
+    optionHandler: handleOptions(['-o', '--output'], optionHandler),
+};
+