main.js

'use strict';

var assert = require('assert'),
    equal = require('deep-equal'),
    lint = require('../index'),
    fs = require('fs'),
    sinon = require('sinon');

var lintFile = function lintFile (file, options, cb) {
  cb = cb || options;
  options = options || {};

  var results = lint.lintFiles(process.cwd() + '/tests/sass/' + file, options);

  cb(results[0]);
};

var lintFiles = function lintFiles (files, options, configPath, cb) {
  options = options || {};
  var results = lint.lintFiles(files, options, configPath);

  cb(results);
};

var resultsObj = [{
  filePath: 'app/scss/echo-base/defaults/utilities/_mixins.scss',
  warningCount: 3,
  errorCount: 0,
  messages: [{
    ruleId: 'no-vendor-prefixes',
    line: 120,
    column: 8,
    message: 'Vendor prefixes should not be used',
    severity: 1
  }, {
    ruleId: 'no-vendor-prefixes',
    line: 130,
    column: 8,
    message: 'Vendor prefixes should not be used',
    severity: 1
  }, {
    ruleId: 'no-vendor-prefixes',
    line: 140,
    column: 8,
    message: 'Vendor prefixes should not be used',
    severity: 1
  }]
}, {
  filePath: 'app/scss/main.scss',
  warningCount: 0,
  errorCount: 2,
  messages: [{
    ruleId: 'no-ids',
    line: 52,
    column: 1,
    message: 'ID selectors not allowed',
    severity: 2
  }, {
    ruleId: 'no-ids',
    line: 57,
    column: 1,
    message: 'ID selectors not allowed',
    severity: 2
  }]
}];
var emptyResult = {
  filePath: 'tests/cli/cli.scss',
  warningCount: 0,
  errorCount: 0,
  messages: []
};
var oneWarningResult = {
  filePath: 'tests/cli/cli.scss',
  warningCount: 1,
  errorCount: 0,
  messages: [
    {
      ruleId: 'no-color-literals',
      line: 2,
      column: 10,
      message: 'Color literals such as \'red\' should only be used in variable declarations',
      severity: 1
    }
  ]
};
var multiInputResults = [{
  filePath: 'tests/cli/cli-error.sass',
  warningCount: 1,
  errorCount: 0,
  messages: [{
    ruleId: 'no-ids',
    line: 1,
    column: 1,
    message: 'ID selectors not allowed',
    severity: 1
  }]
}, {
  filePath: 'tests/cli/cli-error.scss',
  warningCount: 1,
  errorCount: 0,
  messages: [{
    ruleId: 'no-ids',
    line: 1,
    column: 1,
    message: 'ID selectors not allowed',
    severity: 1
  }]
}];
var stringInputResults = [{
  filePath: 'tests/cli/cli-error.sass',
  warningCount: 1,
  errorCount: 0,
  messages: [{
    ruleId: 'no-ids',
    line: 1,
    column: 1,
    message: 'ID selectors not allowed',
    severity: 1
  }]
}];

describe('sass lint', function () {
  describe('default functionality', function () {

    // ==============================================================================
    //  Not Error on Empty Files
    // ==============================================================================

    it('should not error if a file is empty', function (done) {
      lintFile('empty-file.scss', function (data) {
        assert.equal(0, data.warningCount);
        assert.equal(0, data.errorCount);
        assert.equal(0, data.messages.length);
        done();
      });
    });

    // ==============================================================================
    //  Not try to read directories
    // ==============================================================================
    it('should not try to blindly read and lint a directory', function (done) {
      var fileSpy = sinon.spy(lint, 'lintText');
      lintFiles('tests/dir-test/**/*.scss', {
        options: {
          'merge-default-rules': false
        },
        rules: {
          'no-ids': 1
        }}, '', function (data) {
          assert.equal(1, data[0].warningCount);
          assert.equal(0, data[0].errorCount);
          assert.equal(1, data[0].messages.length);

          assert(fileSpy.called);
          assert(fileSpy.calledOnce);
          assert(fileSpy.calledWithMatch({format: 'scss', filename: 'tests/dir-test/dir.scss/test.scss'}));
          assert(fileSpy.neverCalledWithMatch({filename: 'tests/dir-test/dir.scss'}));
          fileSpy.reset();
          done();
        }
      );
    });

    // ==============================================================================
    //  Parse files with YAML front matter
    // ==============================================================================

    it('should parse a file with front matter correctly and without parse error', function (done) {
      lintFile('front-matter/front-matter.scss', function (data) {
        assert.equal(0, data.errorCount);
        assert.equal(2, data.warningCount);
        done();
      });
    });

    it('should preserve line numbers after parsing a file with front matter', function (done) {
      lintFile('front-matter/front-matter.scss', function (data) {
        assert.equal(6, data.messages[0].line);
        done();
      });
    });

    // ==============================================================================
    //  Parse Errors should return as lint errors
    // ==============================================================================

    it('Parse Errors should return as lint errors', function (done) {
      lintFile('parse.scss', function (data) {
        assert.equal(1, data.errorCount);
        done();
      });
    });

    it('Parse Errors should not include warnings too', function (done) {
      lintFile('parse.scss', function (data) {
        assert.equal(0, data.warningCount);
        done();
      });
    });

    it('Parse Errors should return as severity 2', function (done) {
      lintFile('parse.scss', function (data) {
        var severity = data.messages[0].severity;

        assert.equal(2, severity);
        done();
      });
    });

    it('Parse Errors should return the correct error message', function (done) {
      lintFile('parse.scss', function (data) {
        var message = data.messages[0].message,
            expected = 'Please check validity of the block starting from line #5';

        assert.equal(expected, message);
        done();
      });
    });

    it('Parse Errors should return the rule ID \'Fatal\'', function (done) {
      lintFile('parse.scss', function (data) {
        var ruleId = data.messages[0].ruleId,
            expected = 'Fatal';

        assert.equal(expected, ruleId);
        done();
      });
    });
  });

  // ==============================================================================
  //  lintFileText
  // ==============================================================================


  describe('lintFileText', function () {
    var file,
        fileObj;

    beforeEach(function () {
      file = fs.readFileSync('tests/cli/cli.scss');
      fileObj = {
        'text': file,
        'format': 'scss',
        'filename': 'tests/cli/cli.scss'
      };
    });

    it('should ignore a file from the ignore section of a config file', function (done) {
      var result = lint.lintFileText(fileObj, {options: {'cache-config': false}}, 'tests/yml/.ignore-file.yml');
      assert(
        equal(
          result,
          emptyResult,
          {
            'strict': true
          }
        )
      );
      done();
    });

    it('should lint a file when no ignores are specified', function (done) {
      var result = lint.lintFileText(fileObj, {options: {'cache-config': false}}, 'tests/yml/.no-merge-default.yml');
      assert(
        equal(
          result,
          oneWarningResult,
          {
            'strict': true
          }
        )
      );
      done();
    });
  });

  // ==============================================================================
  //  Lint files with config path
  // ==============================================================================

  describe('sassLint Config load', function () {
    it('should accept multiple input sources in a config', function (done) {
      lintFiles(null, {options: {'cache-config': false}}, 'tests/yml/.multiple-inputs.yml', function (data) {
        assert.deepEqual(data, multiInputResults);
        done();
      });
    });

    it('should accept multiple input sources and ignores in a config', function (done) {
      lintFiles(null, {options: {'cache-config': false}}, 'tests/yml/.multiple-ignores.yml', function (data) {
        assert.deepEqual(data, []);
        done();
      });
    });

    it('should accept singular string input sources', function (done) {
      lintFiles(null, {options: {'cache-config': false}}, 'tests/yml/.single-input-include-string.yml', function (data) {
        assert.deepEqual(data, stringInputResults);
        done();
      });
    });

    it('should accept singular string input sources and ignores in a config file', function (done) {
      lintFiles(null, {options: {'cache-config': false}}, 'tests/yml/.multiple-ignore-strings.yml', function (data) {
        assert.deepEqual(data, []);
        done();
      });
    });
  });

  // ==============================================================================
  //  Counters
  // ==============================================================================

  describe('sassLint detect counts', function () {
    // ==============================================================================
    //  Error Count
    // ==============================================================================

    it('should equal 2 errors', function (done) {
      var result = lint.errorCount(resultsObj);

      assert.equal(2, result.count);
      done();
    });

    // ==============================================================================
    //  Warning count
    // ==============================================================================

    it('should equal 3 warnings', function (done) {
      var result = lint.warningCount(resultsObj);

      assert.equal(3, result.count);
      done();
    });

    // ==============================================================================
    //  Result count
    // ==============================================================================

    it('should equal 5 overall detects', function (done) {
      var result = lint.resultCount(resultsObj);

      assert.equal(5, result);
      done();
    });
  });
});