Node.js with Docker

1. Make sure the JavaScript and TypeScript, JavaScript Debugger, Node.js, Node.js Remote Interpreter, and Docker required plugins are enabled on the Settings | Plugins page, tab Installed, see Managing plugins for details.

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

3. Download, install, and configure Docker as described in Docker

Create a remote Node.js interpreter

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

2. Click next to the Node interpreter field.

3. 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 .

   

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

5. 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.

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

   

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

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

   

8. To set the newly configured interpreter as project default, select it in the list and click OK to return to the Node.js dialog.

   

   PyCharm automatically uses this interpreter every time you select the Project alias from Node Interpreter lists, for example, when creating run/debug configurations.

   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. Learn more from Specify the default project Node.js interpreter and package manager.

1. 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.

2. 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).

   

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

4. 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.

   

5. Check the port and volume bindings values in the Docker container settings field.

   

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

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

3. Click to the Select run/debug configuration list.

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

2. 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.

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

1. 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.

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

   {
     "name": "node-express",
     "version": "0.0.0",
     "private": true,
     "dependencies": {
       "cookie-parser": "~1.4.4",
       "debug": "~2.6.9",
       "express": "~4.16.1",
       "http-errors": "~1.6.3",
       "morgan": "~1.9.1",
       "pug": "^3.0.2"
     },
     "devDependencies": {
       "chai": "^4.3.4",
       "concurrently": "^6.3.0",
       "eslint": "^8.1.0",
       "http-server": "^14.0.0",
       "jest": "^27.3.1",
       "mocha": "^9.1.3",
       "nyc": "^15.1.0"
     }
   }

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

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

5. 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.

1. 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.

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

   {
     "name": "node-express",
     "version": "0.0.0",
     "private": true,
     "dependencies": {
       "cookie-parser": "~1.4.4",
       "debug": "~2.6.9",
       "express": "~4.16.1",
       "http-errors": "~1.6.3",
       "morgan": "~1.9.1",
       "pug": "^3.0.2"
     },
     "devDependencies": {
       "eslint": "^8.1.0"
     }
   }

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

4. 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.