Gulp Tool Window
Use this tool window to run Gulp.js tasks The result of executing a task is shown in the Run tool window. The tool window shows the Gulp.js 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.
Before you start
Install Node.js.
Install the
gulp-cli
package (Gulp command line interface) globally and install thegulp
package as a development dependency. See Installing Gulp.js for details.
Running tasks
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 WebStorm 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
Choose
on the main menu.Under the Templates node, click Gulp.js.
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
In the Gulp tool window, click on the toolbar and choose the required
Gulpfile.js
file from the list. By default, WebStorm shows theGulpfile.js
file in the root of your project.If you have another
Gulpfile.js
file, click Choose Gulpfile.js and select theGulpfile.js
file you need in the dialog that opens. WebStorm adds a new node with the path to the chosenGulpfile.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 on the toolbar.
To sort the tasks in a tree by their names
Click 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 inGulpfile.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.
Toolbar
| Add Gulpfile | Click this button to have a tasks tree for another |
| Remove Gulpfile | Click this button to remove the tasks tree under the selected node. |
| Reload tasks | Click this button to have the tasks tree under the selected node re-built. You may need a tree re-built after updating the corresponding |
| Collapse all | Click this button to hide all the tasks trees and have only |
| Click this button to configure the current view and to change the viewing modes of the tool window, see Tool Windows Viewing Modes for details. Note that most of the menu items are options that you can turn on or off. An option which is on has a check mark to the left of its name. The Gulp-specific options are:
| |
| Hide | Click this button to hide the tool window. To have it displayed again, choose on the main menu. The tool window appears again showing all the previously built trees of tasks. |
Context Menu of a Tree
Gulp Settings | Choose this menu item to open the Gulp Settings dialog box and view or edit the Node.js configuration |
Jump to Source | Choose this menu item to open the |
Reload tasks | Choose this menu item to have the tree of tasks under the selected node re-built. |
Copy Path | Choose this menu item to save the path to the |
Remove Gulpfile.js | Choose this menu item to remove the tree of tasks under the selected node. |
Context Menu of a Task
Run <task name> | Choose this menu item to run the selected task. |
Debug <task name> | Choose this menu item to debug the selected task. |
Edit <task name> settings | Choose this menu item to open the Run/Debug Configuration dialog box and edit the predefined settings for the selected task. |
Jump to Source | Choose this menu item to open the |