Run/Debug Configuration: Gulp.js

• To run one task, select it from the drop-down list.

• To run several tasks, type their names in the text box using blank spaces as separators.

In the default configuration, type --harmony in this text box to have IntelliJ IDEA build a tasks tree according to a Gulpfile.js written in ECMA6.

Technically, IntelliJ IDEA invokes Gulp.js and processes Gulpfile.js according to the default Gulp.js run configuration. This is done silently and does not require any steps from your side. However, if your Gulpfile.js is written in ECMA6, by default IntelliJ IDEA does not recognize this format and fails to build a tasks tree. To solve this problem, specify --harmony as a Node parameter of the default Gulp.js run configuration.

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

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

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

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to 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, IntelliJ IDEA suggests to stop the running instance and start another one. This is helpful when a run/debug 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 IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

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 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 IntelliJ IDEA yet, add its definition. For more information, see External tools and External Tools.

• Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

• Build: select to compile the specified module. The Build Module command will be executed.

  If an error occurs during compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

• Build Project: select to compile the entire project. The Build Project command will be executed.

  If an error occurs during compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

• Build, no error check: the same as the Build option, but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation results.

• Build Artifacts: select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.

• 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 Ant target: select this option to run an Ant target. In the dialog that opens, select the target to be run.

• 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 Maven Goal: select this option to run a Maven goal. In the dialog that opens, select the goal to be run.

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

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

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

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

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

• Run Rake task: add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button , and select the desired task from the list of available tasks.

  Note that code completion is available here.

  

• Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).

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.