Node.js with Docker

Install and enable the Node.js Remote Interpreter plugin on the Settings/Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

Make sure the Node.js and Docker required plugins are enabled on the Settings/Preferences | Plugins page, tab Installed, see Managing plugins for details.

Download, install, and configure Docker as described in Docker

Open the Settings/Preferences dialog (Ctrl+Alt+S) and go to Languages & Frameworks | Node.js.

Click next to the Node interpreter field.

In the Node.js Interpreters dialog with a list of all the currently configured interpreters, click on the toolbar and select Add Remote from the context menu .

In the Configure Node.js Remote Interpreter dialog that opens, select Docker.

From the Server list, select the Docker configuration to use.

Alternatively, click New next to the field and configure a Docker server as described in Enable Docker support.

From the Image name list, select the image to use.

The Node.js executable is detected automatically and shown in the Node.js interpreter path field.

Click OK to return to the Node.js Interpreters dialog where the new interpreter is added to the list.

To set the newly configured interpreter as project default, select it in the list. PhpStorm automatically uses this interpreter every time you select the Project alias from Node Interpreter lists, for example, when creating run/debug configurations. Click OK to return to the Node.js dialog.

To use the package manager associated with the new interpreter for managing your project dependencies, set this package manager as default in your project. To do that, specify the location of the package manager in the Package manager field.

• The default location for npm executable is /usr/local/lib/node_modules/npm.

• The default location for pnpm depends on the installation method:

  • /usr/local/lib/node_modules/pnpm for installation through npm.

  • /usr/local/pnpm-global/<version>/node_modules/pnpm for installation through curl (curl -f https://get.pnpm.io/<version>.js | node - add --global pnpm).

  Learn more from the pnpm official website.

• The default location for yarn is /opt/yarn-<version>5, for example, /opt/yarn-v1.22.5.

From the main menu, select Run | Edit Configurations. In the Edit Configuration dialog that opens, click on the toolbar and select Node.js from the context menu. The Run/Debug Configuration: Node.js dialog opens.

In the JavaScript File field, specify the path to the main file of the application that starts it (for example, bin/www for Express applications).

If necessary, specify some optional settings as described in Running and debugging Node.js applications.

From the Node interpreter list, select the relevant remote Node.js interpreter in a Docker environment.

Alternatively, Click next to the Node interpreter field and configure a remote Node.js interpreter as described above.

Specify the Docker container settings.

Click next to the Edit Docker Container Settings field and specify the settings in the Edit Docker Container Settings dialog that opens.

Basically, you need to bind the port on which your application is running with the port of the container.

To bind ports:

1. Expand the Port bindings area and click on the toolbar. The Port bindings dialog that opens, map the ports as follows:

2. Click Modify options and select the options that you want to specify:

   

3. • In the Container port field, type the port specified in your application.

   • In the Host port field, type an arbitrary port through which you want the application to be accessed from your computer.

   • In the Host IP field, type the IP address of the Docker's host. If you are using localhost, type 127.0.0.1.

     

   • Click OK to return to the Edit Docker Container Settings dialog where the new port binding is added to the list.

   

4. Click OK to return to the Run/Debug Configuration: Node.js dialog where the port binding is shown to the Docker container settings field.

Create a Node.js run/debug configuration as described above.

From the Select run/debug configuration list on the toolbar, select the newly created Node.js configuration.

Click to the Select run/debug configuration list.

Set the breakpoints in the Node.js code as necessary.

Create a Node.js configuration as described above, select it from the Select run/debug configuration list on the toolbar, and click next to the list.

Proceed as when starting the debugger together with a Node.js application locally.

Make sure a relevant remote Node.js interpreter in Docker is configured and selected as default for your project. Also make sure the package manager associated with this remote interpreter is set as project default. See Configure a Node.js interpreter in Docker and npm, pnpm, and yarn with Docker for details.

Open your package.json and make sure the required test framework is listed in the devDependencies section:

Right-click anywhere in the editor and select Run '<package manager> install' from the context menu.

Create tests according to the instructions from the Mocha official website or Jest official website.

Run and debug single tests right from the editor or create a run/debug configuration to launch some or all of your tests as described in Running Mocha tests, Debugging Mocha tests, Running Jest tests, and Debugging Jest tests.

Make sure a relevant remote Node.js interpreter in Docker is configured and selected as default for your project. Also make sure the package manager associated with this remote interpreter is set as project default. See Configure a Node.js interpreter in Docker and npm, pnpm, and yarn with Docker for details.

Open your package.json and make sure ESLint is listed in the devDependencies section:

Right-click anywhere in the editor and select Run '<package manager> install' from the context menu.

After that, ESLint works in the same way as when you work with your code locally. View descriptions of detected discrepancies right in the editor or in the Problems tool window and apply suggested quick-fixes. See JavaScript linters and ESLint for details.