Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc(webpack): webpack example (#1436)
* doc: weback example
* doc(webpack): ignore dynamic module loading warnings
  • Loading branch information
mleguen committed Oct 24, 2019
1 parent 7e1c8fc commit 9adf22e
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -98,6 +98,10 @@ npm i @types/yargs --save-dev

See usage examples in [docs](/docs/typescript.md).

## Webpack

See usage examples of yargs with webpack in [docs](/docs/webpack.md).

## Community :

Having problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com).
Expand Down
103 changes: 103 additions & 0 deletions docs/webpack.md
@@ -0,0 +1,103 @@
# Webpack usage examples

## Install dependencies

```bash
$ npm install --save-dev webpack webpack-cli yargs
```

Additional dependencies for typescript users:

```bash
$ npm install --save-dev ts-loader typescript @types/yargs
```

## Sample program

Create `src/index.js`:
```js
const yargs = require('yargs')

console.log(yargs.parse())
```

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

console.log(yargs.parse());
```

along with its `tsconfig.json`:
```json
{
"compilerOptions": {
"sourceMap": true
}
}
```

## Webpack configuration

Create `webpack.config.js`:
```js
const path = require('path');

module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'index.js'
},
stats: {
// Ignore warnings due to yarg's dynamic module loading
warningsFilter: [/node_modules\/yargs/]
},
target: 'node'
}
```

For typescript users, replace :

```js
module.exports = {
entry: './src/index.js',
...
}
```

by:

```js
module.exports = {
entry: './src/index.ts',
module: {
rules: [
{
test: /\.ts$/,
use: [
'ts-loader',
]
}
]
},
resolve: {
extensions: ['.ts', '.js'],
},
...
}
```

## Build

```bash
$ ./node_modules/.bin/webpack --mode=production
```

## Run

```bash
$ rm -rf node_modules
$ node dist/index.js
{ _: [], '$0': 'dist/index.js' }
```

0 comments on commit 9adf22e

Please sign in to comment.