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

yargs.command(module) signature missing in YargsInstance definition #1704

Closed
cspotcode opened this issue Aug 4, 2020 · 3 comments · Fixed by #1707
Closed

yargs.command(module) signature missing in YargsInstance definition #1704

cspotcode opened this issue Aug 4, 2020 · 3 comments · Fixed by #1707
Assignees
Labels

Comments

@cspotcode
Copy link
Contributor

I see that the source no longer declares the command(module) signature on YargsInstance, where you can pass a single options object describing the command. Is this function signature intentionally being removed?

https://github.com/yargs/yargs/blob/master/lib/yargs.ts#L1449-L1456

I ask because it effects decisions I make writing yargs code. If it's likely to be removed in the next release, I can avoid it.

@bcoe
Copy link
Member

bcoe commented Aug 5, 2020

@mleguen can you speak to this design decision?

@mleguen mleguen added bug and removed question labels Aug 5, 2020
@mleguen mleguen changed the title Is yargs.command(module) signature removed? yargs.command(module) signature missing in YargsInstance definition Aug 5, 2020
@mleguen
Copy link
Member

mleguen commented Aug 5, 2020

Is this function signature intentionally being removed?

No, it isn't intentional.

It is something we will probably fix (by adding the missing signature) when aligning yargs.d.ts and yargs.ts

@mleguen
Copy link
Member

mleguen commented Aug 5, 2020

I finally fixed this in #1707

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment