docs: init documentaion #547

rishabh3112 · 2018-07-16T07:15:23Z

What kind of change does this PR introduce?

documentation of init feature
Did you add tests for your changes?
no
If relevant, did you update the documentation?
yes
Does this PR introduce a breaking change?

no
Other information
Refers #247

Add setup walk through and add usage description

jsf-clabot · 2018-07-16T07:15:25Z

All committers have signed the CLA.

dhruvdutt · 2018-07-16T08:05:38Z

INIT.md

+1. Create `package.json` through npm
+
+	```shell
+    	$ npm init


Trim the whitespace in left.

Will do it!

Never seen shell markdown. Is it an alias of bash?

shell used in github flavoured markdown alias to bash in common markdown

shell, bash, sh are just kinda labels. None reflects anything in syntax highlighting.

dhruvdutt · 2018-07-16T08:06:15Z

INIT.md

+    	$ npm install --save-dev webpack webpack-cli
+    ```
+
+3. Optional step : Install @webpack-cli/init package to add init addon


This shouldn't be optional I guess because this document is exclusive for the init command.

When webpack-cli init is runned it install the package on its own.
Given step 2 is followed

I think it should be mandatory, not optional

dhruvdutt · 2018-07-16T08:06:44Z

INIT.md

+    	...
+        "scripts": {
+        	...
+            "project-init" : "webpack-cli init",


No need for this step. We can directly do webpack-cli init

We cant do that directly if webpack-cli isnt installed globally.
I mean wasnt when I unlinked the github repo and installed from npm

dhruvdutt is right, there's no need of the npm script. If the user followed up to the second step, they can simply run the cli command through

npx webpack-cli init

If the package is installed locally, or

webpack-cli init

If the package is installed globally. I think we should make this distinction during all the steps, otherwise the users gets confused

Does npx comes up with npm? as i think it is a package that needed to be installed using npm itself, increasing dependency. maybe?!

Yes npx comes with npm out of the box! It has no deps and it won't be part of the package.json.

Great! just discovered and is coming since npm 5.2!!
So, should we also add up global setup @ematipico ?

I would say so! So we'd cover all cases and we clear up everything!

evenstensberg

Seems like @ematipico & @dhruvdutt got their hands on this one :)

webpack-bot · 2018-07-17T07:21:54Z

Hi @rishabh3112.

Just a little hint from a friendly bot about the best practice when submitting pull requests:

Don't submit pull request from your own master branch. It's recommended to create a feature branch for the PR.

You don't have to change it for this PR, just make sure to follow this hint the next time you submit a PR.

Help Needed: setting up webpack-cli globally

rishabh3112 · 2018-07-17T07:39:20Z

Please verify global setup @dhruvdutt

dhruvdutt · 2018-07-17T09:31:46Z

INIT.md

+Follow following steps to setup `webpack-cli init` globally:
+1. Install `webpack` and `webpack-cli` globally
+	```shell
+	$ sudo npm install -g webpack webpack-cli


Why doing sudo? Global modules are installed at user level, not root.

If you get errors in permission if you remove sudo then you probably have installed node/npm incorrectly in your local machine. Find the fix on Google. For now, remove sudo from here. :)

Yes, I was getting errors,
Will remove sudo from both steps in next commit.

@dhruvdutt , also I wasn't able to install webpack-cli globally using npm but webpack was installed.
Added this because it is only method (i.e. using -g flag) makes sense to me.

What error are you getting?

On running this:
$ sudo npm install -g webpack-cli

npm WARN checkPermissions Missing write access to /usr/lib/node_modules/webpack-cli npm WARN webpack-cli@3.0.8 requires a peer of webpack@^4.x.x but none is installed. You must install peer dependencies yourself.

I have webpack@4.16.1
But was able to setup webpack-command

This issue is not related to webpack-cli. It happens because you've installed node/npm with incorrect permission. This is a common issue which I've also experienced it. You can Google it and find a fix.

Yeah I was able to fix it by setting it up using nvm .

dhruvdutt · 2018-07-17T09:34:00Z

INIT.md

+$ webpack-cli init
+```
+
+### Questions asked by generator


Nice work. 💯 🥇

How about mentioning which specific property/key the question is related to and also provide a link to webpack docs for every question? Similar to how you did for entry. :)

Sure, I will where ever possible in next commit.

this has been resolved @dhruvdutt ?

Looks good. Why have we skipped mentioning property for the last question?

dhruvdutt · 2018-07-17T09:34:41Z

INIT.md

+    $ npm install --save-dev webpack webpack-cli
+    ```
+
+3. Install @webpack-cli/init package to add init addon


~~@webpack-cli/init~~ => @webpack-cli/init

dhruvdutt · 2018-07-17T09:35:43Z

INIT.md

+	$ sudo npm install -g webpack webpack-cli
+	```
+
+2. Install @webpack-cli/init package to add init addon


~~@webpack-cli/init~~ => @webpack-cli/init

Add Property/keys section under each question and other minor changes

webpack-bot · 2018-07-17T11:04:18Z

Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon.

rishabh3112 · 2018-07-19T03:31:22Z

Any Changes Required @ematipico

ematipico · 2018-07-19T06:19:38Z

INIT.md

+2. Install `webpack` and `webpack-cli` as devDependencies
+
+	```shell
+    $ npm install --save-dev webpack webpack-cli


I'd be consistent and would write --save-dev or -D, not both. They are basically the same. -D is just an alias

Updated it @ematipico

ematipico

Just a really minor change, but overall it looks good to me!

Change -D flag to --save-dev flag

webpack-bot · 2018-07-19T06:36:55Z

@rishabh3112 Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@ematipico Please review the new changes.

dhruvdutt · 2018-07-19T12:10:56Z

@rishabh3112 Awesome work. Cheers and thank you for being so thorough. 💯 ❤️

rishabh3112 added 2 commits July 16, 2018 12:39

docs: init documentaion

7ca754b

Add setup walk through and add usage description

docs: init documentaion

8ba7f10

Add setup walk through and add usage description

webpack-bot added the PR: unreviewed label Jul 16, 2018

rishabh3112 mentioned this pull request Jul 16, 2018

[Docs]: Update README and Contributing guidelines #247

Closed

7 tasks

dhruvdutt reviewed Jul 16, 2018

View reviewed changes

dhruvdutt requested changes Jul 16, 2018

View reviewed changes

webpack-bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Jul 16, 2018

dhruvdutt requested review from ematipico and evenstensberg July 16, 2018 08:07

evenstensberg reviewed Jul 16, 2018

View reviewed changes

docs: init documentation

6280abe

Help Needed: setting up webpack-cli globally

webpack-bot added PR: review-outdated and removed PR: reviewed-changes-requested labels Jul 17, 2018

dhruvdutt reviewed Jul 17, 2018

View reviewed changes

docs: init documentaion

6112043

Add Property/keys section under each question and other minor changes

webpack-bot added the PR: CI-ok label Jul 17, 2018

ematipico reviewed Jul 19, 2018

View reviewed changes

ematipico approved these changes Jul 19, 2018

View reviewed changes

webpack-bot added PR: reviewed-approved and removed PR: review-outdated labels Jul 19, 2018

docs: init documentation

a30d684

Change -D flag to --save-dev flag

webpack-bot added PR: review-outdated and removed PR: reviewed-approved labels Jul 19, 2018

ematipico approved these changes Jul 19, 2018

View reviewed changes

webpack-bot added PR: reviewed-approved and removed PR: review-outdated labels Jul 19, 2018

evenstensberg approved these changes Jul 19, 2018

View reviewed changes

dhruvdutt approved these changes Jul 19, 2018

View reviewed changes

dhruvdutt merged commit 3b40708 into webpack:master Jul 19, 2018

docs: init documentaion #547

docs: init documentaion #547

Conversation

rishabh3112 commented Jul 16, 2018

jsf-clabot commented Jul 16, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ematipico Jul 16, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evenstensberg left a comment

Choose a reason for hiding this comment

webpack-bot commented Jul 17, 2018

rishabh3112 commented Jul 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webpack-bot commented Jul 17, 2018

rishabh3112 commented Jul 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ematipico left a comment

Choose a reason for hiding this comment

webpack-bot commented Jul 19, 2018

dhruvdutt commented Jul 19, 2018

jsf-clabot commented Jul 16, 2018 •

edited

ematipico Jul 16, 2018 •

edited