reinstate --help #652
reinstate --help #652
Conversation
|
modules that need "help"
|
|
Could the help data structure be described somewhere as a convention? It smells like a module in itself (similar to multiserver-address). |
|
@staltz yes, it's documented here: https://github.com/dominictarr/muxrpc-usage#data-structure |
|
none of the plugins moved in https://github.com/ssbc/ssb-server/pull/664/files have commands, so merging that doesn't block this. Except ssb-plugins, which needs to be merged: #653 |
| //get config as cli options after --, options before that are | ||
| //options to the command. | ||
|
|
||
| module.exports = function (config, argv) { |
There was a problem hiding this comment.
can we name this function cli or something?
as down at the bottom, we call module.exports(...) and took me a few moments to grok what was happening.
| var i = argv.indexOf('--') | ||
| var conf = argv.slice(i+1) | ||
| argv = ~i ? argv.slice(0, i) : argv | ||
| module.exports(Config(process.env.ssb_appname, minimist(conf)), argv) |
There was a problem hiding this comment.
there's a lot happening here, but it's hard to tell what is happening, what about:
var args = process.argv.slice(2)
var [methodArgs, configArgs] = splitArgsBySeparator(args)
var appName = process.env.ssb_appname
var configOptions = minimist(configArgs)
var config = Config(appName, configOptions)
cli(config, methodArgs)
function splitArgvBySeparator (args) {
var splitIndex = args.indexOf('--')
var methodArgs = splitIndex == -1 ? args : args.slice(0, splitIndex)
var configArgs = args.slice(splitIndex + 1)
return [methodArgs, configArgs]
} | }) | ||
| } | ||
|
|
||
| if(!module.parent && process.title != 'browser') { |
There was a problem hiding this comment.
can there be a comment to describe what this is doing?
|
@corlock had a problem that, running ssb-server inside of patchwork, couldn't use --help. I think whats happening is that --help is really, new, so that i'm not sure it's in the versions of modules that patchwork has? |
|
Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward? |
pretty much a complete rewrite of the internal help system.
now with muxrpcli@3 has each plugin own it's own help - plugins should have a
helpmethod that returns a data structure describing all commands and all their arguments. That has been implemented for ssb-db and ssb-gossip so far, but all the plugins will need that.This data is also machine readable, which I think will lend to other useful things, such as validation of inputs. Also since it describes the patterns, it would be usable for other types of interface, http, cli or javascript.