README

Easy gulp implementation for laravel

Laravel gulp is simply an implementation that aims to make it easy for users that are new to gulp to be able to maintain their gulpfile by adding modules that work out of the box.

Example gulpfile.js

"use strict";

var gulp    = require('gulp'),
    Laravel = require('gulp-laravel');

// Example task (external module)
Laravel.addTask('autoprefixer', require('gulp-laravel-autoprefixer'));

gulp.task('default', function () {
  (new Laravel(gulp))
    .task('autoprefixer')
    .task('cssmin')
    .run();
});

Task configuration

Task configuration can be defined as follows:

var Laravel = require('gulp-laravel');

// Set the configuration of the predefined task 'cssmin'
Laravel.taskConfig('cssmin', {
  removeComments: 'some'
});

Execute tasks asynchronously

Tasks can be pushed onto a asynchronous queue by using the taskAsync function

var laravel = new Laravel(gulp);

laravel
  .tasksAsync('asyncTask1', 'ayncTask2')
  .task('syncTask1')
  .task('syncTask2')
  .run();

Creating a plugin

You can create a plugin by exporting a function that takes an argument of type LaravelTask. The exec function of task sets the function that is executed.

Sample cssmin task

module.exports = function (task) {
  task.setRequirements(['gulp-csso']);
  task.exec(function () {
    // Get the laravel instance (for config if required)
    var laravel = this.getLaravel();

    // The subject of the exec function is gulp
    var gulp = this;

    // Config variables
    var baseDir = laravel.config.cssOutput,
    var cssFiles = baseDir + '/**/*.css';

    // It is most likely favourable to do this on production only
    if (laravel.config.production) {
      return gulp.src(cssFiles)
        .pipe(task.plugins.csso())
        .pipe(gulp.dest(baseDir));
    }

    // Development environment, inform user that nothing has happened
    task.notifier.message('Not in production environment, not minimizing css');
  }
}

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!