mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-22 06:57:48 +00:00
abf573fa47
zero in device UUID). This commit is fairly chunky because it adds the oclif dependency for the first time, and refactors the CLI help and docs generation code to accommodate both Capitano and oclif. Change-type: patch Signed-off-by: Paulo Castro <paulo@balena.io>
123 lines
3.1 KiB
CoffeeScript
123 lines
3.1 KiB
CoffeeScript
###
|
|
Copyright 2016-2017 Balena
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
###
|
|
|
|
_ = require('lodash')
|
|
capitano = require('capitano')
|
|
columnify = require('columnify')
|
|
|
|
messages = require('../utils/messages')
|
|
{ exitWithExpectedError } = require('../utils/patterns')
|
|
{ getOclifHelpLinePairs } = require('./help_ts')
|
|
|
|
parse = (object) ->
|
|
return _.map object, (item) ->
|
|
|
|
# Hacky way to determine if an object is
|
|
# a function or a command
|
|
if item.alias?
|
|
signature = item.toString()
|
|
else
|
|
signature = item.signature.toString()
|
|
|
|
return [
|
|
signature
|
|
item.description
|
|
]
|
|
|
|
indent = (text) ->
|
|
text = _.map text.split('\n'), (line) ->
|
|
return ' ' + line
|
|
return text.join('\n')
|
|
|
|
print = (usageDescriptionPairs...) ->
|
|
data = _.fromPairs([].concat(usageDescriptionPairs...).sort())
|
|
console.log indent columnify data,
|
|
showHeaders: false
|
|
minWidth: 35
|
|
|
|
general = (params, options, done) ->
|
|
console.log('Usage: balena [COMMAND] [OPTIONS]\n')
|
|
console.log(messages.reachingOut)
|
|
console.log('\nPrimary commands:\n')
|
|
|
|
# We do not want the wildcard command
|
|
# to be printed in the help screen.
|
|
commands = _.reject capitano.state.commands, (command) ->
|
|
return command.hidden or command.isWildcard()
|
|
|
|
groupedCommands = _.groupBy commands, (command) ->
|
|
if command.primary
|
|
return 'primary'
|
|
return 'secondary'
|
|
|
|
print(parse(groupedCommands.primary))
|
|
|
|
if options.verbose
|
|
console.log('\nAdditional commands:\n')
|
|
print(parse(groupedCommands.secondary), getOclifHelpLinePairs())
|
|
else
|
|
console.log('\nRun `balena help --verbose` to list additional commands')
|
|
|
|
if not _.isEmpty(capitano.state.globalOptions)
|
|
console.log('\nGlobal Options:\n')
|
|
print(parse(capitano.state.globalOptions))
|
|
|
|
return done()
|
|
|
|
command = (params, options, done) ->
|
|
capitano.state.getMatchCommand params.command, (error, command) ->
|
|
return done(error) if error?
|
|
|
|
if not command? or command.isWildcard()
|
|
exitWithExpectedError("Command not found: #{params.command}")
|
|
|
|
console.log("Usage: #{command.signature}")
|
|
|
|
if command.help?
|
|
console.log("\n#{command.help}")
|
|
else if command.description?
|
|
console.log("\n#{_.capitalize(command.description)}")
|
|
|
|
if not _.isEmpty(command.options)
|
|
console.log('\nOptions:\n')
|
|
print(parse(command.options))
|
|
|
|
return done()
|
|
|
|
exports.help =
|
|
signature: 'help [command...]'
|
|
description: 'show help'
|
|
help: '''
|
|
Get detailed help for an specific command.
|
|
|
|
Examples:
|
|
|
|
$ balena help apps
|
|
$ balena help os download
|
|
'''
|
|
primary: true
|
|
options: [
|
|
signature: 'verbose'
|
|
description: 'show additional commands'
|
|
boolean: true
|
|
alias: 'v'
|
|
]
|
|
action: (params, options, done) ->
|
|
if params.command?
|
|
command(params, options, done)
|
|
else
|
|
general(params, options, done)
|