Run/Debug configuration: React Native

Build and launch application

• Select the Build and launch checkbox if you are launching your application for the first time or if you have updated its native code since the last run.

• Clear this checkbox if you haven't made any changes to the native code of your application since the last build.

  When you start debugging, GoLand waits for you to open your application in the simulator with the Remote debug enabled as described on the React Native official website

• If your application uses Expo, clear the checkbox because this bundler takes care of the process itself.

Platform

In this area, choose the platform for which the application is intended.

Depending on your choice, GoLand will run the bundler with react-native run-ios or with react-native run-android.

• To emulate the Android platform, use an Android virtual device.

• To emulate the iOS platform, you need to install the ios-sim command-line tool globally. You can do it through the Node Package Manager (npm) or by running the sudo npm install ios-sim -g command, depending on your operating system.

Learn more from the React Native official website.

Arguments

In this field, type the arguments to be passed to React Native, for example, specify the simulator type through the ‑‑simulator flag: ‑‑simulator="iPhone 4s".

Browser for debugging

In debugging React Native applications, GoLand relies on the Chrome runtime, which is used by React Native itself. You can also use DevTools together with GoLand. When you initiate a debugging session, GoLand starts a new Chrome instance and attaches to it.

Bundler host

In this field, specify the host where the bundler runs, the default value is localhost.

If you are using Expo, you may need to change the default bundler host to ensure successful connection with the debugger. This connection may fail because GoLand by default uses localhost to start debugging while Expo expects 127.0.0.1 or an external IP address depending on what is selected in Connection field of the Metro bundler configuration.

Bundler port

In this field, specify the port on which the bundler runs.

• GoLand automatically chooses 8081, which is default for the React Native bundler. Learn more from the React Native official website.

• If your application uses Expo, you may need to change the port to 19000 or 19001, depending on the Expo configuration.

Node interpreter

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

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

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

React Native package

In this field, specify the path to react-native-cli.

Working directory

specify the working directory of the application. By default, the field shows the project root folder.

Environment variables

In this field, optionally, type the environment variables for executing the react-native run-android or the react-native run-ios command.

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, GoLand 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 GoLand stores run configuration settings in .idea/workspace.xml.

Alt+Insert

Create a run/debug configuration.

Alt+Delete

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

Ctrl+D

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

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. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click , 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 and buttons.

To remove grouping, select a folder and click .

Click this button to sort configurations in the alphabetical order.

Alt+Insert

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

• Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

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

• Run File Watchers: select this option to have GoLand 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.

• 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 , then in the Configure React Native dialog, choose npm script and select start from the list.

• Go Command: select to run a Go command before running your program. For example, you can run go generate to generate source code before compilation. In the Edit Go Command Task dialog, you can use auto-completion. Auto-completion supports the following commands generate, vet, test -i. You can use your own commands.

Alt+Delete

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

Enter

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

Alt+Up

Alt+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 Alt+4 or Alt+5.