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

enh(webpack-scaffold): improve prompt and doc #794

Merged
merged 7 commits into from
Mar 19, 2019
Prev Previous commit
Next Next commit
misc(init): fix typos
  • Loading branch information
misterdev committed Mar 19, 2019
commit 35565be397962375994abf45f32cf873225b6afd
15 changes: 9 additions & 6 deletions INIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### a. Local setup

Those are the steps necessary to setup `webpack-cli init` locally:
These are the steps necessary to setup `webpack-cli init` locally:

1. Create `package.json` through npm

Expand All @@ -20,21 +20,24 @@ Those are the steps necessary to setup `webpack-cli init` locally:
npm install --save-dev webpack webpack-cli
```

3. Install `@webpack-cli/init` package to add init scaffold
3. Install `@webpack-cli/init` package to add the init scaffold

```shell
npm install --save-dev @webpack-cli/init
```

### b. Global Setup

Follow following steps to setup `webpack-cli init` globally:
These are the steps necessary to setup `webpack-cli init` globally:

1. Install `webpack` and `webpack-cli` globally

```shell
npm install -g webpack webpack-cli
```

2. Install `@webpack-cli/init` package to add init scaffold
2. Install `@webpack-cli/init` package to add the init scaffold

```shell
npm install -g @webpack-cli/init
```
Expand Down Expand Up @@ -66,7 +69,7 @@ If you want to have multiple entry points, answer yes. If you want to have only

> *Property/key resolved: [entry](https://webpack.js.org/configuration/entry-context/#entry)*

This allows webpack to know from which file to start bundling your application. The default answer `src/index` will tell webpack to look for `index.js` inside a folder named `src`.
This tells webpack from which file to start bundling your application. The default answer `src/index` will tell webpack to look for a file called `index` inside a folder named `src`.

3. `In which folder do you want to store your generated bundles? (dist)`

Expand All @@ -78,7 +81,7 @@ The output directory is where your bundled application will be. Your `index.html

> *Property/key resolved: [module.rules](https://webpack.js.org/configuration/module/#module-rules) (for .js files)*

This enables webpack to parse [`ES2015`](https://babeljs.io/learn-es2015/) code. Answer `Yes` if you to use modern JavaScript in your project.
This enables webpack to parse [`ES2015`](https://babeljs.io/learn-es2015/) code. Answer `Yes` if you want to use modern JavaScript in your project.

5. `Will you use one of the below CSS solutions?`

Expand Down