Run/Debug Configuration: Gulp.js
In this dialog, create configurations for running Gulp.js tasks.
Before you start
Download and install Node.js.
Install the gulp package as described in Installing Gulp.js.
Gulp.js-specific configuration settings
In this field, specify the location of the Gulpfile.js file to retrieve the definitions of the tasks from. Select the path from the drop-down list or click the button and choose the file from the dialog box that opens.
In this field, specify the tasks to run. Do one of the following:
In this text box, specify the arguments for tasks to be executed with. Use the format
In this field, specify the Node.js interpreter to use.
If you choose the Project alias, PyCharm will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, PyCharm detects the project default interpreter and fills in the field itself.
You can also choose another configured local or remote interpreter or click and configure a new one.
In this text box, type the Node.js-specific command-line options to be passed to the Node.js executable file. See Node Parameters for details.
In the default configuration, type
Technically, PyCharm 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 PyCharm does not recognize this format and fails to build a tasks tree. To solve this problem, specify
In this field, specify the path to the gulp package installed locally, under the project root. See Installing Gulp.js for details.
In this field, specify the environment variables for the Node.js executable file, if applicable. Click Browse to the right of the field and configure a list of variables in the Environment Variables dialog, that opens:
The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators, for example:
When you edit a run configuration (but not a run configuration template), you can specify the following options:
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, PyCharm 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 PyCharm stores run configuration settings in .idea/workspace.xml.
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
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.
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.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
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.