Skip to content

Commit 577c4e8

Browse files
bondzgaearon
authored andcommitted
Document debugging in the browser. (facebook#1540)
* Document debugging in the browser. * Styling
1 parent bec009c commit 577c4e8

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

packages/react-scripts/template/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ You can find the most recent version of this guide [here](https://github.com/fac
1616
- [Supported Language Features and Polyfills](#supported-language-features-and-polyfills)
1717
- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor)
1818
- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor)
19+
- [Debugging in the Editor](#debugging-in-the-editor)
1920
- [Changing the Page `<title>`](#changing-the-page-title)
2021
- [Installing a Dependency](#installing-a-dependency)
2122
- [Importing a Component](#importing-a-component)
@@ -247,6 +248,35 @@ npm install -g eslint-config-react-app@0.3.0 eslint@3.8.1 babel-eslint@7.0.0 esl
247248

248249
We recognize that this is suboptimal, but it is currently required due to the way we hide the ESLint dependency. The ESLint team is already [working on a solution to this](https://github.com/eslint/eslint/issues/3458) so this may become unnecessary in a couple of months.
249250

251+
## Debugging in the Editor
252+
253+
**This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) editor.**
254+
255+
Visual Studio Code supports live-editing and debugging out of the box with Create React App. This enables you as a developer to write and debug your React code without leaving the editor, and most importantly it enables you to have a continuous development workflow, where context switching is minimal, as you don’t have to switch between tools.
256+
257+
You would need to have the latest version of [VS Code](https://code.visualstudio.com) and VS Code [Chrome Debugger Extension](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) installed.
258+
259+
Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory.
260+
261+
```json
262+
{
263+
"version": "0.2.0",
264+
"configurations": [{
265+
"name": "Chrome",
266+
"type": "chrome",
267+
"request": "launch",
268+
"url": "http://localhost:3000",
269+
"webRoot": "${workspaceRoot}/src",
270+
"userDataDir": "${workspaceRoot}/.chrome",
271+
"sourceMapPathOverrides": {
272+
"webpack:///src/*": "${webRoot}/*"
273+
}
274+
}]
275+
}
276+
```
277+
278+
Start your app by running `npm start`, and start debugging in VS Code by pressing `F5` or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor.
279+
250280
## Changing the Page `<title>`
251281

252282
You can find the source HTML file in the `public` folder of the generated project. You may edit the `<title>` tag in it to change the title from “React App” to anything else.

0 commit comments

Comments
 (0)