Update supercollider and panini dependencies, and add comments to Gulpfile tasks

diff --git a/gulpfile.js b/gulpfile.js
index 8c8055050f71a0bb97df7714eaae75749163f702..dcbf745aad4bef47685393debbbe4c9283774081 100644 (file)
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -8,6 +8,7 @@ var browser = require('browser-sync');
 var foundationDocs = require('foundation-docs');
 var octophant = require('octophant');
 
+// Configuration for the documentation generator
 supercollider
   .config({
     template: foundationDocs.componentTemplate,
@@ -17,15 +18,18 @@ supercollider
   .adapter('sass')
   .adapter('js');
 
+// Cleans the build folder
 gulp.task('clean', function(cb) {
   rimraf('_build', cb);
 });
 
+// Copies static documentation assets
 gulp.task('copy', function() {
   return gulp.src(['docs/assets/**/*', '!docs/assets/scss/**/*'])
     .pipe(gulp.dest('_build/assets'));
 });
 
+// Builds documentation pages
 gulp.task('html', function() {
   return gulp.src('docs/pages/**/*')
     .pipe($.cached('docs'))
@@ -40,6 +44,7 @@ gulp.task('html', function() {
 
 gulp.task('sass', ['sass:docs', 'sass:foundation']);
 
+// Compiles documentation-specific CSS
 gulp.task('sass:docs', function() {
   return gulp.src('docs/assets/scss/docs.scss')
     .pipe($.sass({ includePaths: [process.cwd()] }).on('error', $.sass.logError))
@@ -49,12 +54,14 @@ gulp.task('sass:docs', function() {
     .pipe(gulp.dest('_build/assets/css'));
 });
 
+// Compiles Foundation-specific CSS
 gulp.task('sass:foundation', function() {
   return gulp.src('scss/foundation.scss')
     .pipe($.sass().on('error', $.sass.logError))
     .pipe(gulp.dest('_build/assets/css'));
 });
 
+// Generates a Sass settings file from the current codebase
 gulp.task('settings', function() {
   octophant('scss/**/*.scss', {
     title: 'Foundation for Emails Settings',
@@ -63,6 +70,7 @@ gulp.task('settings', function() {
   });
 });
 
+// Lints the Sass codebase
 gulp.task('lint', function() {
   return gulp.src('scss/**/*.scss')
     .pipe($.sassLint())
@@ -70,16 +78,19 @@ gulp.task('lint', function() {
     .pipe($.sassLint.failOnError());
 });
 
+// Creates a BrowserSync server
 gulp.task('server', ['build'], function() {
   browser.init({
     server: './_build'
   });
 });
 
+// Runs the entire build process
 gulp.task('build', function(cb) {
   sequence('clean', ['copy', 'html', 'sass'], cb);
 });
 
+// Runs the build process, spins up a server, and watches for file changes
 gulp.task('default', ['server'], function() {
   gulp.watch('docs/**/*', ['html', browser.reload]);
   gulp.watch('docs/assets/scss/**/*', ['sass:docs', browser.reload]);

diff --git a/package.json b/package.json
index 8494ade82532302fb3cf7128c77c352f4f123be8..aac3de721d33c0e458a6b1a3bb8cc6dbd24f9927 100644 (file)
--- a/package.json
+++ b/package.json
@@ -39,11 +39,11 @@
     "media-query-extractor": "^0.1.1",
     "multiline": "^1.0.2",
     "octophant": "^1.0.0",
-    "panini": "^1.1.1",
+    "panini": "^1.2.0",
     "rimraf": "^2.4.2",
     "run-sequence": "^1.1.2",
     "string-template": "^0.2.1",
-    "supercollider": "^1.1.1",
+    "supercollider": "^1.3.0",
     "typeahead.js": "^0.11.1",
     "yargs": "^3.9.0",
     "zeroclipboard": "^2.2.0"