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.

Sign up for GitHub

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

Add note for using CHOKIDAR_USEPOLLING in virtual machines to enable HMR #1608

Merged
merged 5 commits into from
Feb 22, 2017
Merged

Add note for using CHOKIDAR_USEPOLLING in virtual machines to enable HMR #1608

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52c0cc2
Add note for using CHOKIDAR_USEPOLLING in virtual machines to enable HMR
AJamesPhillips Feb 21, 2017
7465a51
Use br in react-scripts template README md
AJamesPhillips Feb 22, 2017
153b476
Use br in md for new line breaks
AJamesPhillips Feb 22, 2017
415c165
Update troubleshooting HMR to allow for VMs running Windows
AJamesPhillips Feb 22, 2017
b1565a1
Fix up the instructions
gaearon Feb 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ This ensures it become a part of the build output, and resolves correctly both w

## 0.4.3 (September 18, 2016)

This is a hotfix release for a broken package.
This is a hotfix release for a broken package.<br>
It contained no changes to the code.

### Build Dependency (`react-scripts`)
Expand Down Expand Up @@ -913,7 +913,7 @@ npm install --save-dev --save-exact react-scripts@0.3.0

#### Breaking Change

Now `favicon.ico` is not treated specially anymore.
Now `favicon.ico` is not treated specially anymore.<br>
If you use it, move it to `src` and add the following line to `<head>` in your HTML:

```html
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Following these guidelines helps to communicate that you respect the time of the

As much as possible, we try to avoid adding configuration and flags. The purpose of this tool is to provide the best experience for people getting started with React, and this will always be our first priority. This means that sometimes we [sacrifice additional functionality](https://gettingreal.37signals.com/ch05_Half_Not_Half_Assed.php) (such as server rendering) because it is too hard to solve it in a way that wouldn’t require any configuration.

We prefer **convention, heuristics, or interactivity** over configuration.
We prefer **convention, heuristics, or interactivity** over configuration.<br>
Here’s a few examples of them in action.

### Convention
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Create React apps with no build configuration.
* [Getting Started](#getting-started) – How to create a new app.
* [User Guide](/~https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.

Create React App works on macOS, Windows, and Linux.
Create React App works on macOS, Windows, and Linux.<br>
If something doesn’t work please [file an issue](/~https://github.com/facebookincubator/create-react-app/issues/new).

## tl;dr
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-preset-react-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# babel-preset-react-app

This package includes the Babel preset used by [Create React App](/~https://github.com/facebookincubator/create-react-app).
This package includes the Babel preset used by [Create React App](/~https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [Getting Started](/~https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
Expand Down
2 changes: 1 addition & 1 deletion packages/create-react-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# create-react-app

This package includes the global command for [Create React App](/~https://github.com/facebookincubator/create-react-app).
This package includes the global command for [Create React App](/~https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [Getting Started](/~https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-config-react-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# eslint-config-react-app

This package includes the shareable ESLint configuration used by [Create React App](/~https://github.com/facebookincubator/create-react-app).
This package includes the shareable ESLint configuration used by [Create React App](/~https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [Getting Started](/~https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
Expand Down
20 changes: 10 additions & 10 deletions packages/react-dev-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react-dev-utils

This package includes some utilities used by [Create React App](/~https://github.com/facebookincubator/create-react-app).
This package includes some utilities used by [Create React App](/~https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [Getting Started](/~https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
Expand All @@ -20,7 +20,7 @@ There is no single entry point. You can only import individual top-level modules

#### `new InterpolateHtmlPlugin(replacements: {[key:string]: string})`

This Webpack plugin lets us interpolate custom variables into `index.html`.
This Webpack plugin lets us interpolate custom variables into `index.html`.<br>
It works in tandem with [HtmlWebpackPlugin](/~https://github.com/ampedandwired/html-webpack-plugin) 2.x via its [events](/~https://github.com/ampedandwired/html-webpack-plugin#events).

```js
Expand Down Expand Up @@ -58,8 +58,8 @@ module.exports = {

#### `new WatchMissingNodeModulesPlugin(nodeModulesPath: string)`

This Webpack plugin ensures `npm install <library>` forces a project rebuild.
We’re not sure why this isn't Webpack's default behavior.
This Webpack plugin ensures `npm install <library>` forces a project rebuild.<br>
We’re not sure why this isn't Webpack's default behavior.<br>
See [#186](/~https://github.com/facebookincubator/create-react-app/issues/186) for details.

```js
Expand All @@ -83,8 +83,8 @@ module.exports = {

#### `checkRequiredFiles(files: Array<string>): boolean`

Makes sure that all passed files exist.
Filenames are expected to be absolute.
Makes sure that all passed files exist.<br>
Filenames are expected to be absolute.<br>
If a file is not found, prints a warning message and returns `false`.

```js
Expand Down Expand Up @@ -161,8 +161,8 @@ getProcessForPort(3000);

#### `openBrowser(url: string): boolean`

Attempts to open the browser with a given URL.
On Mac OS X, attempts to reuse an existing Chrome tab via AppleScript.
Attempts to open the browser with a given URL.<br>
On Mac OS X, attempts to reuse an existing Chrome tab via AppleScript.<br>
Otherwise, falls back to [opn](/~https://github.com/sindresorhus/opn) behavior.


Expand All @@ -179,8 +179,8 @@ if (openBrowser('http://localhost:3000')) {

This function displays a console prompt to the user.

By convention, "no" should be the conservative choice.
If you mistype the answer, we'll always take it as a "no".
By convention, "no" should be the conservative choice.<br>
If you mistype the answer, we'll always take it as a "no".<br>
You can control the behavior on `<Enter>` with `isYesDefault`.

```js
Expand Down
2 changes: 1 addition & 1 deletion packages/react-scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react-scripts

This package includes scripts and configuration used by [Create React App](/~https://github.com/facebookincubator/create-react-app).
This package includes scripts and configuration used by [Create React App](/~https://github.com/facebookincubator/create-react-app).<br>
Please refer to its documentation:

* [Getting Started](/~https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
Expand Down
9 changes: 5 additions & 4 deletions packages/react-scripts/template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ You don’t have to ever use `eject`. The curated feature set is suitable for sm

## Supported Language Features and Polyfills

This project supports a superset of the latest JavaScript standard.
This project supports a superset of the latest JavaScript standard.<br>
In addition to [ES6](/~https://github.com/lukehoban/es6features) syntax features, it also supports:

* [Exponentiation Operator](/~https://github.com/rwaldron/exponentiation-operator) (ES2016).
Expand Down Expand Up @@ -402,7 +402,7 @@ Then in `package.json`, add the following lines to `scripts`:
"test": "react-scripts test --env=jsdom",
```

>Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation.
>Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation.

Now you can rename `src/App.css` to `src/App.scss` and run `npm run watch-css`. The watcher will find every Sass file in `src` subdirectories, and create a corresponding CSS file next to it, in our case overwriting `src/App.css`. Since `src/App.js` still imports `src/App.css`, the styles become a part of your application. You can now edit `src/App.scss`, and `src/App.css` will be regenerated.

Expand Down Expand Up @@ -1355,10 +1355,10 @@ You can find instructions in [Deploying React with Zero Configuration](https://b

Sometimes `npm run build` works locally but fails during deploy via Heroku with an error like this:

```
```
remote: Failed to create a production build. Reason:
remote: Module not found: Error: Cannot resolve 'file' or 'directory'
MyDirectory in /tmp/build_1234/src
MyDirectory in /tmp/build_1234/src
```

This means you need to ensure that the lettercase of the file or directory you `import` matches the one you see on your filesystem or on GitHub.
Expand Down Expand Up @@ -1452,6 +1452,7 @@ If this doesn’t happen, try one of the following workarounds:
* Some editors like Vim and IntelliJ have a “safe write” feature that currently breaks the watcher. You will need to disable it. Follow the instructions in [“Working with editors supporting safe write”](https://webpack.github.io/docs/webpack-dev-server.html#working-with-editors-ides-supporting-safe-write).
* If your project path contains parentheses, try moving the project to a path without them. This is caused by a [Webpack watcher bug](/~https://github.com/webpack/watchpack/issues/42).
* On Linux and macOS, you might need to [tweak system settings](https://webpack.github.io/docs/troubleshooting.html#not-enough-watchers) to allow more watchers.
* Inside virtual machines such as (a Vagrant provisioned) VirtualBox, [use `CHOKIDAR_USEPOLLING=true npm start`](/~https://github.com/facebookincubator/create-react-app/issues/1049#issuecomment-261731734).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this problem occur on Windows? If it can, we should recommend running npm i --save-dev cross-env and then replacing npm start with cross-env CHOKIDAR_USEPOLLING=true npm start.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if the problem will occur on Windows. I'm happy to add this advice if you think we should but perhaps we can wait until someone reports a problem on Windows (whilst attempting to use CHOKIDAR_USEPOLLING=true npm start) ?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd rather not wait until somebody complains, better be safe than sorry. It is very frustrating for Windows users when docs assume they don't exist.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I didn't mean it that way. Just meant that I'd prefer not to document a solution to a problem that might not exist (as it would clutter the docs with irrelevant info). But it sounds like you're pretty sure it is a problem. Have added the line to the docs. :)


If none of these solutions help please leave a comment [in this thread](/~https://github.com/facebookincubator/create-react-app/issues/659).

Expand Down
2 changes: 1 addition & 1 deletion template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This page has moved!
This page has moved!<br>
Please update your link to point [here](/~https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) instead.

Sorry for the inconvenience!