PHPackages                             magenio/magento2-gulp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. magenio/magento2-gulp

ActiveMagento2-component[Utility & Helpers](/categories/utility)

magenio/magento2-gulp
=====================

New Magento2 gulpfile

2.0.10(5y ago)53.6k1[2 issues](https://github.com/magenio-it/magento2-gulp/issues)MITJavaScript

Since Sep 14Pushed 5y ago1 watchersCompare

[ Source](https://github.com/magenio-it/magento2-gulp)[ Packagist](https://packagist.org/packages/magenio/magento2-gulp)[ RSS](/packages/magenio-magento2-gulp/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)DependenciesVersions (3)Used By (0)

A NEW MAGENTO2 GULP FILE
========================

[](#a-new-magento2-gulp-file)

[![GitHub release](https://camo.githubusercontent.com/5dd2267b5b8a1f3dc47d7bf38dc298c7251a53290af8fc78fe833090e5f6c026/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6d6167656e696f2d69742f6d6167656e746f322d67756c702e7376673f6c6162656c3d4d6167656e746f3225323047756c70)](https://camo.githubusercontent.com/5dd2267b5b8a1f3dc47d7bf38dc298c7251a53290af8fc78fe833090e5f6c026/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6d6167656e696f2d69742f6d6167656e746f322d67756c702e7376673f6c6162656c3d4d6167656e746f3225323047756c70)

Requirements
------------

[](#requirements)

[![Generic badge](https://camo.githubusercontent.com/7d1e2e1341ff583c46f26bbec230b4f4185df77d0856efa5fd4c2421c53b189e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322d726564)](https://camo.githubusercontent.com/7d1e2e1341ff583c46f26bbec230b4f4185df77d0856efa5fd4c2421c53b189e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322d726564)[![Generic badge](https://camo.githubusercontent.com/0796248857fd2a397eb0dad789a8a83a699039df6abfc832aa149a4202be4fc9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f253230636f6d706f736572253230696e7374616c6c65722d2a2d79656c6c6f77)](https://camo.githubusercontent.com/0796248857fd2a397eb0dad789a8a83a699039df6abfc832aa149a4202be4fc9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f253230636f6d706f736572253230696e7374616c6c65722d2a2d79656c6c6f77)[![Generic badge](https://camo.githubusercontent.com/c0fcc53bc84da8b2d3cb642a2003d4acebdcd42d6f15e0300d554fa09f4edd0f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4e6f64652e6a732d25354531302e302d677265656e)](https://camo.githubusercontent.com/c0fcc53bc84da8b2d3cb642a2003d4acebdcd42d6f15e0300d554fa09f4edd0f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4e6f64652e6a732d25354531302e302d677265656e)[![Generic badge](https://camo.githubusercontent.com/5d05b77b6b1aa60ddceacf3e88047c703eb56cd43735902e48afc48e380bdf68/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6e706d2d253545362e302d726564)](https://camo.githubusercontent.com/5d05b77b6b1aa60ddceacf3e88047c703eb56cd43735902e48afc48e380bdf68/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6e706d2d253545362e302d726564)

Why Use this gulp file
----------------------

[](#why-use-this-gulp-file)

This new file was born from the need to **speed up** the work of the frontend developer on Magento2.

The slowness with which the standard gruntfile processes and compiles files is well known.

For this reason, this file eliminates unnecessary scripts and allows you to set a single theme in the config to speed up both the **watch** process and the **less compile** process.

In addition, the **"superwatch"** mode has been added which allows you to synchronize the js, font, img and template files in the pub **without necessarily running the exec command every time**.

Comparison with grunt
---------------------

[](#comparison-with-grunt)

[![exec comparison](https://camo.githubusercontent.com/69b732ec7dbacefcceca62c193035231e1f003de4135a2c583bb245c61bb04b7/68747470733a2f2f7777772e6d6167656e696f2e636f6d2f636f6e74656e742f75706c6f6164732f67756c706d322f657865632e706e67)](https://camo.githubusercontent.com/69b732ec7dbacefcceca62c193035231e1f003de4135a2c583bb245c61bb04b7/68747470733a2f2f7777772e6d6167656e696f2e636f6d2f636f6e74656e742f75706c6f6164732f67756c706d322f657865632e706e67)[![Less comparison](https://camo.githubusercontent.com/c284dd263db8d174e7609fc06baab7314c4dddaf221306af27bffc7b92d04924/68747470733a2f2f7777772e6d6167656e696f2e636f6d2f636f6e74656e742f75706c6f6164732f67756c706d322f6c6573732e706e67)](https://camo.githubusercontent.com/c284dd263db8d174e7609fc06baab7314c4dddaf221306af27bffc7b92d04924/68747470733a2f2f7777772e6d6167656e696f2e636f6d2f636f6e74656e742f75706c6f6164732f67756c706d322f6c6573732e706e67)

*these statistics were obtained with magento in a local environment inside a docker container. Times could change depending on the type of environment. The purpose of the comparison however is to show the potential time gain with the same task*

Installation
------------

[](#installation)

1. Update your composer.json file:

```
“require-dev”: {
	...
	“antoniocarboni/magento2-gulp”:"2.0.*”
},

 "repositories": [
    { "type": "vcs", "url":  "https://github.com/magenio-it/magento2-gulp" }
    ],

```

2. Run composer update
3. Install node.js
4. Rename `package.gulp.json.sample` to `package.json`
5. Run `npm install`
6. Install gulp globally using `npm install -g gulp-cli`
7. Define your gulp configuration in `dev/gulp-configs.js` using the file sample gulp-configs.sample.js

configs.js structure
--------------------

[](#configsjs-structure)

The file `gulp-configs.js` for this gulpfile has some options:

### options

[](#options)

- `debug`: enable verbose mode (true/false)
- `liveReload`: enable LiveReload Plugin (true/false)
- `browsersync`: enable Browsersync Plugin (true/false)
- `cache-disable`: cache to keep disabled to default on developer mode

### less

[](#less)

- `sourcemap`: creates sourcemap during less compilation (true/false)
- `singletheme`: if set, the less task will only watch the specified theme to improve the speed of compile

### watch

[](#watch)

### supwatch

[](#supwatch)

- `extensionPermitted`: specific extensions to check for create symlinks on pub/static directory
- `folderCustomTheme`: directory where custom theme is located. For now superwatch works only with single custom theme at a time. Use 'app' for custom theme in app/design/ or 'Vendorname/themename' for custom theme managed with composer
- `notifyAll`: notify changes for files that don't require the symlink on pub/static
- `notifyExt`: add specific file extensions filter for notifications

### exec

[](#exec)

- `enableDefaultTask`: if set, task deploy without arguments uses a default task set (true/false)
- `defaultTask`: default task to run if enableDefaultTask is enabled
- `staticFolderToClear`: set full path of pub/static theme to clear before to soure theme deploy.
- `singletheme`: if set, the exec task will only run for the specified theme to improve the speed of symlink creation

### browsersync

[](#browsersync)

for more informations & all configurations visit

Tasks List
----------

[](#tasks-list)

- `prepare-dev`: set developer mode, clear cache & disable specific cache (options.cache-disable)
- `default`: run less task
- `less`: compiles LESS files. Parameters:
- - `--[nometema]`: compile only for specific theme
- `watch`: Watch for file changes and run processing task
- - `--[nometema]`: watch only specific theme (if less config "singletheme" is true this options isn't necessary)
- `superwatch`: Watch less files and create and delete symlinks automatically on pub/static without run 'exec' command
- `browser-sync`: reload the browser page
- `exec`: clean pub/static and executes dev:source-theme:deploy command
- `cache-disable`: disable specific cache
- `cache-clear`: clear Magento2 Cache
- `developer`: set Magento2 to developer mode

Usage
-----

[](#usage)

To obtain maximum speed in daily frontend work we recommend:

- use the config sample file by changing the values on the less and exec config with your theme name (options: singleTheme, defaultTask, staticFolderToClear)
- first time, use prepare-dev to clean cache and set developer mode, then use gulp exec to clean pub/static and create symlinks
- use gulp superwatch and enjoy :)

Common issues
-------------

[](#common-issues)

1. When using the superwatch and adding or removing a less file, gulp will no longer see the changes of that file until the superwatch task is restarted.
2. migrate gulp and all dependencies to gulp 4.0

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance12

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~27 days

Total

2

Last Release

2045d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/26729230?v=4)[magenio](/maintainers/magenio)[@magenio](https://github.com/magenio)

---

Top Contributors

[![antoniocarboni](https://avatars.githubusercontent.com/u/1431817?v=4)](https://github.com/antoniocarboni "antoniocarboni (5 commits)")

### Embed Badge

![Health badge](/badges/magenio-magento2-gulp/health.svg)

```
[![Health](https://phpackages.com/badges/magenio-magento2-gulp/health.svg)](https://phpackages.com/packages/magenio-magento2-gulp)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)