PhpStorm supports integration with the Node.js framework thus enabling running, debugging, and unit testing of Node.js applications.
PhpStorm 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:
Before you start
- Download and install the Node.js framework.
Install and enable the NodeJS plugin
as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
The plugin is not bundled with PhpStorm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PhpStorm projects.
- Restart PhpStorm for the changes to take effect.
The Node.js plugin introduces the following changes to the PhpStorm UI:
- Node.js page is added to the Settings dialog box.
- Run/debug configurations are added.
Configuring the Node.js interpreter
- Choose Settings dialog box that opens, click Node.js and NPM under the Languages&Frameworks node. and in the
- On the Node.Js and NPM page that opens, specify the location of the desired Node.js interpreter.
PhpStorm displays the version of the interpreter.
- Configure the Node.js core module sources if they are not configured yet.
Configuring 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 (
http, etc.). However, these modules are compiled into the Node.js binary. PhpStorm provides the ability
- Choose Settings dialog box that opens, click Node.js and NPM. and in the
- On the Node.Js and NPM page that opens, click the Configure button. The Setting Up Node.js Sources dialog box opens.
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.
PhpStorm will download them from the default location depending on the Node.js version used,
arrange them in a
- 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 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 and choose the folder in the dialog box that opens.
- If you have not downloaded the sources in any format yet, choose the Download from the Internet option. PhpStorm will download them from the default location depending on the Node.js version used, arrange them in a
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. PhpStorm 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 PhpStorm level, clear the Associate with project check box. PhpStorm 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.
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.
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.