1. module gulp-sass-lint
   1. function gulp-sass-lint (options)
   2. function gulp-sass-lint.failOnError ()
   3. function gulp-sass-lint.format (writable)

module gulp-sass-lint

function gulp-sass-lint (options)

• description and source-code

  gulp-sass-lint = function (options) {
    var userOptions = options || {};
    var configFile = userOptions.configFile;
  
    var compile = through.obj(function (file, encoding, cb) {
  
      if (file.isNull()) {
        return cb();
      }
      if (file.isStream()) {
        this.emit('error', new PluginError(PLUGIN_NAME, 'Streams are not supported!'));
        return cb();
      }
  
      // load our config from sassLint and the user provided options if available
      file.sassConfig = lint.getConfig(userOptions, configFile);
      // save the config file within the file object for access when this file is piped around
      file.userOptions = userOptions;
      file.configFile = configFile;
  
      // lint the file and pass the user defined options and config path to sass lint to handle
      try {
        file.sassLint = [
          lint.lintFileText({
            'text': file.contents,
            'format': path.extname(file.path).replace('.', ''),
            'filename': path.relative(process.cwd(), file.path)
          }, userOptions, configFile)];
      } catch(e) {
        this.emit('error', new PluginError(PLUGIN_NAME, e.message));
      }
  
      this.push(file);
      cb();
    });
    return compile;
  }

• example usage

  n/a

function gulp-sass-lint.failOnError ()

• description and source-code

  failOnError = function () {
    var filesWithErrors = [];
    var compile = through({objectMode: true}, function (file, encoding, cb) {
      if (file.isNull()) {
        return cb();
      }
  
      if (file.isStream()) {
        this.emit('error', new PluginError(PLUGIN_NAME, 'Streams are not supported!'));
        return cb();
      }
  
      if (file.sassLint[0].errorCount > 0) {
        filesWithErrors.push(file);
      }
  
      this.push(file);
      cb();
    }, function (cb) {
      var errorMessage;
  
      if (filesWithErrors.length > 0) {
        errorMessage = filesWithErrors.map(function (file) {
          return file.sassLint[0].errorCount + ' errors detected in ' + file.relative
        }).join('\n');
  
        this.emit('error', new PluginError(PLUGIN_NAME, errorMessage));
      }
  
      cb();
    });
  
    return compile;
  }

• example usage

  ...
  var gulp = require('gulp'),
      sassLint = require('gulp-sass-lint');
  
  gulp.task('default', function () {
    return gulp.src('sass/**/*.s+(a|c)ss')
      .pipe(sassLint())
      .pipe(sassLint.format())
      .pipe(sassLint.failOnError())
  });
  ```
  
  ## API
  
  ### sassLint(options)
  ...

function gulp-sass-lint.format (writable)

• description and source-code

  format = function (writable) {
    var compile = through.obj(function (file, encoding, cb) {
      if (file.isNull()) {
        return cb();
      }
      if (file.isStream()) {
        this.emit('error', new PluginError(PLUGIN_NAME, 'Streams are not supported!'));
        return cb();
      }
  
      if (writable) {
        var result = lint.format(file.sassLint, file.userOptions, file.configFile);
        writable.write(result);
      }
      else {
        lint.outputResults(file.sassLint, file.userOptions, file.configFile);
      }
  
      this.push(file);
      cb();
    });
    return compile;
  }

• example usage

  ...
  
  var gulp = require('gulp'),
      sassLint = require('gulp-sass-lint');
  
  gulp.task('default', function () {
    return gulp.src('sass/**/*.s+(a|c)ss')
      .pipe(sassLint())
      .pipe(sassLint.format())
      .pipe(sassLint.failOnError())
  });
  ```
  
  ## API
  
  ### sassLint(options)
  ...