JetBrains Rider 2018.1 Help

Run/Debug Configuration: NPM

Run | Edit Configurations | new | NPM


In this dialog box, 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. Install and enable the NodeJS plugin as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
  2. Install Node.js and configure it as a local Node.js interpreter. Note that npm is also installed so if you are going to use it you are through with the preliminary steps.
  3. To use Yarn, install it as described on the Yarn Official website.

Configuration tab

ItemDescription
NameIn this text box, specify the name of the run/debug configuration.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

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 browseButton.png and choose the required package.json in the dialog box that opens.
Command From this drop-down 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, see Configuring a local Node.js interpreter for details.
Node Options In this text box, type the Node.js-specific command line options to be passed to the Node.js executable file. The acceptable options are:
  • Use --require coffee-script/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 coffee-script package, should be located inside the project. Therefore you need to install the coffee-script package on the Node.js page locally, as described in npm and Yarn.
  • Use --inspect 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 browseButton.png to the right of the field and configure a list of variables in the Environment Variables dialog box, that opens:
  • To define a new variable, click Add add.png and specify the variable name and value.
  • To discard a variable definition, select it in the list and click Delete delete.png.
  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:

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

Toolbar

ItemShortcutDescription
add Alt+Insert Click this button to add a new configuration to the list.
delete Ctrl+R, D Click this button to remove the selected configuration from the list.
copy icon Ctrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
arrowUp or arrowDown Alt+Up or Alt+Down Use these buttons to move the selected configuration or folder up and down in the list.

The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.

sortAlphabetically Sort configurations Click this button to sort configurations in alphabetical order.

Common options

ItemDescription
NameIn this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

Single instance onlyIf this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, JetBrains Rider checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launchSpecify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
add Ctrl+N Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to JetBrains Rider. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in JetBrains Rider yet, add its definition.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Run File Watchers. Select this option to have JetBrains Rider apply all the currently active file watchers.
  • Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box 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 Grunt task. In the Gulp task dialog box 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 box that opens, specify the npm run/debug configuration settings.
  • Start React Native Bundler. Select this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through react-native start. If your application uses Expo, you need to run the development server via the start npm task. To do that, click edit, then in the Configure React Native dialog, choose npm script and select start from the list.
  • Compile TypeScript. Select this option 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 have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located.
  • Upload files to Remote Host. Select this option to have the application files automatically uploaded to the server according to the default server access configuration.
delete Ctrl+R, D Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Activate tool windowSelect this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.
Last modified: 11 July 2018

See Also