fix usage models for editing commands

Fixes #749

Author: starpit

app/plugins/modules/editor/lib/edit.js

@@ -23,11 +23,6 @@ const path = require('path'),
       placeholders = require('./placeholders'),
       { lockIcon } = require('./readonly')
 
-/** optional command line arguments, by command */
-const optionalArguments = {
-    new: '[--kind <nodejs:default*|python:default|php:default|swift:default>]'
-}
-
 /** default settings */
 const defaults = {
     kind: 'nodejs:default'
@@ -717,12 +712,12 @@ module.exports = (commandTree, prequire) => {
     const wsk = prequire('/ui/commands/openwhisk-core')
 
     // command registration: edit existing action
-    commandTree.listen('/editor/edit', edit(wsk, prequire), { docs: strings.docs.edit })
+    commandTree.listen('/editor/edit', edit(wsk, prequire), { usage: usage.edit })
 
     // command registration: create new action
-    commandTree.listen('/editor/new', newAction({wsk, prequire}), { docs: strings.docs.new })
+    commandTree.listen('/editor/new', newAction({wsk, prequire}), { usage: usage.new })
 
     // command registration: create new app/composition
     commandTree.listen('/editor/compose', newAction(compositionOptions({ wsk, prequire, op: 'compose'})),
-                       { docs: strings.docs.compose })
+                       { usage: usage.compose })
 }

app/plugins/modules/editor/usage.js

@@ -35,31 +35,39 @@ module.exports = {
     },
 
     edit: {
+        strict: 'edit',
+        command: 'edit',
         title: 'Edit action',
         header: 'Open a given action or composition in the sidecar for editing.',
         example: 'edit <actionName>',
-        commandPrefix: 'editor edit',
-        required: [{ name: '<actionName>', docs: 'The OpenWhisk action to edit' }],
+        required: [{ name: '<actionName>', docs: 'The OpenWhisk action to edit', implicitOK: ['actions', 'activations'] }],
         parents: [{command: 'editor'}],
         related: allExcept('edit')
     },
 
     compose: {
+        strict: 'compose',
+        command: 'compose',
         title: 'New composition',
         header: 'For quick prototyping of compositions, this command opens an editor in the sidecar.',
         example: 'compose <appName>',
-        commandPrefix: 'editor compose',
         required: [{ name: '<appName>', docs: 'The name of your new composition' }],
         parents: [{command: 'editor'}],
         related: allExcept('compose')
     },
 
     new: {
+        strict: 'new',
+        command: 'new',
         title: 'New action',
         header: 'For quick prototyping of actions, this command opens an editor in the sidecar.',
         example: 'new <actionName>',
-        commandPrefix: 'editor new',
         required: [{ name: '<actionName>', docs: 'The name of your new action' }],
+        optional: [{ name: '--kind', alias: '-k', docs: 'The OpenWhisk kind of the new action',
+                     allowed: ['nodejs', 'python', 'php', 'swift'],
+                     allowedIsPrefixMatch: true,
+                     defaultValue: 'nodejs'
+                   }],
         parents: [{command: 'editor'}],
         related: allExcept('new')
     }

tests/tests/passes/04/edit-new.js

@@ -42,6 +42,10 @@ describe('create new actions in editor', function() {
        .then(cli.expectError(409))
        .catch(common.oops(this)))
 
+    it('should report 498 for new --kind zoo', () => cli.do('new nope --kind zoo', this.app)
+       .then(cli.expectError(498)) // bad value for optional parameter
+       .catch(common.oops(this)))
+
     /** deploy the new action */
     const deploy = (app, action) => () => {
         return app.client.click(ui.selectors.SIDECAR_MODE_BUTTON('Deploy'))

tests/tests/passes/04/edit.js

@@ -36,12 +36,20 @@ describe('edit actions', function() {
        .then(cli.expectError(404))
        .catch(common.oops(this)))
 
+    it('should report 499 for edit --kind', () => cli.do('edit nope --kind foo', this.app)
+       .then(cli.expectError(499)) // unsupported optional parameter
+       .catch(common.oops(this)))
+
     it('should create an action', () => cli.do('let foo = x=>x', this.app)
        .then(cli.expectOK)
        .then(sidecar.expectOpen)
        .then(sidecar.expectShowing('foo'))
        .catch(common.oops(this)))
 
+    it('should report 499 for edit --kind on existing action', () => cli.do('edit foo --kind foo', this.app)
+       .then(cli.expectError(499)) // unsupported optional parameter
+       .catch(common.oops(this)))
+
     it('should edit with implicit entity', () => cli.do('edit', this.app)
        .then(cli.expectOK)
        .then(sidecar.expectOpen)