antoniocarboni/magento2-gulp

This package is abandoned and no longer maintained. No replacement package was suggested.

New Magento2 gulpfile

1.0.0 2017-07-17 03:00 UTC

MIT

README

A new gulpfile for Magento 2

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" }
    ],
    

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

configs.js structure

The file gulp-configs.js for this gulpfile has some 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

• 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

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

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

browsersync

for more informations & all configurations visit https://browsersync.io/docs

Tasks List

• prepare-dev: set developer mode & diables cache
• default: run less task
• less: compiles LESS files. Parameters:
• • --[nometema]: compile only for specific theme
• watch: Watch for file changes and run processing task and/or browserSync reloading:
• • --[nometema]: watch only specific theme
• superwatch: Watch less files and create and delete symlinks automatically on pub/static without run 'exec' command
• browser-sync: reload the browser page
• exec: executes dev:source-theme:deploy command
• cache-disable: disable specific cache
• cache-clear: clear Magento2 Cache
• developer: set Magento2 to developer mode