scss-lint 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70bae0144c5b9e28dc02a481787f9a59d6904829
-  data.tar.gz: 0ae51c9a6ab0cca63274d0026ad07c27acecad75
+  metadata.gz: 1bbc506b11e888967c3a60b4ee497049899db21d
+  data.tar.gz: 3474861bb7c69bc96acfc51a6c4c78ac75372bb3
 SHA512:
-  metadata.gz: a3040302bcde27b996f2f1bb0e3825c0173c6b965d5ffe41e50d7c9313de01ef00482a7c4b408837776882098c9a492c82fb1bd86a2f9eb9b8536c7db838e7c1
-  data.tar.gz: ded041dd16b6b836c21db252c2747acabe2be2296b321cbfc763a7cdd89f9c8232c00b76f37f11045deb4adbb30842316154a32670f7c29c831a94e4061f0943
+  metadata.gz: abdcc9357f0db63b291114acf5748ea2df1ca077fca03033b8b71ac4faae48d26424d00ea23c846854f9da47a6c67baf5187cb34932182ced1f987932cc58970
+  data.tar.gz: 673461370cc8c5598b25bea6b2a06e8e61cb3b53389a7a729cebf6eb79b836b36d4e4c3d211a5aebf6826423b0536f27575042b1ee450712acc5f837b0031941

data/config/default.yml

@@ -21,6 +21,9 @@ linters:
   DuplicateProperty:
     enabled: true
 
+  DuplicateRoot:
+    enabled: true
+
   EmptyLineBetweenBlocks:
     enabled: true
     ignore_single_line_blocks: true
@@ -94,6 +97,9 @@ linters:
   TrailingSemicolonAfterPropertyValue:
     enabled: true
 
+  UnnecessaryMantissa:
+    enabled: true
+
   UrlFormat:
     enabled: true
 

data/lib/scss_lint.rb

@@ -2,6 +2,7 @@ require 'scss_lint/constants'
 require 'scss_lint/config'
 require 'scss_lint/cli'
 require 'scss_lint/engine'
+require 'scss_lint/location'
 require 'scss_lint/lint'
 require 'scss_lint/linter_registry'
 require 'scss_lint/runner'

data/lib/scss_lint/cli.rb

@@ -181,7 +181,7 @@ module SCSSLint
 
     # @param lints [Array<Lint>]
     def report_lints(lints)
-      sorted_lints = lints.sort_by { |l| [l.filename, l.line] }
+      sorted_lints = lints.sort_by { |l| [l.filename, l.location] }
       reporter = @options.fetch(:reporter, Reporter::DefaultReporter)
                          .new(sorted_lints)
       output = reporter.report_lints

data/lib/scss_lint/lint.rb

@@ -1,15 +1,15 @@
 module SCSSLint
   # Stores information about a single problem that was detected by a [Linter].
   class Lint
-    attr_reader :filename, :line, :description, :severity
+    attr_reader :filename, :location, :description, :severity
 
     # @param filename [String]
-    # @param line [Integer]
+    # @param location [SCSSLint::Location]
     # @param description [String]
     # @param severity [Symbol]
-    def initialize(filename, line, description, severity = :warning)
+    def initialize(filename, location, description, severity = :warning)
       @filename    = filename
-      @line        = line
+      @location    = location
       @description = description
       @severity    = severity
     end

data/lib/scss_lint/linter.rb

@@ -23,13 +23,34 @@ module SCSSLint
     # @param node_or_line [Sass::Script::Tree::Node, Sass::Engine::Line]
     # @param message [String]
     def add_lint(node_or_line, message)
-      line = node_or_line.respond_to?(:line) ? node_or_line.line : node_or_line
+      location = if node_or_line.respond_to?(:source_range) && node_or_line.source_range
+                   location_from_range(node_or_line.source_range)
+                 elsif node_or_line.respond_to?(:line)
+                   Location.new(node_or_line.line)
+                 else
+                   Location.new(node_or_line)
+                 end
 
       @lints << Lint.new(engine.filename,
-                         line,
+                         location,
                          message)
     end
 
+    # Extract {SCSSLint::Location} from a {Sass::Source::Range}.
+    #
+    # @param range [Sass::Source::Range]
+    # @return [SCSSLint::Location]
+    def location_from_range(range)
+      length = if range.start_pos.line == range.end_pos.line
+                 range.end_pos.offset - range.start_pos.offset
+               else
+                 line_source = engine.lines[range.start_pos.line]
+                 line_source.length - range.start_pos.offset + 1
+               end
+
+      Location.new(range.start_pos.line, range.start_pos.offset, length)
+    end
+
     # @param source_position [Sass::Source::Position]
     # @param offset [Integer]
     # @return [String] the character at the given [Sass::Source::Position]
@@ -72,7 +93,7 @@ module SCSSLint
     #
     # @param node [Sass::Tree::Node]
     # @return [true,false] whether the node spans a single line
-    def node_on_single_line(node)
+    def node_on_single_line?(node)
       return if node.source_range.start_pos.line != node.source_range.end_pos.line
 
       # The Sass parser reports an incorrect source range if the trailing curly

data/lib/scss_lint/linter/capitalization_in_selector.rb

@@ -33,7 +33,7 @@ module SCSSLint
       name = node.name.join
       if name =~ /[A-Z]/
         selector_name ||= node.class.name.split('::').last
-        add_lint(node, "#{selector_name} `#{name}` in selector should be " <<
+        add_lint(node, "#{selector_name} `#{name}` in selector should be " \
                        "written in all lowercase as `#{name.downcase}`")
       end
     end

data/lib/scss_lint/linter/color_keyword.rb

@@ -28,7 +28,7 @@ module SCSSLint
       end.inspect
 
       add_lint(node,
-               "Color `#{original}` should be written in hexadecimal form " <<
+               "Color `#{original}` should be written in hexadecimal form " \
                "as `#{shortest_hex_form(hex_form)}`")
     end
 

data/lib/scss_lint/linter/compass/property_with_mixin.rb

@@ -9,6 +9,11 @@ module SCSSLint
       if PROPERTIES_WITH_MIXINS.include?(prop_name)
         add_lint node, "Use the Compass `#{prop_name}` mixin instead of the property"
       end
+
+      if prop_name == 'display' && node.value.to_sass == 'inline-block'
+        add_lint node,
+                 'Use the Compass `inline-block` mixin instead of `display: inline-block`'
+      end
     end
 
   private

data/lib/scss_lint/linter/declaration_order.rb

@@ -27,7 +27,7 @@ module SCSSLint
   private
 
     MESSAGE =
-      'Rule sets should start with @extend declarations, followed by ' <<
+      'Rule sets should start with @extend declarations, followed by ' \
       'properties and nested rule sets, in that order'
 
     def important_node?(node)

data/lib/scss_lint/linter/duplicate_root.rb

@@ -0,0 +1,33 @@
+module SCSSLint
+  # Checks for identical root selectors.
+  class Linter::DuplicateRoot < Linter
+    include LinterRegistry
+
+    def visit_root(node)
+      # Root rules are evaluated per document, so use new hashes for eash file
+      @roots = {}
+      yield # Continue linting children
+    end
+
+    def visit_rule(node)
+      if @roots[node.rule]
+        add_lint node.line,
+                 "Merge root rule `#{node.rule.join}` with identical " \
+                 "rule on line #{@roots[node.rule].line}"
+      else
+        @roots[node.rule] = node
+      end
+
+      # Don't yield so we only check one level deep
+    end
+
+    # Define stubs so we don't check rules nested in other constructs
+    %w[
+      media
+      mixin
+      mixindef
+    ].each do |node_type|
+      define_method("visit_#{node_type}") { |*args| }
+    end
+  end
+end

data/lib/scss_lint/linter/empty_line_between_blocks.rb

@@ -30,7 +30,7 @@ module SCSSLint
     MESSAGE_FORMAT = '%s declaration should be %s by an empty line'
 
     def check(node, type)
-      return if config['ignore_single_line_blocks'] && node_on_single_line(node)
+      return if config['ignore_single_line_blocks'] && node_on_single_line?(node)
       check_preceding_node(node, type)
       check_following_node(node, type)
     end

data/lib/scss_lint/linter/id_with_extraneous_selector.rb

@@ -13,8 +13,10 @@ module SCSSLint
       end
 
       if can_be_simplified
-        add_lint(seq, "Selector `#{seq}` can be simplified to `#{id_sel}`, " <<
-                      'since IDs should be uniquely identifying')
+        # TODO: Sass::Selector::SimpleSequence#source_range sometimes lies about
+        # its line, so reference `#line` directly
+        add_lint(seq.line, "Selector `#{seq}` can be simplified to `#{id_sel}`, " <<
+                           'since IDs should be uniquely identifying')
       end
     end
   end

data/lib/scss_lint/linter/indentation.rb

@@ -31,7 +31,7 @@ module SCSSLint
 
       if actual_indent.length != @indent
         add_lint(node.line,
-                 "Line should be indented #{@indent} spaces, " <<
+                 "Line should be indented #{@indent} spaces, " \
                  "but was indented #{actual_indent.length} spaces")
         return true
       end

data/lib/scss_lint/linter/name_format.rb

@@ -47,7 +47,7 @@ module SCSSLint
 
     def check_name(node, node_type, node_text = node.name)
       if convention = violated_convention(node_text)
-        add_lint(node, "Name of #{node_type} `#{node_text}` should be " <<
+        add_lint(node, "Name of #{node_type} `#{node_text}` should be " \
                        "written #{convention[:explanation]}")
       end
     end

data/lib/scss_lint/linter/property_sort_order.rb

@@ -32,7 +32,7 @@ module SCSSLint
 
   private
 
-    MESSAGE = 'Properties should be sorted in order, with vendor-prefixed ' <<
+    MESSAGE = 'Properties should be sorted in order, with vendor-prefixed ' \
               'extensions before the standardized CSS property'
 
     # Compares two properties which can contain a vendor prefix. It allows for a

data/lib/scss_lint/linter/selector_depth.rb

@@ -15,7 +15,7 @@ module SCSSLint
 
       if @depth > @max_depth
         add_lint(node.parsed_rules || node,
-                 'Selector should have depth of applicability no greater ' <<
+                 'Selector should have depth of applicability no greater ' \
                  "than #{@max_depth}, but was #{@depth}")
       end
 

data/lib/scss_lint/linter/shorthand.rb

@@ -43,10 +43,17 @@ module SCSSLint
       end
     end
 
+    LIST_LITERAL_REGEX = %r{
+      \A
+      (\S+\s+\S+(\s+\S+){0,2})   # Two to four values separated by spaces
+      (\s+!\w+)?                 # Ignore `!important` priority overrides
+      \z
+    }x
+
     def check_script_string(prop, script_string)
       return unless script_string.type == :identifier
 
-      if values = script_string.value.strip[/\A(\S+\s+\S+(\s+\S+){0,2})\z/, 1]
+      if values = script_string.value.strip[LIST_LITERAL_REGEX, 1]
         check_shorthand(prop, script_string, values.split)
       end
     end
@@ -57,8 +64,8 @@ module SCSSLint
       shortest_form = condensed_shorthand(*values)
       return if values == shortest_form
 
-      add_lint(node, "Shorthand form for property `#{prop}` should be " <<
-                     "written more concisely as `#{shortest_form.join(' ')}` " <<
+      add_lint(node, "Shorthand form for property `#{prop}` should be " \
+                     "written more concisely as `#{shortest_form.join(' ')}` " \
                      "instead of `#{values.join(' ')}`")
     end
 

data/lib/scss_lint/linter/space_after_property_colon.rb

@@ -11,13 +11,13 @@ module SCSSLint
 
       if config['allow_extra_spaces']
         if spaces < MINIMUM_SPACES_AFTER_COLON
-          add_lint node, 'Colon after property should be followed by ' <<
-                         "at least #{pluralize(MINIMUM_SPACES_AFTER_COLON, 'space')} "
+          add_lint node, 'Colon after property should be followed by ' \
+                         "at least #{pluralize(MINIMUM_SPACES_AFTER_COLON, 'space')}"
         end
       elsif spaces != MINIMUM_SPACES_AFTER_COLON
-        add_lint node, 'Colon after property should be followed by ' <<
-                       pluralize(MINIMUM_SPACES_AFTER_COLON, 'space') <<
-                       " instead of #{pluralize(spaces, 'space')}"
+        add_lint node, 'Colon after property should be followed by ' \
+                       "#{pluralize(MINIMUM_SPACES_AFTER_COLON, 'space')} " \
+                       "instead of #{pluralize(spaces, 'space')}"
       end
     end
 

data/lib/scss_lint/linter/space_before_brace.rb

@@ -3,19 +3,40 @@ module SCSSLint
   class Linter::SpaceBeforeBrace < Linter
     include LinterRegistry
 
-    def visit_root(node)
-      engine.lines.each_with_index do |line, index|
+    def check_node(node)
+      source = source_from_range(node.source_range).strip
 
-        if config['allow_single_line_padding'] && node_on_single_line(node)
-          line.scan(/[^"#' ]\{/) do |match|
-            add_lint(index + 1, 'Opening curly brace `{` should be ' <<
-                                'preceded by at least one space')
-          end
-        else
-          line.scan(/[^"#'](?<![^ ] )\{/) do |match|
-            add_lint(index + 1, 'Opening curly brace `{` should be ' <<
-                                'preceded by one space')
-          end
+      # Only lint `@include`s which have curly braces
+      if source[-1] == '{'
+        check_for_space(node, source)
+      end
+
+      yield
+    end
+
+    alias_method :visit_function, :check_node
+    alias_method :visit_each, :check_node
+    alias_method :visit_for, :check_node
+    alias_method :visit_function, :check_node
+    alias_method :visit_mixindef, :check_node
+    alias_method :visit_mixin, :check_node
+    alias_method :visit_rule, :check_node
+    alias_method :visit_while, :check_node
+
+  private
+
+    def check_for_space(node, string)
+      line = node.source_range.end_pos.line
+
+      if config['allow_single_line_padding'] && node_on_single_line?(node)
+        if string[-2] != ' '
+          add_lint(line, 'Opening curly brace `{` should be ' \
+                              'preceded by at least one space')
+        end
+      else
+        if string[-2] != ' ' || string[-3] == ' '
+          add_lint(line, 'Opening curly brace `{` should be ' \
+                              'preceded by one space')
         end
       end
     end

data/lib/scss_lint/linter/space_between_parens.rb

@@ -26,8 +26,10 @@ module SCSSLint
       spaces = str.count ' '
 
       if spaces != @spaces
-        @lints << Lint.new(engine.filename, index + 1, "Expected #{pluralize(@spaces, 'space')}" <<
-                                                       " between parentheses instead of #{spaces}")
+        location = Location.new(index + 1)
+        message = "Expected #{pluralize(@spaces, 'space')}" <<
+                  " between parentheses instead of #{spaces}"
+        @lints << Lint.new(engine.filename, location, message)
       end
     end
   end

data/lib/scss_lint/linter/string_quotes.rb

@@ -53,7 +53,7 @@ module SCSSLint
         add_lint(node, 'Prefer single quoted strings') if string !~ /'/
       else
         if string =~ /(?<! \\) \\"/x && string !~ /'/
-          add_lint(node, 'Use single-quoted strings when writing double ' <<
+          add_lint(node, 'Use single-quoted strings when writing double ' \
                          'quotes to avoid having to escape the double quotes')
         end
       end
@@ -62,7 +62,7 @@ module SCSSLint
     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 ' <<
+          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")

data/lib/scss_lint/linter/trailing_semicolon_after_property_value.rb

@@ -16,7 +16,7 @@ module SCSSLint
           # being on the next line
           line = node.source_range.end_pos.line - 1
           add_lint line,
-                   'Property declaration should not have a space before ' <<
+                   'Property declaration should not have a space before ' \
                    'the terminating semicolon'
         end
       end

data/lib/scss_lint/linter/unnecessary_mantissa.rb

@@ -0,0 +1,42 @@
+module SCSSLint
+  # Checks for the unnecessary inclusion of a zero-value mantissa in numbers.
+  # (e.g. `4.0` could be written as just `4`)
+  class Linter::UnnecessaryMantissa < Linter
+    include LinterRegistry
+
+    def visit_script_string(node)
+      return unless node.type == :identifier
+
+      node.value.scan(REAL_NUMBER_REGEX) do |number, integer, mantissa, units|
+        if unnecessary_mantissa?(mantissa)
+          add_lint(node, MESSAGE_FORMAT % [number, integer, units])
+        end
+      end
+    end
+
+    def visit_script_number(node)
+      return unless match = REAL_NUMBER_REGEX.match(source_from_range(node.source_range))
+
+      if unnecessary_mantissa?(match[:mantissa])
+        add_lint(node, MESSAGE_FORMAT % [match[:number], match[:integer], match[:units]])
+      end
+    end
+
+  private
+
+    REAL_NUMBER_REGEX = %r{
+      \b(?<number>
+        (?<integer>\d*)
+        \.
+        (?<mantissa>\d+)
+        (?<units>\w*)
+      )\b
+    }ix
+
+    MESSAGE_FORMAT = '`%s` should be written without the mantissa as `%s%s`'
+
+    def unnecessary_mantissa?(mantissa)
+      mantissa !~ /[^0]/
+    end
+  end
+end

data/lib/scss_lint/linter/zero_unit.rb

@@ -21,7 +21,12 @@ module SCSSLint
 
   private
 
-    ZERO_UNIT_REGEX = /\b(0[a-z]+)\b/i
+    ZERO_UNIT_REGEX = %r{
+      \b
+      (?<!\.|\#)    # Ignore zeroes following `#` or `.` (colors / decimals)
+      (0[a-z]+)     # Zero followed by letters (indicating some sort of unit)
+      \b
+    }ix
 
     MESSAGE_FORMAT = '`%s` should be written without units as `0`'
 

data/lib/scss_lint/location.rb

@@ -0,0 +1,38 @@
+module SCSSLint
+  # Stores a location of {Lint} in a source.
+  class Location
+    include Comparable
+
+    attr_reader :line, :column, :length
+
+    # @param line [Integer] One-based index
+    # @param column [Integer] One-based index
+    # @param length [Integer] Number of characters, including the first character
+    def initialize(line = 1, column = 1, length = 1)
+      raise ArgumentError, "Line must be more than 0, passed #{line}" if line < 1
+      raise ArgumentError, "Column must be more than 0, passed #{column}" if column < 1
+      raise ArgumentError, "Length must be more than 0, passed #{length}" if length < 1
+
+      @line   = line
+      @column = column
+      @length = length
+    end
+
+    def ==(other)
+      [:line, :column, :length].all? do |attr|
+        send(attr) == other.send(attr)
+      end
+    end
+
+    alias_method :eql?, :==
+
+    def <=>(other)
+      [:line, :column, :length].each do |attr|
+        result = send(attr) <=> other.send(attr)
+        return result unless result == 0
+      end
+
+      0
+    end
+  end
+end

data/lib/scss_lint/reporter/default_reporter.rb

@@ -5,7 +5,7 @@ module SCSSLint
       if lints.any?
         lints.map do |lint|
           type = lint.error? ? '[E]'.color(:red) : '[W]'.color(:yellow)
-          "#{lint.filename.color(:cyan)}:" << "#{lint.line}".color(:magenta) <<
+          "#{lint.filename.color(:cyan)}:" << "#{lint.location.line}".color(:magenta) <<
                                       " #{type} #{lint.description}"
         end.join("\n") + "\n"
       end

data/lib/scss_lint/reporter/xml_reporter.rb

@@ -6,12 +6,14 @@ module SCSSLint
 
       output << '<lint>'
       lints.group_by(&:filename).each do |filename, file_lints|
-        output << "<file name='#{filename}'>"
+        output << "<file name=#{filename.encode(:xml => :attr)}>"
 
         file_lints.each do |lint|
-          output << "<issue line='#{lint.line}' " <<
-                           "severity='#{lint.severity}' " <<
-                           "reason='#{lint.description}' />"
+          output << "<issue line=\"#{lint.location.line}\" " <<
+                           "column=\"#{lint.location.column}\" " <<
+                           "length=\"#{lint.location.length}\" " <<
+                           "severity=\"#{lint.severity}\" " <<
+                           "reason=#{lint.description.encode(:xml => :attr)} />"
         end
 
         output << '</file>'

data/lib/scss_lint/runner.rb

@@ -43,15 +43,15 @@ module SCSSLint
           linter.run(engine, config.linter_options(linter))
         rescue => error
           raise LinterError,
-                "#{linter.class} raised unexpected error linting file #{file}: " <<
+                "#{linter.class} raised unexpected error linting file #{file}: " \
                 "'#{error.message}'",
                 error.backtrace
         end
       end
     rescue Sass::SyntaxError => ex
-      @lints << Lint.new(ex.sass_filename, ex.sass_line, ex.to_s, :error)
+      @lints << Lint.new(ex.sass_filename, Location.new(ex.sass_line), ex.to_s, :error)
     rescue FileEncodingError => ex
-      @lints << Lint.new(file, 1, ex.to_s, :error)
+      @lints << Lint.new(file, Location.new, 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.22.0'
+  VERSION = '0.23.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -81,6 +81,7 @@ files:
 - lib/scss_lint/version.rb
 - lib/scss_lint/constants.rb
 - lib/scss_lint/utils.rb
+- lib/scss_lint/location.rb
 - lib/scss_lint/reporter/files_reporter.rb
 - lib/scss_lint/reporter/xml_reporter.rb
 - lib/scss_lint/reporter/default_reporter.rb
@@ -106,6 +107,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/duplicate_root.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
@@ -122,6 +124,7 @@ files:
 - 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/unnecessary_mantissa.rb
 - lib/scss_lint/linter/comment.rb
 - lib/scss_lint/linter/empty_rule.rb
 - lib/scss_lint/linter/single_line_per_selector.rb
@@ -156,4 +159,3 @@ signing_key:
 specification_version: 4
 summary: SCSS lint tool
 test_files: []
-has_rdoc: