gulpfile.js

var autoprefixer    = require('gulp-autoprefixer'),
    // base64          = require('gulp-base64'),
    // bundle          = require('gulp-bundle-assets'),
    cached          = require('gulp-cached'),
    // changed         = require('gulp-changed'),
    csslint         = require('gulp-csslint'),
    del             = require('del'),
    // docco           = require('gulp-docco'),
    fixmyjs         = require('gulp-fixmyjs'),
    git             = require('gulp-git'),
    gulp            = require('gulp'),
    // include         = require('gulp-file-include'),
    jshint          = require('gulp-jshint'),
    lintspaces      = require('gulp-lintspaces'),
    nib             = require('nib'),
    notify          = require('gulp-notify'),
    // Pageres         = require('pageres'),
    phpcs           = require('gulp-phpcs'),
    prettify        = require('gulp-jsbeautifier'),
    // sourcemaps      = require('gulp-sourcemaps'),
    // stripDebug      = require('gulp-strip-debug'),
    stylish         = require('jshint-stylish'),
    stylus          = require('gulp-stylus'),
    svgmin          = require('gulp-svgmin'),
    tinypng         = require('gulp-tinypng'),
    uglify          = require('gulp-uglify'),
    p               = {
                        allfiles    : [
                                            './laterpay/**/*.php',
                                            './laterpay/asset_sources/stylus/**/*.styl',
                                            './laterpay/asset_sources/js/*.js'
                                      ],
                        phpfiles    : ['./laterpay/**/*.php', '!./laterpay/library/**/*.php'],
                        srcStylus   : './laterpay/asset_sources/stylus/*.styl',
                        srcJS       : './laterpay/asset_sources/js/',
                        srcSVG      : './laterpay/asset_sources/img/**/*.svg',
                        srcPNG      : './laterpay/asset_sources/img/**/*.png',
                        distJS      : './laterpay/built_assets/js/',
                        distCSS     : './laterpay/built_assets/css/',
                        distIMG     : './laterpay/built_assets/img/',
                    };


// TASKS -----------------------------------------------------------------------
// clean up all files in the target directories
gulp.task('clean', function(cb) {
    del([p.distJS + '*.js', p.distCSS + '*.css'], cb);
});

// CSS related tasks
gulp.task('css-watch', function() {
    gulp.src(p.srcStylus)
        .pipe(stylus({                                                          // process Stylus sources to CSS
            use     : nib(),
            linenos : true,                                                      // make line numbers available in browser dev tools
            // TODO: generate sourcemap
        }))
        .pipe(autoprefixer('last 3 versions', '> 2%', 'ff > 23', 'ie > 8'))     // vendorize properties for supported browsers
        .on('error', notify.onError())
        .pipe(gulp.dest(p.distCSS));                                            // move to target folder
});

gulp.task('css-build', function() {
    gulp.src(p.srcStylus)
        .pipe(stylus({                                                          // process Stylus sources to CSS
            use     : nib(),
            compress: true
        }))
        // .pipe(base64({                                                          // base64-encode images and inline them using datauris
        //     baseDir         : 'laterpay/assets/img',
        //     extensions      : ['png', svg],
        //     exclude         : ['laterpay-wordpress-icons'],
        //     maxImageSize    : 12*1024,
        //     debug           : true
        // }))
        .on('error', notify.onError())
        .pipe(autoprefixer('last 3 versions', '> 2%', 'ff > 23', 'ie > 8'))     // vendorize properties for supported browsers
        .pipe(gulp.dest(p.distCSS));                                            // move to target folder
});

// Javascript related tasks
gulp.task('js-watch', function() {
    gulp.src(p.srcJS + '*.js')
        .pipe(cached('hinting'))                                                // only process modified files
            .pipe(jshint('.jshintrc'))
            .pipe(jshint.reporter(stylish))
            .pipe(gulp.dest(p.distJS));                                          // move to target folder;
});

gulp.task('js-build', function() {
    gulp.src(p.srcJS + '*.js')
        // can't use stripDebug, as it kills the one alert we are using on purpose in laterpay-post-view.js
        // .pipe(stripDebug())                                                     // remove console, alert, and debugger statements
        // .pipe(fixmyjs({                                                         // fix JSHint errors if possible
        //     lookup: false
        // }))
        .pipe(jshint('.jshintrc'))
        .pipe(jshint.reporter(stylish))
        .pipe(uglify())                                                         // compress with uglify
        .pipe(gulp.dest(p.distJS));                                             // move to target folder
});

gulp.task('js-format', function() {
    return gulp.src(p.srcJS + '*.js')
            .pipe(prettify({
                config  : '.jsbeautifyrc',
                mode    : 'VERIFY_AND_WRITE',
            }))
            .pipe(gulp.dest(p.srcJS));
});

// Image related tasks
gulp.task('img-build', function() {
    gulp.src(p.srcSVG)
        .pipe(svgmin())                                                         // compress with svgmin
        .pipe(gulp.dest(p.distIMG));                                            // move to target folder

    gulp.src(p.srcPNG)
        .pipe(tinypng('zHaA4zg6xUKMk6xW3KtC43VOtOU8OZZ9'))                      // compress with TinyPNG
        .pipe(gulp.dest(p.distIMG));                                            // move to target folder
});

// ensure consistent whitespace etc. in files
gulp.task('fileformat', function() {
    return gulp.src(p.allfiles)
            .pipe(lintspaces({
                indentation     : 'spaces',
                spaces          : 4,
                trailingspaces  : true,
                newline         : true,
                newlineMaximum  : 2,
            }))
            .pipe(lintspaces.reporter());
});

// check PHP coding standards
gulp.task('sniffphp', function() {
    return gulp.src(p.phpfiles)
            .pipe(phpcs({
                bin             : '/usr/local/bin/phpcs',
                standard        : 'WordPress',
                warningSeverity : 0
            }))
            .pipe(phpcs.reporter('log'));
});

// update git submodules
gulp.task('updateSubmodules', function() {
    git.updateSubmodule({args: '--init'});
});


// COMMANDS --------------------------------------------------------------------
gulp.task('default', ['clean', 'img-build', 'css-watch', 'js-watch'], function() {
    // watch for changes
    gulp.watch(p.allfiles,          ['fileformat']);
    gulp.watch(p.stylus,            ['css-watch']);
    gulp.watch(p.srcJS + '*.js',    ['js-watch']);
});

// check code quality before git commit
gulp.task('precommit', ['sniffphp', 'js-format'], function() {
    gulp.src(p.srcJS + '*.js')
        .pipe(fixmyjs({                                                         // fix JSHint errors if possible
            lookup: false
        }))
        .pipe(jshint('.jshintrc'))
        .pipe(jshint.reporter(stylish));

    gulp.src(p.distCSS + '*.css')
        .pipe(csslint())
        .pipe(csslint.reporter());
});

// build project for release
gulp.task('build', ['clean', 'updateSubmodules'], function() {
    // TODO: git archive is the right option to export the entire repo
    gulp.start('img-build');
    gulp.start('css-build');
    gulp.start('js-build');
});