scss-lint 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 400884121e0e088fafe2953b2c2bf56957bff0e9
-  data.tar.gz: 59f9d1d2dd3c53c29f58acb39c2281f75e8520ff
+  metadata.gz: ee3e032cedba8042a60c3553efab8f57256e6d29
+  data.tar.gz: 4cc0c97f401c7d3fb69809a10a018ed6b963d5dd
 SHA512:
-  metadata.gz: 901f0882c448ba16faa3d5c6022004e06a883855fa25c21f97daf017e7793fb175ecc4475fea140e2a563742c7a44014e8bea8942a68f8a755da5af9271ec21c
-  data.tar.gz: a08001bb95198be920e2daa8c830ae569177ed6c0aeaf3d2e3497d482d296e0c8326f24d8dedb75f8d0712e7e2fa30fed4ebad7601a2b2e56f2d15d47e2d1c18
+  metadata.gz: a96e204786ee1c9c03753f89e76aabd7db21a6a65f595cfa757f7b6b02c3d69cb1b7c1aac4cdc0a97cd39038e39fd7aacf41e9bced89fd7913681af4eb4dfc3a
+  data.tar.gz: 65f3a369a456c75dcbfaa2a046c210e276a6f8a32d18c37bc32a7e646269a350eb3a599e9953d622a94e984d03349392072d74b881ee54779d21a0bbfa690797

data/config/default.yml

@@ -79,9 +79,16 @@ linters:
     enabled: true
     spaces: 0
 
+  StringQuotes:
+    enabled: true
+    style: single_quotes # or double_quotes
+
   TrailingSemicolonAfterPropertyValue:
     enabled: true
 
+  UrlQuotes:
+    enabled: true
+
   UsageName:
     enabled: true
 

data/lib/scss_lint/config.rb

@@ -62,16 +62,17 @@ module SCSSLint
         file_contents = load_file_contents(file)
 
         options =
-          if file_contents.strip.empty?
-            {}
+          if yaml = YAML.load(file_contents)
+            yaml.to_hash
           else
-            YAML.load(file_contents).to_hash
+            {}
           end
 
         options = convert_single_options_to_arrays(options)
         options = extend_inherited_configs(options, file)
         options = merge_wildcard_linter_options(options)
         options = ensure_exclude_paths_are_absolute(options, file)
+        options = ensure_linter_exclude_paths_are_absolute(options, file)
         options
       end
 
@@ -131,6 +132,19 @@ module SCSSLint
         options
       end
 
+      def ensure_linter_exclude_paths_are_absolute(options, original_file)
+        options = options.dup
+
+        options['linters'] ||= {}
+
+        options['linters'].keys.each do |linter_name|
+          options['linters'][linter_name] =
+            ensure_exclude_paths_are_absolute(options['linters'][linter_name], original_file)
+        end
+
+        options
+      end
+
       # Ensure all excludes are absolute paths
       def ensure_exclude_paths_are_absolute(options, original_file)
         options = options.dup
@@ -227,6 +241,14 @@ module SCSSLint
       end
     end
 
+    def excluded_file_for_linter?(file_path, linter)
+      abs_path = File.expand_path(file_path)
+
+      linter_options(linter).fetch('exclude', []).any? do |exclusion_glob|
+        File.fnmatch(exclusion_glob, abs_path)
+      end
+    end
+
     def exclude_file(file_path)
       abs_path = File.expand_path(file_path)
 

data/lib/scss_lint/engine.rb

@@ -1,6 +1,8 @@
 require 'sass'
 
 module SCSSLint
+  class FileEncodingError < StandardError; end
+
   # Contains all information for a parsed SCSS file, including its name,
   # contents, and parse tree.
   class Engine
@@ -20,6 +22,15 @@ module SCSSLint
 
       @lines = @contents.split("\n")
       @tree = @engine.to_tree
+    rescue Encoding::UndefinedConversionError, ArgumentError => error
+      if error.is_a?(Encoding::UndefinedConversionError) ||
+         error.message.include?('invalid byte sequence')
+        raise FileEncodingError,
+              "Unable to parse SCSS file: #{error.to_s}",
+              error.backtrace
+      else
+        raise
+      end
     end
   end
 end

data/lib/scss_lint/linter.rb

@@ -41,6 +41,29 @@ module SCSSLint
       engine.lines[actual_line][actual_offset]
     end
 
+    # Extracts the original source code given a range.
+    def source_from_range(source_range)
+      current_line = source_range.start_pos.line - 1
+      last_line = source_range.end_pos.line - 1
+
+      source = engine.lines[current_line][(source_range.start_pos.offset - 1)..-1]
+
+      current_line += 1
+      while current_line < last_line
+        source += "#{engine.lines[current_line]}\n"
+        current_line += 1
+      end
+
+      if source_range.start_pos.line != source_range.end_pos.line &&
+         # Sometimes the parser reports ranges ending on the first column of the
+         # line after the last line; don't include the last line in this case.
+         engine.lines.count == current_line - 1
+        source += "#{engine.lines[current_line][0...source_range.end_pos.offset]}\n"
+      end
+
+      source
+    end
+
     # Monkey-patched implementation that adds support for traversing
     # Sass::Script::Nodes (original implementation only supports
     # Sass::Tree::Nodes).

data/lib/scss_lint/linter/selector_depth.rb

@@ -39,6 +39,7 @@ module SCSSLint
       end
 
       parent_selectors = simple_sequences.count do |item|
+        next if item.is_a?(Array) # @keyframe percentages end up as Arrays
         item.rest.any? { |i| i.is_a?(Sass::Selector::Parent) }
       end
 

data/lib/scss_lint/linter/single_line_per_selector.rb

@@ -4,16 +4,14 @@ module SCSSLint
     include LinterRegistry
 
     def visit_rule(node)
-      add_lint(node) if invalid_comma_placement? node
+      add_lint(node, MESSAGE) if invalid_comma_placement?(node)
       yield # Continue linting children
     end
 
-    def description
-      'Each selector should be on its own line'
-    end
-
   private
 
+    MESSAGE = 'Each selector in a comma sequence should be on its own line'
+
     # A comma is invalid if it starts the line or is not the end of the line
     def invalid_comma_placement?(node)
       normalize_spacing(condense_to_string(node.rule)) =~ /\n,|,[^\n]/
@@ -23,10 +21,8 @@ module SCSSLint
     # Sass::Script::Nodes, we need to condense it into a single string that we
     # can run a regex against.
     def condense_to_string(sequence_list)
-      sequence_list.inject('') do |combined, string_or_script|
-        combined +
-          (string_or_script.is_a?(String) ? string_or_script : string_or_script.to_sass)
-      end
+      sequence_list.select { |item| item.is_a?(String) }
+                   .inject('') { |combined, item| combined + item }
     end
 
     # Removes extra spacing between lines in a comma-separated sequence due to

data/lib/scss_lint/linter/space_between_parens.rb

@@ -19,21 +19,6 @@ module SCSSLint
       end
     end
 
-    #def visit_script_number(node)
-      #puts node.class
-      #puts node.node_parent.class
-      #puts node.node_parent.node_parent.class
-      #puts node.inspect
-      #yield
-    #end
-
-    #def visit_script_operation(node)
-      #puts node.node_parent.class
-      #puts node.inspect
-      #puts node.source_range.inspect
-      #yield
-    #end
-
   private
 
     def check(str, index, engine)

data/lib/scss_lint/linter/string_quotes.rb

@@ -0,0 +1,75 @@
+module SCSSLint
+  # Checks the type of quotes used in string literals.
+  class Linter::StringQuotes < Linter
+    include LinterRegistry
+
+    def visit_script_string(node)
+      check_quotes(node, source_from_range(node.source_range))
+    end
+
+    def visit_import(node)
+      # @import source range conveniently includes only the quoted string
+      check_quotes(node, source_from_range(node.source_range))
+    end
+
+    def visit_charset(node)
+      # @charset source range includes entire declaration, so exclude '@charset' prefix
+      source = source_from_range(node.source_range)[('@charset'.length)..-1]
+
+      check_quotes(node, source)
+    end
+
+  private
+
+    def check_quotes(node, source)
+      source = source.strip
+      string = extract_string_without_quotes(source)
+      return unless string
+
+      case source[0]
+      when '"'
+        check_double_quotes(node, string)
+      when "'"
+        check_single_quotes(node, string)
+      end
+    end
+
+    STRING_WITHOUT_QUOTES_REGEX = %r{
+      \A
+      ["'](.*)["']    # Extract text between quotes
+      \s*\)?\s*;?\s*  # Sometimes the Sass parser includes a trailing ) or ;
+      (//.*)?         # Exclude any trailing comments that might have snuck in
+      \z
+    }x
+
+    def extract_string_without_quotes(source)
+      if match = STRING_WITHOUT_QUOTES_REGEX.match(source)
+        match[1]
+      end
+    end
+
+    def check_double_quotes(node, string)
+      if config['style'] == 'single_quotes'
+        add_lint(node, 'Prefer single quoted strings') if string !~ /'/
+      else
+        if string =~ /(?<! \\) \\"/x && string !~ /'/
+          add_lint(node, 'Use single-quoted strings when writing double quotes ' +
+                         'to avoid having to escape the double quotes')
+        end
+      end
+    end
+
+    def check_single_quotes(node, string)
+      if config['style'] == 'single_quotes'
+        if string =~ /(?<! \\) \\'/x && string !~ /"/
+          add_lint(node, 'Use double-quoted strings when writing single quotes ' +
+                         'to avoid having to escape the single quotes')
+        elsif string =~ /(?<! \\) \\"/x
+          add_lint(node, "Don't escape double quotes in single-quoted strings")
+        end
+      else
+        add_lint(node, 'Prefer double-quoted strings') if string !~ /"/
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/url_quotes.rb

@@ -0,0 +1,26 @@
+module SCSSLint
+  # Checks for quotes in URLs.
+  class Linter::UrlQuotes < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      case node.value
+      when Sass::Script::Tree::Literal
+        check(node, node.value.value.to_s)
+      when Sass::Script::Tree::ListLiteral
+        node.value.children.select { |child| child.is_a?(Sass::Script::Tree::Literal) }
+                           .each { |child| check(node, child.value.to_s) }
+      end
+
+      yield
+    end
+
+  private
+
+    def check(node, string)
+      if string =~ /^\s*url\(\s*[^"']/
+        add_lint(node, 'URLs should be enclosed in quotes')
+      end
+    end
+  end
+end

data/lib/scss_lint/reporter/files_reporter.rb

@@ -0,0 +1,8 @@
+module SCSSLint
+  # Reports a single line per file.
+  class Reporter::FilesReporter < Reporter
+    def report_lints
+      lints.map(&:filename).uniq.join("\n") + "\n" if lints.any?
+    end
+  end
+end

data/lib/scss_lint/runner.rb

@@ -34,6 +34,7 @@ module SCSSLint
 
       @linters.each do |linter|
         next unless config.linter_enabled?(linter)
+        next if config.excluded_file_for_linter?(file, linter)
 
         begin
           linter.run(engine, config.linter_options(linter))
@@ -46,6 +47,8 @@ module SCSSLint
       end
     rescue Sass::SyntaxError => ex
       @lints << Lint.new(ex.sass_filename, ex.sass_line, ex.to_s, :error)
+    rescue FileEncodingError => ex
+      @lints << Lint.new(file, 1, ex.to_s, :error)
     end
   end
 end

data/lib/scss_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SCSSLint
-  VERSION = '0.16.1'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 description: Opinionated tool to help write clean and consistent SCSS
 email:
 - eng@causes.com
@@ -81,6 +81,7 @@ files:
 - lib/scss_lint/version.rb
 - lib/scss_lint/constants.rb
 - lib/scss_lint/utils.rb
+- lib/scss_lint/reporter/files_reporter.rb
 - lib/scss_lint/reporter/xml_reporter.rb
 - lib/scss_lint/reporter/default_reporter.rb
 - lib/scss_lint/runner.rb
@@ -110,6 +111,7 @@ files:
 - lib/scss_lint/linter/space_after_property_name.rb
 - lib/scss_lint/linter/property_spelling.rb
 - lib/scss_lint/linter/usage_name.rb
+- lib/scss_lint/linter/url_quotes.rb
 - lib/scss_lint/linter/space_between_parens.rb
 - lib/scss_lint/linter/border_zero.rb
 - lib/scss_lint/linter/space_after_property_colon.rb
@@ -117,6 +119,7 @@ files:
 - lib/scss_lint/linter/duplicate_property.rb
 - lib/scss_lint/linter/hex_format.rb
 - lib/scss_lint/linter/color_keyword.rb
+- lib/scss_lint/linter/string_quotes.rb
 - lib/scss_lint/linter/leading_zero.rb
 - lib/scss_lint/linter/comment.rb
 - lib/scss_lint/linter/empty_rule.rb