Add helper tests constants and support extra syntaxes

Author: DanPurdy

lib/constants.coffee

@@ -0,0 +1,3 @@
+module.exports =
+  SASSLINT_DOC_URL: 'https://github.com/sasstools/sass-lint/tree/master/docs/rules',
+  VALID_SYNTAXES: ['scss', 'sass']

lib/helpers.coffee

@@ -1,6 +1,35 @@
+path = require 'path'
+{SASSLINT_DOC_URL, VALID_SYNTAXES} = require './constants.coffee'
+
 module.exports =
 
-  # Constructs the rule URI from the rule ID provided
+  ###*
+   * Function to construct the rule URI from the rule ID provided
+   * @param {string} ruleId - The rule name / id
+   * @return {string} The rule URL
+   ###
   getRuleURI: (ruleId) ->
-    sassLintDocs = 'https://github.com/sasstools/sass-lint/tree/master/docs/rules'
-    return sassLintDocs + '/' + ruleId + '.md'
+    return SASSLINT_DOC_URL + '/' + ruleId + '.md'
+
+  ###*
+   * Function to check a file base / extension for valid extensions to use with sass-lint
+   * @param {string} syntax - The syntax to check
+   * @return {boolean} Whether or not the syntax is valid for sass-lint
+   ###
+  isValidSyntax: (syntax) ->
+    return VALID_SYNTAXES.indexOf(syntax) isnt -1
+
+  ###*
+   * Function to check a file base / extension for valid extensions to use with sass-lint
+   * @param {string} filePath - The filepath to check
+   * @return {string} The syntax we wish to pass to sass-lint
+   ###
+  getFileSyntax: (filePath) ->
+    existingSyntax = path.extname(filePath).slice(1)
+    if @isValidSyntax(existingSyntax) is false
+      base = path.parse(filePath).base.split('.')
+      syntax = (item for item in base when @isValidSyntax(item))
+      if syntax.length
+        return syntax[0]
+
+    return existingSyntax

lib/main.coffee

@@ -75,7 +75,7 @@ module.exports =
   provideLinter: ->
     {find} = require 'atom-linter'
     globule = require 'globule'
-    {getRuleURI} = require './helpers'
+    helpers = require './helpers'
 
     provider =
       name: 'sass-lint'
@@ -136,7 +136,7 @@ module.exports =
           if globule.isMatch(compiledConfig.files.include, relativePath) and not globule.isMatch(compiledConfig.files.ignore, relativePath)
             result = linter.lintText({
               text: editor.getText(),
-              format: path.extname(filePath).slice(1),
+              format: helpers.getFileSyntax(filePath),
               filename: filePath
             }, {}, config)
         catch error
@@ -169,7 +169,7 @@ module.exports =
           line = if msg.line then msg.line - 1 else 0
           col = if msg.column then msg.column - 1 else 0
           text = if msg.message then ' ' + msg.message else 'Unknown Error'
-          ruleHref = getRuleURI(msg.ruleId)
+          ruleHref = helpers.getRuleURI(msg.ruleId)
           html = '<a href="'+ ruleHref + '" class="badge badge-flexible sass-lint">' + msg.ruleId + '</a>' + text
 
           result = {

spec/helpers-spec.js

@@ -0,0 +1,48 @@
+'use babel';
+
+import { SASSLINT_DOC_URL } from '../lib/constants.coffee';
+
+const helpers = require('../lib/helpers.coffee');
+
+describe('helpers', () => {
+  describe('getRuleURI', () => {
+    it('should return the correct rule URL', () => {
+      const ruleId = 'no-ids';
+      const result = helpers.getRuleURI(ruleId);
+
+      expect(result).toEqual(`${SASSLINT_DOC_URL}/${ruleId}.md`);
+    });
+  });
+
+  describe('isValidSyntax', () => {
+    it('should return true if a supported syntax is passed', () => {
+      expect(helpers.isValidSyntax('scss')).toEqual(true);
+    });
+
+    it('should return false if a supported syntax is not passed', () => {
+      expect(helpers.isValidSyntax('html')).toEqual(false);
+    });
+  });
+
+  describe('getFileSyntax', () => {
+    it('it should return scss if a scss filename is provided', () => {
+      expect(helpers.getFileSyntax('test/file.scss')).toEqual('scss');
+    });
+
+    it('it should return sass if a sass filename is provided', () => {
+      expect(helpers.getFileSyntax('test/file.sass')).toEqual('sass');
+    });
+
+    it('it should return scss if a scss.liquid filename is provided', () => {
+      expect(helpers.getFileSyntax('test/file.scss.liquid')).toEqual('scss');
+    });
+
+    it('it should return sass if a sass.liquid filename is provided', () => {
+      expect(helpers.getFileSyntax('test/file.sass.liquid')).toEqual('sass');
+    });
+
+    it('it should return html if a html filename is provided', () => {
+      expect(helpers.getFileSyntax('test/file.html')).toEqual('html');
+    });
+  });
+});