JetBrains Rider 2017.2 Help

Node.js

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

In this section:

Introduction

JetBrains Rider supports integration with the Node.js runtime environment thus enabling running, debugging, and unit testing of Node.js applications.

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

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 JetBrains Rider, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

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

  • Node.js page is added to the Settings dialog box.
  • Run/debug configurations are added.

Configuring Node.js in JetBrains Rider

  1. Open the Settings/Preferences by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or JetBrains Rider | Preferences for macOS, and click Node.js and NPM under Languages & Frameworks. The Node.js and NPM page opens.
  2. In the Node Interpreter field, specify the local Node.js interpreter to use. Choose the interpreter from the drop-down list or click browseButton and choose the interpreter in the dialog box that opens.

    The term local Node.js interpreter denotes a Node.js installation on your computer. The term remote Node.js interpreter denotes a Node.js installation on a remote host or in a virtual environment set up in a Vagrant instance. On the Node.js and NPM page, you can specify only local interpreters. Remote interpreters are configured in the Configure Node.js Remote Interpreter Dialog dialog which can be accessed only from the Run/Debug Configuration: Node.js dialog. See Configuring Node.js Interpreters for details.

  3. In the Code Assistance area, configure the Node.js core module sources if they are not configured yet.

    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. JetBrains Rider provides the ability to configure these sources as a JavaScript library and associate it with your project.

    • If the Node.js core module sources are not set up, JetBrains Rider displays a notification Node.js Core Library is not enabled with an Enable button. Click this button to have JetBrains Rider configure Node.js Core sources automatically.

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

    • If the library is set up, JetBrains Rider displays information about the currently configured version, the notification Node.js Core Library is enabled, and adds two buttons: the Disable button and the Usage scope button.
      • Click the Disable button to discard the configuration of the Node.js Core libraries in the current project.
      • Click the Usage scope button to associate the desired directories with libraries.
  4. If necessary, configure the scope in which the Node.js Core sources are treated as libraries. Click the Usage scope button, in the Usage Scope dialog box that opens click the desired directories, and select the newly configured Node.js core module sources library from the drop-down list.

    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.

Last modified: 17 November 2017