/** * @file gulpfile.js * * Defines tasks that can be run on gulp. * * Summary: */ 'use strict'; var gulp = require('gulp'); var coveralls = require('gulp-coveralls'); var gutil = require('gulp-util'); var jshint = require('gulp-jshint'); var mocha = require('gulp-mocha'); var rename = require('gulp-rename'); var runsequence = require('run-sequence'); runsequence.use(gulp); var shell = require('gulp-shell'); var uglify = require('gulp-uglify'); var bump = require('gulp-bump'); var git = require('gulp-git'); function ignoreerror() { /* jshint ignore:start */ // using `this` in this context is weird this.emit('end'); /* jshint ignore:end */ } function startGulp(name, opts) { opts = opts || {}; var browser = !opts.skipBrowser; var fullname = name ? 'bitcore-' + name : 'bitcore'; var files = ['lib/**/*.js']; var tests = ['test/**/*.js']; var alljs = files.concat(tests); var buildPath = './node_modules/bitcore-build-zcash/'; var buildModulesPath = buildPath + 'node_modules/'; var buildBinPath = buildPath + 'node_modules/.bin/'; /** * testing */ var testmocha = function() { return gulp.src(tests).pipe(new mocha({ reporter: 'spec' })); }; var testkarma = shell.task([ buildModulesPath + 'karma/bin/karma start ' + buildPath + 'karma.conf.js' ]); gulp.task('test:node', testmocha); gulp.task('test:node:nofail', function() { return testmocha().on('error', ignoreerror); }); gulp.task('test:browser', ['browser:uncompressed', 'browser:maketests'], testkarma); if (browser) { gulp.task('test', function(callback) { runsequence(['test:node'], ['test:browser'], callback); }); } else { gulp.task('test', ['test:node']); } gulp.task('noop', function() { }); /** * file generation */ if (browser) { var browserifyCommand; if (name !== 'lib') { browserifyCommand = buildBinPath + 'browserify --require ./index.js:' + fullname + ' --external bitcore-lib-zcash -o ' + fullname + '.js'; } else { browserifyCommand = buildBinPath + 'browserify --require ./index.js:bitcore-lib-zcash -o bitcore-lib-zcash.js'; } gulp.task('browser:uncompressed', shell.task([ browserifyCommand ])); gulp.task('browser:compressed', ['browser:uncompressed'], function() { return gulp.src(fullname + '.js') .pipe(uglify({ mangle: true, compress: true })) .pipe(rename(fullname + '.min.js')) .pipe(gulp.dest('.')) .on('error', gutil.log); }); gulp.task('browser:maketests', shell.task([ 'find test/ -type f -name "*.js" | xargs ' + buildBinPath + 'browserify -t brfs -o tests.js' ])); gulp.task('browser', function(callback) { runsequence(['browser:compressed'], callback); }); } /** * code quality and documentation */ gulp.task('lint', function() { return gulp.src(alljs) .pipe(jshint()) .pipe(jshint.reporter('default')); }); gulp.task('plato', shell.task([buildBinPath + 'plato -d report -r -l .jshintrc -t ' + fullname + ' lib'])); gulp.task('coverage', shell.task([buildBinPath + './istanbul cover ' + buildBinPath + '_mocha -- --recursive'])); gulp.task('coveralls', ['coverage'], function() { gulp.src('coverage/lcov.info').pipe(coveralls()); }); /** * watch tasks */ gulp.task('watch:test', function() { // todo: only run tests that are linked to file changes by doing // something smart like reading through the require statements return gulp.watch(alljs, ['test']); }); gulp.task('watch:test:node', function() { // todo: only run tests that are linked to file changes by doing // something smart like reading through the require statements return gulp.watch(alljs, ['test:node']); }); if (browser) { gulp.task('watch:test:browser', function() { // todo: only run tests that are linked to file changes by doing // something smart like reading through the require statements return gulp.watch(alljs, ['test:browser']); }); } gulp.task('watch:coverage', function() { // todo: only run tests that are linked to file changes by doing // something smart like reading through the require statements return gulp.watch(alljs, ['coverage']); }); gulp.task('watch:lint', function() { // todo: only lint files that are linked to file changes by doing // something smart like reading through the require statements return gulp.watch(alljs, ['lint']); }); if (browser) { gulp.task('watch:browser', function() { return gulp.watch(alljs, ['browser']); }); } /** * Release automation */ gulp.task('release:install', function() { return shell.task([ 'npm install', ]); }); var releaseFiles = ['./package.json']; if (browser) { releaseFiles.push('./bower.json'); } var bump_version = function(importance) { return gulp.src(releaseFiles) .pipe(bump({ type: importance })) .pipe(gulp.dest('./')); }; var tempBranch = 'releases/' + new Date().getTime() + '-build'; gulp.task('release:checkout-releases', function(cb) { git.branch(tempBranch, { args: '' }, function() { git.checkout(tempBranch, { args: '' }, cb); }); }); gulp.task('release:cleanup', function(cb) { git.branch(tempBranch, { args: '-D' }, cb); }); gulp.task('release:checkout-master', function(cb) { git.checkout('master', { args: '' }, cb); }); gulp.task('release:sign-built-files', shell.task([ 'gpg --yes --out ' + fullname + '.js.sig --detach-sig ' + fullname + '.js', 'gpg --yes --out ' + fullname + '.min.js.sig --detach-sig ' + fullname + '.min.js' ])); var buildFiles = ['./package.json']; var signatureFiles = []; if (browser) { buildFiles.push(fullname + '.js'); buildFiles.push(fullname + '.js.sig'); buildFiles.push(fullname + '.min.js'); buildFiles.push(fullname + '.min.js.sig'); buildFiles.push('./bower.json'); signatureFiles.push(fullname + '.js.sig'); signatureFiles.push(fullname + '.min.js.sig'); } var addFiles = function() { var pjson = require('../../package.json'); return gulp.src(buildFiles) .pipe(git.add({ args: '-f' })); }; var buildCommit = function() { var pjson = require('../../package.json'); return gulp.src(buildFiles) .pipe(git.commit('Build: ' + pjson.version, { args: '' })); }; gulp.task('release:add-signed-files', ['release:sign-built-files'], addFiles); gulp.task('release:add-built-files', addFiles); if (browser) { gulp.task('release:build-commit', [ 'release:add-signed-files' ], buildCommit); } else { gulp.task('release:build-commit', [ 'release:add-built-files' ], buildCommit); } gulp.task('release:version-commit', function() { var pjson = require('../../package.json'); return gulp.src(releaseFiles) .pipe(git.commit('Bump package version to ' + pjson.version, { args: '' })); }); gulp.task('release:push', function(cb) { git.push('bitpay', 'master', { args: '' }, cb); }); gulp.task('release:push-tag', function(cb) { var pjson = require('../../package.json'); var name = 'v' + pjson.version; git.tag(name, 'Release ' + name, function() { git.push('bitpay', name, cb); }); }); gulp.task('release:publish', shell.task([ 'npm publish' ])); // requires https://hub.github.com/ var release = function(importance, cb) { var bumper = 'release:bump:' + importance; return runsequence( // Checkout the release temporal branch 'release:checkout-releases', // Run npm install 'release:install', // Run tests with gulp test 'test', // Update package.json and bower.json bumper, // build browser files browser ? 'browser' : 'noop', // Commit 'release:build-commit', // Run git push bitpay $VERSION 'release:push-tag', // Run npm publish 'release:publish', // Checkout the `master` branch 'release:checkout-master', // Bump package.json and bower.json, again bumper, // Version commit with no binary files to master 'release:version-commit', // Push to master 'release:push', // remove release branch 'release:cleanup', cb); }; ['patch', 'minor', 'major'].forEach(function(importance) { gulp.task('release:' + importance, function(cb) { release(importance, cb); }); gulp.task('release:bump:' + importance, function() { bump_version(importance); }); }); gulp.task('release', ['release:patch']); } module.exports = startGulp;