scss-lint 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05986225943272819dc966c20d294f39f54bd7ef
-  data.tar.gz: c5fb97b91c46be45d9a4bb72573356639e1f5afb
+  metadata.gz: e0c38097da925d1dcc77a8cc9c4d90468e598abb
+  data.tar.gz: e5e2f0352fc1e808b3ebe147c200c24727e425d0
 SHA512:
-  metadata.gz: b38f342599f822cb5d26617986f264e5ef2ad00ddddc10c049a57369a191706e77b38b9a97b9735daaa424703d19b93829a33f0a09b2ebac208bec52a5874eba
-  data.tar.gz: 45ecd691b23e170805dd1e45f509fbff7891c0f32880c1eeb4ff9d4967d7b7733128d1a3dcad4f367ac44309eca8ab79884dda18fe0436654c95d985a4f639b0
+  metadata.gz: 0e65ae3133dbdefac6e650b8561db659671280f659d050d37c5dc0704b3b592ac1d7ab8303a936ccaf0aa6fab6a02c50a2e8be254039e5cfc2caa741890cf600
+  data.tar.gz: e7677e4fe7bbc9337884d8cc423105a08d77361d9d50369ae41c4677677cf8626e920e791592d715db56d763dca2d91292469453a61b4201dbe66c1e3be25419

data/config/default.yml

@@ -43,6 +43,10 @@ linters:
   PlaceholderInExtend:
     enabled: true
 
+  SelectorDepth:
+    enabled: true
+    max_depth: 3
+
   Shorthand:
     enabled: true
 

data/lib/scss_lint/cli.rb

@@ -57,6 +57,10 @@ module SCSSLint
           @options[:excluded_files] = files
         end
 
+        opts.on('-f', '--format Formatter', 'Specify how to display lints', String) do |format|
+          set_output_format(format)
+        end
+
         opts.on('-i', '--include-linter linter,...', Array,
                 'Specify which linters you want to run') do |linters|
           @options[:included_linters] = linters
@@ -78,10 +82,6 @@ module SCSSLint
         opts.on_tail('-v', '--version', 'Show version') do
           print_version opts.program_name, VERSION
         end
-
-        opts.on('--xml', 'Output the results in XML format') do
-          @options[:reporter] = SCSSLint::Reporter::XMLReporter
-        end
       end
     end
 
@@ -175,6 +175,13 @@ module SCSSLint
       print output if output
     end
 
+    def set_output_format(format)
+      @options[:reporter] = SCSSLint::Reporter.const_get(format + 'Reporter')
+    rescue NameError
+      puts "Invalid output format specified: #{format}"
+      halt :config
+    end
+
     def print_linters
       puts 'Installed linters:'
 

data/lib/scss_lint/config.rb

@@ -68,27 +68,49 @@ module SCSSLint
             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
+      end
+
+      # Convert any config options that accept a single value or an array to an
+      # array form so that merging works.
+      def convert_single_options_to_arrays(options)
+        options = options.dup
+
         if options['exclude']
           # Ensure exclude is an array, since we allow user to specify a single
           # string. We do this before merging with the config loaded via
-          # inherit_form since this allows us to merge the excludes from that,
+          # inherit_from since this allows us to merge the excludes from that,
           # rather than overwriting them.
           options['exclude'] = [options['exclude']].flatten
         end
 
-        if options['inherit_from']
-          includes = [options.delete('inherit_from')].flatten.map do |include_file|
-            load_options_hash_from_file(path_relative_to_config(include_file, file))
-          end
+        options
+      end
 
-          merged_includes = includes[1..-1].inject(includes.first) do |merged, include_file|
-            smart_merge(merged, include_file)
-          end
+      # Loads and extends a list of inherited options with the given options.
+      def extend_inherited_configs(options, original_file)
+        return options unless options['inherit_from']
+        options = options.dup
 
-          options = smart_merge(merged_includes, options)
+        includes = [options.delete('inherit_from')].flatten.map do |include_file|
+          load_options_hash_from_file(path_relative_to_config(include_file, original_file))
         end
 
-        # Merge options from wildcard linters into individual linter configs
+        merged_includes = includes[1..-1].inject(includes.first) do |merged, include_file|
+          smart_merge(merged, include_file)
+        end
+
+        smart_merge(merged_includes, options)
+      end
+
+      # Merge options from wildcard linters into individual linter configs
+      def merge_wildcard_linter_options(options)
+        options = options.dup
+
         options.fetch('linters', {}).keys.each do |class_name|
           next unless class_name.include?('*')
 
@@ -106,7 +128,13 @@ module SCSSLint
           end
         end
 
-        # Ensure all excludes are absolute paths
+        options
+      end
+
+      # Ensure all excludes are absolute paths
+      def ensure_exclude_paths_are_absolute(options, original_file)
+        options = options.dup
+
         if options['exclude']
           excludes = [options['exclude']].flatten
 
@@ -115,7 +143,7 @@ module SCSSLint
               exclusion_glob
             else
               # Expand the path assuming it is relative to the config file itself
-              File.expand_path(exclusion_glob, File.expand_path(File.dirname(file)))
+              File.expand_path(exclusion_glob, File.expand_path(File.dirname(original_file)))
             end
           end
         end

data/lib/scss_lint/engine.rb

@@ -1,6 +1,8 @@
 require 'sass'
 
 module SCSSLint
+  # Contains all information for a parsed SCSS file, including its name,
+  # contents, and parse tree.
   class Engine
     ENGINE_OPTIONS = { cache: false, syntax: :scss }
 

data/lib/scss_lint/lint.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Stores information about a single problem that was detected by a [Linter].
   class Lint
     attr_reader :filename, :line, :description, :severity
 

data/lib/scss_lint/linter/color_keyword.rb

@@ -11,7 +11,7 @@ module SCSSLint
     def visit_script_string(node)
       return unless node.type == :identifier
 
-      remove_quoted_strings(node.value).scan(/[a-z]+/i) do |word|
+      remove_quoted_strings(node.value).scan(/(^|\s)([a-z]+)(?=\s|$)/i) do |_, word|
         add_color_lint(node, word) if color_keyword?(word)
       end
     end

data/lib/scss_lint/linter/declaration_order.rb

@@ -10,8 +10,8 @@ module SCSSLint
     ]
 
     def visit_rule(node)
-      children = node.children.select { |node| important_node?(node) }.
-                               map { |node| node.class }
+      children = node.children.select { |n| important_node?(n) }
+                              .map { |n| n.class }
 
       sorted_children = children.sort do |a, b|
         DECLARATION_ORDER.index(a) <=> DECLARATION_ORDER.index(b)

data/lib/scss_lint/linter/duplicate_property.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for a property declared twice in a rule set.
   class Linter::DuplicateProperty < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/empty_rule.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for rules with no content.
   class Linter::EmptyRule < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/hex_format.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for hexadecimal colors that can be shortened.
   class Linter::HexFormat < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/selector_depth.rb

@@ -0,0 +1,61 @@
+module SCSSLint
+  # Checks for selectors with large depths of applicability.
+  class Linter::SelectorDepth < Linter
+    include LinterRegistry
+
+    def visit_root(node)
+      @max_depth = config['max_depth']
+      @depth = 0
+      yield # Continue
+    end
+
+    def visit_rule(node)
+      old_depth = @depth
+      @depth = max_sequence_depth(node.parsed_rules, @depth)
+
+      if @depth > @max_depth
+        add_lint(node.parsed_rules || node,
+                 'Selector should have depth of applicability no greater ' <<
+                 "than #{@max_depth}, but was #{@depth}")
+      end
+
+      yield # Continue linting children
+      @depth = old_depth
+    end
+
+  private
+
+    # Find the maximum depth of all sequences in a comma sequence.
+    def max_sequence_depth(comma_sequence, current_depth)
+      # Sequence contains interpolation; assume a depth of 1
+      return current_depth + 1 unless comma_sequence
+
+      comma_sequence.members.map { |sequence| sequence_depth(sequence, current_depth) }.max
+    end
+
+    def sequence_depth(sequence, current_depth)
+      separators, simple_sequences = sequence.members.partition do |item|
+        item.is_a?(String)
+      end
+
+      parent_selectors = simple_sequences.count { |item| item.to_s == '&' }
+
+      # Take the number of simple sequences and subtract one for each sibling
+      # combinator, as these "combine" simple sequences such that they do not
+      # increase depth.
+      depth = simple_sequences.size -
+        separators.count { |item| item == '~' || item == '+'  }
+
+      if parent_selectors > 0
+        # If parent selectors are present, add the current depth for each
+        # additional parent selector.
+        depth += parent_selectors * (current_depth - 1)
+      else
+        # Otherwise this just descends from the containing selector
+        depth += current_depth
+      end
+
+      depth
+    end
+  end
+end

data/lib/scss_lint/linter/single_line_per_selector.rb

@@ -24,8 +24,8 @@ module SCSSLint
     # 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)
+        combined +
+          (string_or_script.is_a?(String) ? string_or_script : string_or_script.to_sass)
       end
     end
 

data/lib/scss_lint/linter/usage_name.rb

@@ -1,4 +1,6 @@
 module SCSSLint
+  # Checks for variable/function/mixin/placeholder uses which contains uppercase
+  # characters or underscores.
   class Linter::UsageName < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter_registry.rb

@@ -1,6 +1,7 @@
 module SCSSLint
   class NoSuchLinter < StandardError; end
 
+  # Stores all linters available to the application.
   module LinterRegistry
     @linters = []
 
@@ -16,7 +17,7 @@ module SCSSLint
           begin
             Linter.const_get(linter_name)
           rescue NameError
-            raise NoSuchLinter.new("Linter #{linter_name} does not exist")
+            raise NoSuchLinter, "Linter #{linter_name} does not exist"
           end
         end
       end

data/lib/scss_lint/reporter.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Responsible for displaying lints to the user in some format.
   class Reporter
     attr_reader :lints
 

data/lib/scss_lint/reporter/default_reporter.rb

@@ -1,6 +1,7 @@
 require 'colorize'
 
 module SCSSLint
+  # Reports a single line per lint.
   class Reporter::DefaultReporter < Reporter
     def report_lints
       if lints.any?

data/lib/scss_lint/reporter/xml_reporter.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Reports lints in an XML format.
   class Reporter::XMLReporter < Reporter
     def report_lints
       output = '<?xml version="1.0" encoding="utf-8"?>'

data/lib/scss_lint/sass/script.rb

@@ -1,4 +1,7 @@
 module Sass::Script
+  # Ignore documentation lints as these aren't original implementations.
+  # rubocop:disable Documentation
+
   # Redefine some of the lexer helpers in order to store the original string
   # with the created object so that the original string can be inspected rather
   # than a typically normalized version.

data/lib/scss_lint/sass/tree.rb

@@ -3,6 +3,9 @@
 # breaks the Sass compiler, but since we're only doing lints this is fine for
 # now.
 module Sass::Tree
+  # Ignore documentation lints as these aren't original implementations.
+  # rubocop:disable Documentation
+
   # Define some common helper code for use in the various monkey patchings.
   class Node
     # Stores node for which this node is a direct child

data/lib/scss_lint/version.rb

@@ -1,3 +1,4 @@
+# Defines the gem version.
 module SCSSLint
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -103,6 +103,7 @@ files:
 - lib/scss_lint/linter/declaration_order.rb
 - lib/scss_lint/linter/zero_unit.rb
 - lib/scss_lint/linter/placeholder_in_extend.rb
+- lib/scss_lint/linter/selector_depth.rb
 - lib/scss_lint/linter/compass/property_with_mixin.rb
 - lib/scss_lint/linter/space_after_property_name.rb
 - lib/scss_lint/linter/usage_name.rb
@@ -141,9 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: SCSS lint tool
 test_files: []
-has_rdoc: