northem-light/gulpfile.js

A north-bluish, light color palette.

/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
title      Gulp Project File                                +
project    northem-light                                    +
version    2.0.1                                            +
repository https://github.com/arcticicestudio/northem-light +
author     Arctic Ice Studio                                +
email      development@arcticicestudio.com                  +
copyright  Copyright (C) 2016                               +
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

[Index]
  > Configuration
  > Imports
  > Tasks
      clean
      clean-css
      clean-documentation
      compile-css-template
      default
      sassdoc

[References]
Gulp
  (http://gulpjs.com)
npmjs
  (https://www.npmjs.com)
*/
"use strict";
/*+---------------+
  + Configuration +
  +---------------+*/
var config = {
  project: {
    id: "northem-light",
    name: "Northem Light",
    version: "2.0.1",
    repository: "https://github.com/arcticicestudio/northem-light",
    author: "Arctic Ice Studio",
    email: "development@arcticicestudio.com"
  },
  build: {
    base: "./build",
    css: "./build/css",
    sassdoc: "./build/documentation/sassdoc"
  },
  src: {
    sass: "./src/sass"
  },
  tasks: {
    compilation: {
      sass: {
        extensions: {
          input: ["scss"],
          output: "css"
        },
        options: {
          indentedSyntax: false,
          indentType: "space",
          indentWidth: 2,
          linefeed: "lf",
          outputStyle: "expanded",
          precision: 5,
          sourceComments: false
        }
      }
    }
  }
}

/*+---------+
  + Imports +
  +---------+*/
var del      = require("del");
var fs       = require("fs");
var gulp     = require("gulp-help")(require("gulp"));
var gulputil = require("gulp-util");
var path     = require("path");
var plumber  = require("gulp-plumber");
var rename   = require("gulp-rename");
var sass     = require("gulp-sass");
var sassdoc  = require("sassdoc");

/*+-------+
  + Tasks +
  +-------+*/
/**
 * Cleans the whole build folder.
 *
 * @since 2.0.0
 */
gulp.task("clean", function() {
  del(config.build.base);
});

/**
 * Cleans the CSS build folder.
 *
 * @since 2.0.0
 */
gulp.task("clean-css", function(){
  del(config.build.css);
});

/**
 * Cleans the documentation build folder.
 *
 * @since 2.0.0
 */
gulp.task("clean-documentation", function(){
  del(config.build.sassdoc);
});

/**
 * Compiles the Sass CSS template.
 *
 * @since 2.0.0
 */
gulp.task("compile-css-template", function() {
  return gulp.src(path.join(config.src.sass, "/template-css." + config.tasks.compilation.sass.extensions.input))
    .pipe(plumber())
    .pipe(sass(config.tasks.compilation.sass.options).on("error", sass.logError))
    .pipe(rename(config.project.id + "." + config.tasks.compilation.sass.extensions.output))
    .pipe(gulp.dest(config.build.css))
});

/**
 * Shows the help.
 *
 * @since 2.0.0
 */
gulp.task("default", ["help"]);

/**
 * Creates the Sassdoc documentation.
 *
 * @since 2.0.0
 */
gulp.task("sassdoc", function () {
  return gulp.src(path.join(config.src.sass, "/**/*." + config.tasks.compilation.sass.extensions.input))
    .pipe(sassdoc())
});