scss_lint 0.41.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 478b23880809f4fb5eeb95543b34534de05edf5a
-  data.tar.gz: 97f5d37498b751b7bdae0dd23032acc92de56fdf
+  metadata.gz: 84412ffcfbcad02e1d135dae52e56c33c0f42c19
+  data.tar.gz: af6e1f97f4755ab0b69cf7b4162412571aa42704
 SHA512:
-  metadata.gz: 4808204c5756753ab99d9485590e034c6711f5b4ce67024c09dcfd281f6fa4199eb12331dd4a272933428c5991093bb4e6d2b5cf77743886df83488acc35651d
-  data.tar.gz: 951df4e1c90579ff4ebc55b61693bab102ba66761875781f6e0baf7d64232c0e95004f0de6eaacdc2db483a1c0d5d287aa79dd14d75d52220540f7cfbc129ee4
+  metadata.gz: 1fe04a0e8578d96cb59af5ea52bb4ca274d386153bbe9cb47541bb6f04905ff5e47062237bb7956dfcbdf860fde3c3814344321a62e1d3d3f21cb92a99939ebf
+  data.tar.gz: cefba0a8a5a0ab3b7c19e706efaaac38fbde69fabcd2ae813f4fc363ce2e42babd5fbca2261cf5db9c964a05d35dc2a262d756db45e88c5ced577a5b76b8a4c5

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2014-2015 Brigade
+http://www.brigade.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/config/default.yml

@@ -164,6 +164,7 @@ linters:
 
   SpaceAfterComma:
     enabled: true
+    style: one_space # or 'no_space', or 'at_least_one_space'
 
   SpaceAfterPropertyColon:
     enabled: true

data/lib/scss_lint/cli.rb

@@ -19,7 +19,6 @@ module SCSSLint
       software:       70, # Internal software error
       config:         78, # Configuration error
       no_files:       80, # No files matched by specified glob patterns
-      files_filtered: 81, # All matched files were filtered by exclusions
       plugin:         82, # Plugin loading error
     }
 
@@ -79,9 +78,6 @@ module SCSSLint
       when SCSSLint::Exceptions::RequiredLibraryMissingError
         puts exception.message
         halt :unavailable
-      when SCSSLint::Exceptions::AllFilesFilteredError
-        puts exception.message
-        halt :files_filtered
       when SCSSLint::Exceptions::NoFilesError
         puts exception.message
         halt :no_files

data/lib/scss_lint/config.rb

@@ -156,7 +156,7 @@ module SCSSLint
         else
           path = File.join(File.dirname(base_config_path), relative_include_path)
           # Remove double backslashes appearing in Windows paths.
-          path.gsub(%r{^//}, File::SEPARATOR)
+          path.sub(%r{^//}, File::SEPARATOR)
         end
       end
 

data/lib/scss_lint/engine.rb

@@ -8,7 +8,7 @@ module SCSSLint
   class Engine
     ENGINE_OPTIONS = { cache: false, syntax: :scss }
 
-    attr_reader :contents, :filename, :lines, :tree
+    attr_reader :contents, :filename, :lines, :tree, :any_control_commands
 
     # Creates a parsed representation of an SCSS document from the given string
     # or file.
@@ -27,7 +27,8 @@ module SCSSLint
       # Need `to_a` for Ruby 1.9.3.
       @lines = @contents.force_encoding('UTF-8').lines.to_a
       @tree = @engine.to_tree
-    rescue Encoding::UndefinedConversionError, Sass::SyntaxError => error
+      find_any_control_commands
+    rescue Encoding::UndefinedConversionError, Sass::SyntaxError, ArgumentError => error
       if error.is_a?(Encoding::UndefinedConversionError) ||
          error.message.match(/invalid.*(byte sequence|character)/i)
         raise FileEncodingError,
@@ -52,5 +53,10 @@ module SCSSLint
       @engine = Sass::Engine.new(scss, ENGINE_OPTIONS)
       @contents = scss
     end
+
+    def find_any_control_commands
+      @any_control_commands =
+        @lines.any? { |line| line['scss-lint:disable'] || line['scss-line:enable'] }
+    end
   end
 end

data/lib/scss_lint/exceptions.rb

@@ -1,8 +1,4 @@
 module SCSSLint::Exceptions
-  # Raised when all files matched by the specified glob patterns were filtered
-  # by exclude patterns.
-  class AllFilesFilteredError < StandardError; end
-
   # Raised when an invalid flag is given via the command line.
   class InvalidCLIOption < StandardError; end
 

data/lib/scss_lint/file_finder.rb

@@ -28,14 +28,7 @@ module SCSSLint
               "No SCSS files matched by the patterns: #{patterns.join(' ')}"
       end
 
-      filtered_files = matched_files.reject { |file| @config.excluded_file?(file) }
-      if filtered_files.empty?
-        raise SCSSLint::Exceptions::AllFilesFilteredError,
-              "All files matched by the patterns [#{patterns.join(', ')}] " \
-              "were excluded by the patterns: [#{@config.exclude_patterns.join(', ')}]"
-      end
-
-      filtered_files
+      matched_files.reject { |file| @config.excluded_file?(file) }
     end
 
   private

data/lib/scss_lint/linter.rb

@@ -68,7 +68,7 @@ module SCSSLint
       actual_line   = source_position.line - 1
       actual_offset = source_position.offset + offset - 1
 
-      engine.lines[actual_line][actual_offset]
+      engine.lines.size > actual_line && engine.lines[actual_line][actual_offset]
     end
 
     # Extracts the original source code given a range.
@@ -127,9 +127,9 @@ module SCSSLint
         visit_selector(node.parsed_rules)
       end
 
-      @comment_processor.before_node_visit(node)
+      @comment_processor.before_node_visit(node) if @engine.any_control_commands
       super
-      @comment_processor.after_node_visit(node)
+      @comment_processor.after_node_visit(node) if @engine.any_control_commands
     end
 
     # Redefine so we can set the `node_parent` of each node

data/lib/scss_lint/linter/color_variable.rb

@@ -3,6 +3,8 @@ module SCSSLint
   class Linter::ColorVariable < Linter
     include LinterRegistry
 
+    COLOR_FUNCTIONS = %w[rgb rgba hsl hsla]
+
     def visit_script_color(node)
       return if in_variable_declaration?(node) ||
                 in_map_declaration?(node) ||
@@ -30,6 +32,14 @@ module SCSSLint
       # comments, so it's easiest to just ignore them.
     end
 
+    def visit_script_funcall(node)
+      if color_function?(node) && all_arguments_are_literals?(node)
+        record_lint node, node.to_sass
+      else
+        yield
+      end
+    end
+
   private
 
     def record_lint(node, color)
@@ -63,5 +73,15 @@ module SCSSLint
     def in_map_declaration?(node)
       node_ancestor(node, 2).is_a?(Sass::Script::Tree::MapLiteral)
     end
+
+    def all_arguments_are_literals?(node)
+      node.args.all? do |arg|
+        arg.is_a?(Sass::Script::Tree::Literal)
+      end
+    end
+
+    def color_function?(node)
+      COLOR_FUNCTIONS.include?(node.name)
+    end
   end
 end

data/lib/scss_lint/linter/else_placement.rb

@@ -7,6 +7,7 @@ module SCSSLint
     def visit_if(node)
       visit_else(node, node.else) if node.else
       yield # Lint nested @if statements
+      visit(node.else) if node.else
     end
 
     def visit_else(if_node, else_node)

data/lib/scss_lint/linter/import_path.rb

@@ -43,13 +43,13 @@ module SCSSLint
       fixed_basename = orig_basename
 
       if config['leading_underscore']
-        fixed_basename = '_' + fixed_basename unless fixed_basename.match(/^_/)
+        fixed_basename = '_' + fixed_basename unless fixed_basename.start_with?('_')
       else
         fixed_basename = fixed_basename.sub(/^_/, '')
       end
 
       if config['filename_extension']
-        fixed_basename += '.scss' unless fixed_basename.match(/\.scss$/)
+        fixed_basename += '.scss' unless fixed_basename.end_with?('.scss')
       else
         fixed_basename = fixed_basename.sub(/\.scss$/, '')
       end

data/lib/scss_lint/linter/name_format.rb

@@ -52,7 +52,7 @@ module SCSSLint
     def trim_underscore_prefix(name)
       if config['allow_leading_underscore']
         # Remove if there is a single leading underscore
-        name = name.gsub(/^_(?!_)/, '')
+        name = name.sub(/^_(?!_)/, '')
       end
 
       name

data/lib/scss_lint/linter/space_after_comma.rb

@@ -59,7 +59,16 @@ module SCSSLint
       end
     end
 
-    EXPECTED_SPACES_AFTER_COMMA = 1
+    def valid_spaces_after_comma?(spaces)
+      case config['style']
+      when 'one_space'
+        spaces == 1
+      when 'no_space'
+        spaces == 0
+      when 'at_least_one_space'
+        spaces >= 1
+      end
+    end
 
     # Check the comma after each argument in a list for a space following it,
     # reporting a lint using the given [arg_type].
@@ -79,7 +88,7 @@ module SCSSLint
           offset += 1
         end
         next if char == "\n" || # Ignore trailing spaces
-                spaces == EXPECTED_SPACES_AFTER_COMMA
+                valid_spaces_after_comma?(spaces)
 
         add_lint arg, "Commas in #{arg_type} should be followed by a single space"
       end

data/lib/scss_lint/linter/space_around_operator.rb

@@ -3,20 +3,32 @@ module SCSSLint
   class Linter::SpaceAroundOperator < Linter
     include LinterRegistry
 
-    def visit_script_operation(node) # rubocop:disable Metrics/AbcSize
-      source = normalize_source(source_from_range(node.source_range))
-      left_range = node.operand1.source_range
-      right_range = node.operand2.source_range
-
-      # We need to #chop at the end because an operation's operand1 _always_
-      # includes one character past the actual operand (which is either a
-      # whitespace character, or the first character of the operation).
-      left_source = normalize_source(source_from_range(left_range))
-      right_source = normalize_source(source_from_range(right_range))
-      operator_source = source_between(left_range, right_range)
-      left_source, operator_source = adjust_left_boundary(left_source, operator_source)
-
-      match = operator_source.match(/
+    def visit_script_operation(node)
+      operation_sources = OperationSources.new(node, self)
+      operation_sources.adjust_sources
+
+      # When an operation is found interpolated within something not a String
+      # (only selectors?), the source ranges are offset by two (probably not
+      # accounting for the `#{`. Slide everything to the left by 2, and maybe
+      # things will look sane this time.
+      unless operation_sources.operator_source =~ Sass::Script::Lexer::REGULAR_EXPRESSIONS[:op]
+        operation_sources.adjust_for_interpolation
+        operation_sources.adjust_sources
+      end
+
+      check(node, operation_sources)
+
+      yield
+    end
+
+    def source_fm_range(range)
+      source_from_range(range)
+    end
+
+  private
+
+    def check(node, operation_sources)
+      match = operation_sources.operator_source.match(/
         (?<left_space>\s*)
         (?<operator>\S+)
         (?<right_space>\s*)
@@ -24,63 +36,107 @@ module SCSSLint
 
       if config['style'] == 'one_space'
         if match[:left_space] != ' ' || match[:right_space] != ' '
-          add_lint(node, SPACE_MSG % [source, left_source, match[:operator], right_source])
+          add_lint(node, operation_sources.space_msg(match[:operator]))
         end
       elsif match[:left_space] != '' || match[:right_space] != ''
-        add_lint(node, NO_SPACE_MSG % [source, left_source, match[:operator], right_source])
+        add_lint(node, operation_sources.no_space_msg(match[:operator]))
       end
-
-      yield
     end
 
-  private
+    # A helper class for storing and adjusting the sources of the different
+    # components of an Operation node.
+    class OperationSources
+      attr_reader :operator_source
 
-    SPACE_MSG = '`%s` should be written with a single space on each side of ' \
-                'the operator: `%s %s %s`'
-    NO_SPACE_MSG = '`%s` should be written without spaces around the ' \
-                   'operator: `%s%s%s`'
-
-    def source_between(range1, range2)
-      # We don't want to add 1 to range1.end_pos.offset for the same reason as
-      # the #chop comment above.
-      between_start = Sass::Source::Position.new(
-        range1.end_pos.line,
-        range1.end_pos.offset,
-      )
-      between_end = Sass::Source::Position.new(
-        range2.start_pos.line,
-        range2.start_pos.offset - 1,
-      )
-
-      source_from_range(Sass::Source::Range.new(between_start,
-                                                between_end,
-                                                range1.file,
-                                                range1.importer))
-    end
+      def initialize(node, linter)
+        @node = node
+        @linter = linter
+        @source = normalize_source(@linter.source_fm_range(@node.source_range))
+        @left_range = @node.operand1.source_range
+        @right_range = @node.operand2.source_range
+      end
 
-    # Removes trailing parentheses and compacts newlines into a single space
-    def normalize_source(source)
-      source.chop.gsub(/\s*\n\s*/, ' ')
-    end
+      def adjust_sources
+        # We need to #chop at the end because an operation's operand1 _always_
+        # includes one character past the actual operand (which is either a
+        # whitespace character, or the first character of the operation).
+        @left_source = normalize_source(@linter.source_fm_range(@left_range))
+        @right_source = normalize_source(@linter.source_fm_range(@right_range))
+        @operator_source = calculate_operator_source
+        adjust_left_boundary
+      end
 
-    def adjust_left_boundary(left, operator)
-      # If the left operand is wrapped in parentheses, any right parens end up
-      # in the operator source. Here, we move them into the left operand
-      # source, which is awkward in any messaging, but it works.
-      if match = operator.match(/^(\s*\))+/)
-        left += match[0]
-        operator = operator[match.end(0)..-1]
+      def adjust_for_interpolation
+        @source = normalize_source(
+          @linter.source_fm_range(slide_to_the_left(@node.source_range)))
+        @left_range = slide_to_the_left(@node.operand1.source_range)
+        @right_range = slide_to_the_left(@node.operand2.source_range)
       end
 
-      # If the left operand is a nested operation, Sass includes any whitespace
-      # before the (outer) operator in the left operator's source_range's
-      # end_pos, which is not the case with simple, non-operation operands.
-      if match = left.match(/\s+$/)
-        left = left[0..match.begin(0)]
-        operator = match[0] + operator
+      def space_msg(operator)
+        SPACE_MSG % [@source, @left_source, operator, @right_source]
       end
 
-      [left, operator]
+      def no_space_msg(operator)
+        NO_SPACE_MSG % [@source, @left_source, operator, @right_source]
+      end
+
+    private
+
+      SPACE_MSG = '`%s` should be written with a single space on each side of ' \
+                  'the operator: `%s %s %s`'
+
+      NO_SPACE_MSG = '`%s` should be written without spaces around the ' \
+                     'operator: `%s%s%s`'
+
+      def calculate_operator_source
+        # We don't want to add 1 to range1.end_pos.offset for the same reason as
+        # the #chop comment above.
+        between_start = Sass::Source::Position.new(
+          @left_range.end_pos.line,
+          @left_range.end_pos.offset,
+        )
+        between_end = Sass::Source::Position.new(
+          @right_range.start_pos.line,
+          @right_range.start_pos.offset - 1,
+        )
+
+        @linter.source_fm_range(Sass::Source::Range.new(between_start,
+                                                        between_end,
+                                                        @left_range.file,
+                                                        @left_range.importer))
+      end
+
+      def adjust_left_boundary
+        # If the left operand is wrapped in parentheses, any right parens end up
+        # in the operator source. Here, we move them into the left operand
+        # source, which is awkward in any messaging, but it works.
+        if match = @operator_source.match(/^(\s*\))+/)
+          @left_source += match[0]
+          @operator_source = @operator_source[match.end(0)..-1]
+        end
+
+        # If the left operand is a nested operation, Sass includes any whitespace
+        # before the (outer) operator in the left operator's source_range's
+        # end_pos, which is not the case with simple, non-operation operands.
+        if match = @left_source.match(/\s+$/)
+          @left_source = @left_source[0..match.begin(0)]
+          @operator_source = match[0] + @operator_source
+        end
+
+        [@left_source, @operator_source]
+      end
+
+      # Removes trailing parentheses and compacts newlines into a single space
+      def normalize_source(source)
+        source.chop.gsub(/\s*\n\s*/, ' ')
+      end
+
+      def slide_to_the_left(range)
+        start_pos = Sass::Source::Position.new(range.start_pos.line, range.start_pos.offset - 2)
+        end_pos = Sass::Source::Position.new(range.end_pos.line, range.end_pos.offset - 2)
+        Sass::Source::Range.new(start_pos, end_pos, range.file, range.importer)
+      end
     end
   end
 end