Add autocomplete for CLI (#497)

* Add autocomplete for CLI

* Docs update

* Improve autocomplete for category

* Skip ID for first autocomplete; fix 'init' cmd name

Author: ad-m

bin/agent/index.js

@@ -3,6 +3,7 @@ const text = require('lib/text');
 const genericDefaults = require('bin/generic/defaults');
 const genericResource = require('bin/generic');
 const genericAction = require('bin/generic/action');
+const complete = require('lib/complete');
 
 const schema = {
     name: {
@@ -17,6 +18,7 @@ const schema = {
         required: true,
         onCreate: true,
         destBody: 'service',
+        complete: complete.completeService('agent'),
     },
     credentials: {
         virtual: true,

bin/config/autocomplete/index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const Cli = require('lib/cli');
+
+const category = Cli.createCategory('autocomplete', {
+    description: 'Manage autocomplete for CLI',
+    priority: 25,
+});
+
+category.addChild(require('./init'));
+category.addChild(require('./remove'));
+
+module.exports = category;

bin/config/autocomplete/init/examples.md

@@ -0,0 +1,11 @@
+# Get default virtual machine type for a new one
+
+```
+{{command_name}}
+```
+
+# Introduces changes
+
+If you use Bash, it will create a file at ```~/.h1/completion.sh``` and append a loader code to ```~/.bash_profile``` file.
+If you use Zsh, it appends a loader code to ```~/.zshrc``` file.
+If you use Fish, it appends a loader code to ```~/.config/fish/config.fish``` file.

bin/config/autocomplete/init/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const Cli = require('lib/cli');
+const complete = require('lib/complete');
+
+module.exports = Cli.createCommand('init', {
+    dirname: __dirname,
+    description: 'Update shell configuration to support autocomplete',
+    plugins: [
+        require('bin/_plugins/outputFormat'),
+    ],
+    handler: args => {
+        complete.autocomplete(Cli.root(args)).setupShellInitFile();
+        return 'autocomplete set';
+    },
+});

bin/config/autocomplete/remove/examples.md

@@ -0,0 +1,5 @@
+# Update shell configuration to disable autocomplete
+
+```
+{{command_name}}
+```

bin/config/autocomplete/remove/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const Cli = require('lib/cli');
+const complete = require('lib/complete');
+
+module.exports = Cli.createCommand('remove', {
+    dirname: __dirname,
+    description: 'Update shell configuration to remove autocomplete',
+    plugins: [
+        require('bin/_plugins/outputFormat'),
+    ],
+    handler: () => {
+        complete.cleanupShellInitFile();
+        return 'autocomplete removed';
+    },
+});

bin/config/index.js

@@ -11,5 +11,6 @@ category.addChild(require('./show'));
 category.addChild(require('./set'));
 category.addChild(require('./get'));
 category.addChild(require('./unset'));
+category.addChild(require('./autocomplete'));
 
 module.exports = category;

bin/container/create/index.js

@@ -2,6 +2,7 @@
 
 const Cli = require('lib/cli');
 const registry = require('../registry');
+const complete = require('lib/complete');
 
 const options = {
     name: {
@@ -15,9 +16,10 @@ const options = {
         required: true,
     },
     type: {
-        description: 'Container type',
+        description: 'Container type name or ID',
         type: 'string',
         required: true,
+        complete: complete.completeService('container'),
     },
     expose: {
         description: 'Mapping port to expose to the world as external:internal',

bin/database/index.js

@@ -1,6 +1,7 @@
 'use strict';
 const genericDefaults = require('bin/generic/defaults');
 const genericResource = require('bin/generic');
+const complete = require('lib/complete');
 
 const schema = {
     name: {
@@ -10,11 +11,12 @@ const schema = {
         onCreate: true,
     },
     type: {
-        description: 'Database type',
+        description: 'Database type name or ID',
         type: 'string',
         required: true,
         onCreate: true,
         destBody: 'service',
+        complete: complete.completeService('database'),
     },
     credentials: {
         virtual: true,

bin/disk/create/index.js

@@ -7,6 +7,7 @@ const path = require('path');
 const fs = require('fs');
 
 const Cli = require('lib/cli');
+const complete = require('lib/complete');
 
 const options = {
     name: {
@@ -17,6 +18,7 @@ const options = {
     type: {
         description: 'Disk type ID or name. Required if no source disk is specified',
         type: 'string',
+        complete: complete.completeService('disk'),
     },
     size: {
         description: 'Disk size in GiB. Required if no source file and no disk is specified',