Improve `npm run eject` description #363

btnwtn · 2016-08-04T21:25:11Z

I feel as if the description for npm run eject is incredibly vague. eject does more than just removing the tool and that should be explained to the user.

I feel as if the description for `npm run eject` is incredibly vague. `eject` does more than just removing the tool and that should be explained to the user.

Improve `npm run eject` description

ghost · 2016-08-04T21:25:24Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla - and if you have received this in error or have any questions, please drop us a line at cla@fb.com. Thanks!

ghost · 2016-08-04T21:42:32Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

gaearon · 2016-08-04T22:48:55Z

Can you show the screenshot?

If this doesn't look very well we should just reformat the whole message.

We can use chalk inversion to highlight commands, and write small descriptions below.

btnwtn · 2016-08-05T21:34:27Z

@gaearon screenshots supplied. Looks OK.

Sorry for the massive images!

gaearon · 2016-09-02T17:17:59Z

I don’t like that npm run eject prints multiple lines, inconsistent with earlier commands.
Can you please split list into separate sections with headers?

I was thinking something like

npm start

  Starts...

npm run build

  ...

npm test

  ...

npm run eject

  ...

We suggest that you ...

Where all commands (npm start etc) are wrapped in chalk.cyan() (see scripts/build.js for example of this) so that they appear highlighted.

What do you think?

btnwtn · 2016-09-03T14:07:06Z

@gaearon sounds good to me, I'll have some time Monday to implement this. 👍

btnwtn · 2016-09-10T05:00:00Z

@gaearon I've committed the changes that add better formatting and highlighting. Unfortunately, I've generated a node-debug log that I can't seem to get rid of 😦

fson · 2016-09-11T13:22:32Z

@btnwtn You can get rid of the npm-debug.log file with git rm:

git rm npm-debug.log
git commit -m "Remove npm-debug.log"
git push origin master  # Push to your GitHub remote

Alternatively you can also remove it directly from the GitHub web interface, if you go to https://github.com/btnwtn/create-react-app/blob/master/npm-debug.log and click the thrash can icon.

fson · 2016-09-11T13:56:58Z

scripts/init.js

+    console.log('  Bundles the app into static files for production.');
+    console.log();
+    console.log(chalk.cyan('npm run eject'));
+    console.log('  Removes this tool and copies build dependencies, configs, and scripts into the app directory.')


The new message looks good to me. But let's wrap this line at 80 characters, so it doesn't break with the "standard" terminal window size.

btnwtn · 2016-09-11T16:58:12Z

Deleted npm-debug.log and fit npm script descriptions to 80 characters. Looks good to me 😄

fson · 2016-09-11T17:03:01Z

Thanks @btnwtn! Can you also merge create-react-app master branch into yours to resolve the conflicts. Happy to merge as soon as that's done.

btnwtn · 2016-09-11T17:09:23Z

Having issues with git... git pull says everything is up-to-date. I tried rebasing the commit(?) but that hasn't done anything. @fson what should I do?

Can't figure this out :\

With the HTTPS env var set 'true', the dev server will serve over HTTPS.

* Clarify proxy instructions in generated app README * Add backticks to format text/html as code

For the 0.4.0 CHANGELOG entry, the npm install command should be: ``` npm install --save-dev --save-exact react-scripts@0.4.0 ``` Not: ``` npm install --save-dev --save-exact react-scripts@0.3.1 ```

* Change http-proxy-middleware logLevel from silent to error * provide onError handler for httpProxyMiddleware

* Adds JSX extension support * PR changes * Add testRegex * Add note about not recommending JSX, link to issue

…dleware. (#588) * Change http-proxy-middleware logLevel from silent to error * provide onError handler for httpProxyMiddleware * Send proper error reponse upon proxy error.

* Warn about unsupported Node.js versions Add the `engines` field to package.json so users of old Node.js versions will at least get a warning when trying to install create-react-app or react-scripts, e.g.: npm WARN engine create-react-app@0.3.0: wanted: {"node":">=6"} (current: {"node":"4.2.3","npm":"2.14.7"}) * Remove duplicated field and extra whitespace * Change the engine version back to 4

The regexes in the Jest `moduleNameMapper` configs were a bit too strict, causing them to not pick up files with special characters like `@` in the file path. Change them to match anything with the correct file extension.

…with docker node (#620) * Specify cache directory for babel loader * Use `react-scripts` for folder name instead

Resolves an issue that can occur in certain situations that causes a build error when user has CDed into an incorrectly cased directory.

btnwtn · 2016-09-11T18:05:45Z

Oh for fucks sake. I'm going to close this, re-fork, and open a new pull request. @fson

btnwtn added 2 commits August 4, 2016 14:24

Improve npm run eject description

5a045b4

I feel as if the description for `npm run eject` is incredibly vague. `eject` does more than just removing the tool and that should be explained to the user.

Merge pull request #1 from btnwtn/btnwtn-improve-eject-description

d1b3142

Improve `npm run eject` description

ghost added the CLA Signed label Aug 4, 2016

ghost added the CLA Signed label Aug 5, 2016

gaearon added the review-needs-changes label Sep 2, 2016

ghost added the CLA Signed label Sep 2, 2016

ghost added the CLA Signed label Sep 3, 2016

gaearon added this to the 1.0.0 milestone Sep 3, 2016

ghost added the CLA Signed label Sep 3, 2016

Better formatting of command descriptions

4dbe43b

ghost added the CLA Signed label Sep 10, 2016

ghost added the CLA Signed label Sep 11, 2016

fson reviewed Sep 11, 2016
View reviewed changes

btnwtn added 2 commits September 11, 2016 09:56

Fit npm script descriptions to 80 character width

5261af2

Delete npm-debug.log

c1e5665

btnwtn added 2 commits September 11, 2016 10:07

Resolve rebase

6517ea3

Remove stray comment

5767ccc

ghost added the CLA Signed label Sep 11, 2016

Merge master

02e9b20

dceddia and others added 26 commits September 11, 2016 11:02

Look for HTTPS environment variable (#430)

6287030

With the HTTPS env var set 'true', the dev server will serve over HTTPS.

Add 0.4.0 changelog

3e12578

0.4.0

a6668c2

Mention npm test in init output

a0d79ac

Clarify proxy instructions in generated app README (#537)

c35b806

* Clarify proxy instructions in generated app README * Add backticks to format text/html as code

Fix tasks

3880051

Fix typo

03a65fc

fix typo setupTest.js -> setupTests.js (#555)

edd9383

Fix version in CHANGELOG npm install command (#557)

ad332ed

For the 0.4.0 CHANGELOG entry, the npm install command should be: ``` npm install --save-dev --save-exact react-scripts@0.4.0 ``` Not: ``` npm install --save-dev --save-exact react-scripts@0.3.1 ```

Provide custom onError handler for http-proxy-middleware (#502)

b46617e

* Change http-proxy-middleware logLevel from silent to error * provide onError handler for httpProxyMiddleware

Add missing breaking change description from 0.3.0 (#562)

31651e8

Fix e2e test (#561)

d7c4cb0

Document #564

c9aee5b

Adds JSX extension support (#563)

9d8a2f9

* Adds JSX extension support * PR changes * Add testRegex * Add note about not recommending JSX, link to issue

Fix local end-to-end testing flow (#566)

fffcdda

Add 0.4.1 changelog

9dd60d6

0.4.1

4914615

Update Flow instructions (#567)

c1161d6

Add a note on decorators

79d4e10

Send proper error response in custom onError handler for httpProxyMid…

93dbdbf

…dleware. (#588) * Change http-proxy-middleware logLevel from silent to error * provide onError handler for httpProxyMiddleware * Send proper error reponse upon proxy error.

Avoid tons of *.json.gzip-files created in project root when running …

6139e6d

…with docker node (#620) * Specify cache directory for babel loader * Use `react-scripts` for folder name instead

Add support for *.jpeg file extension. (#624)

9bf7939

Bump case-sensitive-paths-webpack-plugin version (#593)

51f16e7

Resolves an issue that can occur in certain situations that causes a build error when user has CDed into an incorrectly cased directory.

Better formatting of command descriptions

eb19f41

btnwtn closed this Sep 11, 2016

btnwtn mentioned this pull request Sep 11, 2016

Improve the output of scripts/init.js #629

Merged

lock bot locked and limited conversation to collaborators Jan 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve `npm run eject` description #363

Improve `npm run eject` description #363

btnwtn commented Aug 4, 2016

ghost commented Aug 4, 2016

ghost commented Aug 4, 2016

gaearon commented Aug 4, 2016

btnwtn commented Aug 5, 2016

gaearon commented Sep 2, 2016

btnwtn commented Sep 3, 2016

btnwtn commented Sep 10, 2016

fson commented Sep 11, 2016

fson Sep 11, 2016

btnwtn commented Sep 11, 2016

fson commented Sep 11, 2016

btnwtn commented Sep 11, 2016 •

edited

Loading

btnwtn commented Sep 11, 2016 •

edited

Loading

Improve npm run eject description #363

Improve npm run eject description #363

Conversation

btnwtn commented Aug 4, 2016

ghost commented Aug 4, 2016

ghost commented Aug 4, 2016

gaearon commented Aug 4, 2016

btnwtn commented Aug 5, 2016

gaearon commented Sep 2, 2016

btnwtn commented Sep 3, 2016

btnwtn commented Sep 10, 2016

fson commented Sep 11, 2016

fson Sep 11, 2016

Choose a reason for hiding this comment

btnwtn commented Sep 11, 2016

fson commented Sep 11, 2016

btnwtn commented Sep 11, 2016 • edited Loading

btnwtn commented Sep 11, 2016 • edited Loading

Improve `npm run eject` description #363

Improve `npm run eject` description #363

btnwtn commented Sep 11, 2016 •

edited

Loading

btnwtn commented Sep 11, 2016 •

edited

Loading