PhpStorm 2018.2 Help

Gulp

PhpStorm integrates with the Gulp.js Task Runner. PhpStorm parses Gulpfile.js files, recognizing definitions of tasks, shows tasks in a tree view, lets you navigate between a task in the tree and its definition in the Gulpfile.js file, and supports running and debugging tasks.

Gulp.js tasks can be run from the tasks tree in the dedicated Gulp Tool Window, or from the Gulpfile.js file, by launching a Gulp.js run configuration, or as aa before-launch task from another run configuration. PhpStorm shows the result of executing a task in the Run tool window. The tool window shows the Grunt output, reports the errors occurred, lists the packages or plugins that have not been found, etc. The name of the last executed task is displayed on the title bar of the tool window.

Installing Gulp.js

To use Gulp in a PhpStorm project, you need two packages:

  • A globally installed gulp-cli package (Gulp command line interface) for executing Gulp commands.
  • A gulp package installed as a development dependency to build the project tasks tree and provide coding assistance while editing the Gulpfile.js file. Learn more about Gupfile.js from the Gulp.js Official website.

To install gulp-cli globally

  • Open the built-in PhpStorm Terminal (Alt+F12) and type npm install -global gulp-cli at the command prompt.

To install Gulp.js in a project

  • Open the built-in PhpStorm Terminal (Alt+F12) and type npm install gulp --save-dev at the command prompt.

Running Gulp.js tasks from the tasks tree

PhpStorm lets you run Gulp.js tasks easily and fast right from the tasks tree in the Gulp tool window. PhpStorm automatically creates a temporary run configuration which you can save and use later, if necessary.

Gulp.js starts building a tasks tree as soon as you invoke Gulp.js by choosing Show Gulp Tasks on the context menu of a Gulpfile.js in the Project tool window or of a Gulpfile.js opened in the editor. The tree is built according to the Gulpfile.js file on which Gulp.js was invoked. If you have several Gulpfile.js files in your project, you can build a separate tasks tree for each of them and run tasks without abandoning the previously built tasks trees. Each tree is shown under a separate node.

Technically, PhpStorm 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.

To open the Gulp tool window

  • Select the required Gulpfile.js file in the Project tool window or open it in the editor and choose Show Gulp Tasks on the context menu.

By default PhpStorm does not recognize ES6 in Gulpfile.js and fails to build a tasks tree. To solve this problem, update the default Gulp.js run configuration.

To build a tasks tree from a ES6 Gulpfile.js

  1. Choose Run | Edit Configuration on the main menu.
  2. Under the Defaults node, click Gulp.js.
  3. In the Run/Debug Configuration: Gulp.js dialog box that opens, type --harmony in the Node options text box and click OK.

To build a tree of tasks from the Gulp tool window

  • In the Gulp tool window, click icons general add on the toolbar and choose the required Gulpfile.js file from the list. By default, PhpStorm shows the Gulpfile.js file in the root of your project.
  • If you have another Gulpfile.js file, click Choose Gulpfile.js and select the Gulpfile.js file you need in the dialog that opens. PhpStorm adds a new node with the path to the chosen Gulpfile.js file on its title and builds a tasks tree under the new node.

To re-build a tree

  • Switch to the required node and click icon_reload_grunt.png on the toolbar.

To sort the tasks in a tree by their names

  • Click viewMode.png on the toolbar, choose Sort by on the menu, and then choose Name.
    By default, a tree shows the tasks in the order in which they are defined in Gulpfile.js (option Definition order).

To run a task

  • Double click the task.
  • Select the task in the tree and press Enter or choose Run <task name> on the context menu.

To run the default task

  • Select the root node in the tree, and choose Run default on the context menu of the selection.

To run several tasks

  • Use the multiselect mode: hold Shift (for adjacent items) or Ctrl (for non-adjacent items) keys and select the required tasks, then choose Run or Debug on the context menu of the selection.

To navigate to the definition of a task

  • Select the required task in the tree, and choose Jump to source on the context menu of the selection.

Running tasks from Gulpfile.js

  1. Position the cursor at the definition of the task to run and choose Run <task name> on the context menu of the selection. PhpStorm creates and launches a temporary run configuration with the name of the selected task.
  2. To save an automatically created temporary run configuration, position the cursor at the definition of the task for which it was created and choose Save <task name> on the context menu of the selection.

Running and debugging tasks according to a run configuration

Besides using temporary run configurations that PhpStorm creates automatically, you can create and launch your own Gulp.js run configurations.

To create a Gulp.js run configuration

  1. Choose Run | Edit Configuration on the main menu.
  2. Click icons general add on the toolbar and select Gulp.js from the pop-up list. The Run/Debug Configuration: Gulp.js dialog box opens.
  3. Specify the name of the run configuration, the tasks to run (use blank spaces as separators), the location of the Gulpfile.js file where these tasks are defined, and the path to the Gulp package installed under the current project root.
  4. Specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on WSL, see Configuring a local Node.js interpreter and Using Node.js on Windows Subsystem for Linux for details.

    Optionally, specify the environment variables for Node.js and the arguments for executing the tasks. Use the format --<parameter_name> <parameter_value>, for example: --env development. Learn more from the Gulp Official website.

To run the tasks

  • Select the newly created run configuration from the list on the main toolbar and click icons toolwindows toolWindowRun svg next to the list. The output is displayed in the Run tool window.

To debug the tasks

  1. Create a Gulp.js run/debug configuration as described above.
  2. Open the Gulpfile.js file in the editor and set the breakpoints in it where necessary.
  3. To start a debugging session, select the required debug configuration from the list on the main tool bar and click icons actions startDebugger svg next to the list or choose Run | Debug <configuration name>.
  4. In the Debug tool window that opens, analyze the suspended task execution, step through the task, etc. as described in Examining a Suspended Program and Stepping Through the Program.

To run a Gulp task as a Before-Launch task

  1. Open the Run/Debug Configurations Dialog dialog by choosing Run | Edit Configurations on the main menu, and select the required configuration from the list or create it anew by clicking icons general add svg and choosing the relevant run configuration type.
  2. In the dialog box that opens, click icons general add svg in the Before launch area and choose Run Gulp task from the drop-down list.
  3. 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.

Running Gulp.js tasks automatically

If you have some tasks that you run on a regular basis, you can add the corresponding run configurations to a list of startup tasks. The tasks will be executed automatically on the project start-up.

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click Startup Tasks underTools.
  2. On the Startup Tasks page that opens, click Add on the toolbar.
  3. From the drop-down list, choose the required Gulp.js run configuration. The configuration is added to the list.

    If no applicable configuration is available in the project, click Add and choose Edit Configurations. Then define a configuration with the required settings on the Run/Debug Configuration: Gulp.js page that opens. When you save the new configuration it is automatically added to the list of startup tasks.

Last modified: 19 July 2018

See Also