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

doc(webpack): webpack example #1436

Merged
merged 4 commits into from Oct 24, 2019
Merged

doc(webpack): webpack example #1436

merged 4 commits into from Oct 24, 2019

Conversation

mleguen
Copy link
Member

@mleguen mleguen commented Oct 2, 2019

Usage example for webpack, both in javascript and typescript.

I stumbled myself on this issue in one of my projects a few days ago, and found it was about time to close #781 !

@mleguen mleguen changed the title doc: weback example doc: webpack example Oct 2, 2019
Copy link
Member Author

@mleguen mleguen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not to be merged yet.

docs/webpack.md Outdated Show resolved Hide resolved
@mleguen mleguen changed the title doc: webpack example wip: doc: webpack example Oct 3, 2019
@bcoe
Copy link
Member

bcoe commented Oct 3, 2019

@mleguen neat, thanks for pulling this together.

docs/webpack.md Outdated Show resolved Hide resolved
@mleguen mleguen changed the title wip: doc: webpack example doc(webpack): webpack example Oct 9, 2019
@mleguen
Copy link
Member Author

mleguen commented Oct 9, 2019

Ready for reviews!


Or for typescript users, `src/index.ts`:
```ts
import * as yargs from 'yargs';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we're going to want to update the TypeScript examples themselves to use this approach as well, we swapped to the following approach:

b1b156a

But it seems to be causing trouble for folks, see:

#1455

I think we actually addressed #1439 elsewhere, by removing the deprecation warning.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1455 is on my TODO list, once I'm done with #1452

Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me, thanks for adding this 👍 main feedback is we should fix up our other TypeScript examples.

@mleguen mleguen merged commit 9adf22e into master Oct 24, 2019
@mleguen mleguen deleted the fix/781 branch October 24, 2019 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: write docs reflecting how to use yargs with webpack
2 participants