02-05-2021

Phpstorm Gulp



Run | Edit Configurations || Gulp.js

In this dialog, create configurations for running Gulp.js tasks.

Before you start

TypeScript is a programming language developed and maintained by Microsoft.It is a strict syntactical superset of JavaScript and adds optional static typing to the language. TypeScript is designed for the development of large applications and transcompiles to JavaScript. Laravel is a free, open-source PHP web framework, created by Taylor Otwell and intended for the development of web applications following the model–view–controller (MVC) architectural pattern and based on Symfony.

Phpstorm Gulp Download

Phpstorm

  1. Download and install Node.js.

  2. Install the gulp package as described in Installing Gulp.js.

Check for node, npm, and npx# node -version. If they are not installed. In the block Gulp where webstorm show the list of task, click the cog icon and select gulp settings, in the section 'Gulp package' add the path to the local gulp package (the gulp inside the nodemodules in your project). Example of path: yourprojectnodemodulesgulp. A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.

GulpGulp

Gulp.js-specific configuration settings

ItemDescription
GulpfileIn 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.
TasksIn this field, specify the tasks to run. Do one of the following:

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

ArgumentsIn this text box, specify the arguments for tasks to be executed with. Use the format --<parameter_name> <parameter_value>, for example: --env development. Learn more from the Gulp official website.
Node interpreterIn this field, specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.
Node optionsIn 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 --harmony in this text box to have PhpStorm build a tasks tree according to a Gulpfile.js written in ECMA6.

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. However, if your Gulpfile.js is written in ECMA6, by default PhpStorm 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.

Gulp packageIn this field, specify the path to the gulp package installed locally, under the project root. See Installing Gulp.js for details.
Environment Variables 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:

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

Phpstorm Gulp Failed To List Tasks

Common

Phpstorm

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

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

Toolbar

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.

ItemShortcutDescription
Alt+InsertCreate a run/debug configuration.
Alt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
Ctrl+DCreate 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.
View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
/ Alt+Up/ Alt+Down

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 button to sort configurations in the alphabetical order.

Before Launch

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.

Phpstorm Gulp

ItemShortcutDescription
Alt+Insert

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

  • 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 File Watchers: select this option to have PhpStorm apply all the currently active File Watchers.

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

  • Run Phing target: add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click Browse and select the desired target in the dialog that opens.

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

Alt+DeleteClick this icon to remove the selected task from the list.
EnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/ Alt+Up/ Alt+DownClick 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 pageSelect 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.