vtex / findhelp Goto Github PK

Show help, version, etc.

From doing the PR #3 and dealing a little bit with the library, I perceived one core problem, which is the use of maps everywhere. Maps, as we know, shouldn't have any order for their keys and values. That made me do a bit of a hack to get the namespace command represented before all others, and I believe more problems may arise from it.

So here I suggest that we switch from a map-based structure to arrays, switching from:

const tree = {
  list: {
    description: 'List apps',
    handler: () => {}
  },
  settings: {
    description: 'Get settings',
    handler: () => {},

    set: {
      description: 'Set settings value',
      handler: () => {}
    },
    unset: {
      description: 'Unset settings value',
      handler: () => {}
    }
  }
}

To:

const tree = [
  {
    name: 'list',
    description: 'List apps',
    handler: () => {}
  },
  {
    name: 'settings',
    description: 'Get settings',
    handler: () => {},
    children: [
      {
        name: 'set',
        description: 'Set settings value',
        handler: () => {}
      },
      {
        name: 'unset',
        description: 'Unset settings value',
        handler: () => {}
      },
    ]
  }
]

Yes, I know it is not as pretty, but I think it is clearer, of easier maintenance and less error-prone. For instance, ambiguity between a field and a command name would never be an issue.

@firstdoit, @tamorim, what do you think?

Similar to http://stackoverflow.com/questions/20838284/how-can-i-provide-tab-completions-to-fish-shell-from-my-own-script

findhelp should have an API that allows the user to pass in names of modules, so it can lazily require commands and namespaces.

This should immensely improve start-up times for any non-trivial CLI application.

Suggestions on how to do it? I'd like to keep it simple. Maybe a module property which has more priority than handler?

@rdumont @tamorim

This error happens when the tree object has no options value, and/or when none of its children have an options value, from what I gather.