PyCharm
 
2022.3
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Web Development
  2. JavaScript
  3. Find unused code with coverage

Find unused code with coverage

Last modified: 29 September 2022

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 lets you find unused JavaScript, TypeScript, and CSS code in your client-side applications. When you run an application in the special Code Coverage mode, PyCharm creates a report showing how much code in every file and folder was used. Thanks to source maps, this report shows coverage for your source files but not for the compiled code that was actually run in the browser.

Run an application in the Code Coverage mode

  1. Create a run/debug configuration of the type JavaScript Debug:

    Choose Run | Edit Configurations from the main menu, In the Edit Configurations dialog that opens, click the Add button (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.

    tip

    Because the JavaScript Debug configuration works only with Chrome, the Code Coverage mode is also available only in this browser.

  2. Choose the newly created configuration in the Select run/debug configuration list on the toolbar and click the Run with Coverage button (the Run with Coverage button) next to the list.

    Start app with coverage

    The URL address specified in the run configuration opens in the browser.

  3. To learn what code was executed during the page load, just load the application and then stop it by clicking the Stop button (the Stop button) on the toolbar, next to the Run with Coverage button (the Run with Coverage button), or in the Run tool window. If you need a coverage report for some specific features of your application, trigger these features in the browser and only then click the Stop button (the Stop button) to stop the application.

  4. View the report in the Coverage tool window. The Project tool window shows information about the coverage of files and folders. In the editor, the gutter shows green markers next to the lines that were executed and red markers next to those that were not. You can also hover over the line markers and see how many times each line of code was hit.

    Coverage report