Debug JavaScript in Chrome

Last modified: 08 September 2023

Available only in PyCharm Professional: download to try or compare editions

Required plugins:

Javascript and TypeScript, JavaScript Debugger - The plugins are available only in PyCharm Professional, where they are enabled by default.

PyCharm provides a built-in debugger for your client-side JavaScript code.

note
Debugging of JavaScript code is only supported in Google Chrome and in other Chromium-based browsers.

Before you start

Make sure the JavaScript and TypeScript bundled plugin is enabled in the settings. Press to open the IDE settings and then select Plugins. Click the Installed tab. In the search field, type JavaScript and TypeScript. For more information about plugins, refer to Managing plugins.
Make sure the JavaScript Debugger bundled plugin is enabled in the settings. Press to open the IDE settings and then select Plugins. Click the Installed tab. In the search field, type JavaScript Debugger. For more information about plugins, refer to Managing plugins.
Configure the built-in debugger as described in Configuring JavaScript debugger.
To have the changes you make to your HTML, CSS, or JavaScript code immediately shown in the browser without reloading the page, activate the Live Edit functionality. For more information about the live editing functionality, refer to Live Edit in HTML, CSS, and JavaScript.

Debug an application that is running on the built-in server

PyCharm has a built-in web server that can be used to preview and debug your application. This server is always running and does not require any manual configuration. All the project files are served on the built-in server with the root URL http://localhost:<built-in server port>/<project root>, with respect to the project structure.

Start debugging

Set the breakpoints in the JavaScript code, as required.
Open the HTML file that references the JavaScript to debug or select the HTML file in the Project tool window.
From the context menu of the editor or the selection, choose Debug <HTML_file_name>. PyCharm generates a debug configuration and starts a debugging session through it. The file opens in the browser, and the Debug tool window appears.
tip
To save the automatically generated configuration for further re-use, choose Save <HTML_file_name> from the context menu after the debugging session is over.
In the Debug tool window, proceed as usual: step through the program, stop and resume the program execution, examine it when suspended, view actual HTML DOM, run JavaScript code snippets in the Console, and so on.

tip
By default, a debugging session starts in a new window with a custom Chrome user data. To open a new Chrome instance with your familiar look-and-feel, configure Chrome in PyCharm to start with your user data. For more information, refer to Starting a debugging session with your default Chrome user data.

Example

Let's suppose that you have a simple application that consists of an index.html file and an index.js file, where index.html references index.js. To start debugging this application using the built-in server, open index.html in the editor and choose Debug 'index.html' from the context menu.

PyCharm creates a run/debug configuration automatically, and a debugging session starts.

Debugging session starts, the app opens in the browser

To restart the new run/debug configuration, click () on the toolbar or select Run | Debug from the main menu.

Reload the current page in browser

Besides restarting your application by clicking the Rerun button () in the Debug tool window, you can also click the Reload in Browser button () to reload the page where you have currently navigated. This works the same way as the Reload Page functionality () in Chrome.

The example below shows a simple application that consists of two HTML pages and a JavaScript script. The starting home.html page has a Submit button on pressing which the calculator.html page opens with the results of the Calculator.js script execution.

During a debugging session, clicking the Rerun button () would reload the home.html page with the Submit button. Clicking the Reload in Browser button () reloads the calculator.html page so all the previous script output is cleared and the debugger returns to line 1 in Calculator.js.

https://resources.jetbrains.com.cn/help/img/idea/2023.2/ws_js_debug_reload_in_browser.png

Debug an application that is running on the localhost in the development mode

If your application is running in the development mode on localhost, you can start debugging it from the built-in Terminal (), from the Run tool window, or from the Debug tool window. Just hold and click the URL at which the application is running.

https://resources.jetbrains.com.cn/help/img/idea/2023.2/ws_js_start_debugging_from_run_tool_window.png

Set the breakpoints in your code.
Start the application in the development mode, for example, using an npm script.
The Run tool window or the Terminal shows the URL at which your application is running. Hold and click this URL link. PyCharm starts a debugging session with an automatically generated configuration of the type JavaScript Debug.

This also works for debugging Vue.js, Angular, React, and Node.js applications.

Debug an application that is running on an external web server

Often you may want to debug client-side JavaScript of an application that is running on an external development web server, for example, powered by Node.js.

Set the breakpoints in the JavaScript code, as required.
Run the application in the development mode. Often you need to run npm start for that.
When the development server is ready, copy the URL address at which the application is running in the browser - you will need to specify this URL address in the run/debug configuration.
Create a debug configuration of the type JavaScript Debug: go to Run | Edit Configurations, in the Edit Configurations dialog that opens, click the Add button () on the toolbar and select JavaScript Debug from the list. In the Run/Debug Configuration: JavaScript Debug dialog that opens, specify the URL address at which the application is running. This URL can be copied from the address bar of your browser as described in Step 2 above. Click OK to save the configuration settings.
Select the newly created configuration from the Select run/debug configuration list on the toolbar and click the Run button () next to the list. The URL address specified in the run configuration opens in the browser and the Debug tool window appears.
In the Debug tool window, proceed as usual: step through the program, stop and resume the program execution, examine it when suspended, view actual HTML DOM, run JavaScript code snippets in the Console, and so on.

For more debugging examples, refer to the following posts in the WebStorm blog: Debugging React Applications and Debugging Angular Applications.

Debug asynchronous code

PyCharm supports debugging asynchronous client-side JavaScript code. PyCharm recognizes breakpoints inside asynchronous code, stops at them, and lets you step into such code. As soon as a breakpoint inside an asynchronous function is hit or you step into asynchronous code, a new element Async call from <caller> is added in the Frames pane of the Debugger tab. PyCharm displays a full call stack, including the caller and the entire way to the beginning of the asynchronous actions.

The image below shows an example of a JavaScript debugging session.

The debugger stops at line3(breakpoint), then at line5(breakpoint). On clicking Step into, the debugger will stop at line5 (on function), then will move to line6.

The asynchronous debugging mode is turned on by default. To disable asynchronous stack traces, set js.debugger.async.call.stack.depth in Registry to 0.

Debug workers

PyCharm supports debugging Service Workers and Web Workers. PyCharm recognizes breakpoints in each worker and shows the debug data for it as a separate thread in the Frames pane on the Debugger tab of the Debug tool window.

Note that PyCharm can debug only dedicated workers, debugging for shared workers is currently not supported.

Set the breakpoints in the Workers to debug.
If you are using Service Workers, make sure the Allow unsigned requests checkbox is selected on the Debugger page (Settings| Build, Execution, Deployment | Debugger). Otherwise your service workers may be unavailable during a debug session.
Create a debug configuration of the type JavaScript Debug as described above in Debugging client-side JavaScript running on an external web server.
Select the newly created configuration from the Select run/debug configuration list on the toolbar and click the Debug button () next to the list.
The HTML file specified in the run configuration opens in the browser and the Debug tool window opens with the Frames list showing all the Workers:
To examine the data (variables, watches, and so on) for a Worker, select its thread in the list and view its data in the Variables and Watches panes. When you select another Worker, the contents of the panes are updated accordingly.

Debug JavaScript in Chrome

See also

Procedures

Reference

Tutorials and Examples

Debug JavaScript in Chrome﻿

note

Before you start﻿

Debug an application that is running on the built-in server﻿

Start debugging﻿

tip

tip

Example﻿

Reload the current page in browser﻿

Debug an application that is running on the localhost in the development mode﻿

Debug an application that is running on an external web server﻿

Debug asynchronous code﻿

Debug workers﻿

See also

Procedures

Reference

Tutorials and Examples

Debug JavaScript in Chrome

Before you start

Debug an application that is running on the built-in server

Start debugging

Example

Reload the current page in browser

Debug an application that is running on the localhost in the development mode

Debug an application that is running on an external web server

Debug asynchronous code

Debug workers