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

fix: unknown flag values to be passed in explicitly #13

Merged
merged 6 commits into from
Oct 27, 2022
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
Prev Previous commit
Next Next commit
revert: ignoreUnknown removal
  • Loading branch information
privatenumber committed Oct 26, 2022
commit 59734af36971146d0fb86ea0674a3487498f07b3
11 changes: 10 additions & 1 deletion src/type-flag.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ const parsed = typeFlag({
export function typeFlag<Schemas extends Flags>(
schemas: Schemas,
argv: string[] = process.argv.slice(2),
options: {
ignoreUnknown?: boolean;
} = {},
) {
const aliasesMap = mapAliases(schemas);
const parsed: TypeFlag<Schemas> = {
Expand Down Expand Up @@ -129,6 +132,8 @@ export function typeFlag<Schemas extends Flags>(
hasAlias.schema,
isLastAlias ? flagValue : true,
);
} else if (options.ignoreUnknown) {
parsed._.push(argvElement);
} else {
setUnknown(alias, isLastAlias ? flagValue : true);
}
Expand All @@ -148,7 +153,11 @@ export function typeFlag<Schemas extends Flags>(
}

if (!flagSchema) {
setUnknown(flagName, flagValue);
if (options.ignoreUnknown) {
parsed._.push(argvElement);
} else {
setUnknown(flagName, flagValue);
}
continue;
}

Expand Down
20 changes: 20 additions & 0 deletions tests/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,26 @@ describe('Parsing', ({ test }) => {
);
});

test('ignore unknown flags', () => {
const parsed = typeFlag(
{
string: [String],
},
['--string', 'a', '--string=b', '--unknown', 'c', '--unknown=d', '-u'],
{ ignoreUnknown: true },
);

expect(parsed).toStrictEqual({
flags: {
string: ['a', 'b'],
},
unknownFlags: {},
_: Object.assign(['--unknown', 'c', '--unknown=d', '-u'], {
'--': [],
}),
});
});

test('custom type', () => {
const ParseDate = (dateString: string) => new Date(dateString);

Expand Down