Formatting changes to gulpfile.js.

This commit is contained in:
jordanbrauer 2016-10-04 12:03:59 -05:00
parent 9feb5aafed
commit fb8dbeed3d

View File

@ -1,6 +1,9 @@
// gulpfile.js // gulpfile.js
// Dependencies ================================= /*
* Dependencies =================================
* | uses/functions of each are provided indiviudally.
*/
var gulp = require('gulp'), // task runner/manager (even tho this is a small project, it's still nice to have) var gulp = require('gulp'), // task runner/manager (even tho this is a small project, it's still nice to have)
sass = require('gulp-sass'), // compiles sass for us sass = require('gulp-sass'), // compiles sass for us
notify = require('gulp-notify'), // notifies us when a gulp task is completed through a system notifcation notify = require('gulp-notify'), // notifies us when a gulp task is completed through a system notifcation
@ -11,18 +14,26 @@ var gulp = require('gulp'), // task runner/manager (even
runseq = require('run-sequence'), // runs a sequence of gulp tasks. this is used because gulp.run is deprecated. runseq = require('run-sequence'), // runs a sequence of gulp tasks. this is used because gulp.run is deprecated.
del = require('del'); // del is used to cleanup cache and build files. del = require('del'); // del is used to cleanup cache and build files.
// Variables ==================================== /*
// silly, long, reused paths/dirs go here. * Variables ====================================
* | silly, long, reused paths/dirs go here if needed.
*/
// Gulp Tasks =================================== /*
* Gulp Tasks ===================================
* | All gulp tasks will be written/explained here.
*/
// Build CSS task ---------------------------- /*
// Compiles scss into css, * Build CSS Task -------------------------------
// autoprefix necessary css attributes/values, * | $ gulp build
// minify prefixed css, * |
// rename minified file with a '.min' suffix, * | compiles scss into css,
// place into ./css directory * | autoprefix necessary css attributes/values,
// * | minify prefixed css,
* | rename minified file with a '.min' suffix,
* | place into ./css directory
*/
gulp.task('build', function() { gulp.task('build', function() {
return gulp.src('./sass/**/*.scss') return gulp.src('./sass/**/*.scss')
.pipe(sass()) .pipe(sass())
@ -34,27 +45,31 @@ gulp.task('build', function() {
.pipe(notify({ onLast: true, message: 'build task complete' })); .pipe(notify({ onLast: true, message: 'build task complete' }));
}); });
// Clean task ----------------------------------- /*
// Ensures that all artifacts/remnants of previous build are gone. * Clean Task -----------------------------------
// * | $ gulp clean
// $ gulp clean * |
* | Ensures that all artifacts/remnants of previous build are gone.
*/
gulp.task('clean', function() { gulp.task('clean', function() {
return del(['./css/**/*.*']); return del(['./css/**/*.*']);
}); });
// Watch task ----------------------------------- /*
// Great for automating compilation during develpoment. * Watch Task -----------------------------------
// * | $ gulp watch
// $ gulp watch * |
* | Great for automating compilation during develpoment.
*/
gulp.task('watch', function() { gulp.task('watch', function() {
gulp.watch('./sass/**/*.scss', ['clean', 'build']); gulp.watch('./sass/**/*.scss', ['clean', 'build']);
}); });
// Default task --------------------------------- /*
// Runs the watch task as a task dependency by default. * Default Task ---------------------------------
// To execute this command use one of the following commands * | $ gulp
// from within the project root. * | $ gulp default
// * |
// $ gulp * | Runs the watch task as a task dependency by default.
// $ gulp default */
gulp.task('default', ['watch']); gulp.task('default', ['watch']);