Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add required option #2

Merged
merged 2 commits into from
Dec 7, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: add required option
  • Loading branch information
privatenumber committed Dec 7, 2021
commit 36c414839f421022bd89d081759c6e3c17808f9e
3 changes: 3 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
mapAliases,
parseFlag,
getDefaultFromTypeWithValue,
validateFlags,
} from './utils';

const isAliasPattern = /^-[\da-z]+/i;
Expand Down Expand Up @@ -154,6 +155,8 @@ function typeFlag<Schemas extends Flags>(
expectingValue();
}

validateFlags(schemas, flags);

return {
flags,
unknownFlags,
Expand Down
7 changes: 6 additions & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export type TypeFunctionArray<T = any> = [TypeFunction<T>];
export type FlagSchema = {
type: TypeFunction | TypeFunctionArray;
alias?: string;
required?: true;
};

export type FlagTypeOrSchema = TypeFunction | TypeFunctionArray | FlagSchema;
Expand All @@ -21,7 +22,11 @@ export type InferFlagType<
Flag extends FlagTypeOrSchema
> = Flag extends (TypeFunction<infer T> | { type: TypeFunction<infer T> })
// Type function return-type
? (T | undefined)
? (
Flag extends { required: true }
? T
: T | undefined
)

// Type function return-type in array
: (
Expand Down
47 changes: 38 additions & 9 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,26 +78,26 @@ export function mapAliases<Schemas extends Flags>(
schema: FlagSchema;
}>();

for (const name in schemas) {
if (!hasOwn(schemas, name)) {
for (const flagName in schemas) {
if (!hasOwn(schemas, flagName)) {
continue;
}

validateFlagName(schemas, name);
validateFlagName(schemas, flagName);

const schema = schemas[name] as FlagSchema;
const schema = schemas[flagName] as FlagSchema;
if (schema && typeof schema === 'object') {
const { alias } = schema;
if (alias) {
assert(alias.length > 0, `Invalid flag alias ${stringify(name)}: flag alias cannot be empty`);
assert(alias.length === 1, `Invalid flag alias ${stringify(name)}: flag aliases can only be a single-character`);
assert(alias.length > 0, `Invalid flag alias ${stringify(flagName)}: flag alias cannot be empty`);
assert(alias.length === 1, `Invalid flag alias ${stringify(flagName)}: flag aliases can only be a single-character`);
assert(
!aliases.has(alias),
`Flag collision: Alias "${alias}" is already used`,
);

aliases.set(alias, {
name,
name: flagName,
schema,
});
}
Expand All @@ -112,10 +112,12 @@ const isArrayType = (schema: FlagTypeOrSchema) => {
return false;
}

return (Array.isArray(schema) || Array.isArray(schema.type));
return Array.isArray(schema) || Array.isArray(schema.type);
};

export const createFlagsObject = <Schemas extends Flags>(schema: Flags) => {
export const createFlagsObject = <Schemas extends Flags>(
schema: Schemas,
) => {
const flags: Record<string, any> = {};

for (const flag in schema) {
Expand Down Expand Up @@ -143,3 +145,30 @@ export const getDefaultFromTypeWithValue = (

return value;
};

export const validateFlags = <Schemas extends Flags>(
schemas: Schemas,
flags: Record<keyof Schemas, any>,
) => {
for (const flagName in schemas) {
if (!hasOwn(schemas, flagName)) {
continue;
}

const schema = schemas[flagName];

if (
schema
&& ('required' in schema)
&& schema.required
) {
const value = flags[flagName];
if (
value === undefined
|| (Array.isArray(value) && value.length === 0)
) {
throw new Error(`Missing required option "--${flagName}"`);
}
}
}
};
49 changes: 49 additions & 0 deletions tests/type-flag.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,15 @@ describe('Parsing', () => {
expect<string | undefined>(parsed.flags.someString).toEqual('4');
});

test('kebab-case flags', () => {
const parsed = typeFlag(['--some-string=2', '--someString=3', '--some-string=4'], {
'some-string': String,
});

expect<string | undefined>(parsed.flags['some-string']).toEqual('4');
expect(!('someString' in parsed.flags)).toBe(true);
});

test('flag=', () => {
const parsed = typeFlag(['--string=hello', '-s=bye', '--string=', '--boolean=true', '--boolean=false', '--boolean=', 'world', '--number=3.14', '--number='], {
string: {
Expand Down Expand Up @@ -293,4 +302,44 @@ describe('Parsing', () => {
expect<number[]>(parsed.flags.numberArray).toEqual([1, 2]);
expect<string[]>(parsed._).toEqual(['world']);
});

describe('Required flag', () => {
test('Types and parsing', () => {
const parsed = typeFlag(['--string', 'hello', '--boolean', '--number', '1'], {
string: {
type: String,
required: true,
},
boolean: {
type: Boolean,
required: true,
},
number: Number,
});

expect<string>(parsed.flags.string).toEqual('hello');
expect<boolean>(parsed.flags.boolean).toEqual(true);
expect<number | undefined>(parsed.flags.number).toEqual(1);
});

test('Throw on missing', () => {
expect(() => {
typeFlag([], {
flagA: {
type: String,
required: true,
},
});
}).toThrow(/* 'Missing required option "--flagA"' */);

expect(() => {
typeFlag([], {
flagA: {
type: [String],
required: true,
},
});
}).toThrow(/* 'Missing required option "--flagA"' */);
});
});
});