compass.js

/*
 * grunt-contrib-compass
 * http://gruntjs.com/
 *
 * Copyright (c) 2016 Sindre Sorhus, contributors
 * Licensed under the MIT license.
 */

'use strict';
var binVersionCheck = require('bin-version-check');

module.exports = function (grunt) {
  var compass = require('./lib/compass').init(grunt);

  function compile(args, cb) {
    grunt.log.verbose.writeln('Running command: ' + args.join(' '));
    var child = grunt.util.spawn({
      cmd: args.shift(),
      args: args,
      opts: { shell: true },
    }, function (err, result, code) {
      if (code === 127) {
        grunt.warn(
          'You need to have Ruby and Compass installed ' +
          'and in your system PATH for this task to work. ' +
          'More info: https://github.com/gruntjs/grunt-contrib-compass'
        );
      }

      // `compass compile` exits with 1 and outputs "Nothing to compile"
      // on stderr when it has nothing to compile.
      // https://github.com/chriseppstein/compass/issues/993
      // Don't fail the task in this situation.
      if (code === 1 && !/Nothing to compile|Compass can't find any Sass files to compile/g.test(result.stderr)) {
        grunt.warn('↑');
      }

      cb();
    });
    if (child) {
      child.stdout.pipe(process.stdout);
      child.stderr.pipe(process.stderr);
    }
  }

  grunt.registerMultiTask('compass', 'Compile Sass to CSS using Compass', function () {
    var options = this.options();
    var cb = this.async();

    // display compilation time
    if (!options.clean) {
      options.time = true;
    }

    // create a function to retroactively add a banner to the top of the
    // generated files, if specified
    var bannerCallback = compass.buildBannerCallback(grunt, options);
    // create a temporary config file if there are 'raw' options or
    // settings not supported as CLI arguments
    var configContext = compass.buildConfigContext(options);
    // get the array of arguments for the compass command
    var args = compass.buildArgsArray(options);

    configContext(function (err, path) {
      if (err) {
        grunt.warn(err);
      }

      if (path) {
        // add `--config` path arguments before `--` option-argument separator if one exists,
        // otherwise add to the end
        var doubleDashIdx = args.indexOf('--');
        args.splice(doubleDashIdx === -1 ? args.length : doubleDashIdx, 0, '--config', path);
      }

      binVersionCheck(args[0], '>=0.12.2', function (err) {
        if (err) {
          grunt.warn(err);
        }

        compile(args, function () {
          bannerCallback();
          cb();
        });
      });
    });
  });
};