PyCharm 2017.3 Help


This feature is only supported in the Professional edition.

The following is only valid when Node.js Plugin is installed and enabled!

Node.js is a lightweight runtime environment for executing JavaScript on the server side. PyCharm integrates with Node.js providing assistance in configuring, editing, running, debugging, testing, profiling, and maintaining your applications.

Before you start

  1. Download and install the Node.js runtime environment.
  2. Install and enable the NodeJS plugin. The NodeJS plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

Quick start with a Node.js application

Here we will use a simple Express application as an example.

To create an application

  1. Choose File | New | Project on the main menu or click Create New Project on the Welcome screen. The New Project dialog box opens.
  2. In the left-hand pane, choose Node.js Express App.
  3. In the right-hand pane, specify the project folder, the Node.js interpreter, and the version of express-generator to use. In the Options area, choose the template language and the Style Sheet language to use.
  4. When you click Create, PyCharm generates a Node.js Express-specific project with all the required configuration files.

Configuring Node.js in a project

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), choose Node.js and NPM under Languages and Frameworks. The Node.js and NPM page opens.
  2. In the Node Interpreter field, choose the interpreter from the drop-down list or from the dialog that opens when you click browseButton.
  3. In the Coding Assistance area, click Enable to configure the Node.js Core module sources as a JavaScript library and associate it with your project. As a result, PyCharm provides code completion, reference resolution, validation, and debugging capabilities for fs, path, http, and other core modules that are compiled into the Node.js binary.

    When the configuration is completed, PyCharm displays information about the currently configured version, the notification Node.js Core Library is enabled, and adds the Disable and the Usage scope buttons.

Configure the scope in which the Node.js Core sources are treated as libraries:

  1. Click Usage scope. The Usage Scope dialog opens.
  2. Click the relevant directories, and for each of them select the newly configured Node.js Core library from the list.

Last modified: 28 March 2018

See Also