fix: types on custom flags (#463)

* fix: types on custom flags * chore: fix tests
oclif · Aug 8, 2022 · 2728e23 · 2728e23
1 parent 821a16d
commit 2728e23
Showing 1 changed file with 13 additions and 7 deletions.
diff --git a/src/parser/flags.ts b/src/parser/flags.ts
@@ -2,7 +2,7 @@
 
 import {URL} from 'url'
 
-import {Definition, OptionFlag, BooleanFlag} from '../interfaces'
+import {Definition, OptionFlag, BooleanFlag, Default} from '../interfaces'
 import * as fs from 'fs'
 
 export function build<T>(
@@ -12,15 +12,15 @@ export function build(
   defaults: Partial<OptionFlag<string>>,
 ): Definition<string>
 export function build<T>(defaults: Partial<OptionFlag<T>>): Definition<T> {
-  return (options: any = {}): any => {
+  return (options: any = {}) => {
     return {
       parse: async (i: string, _: any) => i,
       ...defaults,
       ...options,
       input: [] as string[],
       multiple: Boolean(options.multiple === undefined ? defaults.multiple : options.multiple),
       type: 'option',
-    } as any
+    }
   }
 }
 
@@ -35,8 +35,10 @@ export function boolean<T = boolean>(
   } as BooleanFlag<T>
 }
 
-export const integer = (opts: { min?: number; max?: number} & Partial<OptionFlag<number>> = {}): OptionFlag<number | undefined> => {
-  return build<number>({
+export function integer(opts: Partial<OptionFlag<number>> & {min?: number; max?: number } & ({required: true} | { default: Default<number> })): OptionFlag<number>
+export function integer(opts?: Partial<OptionFlag<number>> & {min?: number; max?: number }): OptionFlag<number | undefined>
+export function integer(opts: Partial<OptionFlag<number>> & {min?: number; max?: number } = {}): OptionFlag<number> | OptionFlag<number | undefined> {
+  return build({
     ...opts,
     parse: async input => {
       if (!/^-?\d+$/.test(input))
@@ -51,14 +53,18 @@ export const integer = (opts: { min?: number; max?: number} & Partial<OptionFlag
   })()
 }
 
-export const directory = (opts: { exists?: boolean } & Partial<OptionFlag<string>> = {}): OptionFlag<string | undefined> => {
+export function directory(opts: { exists?: boolean } & Partial<OptionFlag<string>> & ({required: true} | { default: Default<string> })): OptionFlag<string>
+export function directory(opts?: { exists?: boolean } & Partial<OptionFlag<string>>): OptionFlag<string | undefined>
+export function directory(opts: { exists?: boolean } & Partial<OptionFlag<string>> = {}): OptionFlag<string> | OptionFlag<string | undefined> {
   return build<string>({
     ...opts,
     parse: async (input: string) => opts.exists ? dirExists(input) : input,
   })()
 }
 
-export const file = (opts: { exists?: boolean } & Partial<OptionFlag<string>> = {}): OptionFlag<string | undefined> => {
+export function file(opts: { exists?: boolean } & Partial<OptionFlag<string>> & ({required: true} | { default: string })): OptionFlag<string>
+export function file(opts?: { exists?: boolean } & Partial<OptionFlag<string>>): OptionFlag<string | undefined>
+export function file(opts: { exists?: boolean } & Partial<OptionFlag<string>> = {}): OptionFlag<string> | OptionFlag<string | undefined>  {
   return build<string>({
     ...opts,
     parse: async (input: string) => opts.exists ? fileExists(input) : input,