WebStorm 2017.3 Help

Run/Debug Configuration: React Native

In this dialog box, create configurations for running React Native applications.

On this page:

React Native-specific configuration settings

ItemDescription
Node interpreter In this field, specify the Node.js interpreter to use. Choose one of the configured interpreters or click browseButton.png and configure a new one as described in Configuring Node.js Interpreters.

If you have appointed one of the installations as default, the field displays the path to its executable file.

React Native package In this field, specify the location of the react-native package.
Working Directory In this field, specify the working directory of the application. All references in the starting Node.js application file, for example, imports, will be resolved relative to this folder, unless such references use full paths.

By default, the field shows the project root folder. To change this predefined setting, choose the desired folder from the drop-down list, or type the path manually, or click the Browse button browseButton.png and select the location in the dialog box, that opens.

Only start packager
  • When this checkbox is selected, the react-native run-android/react-native run-ios command is not executed, and debugging is started when you run the application on the device.
  • When this checkbox is cleared, the react-native run-android/react-native run-ios command is executed with the arguments specified in the Environment text box.
Target platform In this area, choose the platform for running on which the application is intended. The available options are:
  • Android
  • ios To emulate this platform, you need to install the ios-sim command line tool globally. You can do it through the Node Package Manager (npm), see NPM or by running the sudo npm install ios-sim -g command, depending on your oeprating system.
Run arguments In this text box, type the arguments to be passed to React Native, for example, specify the simulator type through the --simulator flag: --simulator="iPhone 4s".
Environment In this field, optionally specify the environment variables for executing the rect-native run-android or react-native run-ios command.

Toolbar

ItemShortcutDescription
/help/img/idea/2017.3/add.png Alt+Insert Click this button to add a new configuration to the list.
/help/img/idea/2017.3/delete.png Alt+Delete Click this button to remove the selected configuration from the list.
/help/img/idea/2017.3/copy.gif Ctrl+D Click this button to create a copy of the selected configuration.
/help/img/idea/2017.3/settings.png Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
/help/img/idea/2017.3/arrowUp.png or /help/img/idea/2017.3/arrowDown.png 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.

/help/img/idea/2017.3/sortAlphabetically.png 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 checkbox 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 checkbox is not available when editing the run/debug configuration defaults.

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

Every time a new run/debug configuration is launched, WebStorm 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 checkbox 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
/help/img/idea/2017.3/add.png Alt+Insert 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 WebStorm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in WebStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • 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 WebStorm apply all the currently active file watchers, see Using File Watchers for details.
  • 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 checkbox to execute an npm script. In the NPM Script dialog box that opens, specify the package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.

    Specify the location of the Node.js interpreter and the parameters to pass to it.

  • 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. For more information, see CoffeeScript.
  • 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. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
/help/img/idea/2017.3/delete.png Alt+Delete Click this icon to remove the selected task from the list.
/help/img/idea/2017.3/edit1.png Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/help/img/idea/2017.3/arrowUp.png Alt+Up Click this icon to move the selected task one line up in the list.
/help/img/idea/2017.3/arrowDown.png Alt+Down Click this icon to move the selected task one line down in the list.
Show this page Select this checkbox to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Active 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: 20 September 2017