JetBrains Rider
 
2023.3
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
Get your hands on the new features ahead of the release by joining the Early Access Program for Rider 2025.1! Learn more
Upcoming webinar
Uno Platform & Hot Design for Rider
March 11, 2025 at 03:00 PM
  1. Reference
  2. UI reference
  3. Dialogs
  4. Run/debug configurations dialog
  5. NPM

Run/Debug Configuration: NPM

Last modified: 21 March 2024

Required plugins:

JavaScript and TypeScript - The plugin is bundled with JetBrains Rider and enabled by default.

Node.js - The plugin is bundled with JetBrains Rider and enabled by default.

note

Please do not confuse run/debug configurations with build configurations.

Create: Run | Edit Configurations | Add New Configuration | NPM

In this dialog, create configurations for running npm and Yarn scripts locally. "Locally" in the current context means that JetBrains Rider itself starts Node.js installed on your computer, whereupon initiates script execution.

Before you start

  1. Download and install Node.js. Note that npm is also installed so if you are going to use it, you are through with the preliminary steps.

  2. To use Yarn, install it as described on the Yarn official website.

Configuration tab

Item

Description

package.json

In this field, specify the package.json file to run the scripts from. Choose the file from the drop-down list which shows all the package.json files detected in the current project or click the Browse button and choose the required package.json in the dialog that opens.

Command

From this list, choose the npm CLI command to execute, by default run-script is selected. Learn more at npm documentation, under the section CLI Commands.

Scripts

From this drop-down list, choose the script to which the chosen command will be applied. The list contains all the scripts defined within the scripts property in the package.json file.

Arguments

In this field, specify the command-line arguments to execute a script with. Learn more from the npm official website.

Node interpreter

In this field, specify the Node.js interpreter to use.

If you choose the Project alias, JetBrains Rider will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, JetBrains Rider detects the project default interpreter and fills in the field itself.

You can also choose another configured local or remote interpreter or click the Browse button and configure a new one.

Node Options

In this field, type the Node.js-specific command-line options to be passed to the Node.js executable file. The acceptable options are:

  • Use --require coffeescript/register to have CoffeeScript files compiled into JavaScript on the fly during run.

    This mode requires that the register.js file, which is a part of the coffeescript package, is located inside your project. Therefore make sure you have the coffeescript package installed locally as described in Install the CoffeeScript compiler.

  • Use --inspect or --inspect-brk parameter when you are using Node.js v7 for Chrome Debugging Protocol support. Otherwise, by default the debug process will use V8 Debugging Protocol.

Package manager

In this field. specify the package manager to use. If you choose the Project alias, JetBrains Rider will use the default project package manager from the Node.js page. You can also choose the relevant package alias (npm or yarn) or specify an explicit path to a custom installation of a package manager.

Environment Variables

In this field, specify the environment variables for the Node.js executable file, if applicable. Click Browse the Browse button to the right of the field and configure a list of variables in the Environment Variables dialog, that opens:

  • To define a new variable, click the Add button and specify the variable name and value.

  • To discard a variable definition, select it in the list and click the Remove button.

  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators, for example:

  • NODE_PATH: A :-separated list of directories prefixed to the module search path.

  • NODE_MODULE_CONTEXTS: Set to 1 to load modules in their own global contexts.

  • NODE_DISABLE_COLORS: Set to 1 to disable colors in the REPL.

Docker container settings

This read-only field shows port and volume bindings. Click the Expand button to open the command preview.

warning

This field only appears when a Docker-based remote interpreter is selected.

Check Docker container settings

Docker Compose

In this area, specify the commands and options to be passed to Docker Compose. Accept the default settings or click the Expand button and specify custom ones, for example, custom Docker Compose flags, like --rm or --service-ports. Learn more from the Docker official website.

Check the Command Preview.

warning

This field only appears when a remote interpreter via Docker Compose is selected.

Common settings

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, JetBrains Rider suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and JetBrains Rider stores run configuration settings in .idea/workspace.xml.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your solution as well as adjust default configurations templates.

Item

Shortcut

Description

the Add button

Ctrl0N

Create a run/debug configuration.

the Remove button

Ctrl0R,0D

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Copy

Ctrl0D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

Save configuration

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Move into new folder / Create new folder

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click Folder, and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations

Click this button to sort configurations in the alphabetical order.

Before launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item

Shortcut

Description

the Add button

Ctrl0N

Click this icon to add one of the following available tasks:

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in JetBrains Rider yet, add its definition.

  • Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration.

  • Build solution: select this option to build the solution before launching the configuration.

  • Run File Watchers: select this option to have JetBrains Rider apply all the currently active File Watchers.

  • Run Remote External tool: adds a remote SSH external tool.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run Gulp task: select this option to run a Gulp task.

    In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm Script: select this option to execute an npm script.

    In the NPM Script dialog that opens, specify the npm run/debug configuration settings.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

the Remove button

Ctrl0R,0D

Click this icon to remove the selected task from the list.

Edit

Enter

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

Method up

Method down

Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.

Show this page

Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.

Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt04 or Alt05.

See also

Procedures

Reference