fix: better type for flags with default value (#53)

src/flags.ts

@@ -4,6 +4,8 @@ import {AlphabetLowercase, AlphabetUppercase} from './alphabet'
 
 export type DefaultContext<T> = { options: IOptionFlag<T>; flags: { [k: string]: string } }
 
+export type Default<T> = T | ((context: DefaultContext<T>) => T)
+
 export type IFlagBase<T, I> = {
   name: string
   char?: AlphabetLowercase | AlphabetUppercase
@@ -26,21 +28,21 @@ export type IBooleanFlag<T> = IFlagBase<T, boolean> & {
   /**
    * specifying a default of false is the same not specifying a default
    */
-  default?: boolean | ((context: DefaultContext<boolean>) => boolean)
+  default?: Default<boolean>
 }
 
 export type IOptionFlag<T> = IFlagBase<T, string> & {
   type: 'option'
   helpValue?: string
-  default?: T | ((context: DefaultContext<T>) => T | undefined)
+  default?: Default<T | undefined>
   multiple: boolean
   input: string[]
   options?: string[]
 }
 
 export type Definition<T> = {
   (options: {multiple: true} & Partial<IOptionFlag<T>>): IOptionFlag<T[]>
-  (options: {required: true} & Partial<IOptionFlag<T>>): IOptionFlag<T>
+  (options: ({required: true} | {default: Default<T>}) & Partial<IOptionFlag<T>>): IOptionFlag<T>
   (options?: Partial<IOptionFlag<T>>): IOptionFlag<T | undefined>
 }
 

test/parse.test.ts

@@ -459,22 +459,22 @@ See more help with --help`)
     })
 
     it('default has options', () => {
+      const def: flags.Default<string | undefined> = ({options}) => options.description
       const out = parse([], {
         // args: [{ name: 'baz', default: () => 'BAZ' }],
-        flags: {foo: flags.string({description: 'bar', default: ({options}) => options.description})},
+        flags: {foo: flags.string({description: 'bar', default: def})},
       })
       // expect(out.args).to.deep.include({ baz: 'BAZ' })
       // expect(out.argv).to.deep.include(['BAZ'])
       expect(out.flags).to.deep.include({foo: 'bar'})
     })
 
     it('can default to a different flag', () => {
+      const def: flags.Default<string | undefined> = opts => opts.flags.foo
       const out = parse(['--foo=bar'], {
         flags: {
           bar: flags.string({
-            default: opts => {
-              return opts.flags.foo
-            },
+            default: def,
           }),
           foo: flags.string(),
         },