simonlovesyou / cling Goto Github PK

Propagate unknown arguments from the parser at the root level but also on each command

Schema

const schema = parser({
  commands: {
    foo: {}
  }
} as const, {})

Argvs

Unknown command

argv: baz

should output

{
  commands: {
    _unknown: [{
      name: 'baz'
    }]
  }
}

Unknown command & positional

argv: baz quux

should output

{
  commands: {
    _unknown: [{ name: 'baz', _unknown: [{ value: 'quux' }] }]
  }
}

Unknown command & argument

argv: baz --quux=foo

should output

{
  commands: {
    _unknown: [{
     name: 'baz',
     _unknown: [{
       name: 'quux',
       value: 'foo'
    }]
  }]
}

Unknown argument

argv: foo --quux=foo

should output

{
  commands: {
    foo: {
      _unknown: [{
        name: 'quux',
        value: 'foo'
    }
}

cling({
  arguments: {
    role: {
      type: 'string',
      enum: ['user', 'admin'],
      description: "The users' role"
    }
  }
} as const)

should output the following help output:

Usage:
  cli --role (user|admin)

Options:
  -h --help     Show this screen.

Arguments:
  --role  The users' role in the organization. (user|admin)

Add runtime & static logic for determining whether or not a argument / option has a conflicting name.

Static logic does not seem to be possible yet, see this PR

Should be cleaned up similar to how @cling/cling was improved in #2

cling({
  arguments: {
    email: {
      type: 'array',
      items: [{
        type: 'string'
      }, {
        type: 'number'
      }],
      // description: "The users' email",
    },
    age: {
      type: 'integer'
    },
  }
} as const)

will output Usage: test [--email],[--age], should be Usage: test [--email] [--age]