feat: exclusive

src/flags.ts

@@ -11,6 +11,7 @@ export type IFlagBase<T, I> = {
  hidden?: boolean
  required?: boolean
  dependsOn?: string[],
+ exclusive?: string[],
  /**
  * also accept an environment variable as input
  */

src/validate.ts

@@ -25,6 +25,11 @@ export function validate(parse: { input: ParserInput; output: ParserOutput<any,
  throw new CLIError(`--${also}= must also be provided when using --${name}=`)
  }
  }
+ for (let also of flag.exclusive || []) {
+ if (parse.output.flags[also]) {
+ throw new CLIError(`--${also}= cannot also be provided when using --${name}=`)
+ }
+ }
  } else {
  if (flag.required) throw new RequiredFlagError({parse, flag})
  }

test/parse.test.ts

@@ -446,4 +446,36 @@ See more help with --help`)
  }).to.throw('--bar= must also be provided when using --foo=')
  })
  })
+
+ describe('exclusive', () => {
+ it('ignores', () => {
+ parse([], {
+ flags: {
+ foo: flags.string({exclusive: ['bar']}),
+ bar: flags.string({char: 'b'}),
+ },
+ })
+ })
+
+ it('succeeds', () => {
+ const out = parse(['--foo', 'a'], {
+ flags: {
+ foo: flags.string({exclusive: ['bar']}),
+ bar: flags.string({char: 'b'}),
+ },
+ })
+ expect(out.flags.foo).to.equal('a')
+ })
+
+ it('fails', () => {
+ expect(() => {
+ parse(['--foo', 'a', '-bb'], {
+ flags: {
+ foo: flags.string({exclusive: ['bar']}),
+ bar: flags.string({char: 'b'}),
+ },
+ })
+ }).to.throw('--bar= cannot also be provided when using --foo=')
+ })
+ })
 })