add shell and version to top-level help

starpit · starpit · commit 4790ac770101 · 2018-03-17T18:25:59.000-04:00
Fixes #689
diff --git a/app/content/js/usage-error.js b/app/content/js/usage-error.js
@@ -125,7 +125,8 @@ const format = message => {
               messageString = replWrappedAMessageString && message.message
               
         const { command, docs, title, breadcrumb=title||command, header=`${docs}.`, example, detailedExample, sampleInputs,
-                commandPrefix, available, parents=[], related, required, optional, oneof } = usage
+                commandPrefix, commandPrefixNotNeeded,
+                available, parents=[], related, required, optional, oneof } = usage
 
         // the return value will be `result`; we will populate it with
         // those fields now; `body` is the flex-wrap portion of the
@@ -334,6 +335,9 @@ const format = message => {
                       docsPart = span(docs),
                       allowedPart = allowed && smaller(span(undefined))
 
+                // for repl.exec, 
+                const commandForExec = alias => `${commandPrefix && !commandPrefixNotNeeded ? commandPrefix + ' ' : ''}${alias}`
+
                 row.className = 'log-line entity'
                 cmdCell.className = 'log-field'
                 docsCell.className = 'log-field'
@@ -351,7 +355,7 @@ const format = message => {
                               cmdPart = span(alias, 'clickable clickable-blatant'),
                               dirPart = isDir && span('/')
 
-                        cmdPart.onclick = () => repl.pexec(`${commandPrefix ? commandPrefix + ' ' : ''}${alias}`)
+                        cmdPart.onclick = () => repl.pexec(commandForExec(alias))
 
                         aliasesPart.appendChild(cmdCell)
                         cmdCell.appendChild(cmdPart)
@@ -379,11 +383,12 @@ const format = message => {
                 if (command) {
                     cmdPart.classList.add('clickable')
                     cmdPart.classList.add('clickable-blatant')
+                    if (!isDir) cmdPart.style.fontWeight = 'bold'
                     cmdPart.onclick = () => {
                         if (partial) {
-                            return repl.partial(`${commandPrefix ? commandPrefix + ' ' : ''}${command}${partial === true ? '' : ' ' + partial}`)
+                            return repl.partial(commandForExec(alias)(command) + `${partial === true ? '' : ' ' + partial}`)
                         } else {
-                            return repl.pexec(`${commandPrefix ? commandPrefix + ' ' : ''}${command}`)
+                            return repl.pexec(commandForExec(command))
                         }
                     }
                 }
@@ -442,7 +447,7 @@ const format = message => {
     }
 }
 
-module.exports = function UsageError(message, extra, code=message.statusCode || message.code || 500) {
+module.exports = function UsageError(message, extra, code=(message && (message.statusCode || message.code)) || 500) {
     Error.captureStackTrace(this, this.constructor)
     this.name = this.constructor.name
     this.message = format(message)
diff --git a/app/headless.js b/app/headless.js
@@ -272,7 +272,7 @@ const prettyDom = (dom, logger=log, stream=process.stdout, _color, { columnWidth
         stream.write(' ')
     }
 
-    const extraColor = isHeader ? 'bold' : dom.hasStyle('fontWeight', 500) ? 'green' : dom.hasStyle('fontSize', '0.875em') ? 'gray' : _extraColor || 'reset',
+    const extraColor = isHeader || dom.hasStyle('fontWeight', 'bold') ? 'bold' : dom.hasStyle('fontWeight', 500) ? 'green' : dom.hasStyle('fontSize', '0.875em') ? 'gray' : _extraColor || 'reset',
           colorCode = dom.hasStyle('color') || _color,
           color = colorMap[colorCode] || colorCode
     // debug('child', dom.nodeType)
diff --git a/app/plugins/admin/updater.js b/app/plugins/admin/updater.js
@@ -15,7 +15,6 @@
  */
 
 const fs = require('fs'),
-      rp = require('request-promise'),
       path = require('path'),
       exec = require('child_process').exec
 
@@ -75,14 +74,15 @@ const notifyOfAvailableUpdatesVisually = changes => {
  * Wrap the given string in a div
  *
  */
-const wrapInDiv = str => {
+const wrapInDiv = (str, tag='div') => {
     if (typeof str === 'string') {
-        const div = document.createElement('div')
+        const div = document.createElement(tag)
         div.innerText = str
         return div
 
     } else {
-        const pre = document.createElement('pre')
+        const pre = document.createElement('div')
+        pre.style.whiteSpace = 'pre-wrap'
 
         str.forEach(line => {
             pre.appendChild(wrapInDiv(line))
@@ -158,11 +158,13 @@ const npmProcessResponse = (exec = 'npm', name, stdout) => {
             Current = header.indexOf('Current'),
             Wanted = header.indexOf('Wanted'),
             Location = header.indexOf(' Location')
+
         return lines
             .filter(_ => _)                           // strip blank lines
             .map(line => line.substring(0, Location)) // strip last column
             .map(line => line.substring(0, Current + 'Current'.length) +
-                         line.substring(Wanted + 'Wanted'.length)) // strip Wanted column
+                 line.substring(Wanted + 'Wanted'.length)) // strip Wanted column
+            .concat(' ')
             .concat('To update, run the following command from the terminal:')
             .concat(`${exec} update ${name} -g`)
 }
diff --git a/app/plugins/modules/activation-visualizations/usage.js b/app/plugins/modules/activation-visualizations/usage.js
@@ -52,7 +52,8 @@ module.exports = {
         title: 'Activation visualizations',
         header: 'These commands will help you visualize your activations',
         example: 'visualize <command>',
-        commandPrefix: '',
+        commandPrefix: 'visualize',
+        commandPrefixNotNeeded: true,
         available: [{ command: 'summary', docs: header.summary },
                     { command: 'timeline', docs: header.timeline },
                     { command: 'grid', docs: header.grid }],
@@ -61,6 +62,7 @@ module.exports = {
 
     summary: {
         strict: 'summary',
+        command: 'summary',
         nRowsInViewport,
         title: 'Summarize performance',
         header: '${header.summary}.',
diff --git a/app/plugins/ui/commands/help.js b/app/plugins/ui/commands/help.js
@@ -21,7 +21,7 @@ debug('loading')
  * Respond with a top-level usage document
  *
  */
-const help = (usage, docs) => (_1, _2, _3, { errors }) => {
+const help = (usage, docs) => (_1, _2, _3, { ui, errors }) => {
     if (usage) {
         // this will be our return value
         const topLevelUsage = {
@@ -34,12 +34,12 @@ const help = (usage, docs) => (_1, _2, _3, { errors }) => {
         // traverse the top-level usage documents, populating topLevelUsage.available
         for (let key in usage) {
             const { route, usage:model } = usage[key]
-            if (model) {
+            if (model && (ui.headless || !model.headlessOnly)) {
                 topLevelUsage.available.push({
                     label: route.substring(1),
-                    dir: true,
-                    command: model.commandPrefix,
-                    docs: model.title
+                    dir: model.available,
+                    command: model.commandPrefix || model.command,   // either subtree or leaf command
+                    docs: model.command ? model.header : model.title // for leaf commands, print full header
                 })
             }
         }
diff --git a/app/plugins/ui/commands/open-ui-from-terminal.js b/app/plugins/ui/commands/open-ui-from-terminal.js
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 IBM Corporation
+ * Copyright 2017-18 IBM Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,15 @@
  */
 
 
-const docs = { docs: 'Open the visual shell', needsUI: true, fullscreen: false, noEcho: true, noHistory: true } // noEcho means don't echo the command if we came from headless
+const usage = {
+    command: 'shell',
+    title: 'Visual Shell',
+    header: 'Open the visual shell',
+    headlessOnly: true
+}
+
+// noEcho means don't echo the command if we came from headless
+const docs = { usage, needsUI: true, fullscreen: false, noEcho: true, noHistory: true }
 
 /**
  * This plugin allows opening the graphical shell from the terminal
diff --git a/app/plugins/ui/commands/shell.js b/app/plugins/ui/commands/shell.js
@@ -16,13 +16,11 @@
 
 
 /**
- * This plugin introduces /shell, and a synonym !, which executes a
- * given shell command.
+ * This plugin introduces !, which executes a given shell command.
  *
  */
 
 const shell = require('shelljs')
-const request = require('request-promise')
 
 const doShell = (argv, options, execOptions) => new Promise((resolve, reject) => {
     if (argv.length < 2) {
@@ -137,23 +135,28 @@ const usage = {
     }
 }
 
+/**
+ * Register command handlers
+ *
+ */
 module.exports = commandTree => {
+    // commandTree.subtree('/!', { usage: usage.toplevel })
+
     const shellFn = (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(fullArgv, options, execOptions)
     const shellCmd = commandTree.listen('/!', shellFn, { docs: 'Execute a UNIX shell command' })
-    // commandTree.synonym('/shell', shellFn, shellCmd)
 
-    commandTree.listen('/pwd', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'pwd', ...argv.slice(1)], options, execOptions),
+    commandTree.listen('/!/pwd', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'pwd', ...argv.slice(1)], options, execOptions),
                        { docs: 'Print the current working directory' })
 
-    commandTree.listen('/lcd', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'cd', ...argv.slice(1)], options, execOptions),
+    commandTree.listen('/!/lcd', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'cd', ...argv.slice(1)], options, execOptions),
                        { docs: 'Change the current working directory for future shell commands' })
 
-    commandTree.listen('/lls', (_1, _2, fullArgv, { errors }, _4, execOptions, argv, options) => {
+    commandTree.listen('/!/lls', (_1, _2, fullArgv, { errors }, _4, execOptions, argv, options) => {
         return doShell(['!', 'ls', '-l', ...argv.slice(1)], options, Object.assign({}, execOptions, { nested: true }))
             .catch(message => { throw new errors.usage({ message, usage: usage.lls }) })
     }, { usage: usage.lls })
 
-    commandTree.listen('/lrm', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'rm', ...argv.slice(1)], options, execOptions),
+    commandTree.listen('/!/lrm', (_1, _2, fullArgv, _3, _4, execOptions, argv, options) => doShell(['!', 'rm', ...argv.slice(1)], options, execOptions),
                        { docs: 'Remove a file from your local filesystem' })
 
     return {
diff --git a/app/plugins/welcome/about.js b/app/plugins/welcome/about.js
@@ -15,6 +15,9 @@
  */
 
 const debug = require('debug')('about')
+debug('loading')
+
+const usage = require('./usage')
 
 /**
  * The repl allows plugins to provide their own window, via the
@@ -67,7 +70,7 @@ const getVersion = () => {
 const reportVersion = (_1, _2, argv) => {
     debug('reportVersion')
 
-    const checkForUpdates = argv.find(_ => _ === '-u'),
+    const checkForUpdates = argv.find(_ => _ === '-u' || _ === '--update-check'),
           version = getVersion()
 
     if (!checkForUpdates) {
@@ -99,6 +102,7 @@ const reportVersion = (_1, _2, argv) => {
                   // now we need to clear a newline see shell issue
                   // #194
                   console.log('')
+                  console.log('')
               }
               return updates
           }
@@ -126,7 +130,8 @@ module.exports = (commandTree, prequire) => {
      */
     commandTree.listen('/version',      // the command path
                        reportVersion,   // the command handler
-                       { noAuthOk })    // the command options
+                       { noAuthOk,      // the command options
+                         usage: usage.version })
 
     /**
      * Open a graphical window displaying more detail about the tool
diff --git a/app/plugins/welcome/usage.json b/app/plugins/welcome/usage.json
@@ -0,0 +1,14 @@
+{
+    "version": {
+        "strict": "version",
+        "command": "version",
+        "title": "Version Information",
+        "header": "Print the current version of the Shell",
+        "example": "version",
+        "optional": [
+            { "name": "--update-check", "alias": "-u",
+              "docs": "also check for updates"
+            }
+        ]
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -272,7 +272,7 @@ const prettyDom = (dom, logger=log, stream=process.stdout, _color, { columnWidth`
`272`	`272`	`stream.write(' ')`
`273`	`273`	`}`
`274`	`274`
`275`		`- const extraColor = isHeader ? 'bold' : dom.hasStyle('fontWeight', 500) ? 'green' : dom.hasStyle('fontSize', '0.875em') ? 'gray' : _extraColor \|\| 'reset',`
	`275`	`+ const extraColor = isHeader \|\| dom.hasStyle('fontWeight', 'bold') ? 'bold' : dom.hasStyle('fontWeight', 500) ? 'green' : dom.hasStyle('fontSize', '0.875em') ? 'gray' : _extraColor \|\| 'reset',`
`276`	`276`	`colorCode = dom.hasStyle('color') \|\| _color,`
`277`	`277`	`color = colorMap[colorCode] \|\| colorCode`
`278`	`278`	`// debug('child', dom.nodeType)`