PyCharm 3.1.0 Web Help

Some features described here are available in Professional edition only.

PyCharm supports integration with the Node.js framework thus enabling running, debugging, and unit testing of Node.js applications.

PyCharm recognizes Node.js code and provides basic coding assistance and highlighting for it. To get guidance in Node development, see HowToNode.org.

In this section:

Prerequisites

  1. Node.js framework is downloaded and installed on your computer.
  2. The Node.js plugin is installed and enabled.

    The plugin is not bundled with PyCharm, but it is available from the PyCharm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PyCharm projects.

Changes to the UI

The Node.js plugin introduces the following changes to the PyCharm UI:

  • Node.js page is added to the Settings dialog box.
  • Dedicated button update_node_js.png appears on the main toolbar. Clicking this button opens the Node.js settings dialog box.
  • Run/debug configurations are added.
To enable Node.js support in PyCharm
  1. Make sure that the Node.js framework is downloaded and installed on your computer.
  2. Install and enable the Node.js repository plugin.
  3. Restart PyCharm for the changes to take effect.
To configure the Node.js interpreter
  1. Do one of the following:
  2. In the Node.js page, specify the location of the desired Node.js interpreter.

    PyCharm displays the version of the interpreter.

  3. Configure the Node.js core module sources if they are not configured yet.
To configure Node core module sources

When developing a Node.js application it can be convenient to have code completion, reference resolution, validation, and debugging capabilities for Node core modules (fs\, path, http, etc.). However, these modules are compiled into the Node.js binary. PyCharm provides the ability to configure these sources as a JavaScript library and associate it with your project.

  1. Do one of the following:
  2. Click the Configure button. The Setting Up Node.js Sources dialog box opens.
  3. In the Node.js sources location area, specify where to take the Node.js core module sources to use.
    • If you have not downloaded the sources in any format yet, choose the Download from the Internet option. PyCharm will download them from the default location depending on the Node.js version used, arrange them in a Node.js 0.6.12 Core Library JavaScript library, and store the library in the PyCharm system local folder.
    • If you have already downloaded the sources but have not extracted them from the archive, choose the Archive file: option. Specify the location of the downloaded archive in the File text box. Type the path to the file manually or click the Browse button browseButton.png and choose the file in the dialog box that opens.
    • If you have already downloaded and extracted the sources, choose the Directory: option. In the Source root directory text box, specify the folder where the sources have been extracted to. Type the path to the folder manually or click the Browse button browseButton.png and choose the folder in the dialog box that opens.
  4. In the Usage scope area, specify the visibility (Global or Project) and availability of the library to be configured.
    • To restrict the visibility of the sources and the ability to reference them to the current project, select the Associate with project check box. PyCharm will configure the sources as a Project library and automatically enable referencing them from the entire current project. However you will be unable to associate them with any other projects later.
    • To enable the use of the configured sources at the PyCharm level, clear the Associate with project check box. PyCharm will configure the sources as a Global library, so you will be able to associate them with other projects. However, the configured library will not be automatically associated with the current project, so you will have to configure its usage scope manually.
  5. Click the Configure button to start configuring the sources as a JavaScript library.
  6. After the library configuration is completed, customize the library usage scope, if necessary. Click the Edit usage scope link. In the Usage Scope dialog box that opens, click the desired directories, and from the drop-down list select the newly configured Node.js core module sources library.

    Note

    The use of a library is enabled recursively, that is, if a library is associated with a folder it is automatically enabled in all the nested directories and files.

See Also

Procedures:

Reference:

External Links:

Web Resources: