scss_lint 0.42.2 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bb29e6e4cef4d98cce3e61248d11f2dde2315a1
-  data.tar.gz: 52c5cdfb7895f10c883188633a75c32b3e77267a
+  metadata.gz: 26102783a3fa8f2e4ade260a8a483aa2d2a315f6
+  data.tar.gz: ce8673ca36772ff3505bb6ce3eec4861f78ebed4
 SHA512:
-  metadata.gz: 5e68b7e8d5afa4970b42da268f4fb2085c2ee81ab5f4eb0d020a67b97af286ec629ccad33429d542723bf0dd851e9c8ae31a93c464d203609c0b0c4c26db7c5b
-  data.tar.gz: 5cc833524095ed48bd5a01e3aebd2a4919ec4c79149b7d0f7c006552bdeb5d6fd42512109fdb6994ee78b50461cb144c3a7283703726d99b71a5cca2d4b691f7
+  metadata.gz: d5558f7bbe06908b1901d949215856aad7c0318a4fb10305ff89e3dbea00b08a73c1dcd5edece21898b37cf331585e37c02429ec66337a3a5a887365fa151a18
+  data.tar.gz: 08b6257a9482c94ee656debfc1b141a0c557dccdb970bec4df3588f6ec69dab8888e9a282ab8f74a580f783c81844136f2c729c034a32703dd756873a2a4d0a7

data/config/default.yml

@@ -21,6 +21,9 @@ linters:
     enabled: true
     convention: zero # or `none`
 
+  ChainedClasses:
+    enabled: false
+
   ColorKeyword:
     enabled: true
 
@@ -29,6 +32,7 @@ linters:
 
   Comment:
     enabled: true
+    style: silent
 
   DebugStatement:
     enabled: true
@@ -123,6 +127,7 @@ linters:
   PropertySpelling:
     enabled: true
     extra_properties: []
+    disabled_properties: []
 
   PropertyUnits:
     enabled: true
@@ -137,6 +142,9 @@ linters:
       '%']                                     # Other
     properties: {}
 
+  PseudoElement:
+    enabled: true
+
   QualifyingElement:
     enabled: true
     allow_element_with_attribute: false
@@ -178,7 +186,7 @@ linters:
 
   SpaceAroundOperator:
     enabled: true
-    style: one_space # or 'no_space'
+    style: one_space # or 'at_least_one_space', or 'no_space'
 
   SpaceBeforeBrace:
     enabled: true

data/data/properties.txt

@@ -421,8 +421,8 @@ text-overline-style
 text-overline-width
 text-rendering
 text-security
-text-size-adjust
 text-shadow
+text-size-adjust
 text-stroke
 text-stroke-color
 text-stroke-width

data/lib/scss_lint/cli.rb

@@ -54,8 +54,16 @@ module SCSSLint
 
     def scan_for_lints(options, config)
       runner = Runner.new(config)
-      runner.run(FileFinder.new(config).find(options[:files]))
-      report_lints(options, runner.lints, runner.files)
+      files =
+        if options[:stdin_file_path]
+          [{ file: STDIN, path: options[:stdin_file_path] }]
+        else
+          FileFinder.new(config).find(options[:files]).map do |file_path|
+            { path: file_path }
+          end
+        end
+      runner.run(files)
+      report_lints(options, runner.lints, files)
 
       if runner.lints.any?(&:error?)
         halt :error
@@ -203,9 +211,7 @@ module SCSSLint
     def print_linters
       puts 'Installed linters:'
 
-      linter_names = LinterRegistry.linters.map do |linter|
-        linter.name.split('::').last
-      end
+      linter_names = LinterRegistry.linters.map(&:simple_name)
 
       linter_names.sort.each do |linter_name|
         puts " - #{linter_name}"

data/lib/scss_lint/config.rb

@@ -41,8 +41,7 @@ module SCSSLint
       end
 
       def linter_name(linter)
-        linter = linter.is_a?(Class) ? linter : linter.class
-        linter.name.split('::')[2..-1].join('::')
+        (linter.is_a?(Class) ? linter : linter.class).simple_name
       end
 
     private

data/lib/scss_lint/control_comment_processor.rb

@@ -20,19 +20,21 @@ module SCSSLint
     #
     # @param node [Sass::Tree::Node]
     def before_node_visit(node)
-      return unless command = extract_command(node)
+      return unless (commands = Array(extract_commands(node))).any?
 
-      linters = command[:linters]
-      return unless linters.include?('all') || linters.include?(@linter.name)
+      commands.each do |command|
+        linters = command[:linters]
+        next unless linters.include?('all') || linters.include?(@linter.name)
 
-      process_command(command, node)
+        process_command(command, node)
 
-      # Is the control comment the only thing on this line?
-      return if node.is_a?(Sass::Tree::RuleNode) ||
-                %r{^\s*(//|/\*)}.match(@linter.engine.lines[command[:line] - 1])
+        # Is the control comment the only thing on this line?
+        next if node.is_a?(Sass::Tree::RuleNode) ||
+                  %r{^\s*(//|/\*)}.match(@linter.engine.lines[command[:line] - 1])
 
-      # Otherwise, pop since we only want comment to apply to the single line
-      pop_control_comment_stack(node)
+        # Otherwise, pop since we only want comment to apply to the single line
+        pop_control_comment_stack(node)
+      end
     end
 
     # Executed after a node has been visited.
@@ -46,35 +48,38 @@ module SCSSLint
 
   private
 
-    def extract_command(node)
+    def extract_commands(node)
       return unless comment = retrieve_comment_text(node)
 
-      comment.split(/(?<=\n)/).each_with_index do |comment_line, line_no|
-        if match = %r{
-          (/|\*|^ \*)\s* # Comment start marker
-          scss-lint:
+      commands = []
+      comment.split("\n").each_with_index do |comment_line, line_no|
+        next unless match = %r{
+          //\s*scss-lint:
           (?<action>disable|enable)\s+
           (?<linters>.*?)
-          \s*(?:\*/|\n) # Comment end marker or end of line
+          \s*($|\*\/) # End of line
         }x.match(comment_line)
-          return {
-            action: match[:action],
-            linters: match[:linters].split(/\s*,\s*|\s+/),
-            line: node.line + line_no
-          }
-        end
+
+        commands << {
+          action: match[:action],
+          linters: match[:linters].split(/\s*,\s*|\s+/),
+          line: node.line + line_no
+        }
       end
 
-      false
+      commands
     end
 
     def retrieve_comment_text(node)
-      case node
-      when Sass::Tree::CommentNode
-        node.value.first
-      when Sass::Tree::RuleNode
-        node.rule.select { |chunk| chunk.is_a?(String) }.join
-      end
+      text_with_markers =
+        case node
+        when Sass::Tree::CommentNode
+          node.value.first
+        when Sass::Tree::RuleNode
+          node.rule.select { |chunk| chunk.is_a?(String) }.join
+        end
+
+      text_with_markers.gsub(%r{\A/\*}, '//').gsub(/\n \*/, "\n//") if text_with_markers
     end
 
     def process_command(command, node)

data/lib/scss_lint/engine.rb

@@ -17,8 +17,8 @@ module SCSSLint
     # @option options [String] :file The file to load
     # @option options [String] :code The code to parse
     def initialize(options = {})
-      if options[:file]
-        build_from_file(options[:file])
+      if options[:path]
+        build_from_file(options)
       elsif options[:code]
         build_from_string(options[:code])
       end
@@ -41,11 +41,14 @@ module SCSSLint
 
   private
 
-    # @param path [String]
-    def build_from_file(path)
-      @filename = path
-      @engine = Sass::Engine.for_file(path, ENGINE_OPTIONS)
-      @contents = File.open(path, 'r').read
+    # @param options [Hash]
+    # @option file [IO] if provided, us this as the file object
+    # @option path [String] path of file, loading from this if `file` object not
+    #   given
+    def build_from_file(options)
+      @filename = options[:path]
+      @contents = options[:file] ? file.read : File.read(@filename)
+      @engine = Sass::Engine.new(@contents, ENGINE_OPTIONS.merge(filename: @filename))
     end
 
     # @param scss [String]

data/lib/scss_lint/linter.rb

@@ -1,9 +1,25 @@
 module SCSSLint
   # Defines common functionality available to all linters.
-  class Linter < Sass::Tree::Visitors::Base
+  class Linter < Sass::Tree::Visitors::Base # rubocop:disable ClassLength
     include SelectorVisitor
     include Utils
 
+    class << self
+      attr_accessor :simple_name
+
+      # When defining a Linter class, define its simple name as well. This
+      # assumes that the module hierarchy of every linter starts with
+      # `SCSSLint::Linter::`, and removes this part of the class name.
+      #
+      # `SCSSLint::Linter::Foo.simple_name`          #=> "Foo"
+      # `SCSSLint::Linter::Compass::Bar.simple_name` #=> "Compass::Bar"
+      def inherited(linter)
+        name_parts = linter.name.split('::')
+        name = name_parts.length < 3 ? '' : name_parts[2..-1].join('::')
+        linter.simple_name = name
+      end
+    end
+
     attr_reader :config, :engine, :lints
 
     # Create a linter.
@@ -29,7 +45,7 @@ module SCSSLint
     # Return the human-friendly name of this linter as specified in the
     # configuration file and in lint descriptions.
     def name
-      self.class.name.split('::')[2..-1].join('::')
+      self.class.simple_name
     end
 
   protected
@@ -61,16 +77,6 @@ module SCSSLint
       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]
-    def character_at(source_position, offset = 0)
-      actual_line   = source_position.line - 1
-      actual_offset = source_position.offset + offset - 1
-
-      engine.lines.size > actual_line && engine.lines[actual_line][actual_offset]
-    end
-
     # Extracts the original source code given a range.
     #
     # @param source_range [Sass::Source::Range]
@@ -145,6 +151,16 @@ module SCSSLint
 
   private
 
+    def visit_comment(_node)
+      # Don't lint children of comments by default, as the Sass parser contains
+      # many bugs related to the source ranges reported within code in /*...*/
+      # comments.
+      #
+      # Instead of defining this empty method on every linter, we assume every
+      # linter ignores comments by default. Individual linters can override at
+      # their discretion.
+    end
+
     def extract_location(node_or_line_or_location)
       if node_or_line_or_location.is_a?(Location)
         node_or_line_or_location
@@ -157,5 +173,33 @@ module SCSSLint
         Location.new(node_or_line_or_location)
       end
     end
+
+    # @param source_position [Sass::Source::Position]
+    # @param offset [Integer]
+    # @return [String] the character at the given [Sass::Source::Position]
+    def character_at(source_position, offset = 0)
+      actual_line   = source_position.line - 1
+      actual_offset = source_position.offset + offset - 1
+
+      engine.lines.size > actual_line && engine.lines[actual_line][actual_offset]
+    end
+
+    # Starting at source_position (plus offset), search for pattern and return
+    # the offset from the source_position.
+    #
+    # @param source_position [Sass::Source::Position]
+    # @param pattern [String, RegExp] the pattern to search for
+    # @param offset [Integer]
+    # @return [Integer] the offset at which [pattern] was found.
+    def offset_to(source_position, pattern, offset = 0)
+      actual_line   = source_position.line - 1
+      actual_offset = source_position.offset + offset - 1
+
+      return nil if actual_line >= engine.lines.size
+
+      actual_index = engine.lines[actual_line].index(pattern, actual_offset)
+
+      actual_index && actual_index + 1 - source_position.offset
+    end
   end
 end

data/lib/scss_lint/linter/chained_classes.rb

@@ -0,0 +1,21 @@
+module SCSSLint
+  # Checks for uses of chained classes (e.g. .foo.bar).
+  class Linter::ChainedClasses < Linter
+    include LinterRegistry
+
+    def visit_sequence(sequence)
+      sequence.members.each do |simple_sequence|
+        next unless chained_class?(simple_sequence)
+        add_lint(simple_sequence.line,
+                 'Prefer using a distinct class over chained classes ' \
+                 '(e.g. .new-class over .foo.bar')
+      end
+    end
+
+  private
+
+    def chained_class?(simple_sequence)
+      simple_sequence.members.count { |member| member.is_a?(Sass::Selector::Class) } >= 2
+    end
+  end
+end

data/lib/scss_lint/linter/color_variable.rb

@@ -25,13 +25,6 @@ module SCSSLint
         .each   { |_, color| record_lint(node, color) }
     end
 
-    def visit_comment(_node)
-      # Don't lint children. Sass multiline comments (/*...*/) are actually
-      # rendered in code and thus allow variable interpolation. Unfortunately,
-      # the Sass parser returns bad source ranges for interpolation in these
-      # comments, so it's easiest to just ignore them.
-    end
-
     def visit_script_funcall(node)
       if literal_color_function?(node)
         record_lint node, node.to_sass

data/lib/scss_lint/linter/comment.rb

@@ -4,11 +4,25 @@ module SCSSLint
     include LinterRegistry
 
     def visit_comment(node)
-      add_lint(node, 'Use `//` comments everywhere') unless node.invisible? || allowed?(node)
+      add_lint(node, 'Use `//` comments everywhere') unless valid_comment?(node)
     end
 
   private
 
+    def valid_comment?(node)
+      allowed_type =
+        if config.fetch('style', 'silent') == 'silent'
+          node.invisible?
+        else
+          !node.invisible?
+        end
+      return true if allowed_type
+
+      # Otherwise check if comment contains content that excludes it (i.e. a
+      # copyright notice for loud comments)
+      allowed?(node)
+    end
+
     # @param node [CommentNode]
     # @return [Boolean]
     def allowed?(node)

data/lib/scss_lint/linter/empty_line_between_blocks.rb

@@ -3,11 +3,21 @@ module SCSSLint
   class Linter::EmptyLineBetweenBlocks < Linter
     include LinterRegistry
 
+    def visit_atroot(node)
+      check(node, '@at-root')
+      yield
+    end
+
     def visit_function(node)
       check(node, '@function')
       yield
     end
 
+    def visit_media(node)
+      check(node, '@media')
+      yield
+    end
+
     def visit_mixin(node)
       # Ignore @includes which don't have any block content
       check(node, '@include') if node.children

data/lib/scss_lint/linter/indentation.rb

@@ -6,7 +6,16 @@ module SCSSLint
     def visit_root(_node)
       @indent_width = config['width'].to_i
       @indent_character = config['character'] || 'space'
+      if @indent_character == 'tab'
+        @other_character = ' '
+        @other_character_name = 'space'
+      else
+        @other_character = "\t"
+        @other_character_name = 'tab'
+      end
+      @allow_non_nested_indentation = config['allow_non_nested_indentation']
       @indent = 0
+      @indentations = {}
       yield
     end
 
@@ -28,31 +37,23 @@ module SCSSLint
       # sibling or its parent, as indentation isn't possible
       return if nodes_on_same_line?(previous_node(node), node)
 
-      if @indent_character == 'tab'
-        other_character = ' '
-        other_character_name = 'space'
-      else
-        other_character = "\t"
-        other_character_name = 'tab'
-      end
-
-      check_indent_width(node, other_character, @indent_character, other_character_name)
+      check_indent_width(node)
     end
 
-    def check_indent_width(node, other_character, character_name, other_character_name)
+    def check_indent_width(node)
       actual_indent = node_indent(node)
 
-      if actual_indent.include?(other_character)
+      if actual_indent.include?(@other_character)
         add_lint(node.line,
-                 "Line should be indented with #{character_name}s, " \
-                 "not #{other_character_name}s")
+                 "Line should be indented with #{@indent_character}s, " \
+                 "not #{@other_character_name}s")
         return true
       end
 
-      if config['allow_non_nested_indentation']
-        check_arbitrary_indent(node, actual_indent.length, character_name)
+      if @allow_non_nested_indentation
+        check_arbitrary_indent(node, actual_indent.length)
       else
-        check_regular_indent(node, actual_indent.length, character_name)
+        check_regular_indent(node, actual_indent.length)
       end
     end
 
@@ -61,7 +62,7 @@ module SCSSLint
     def visit_if(node)
       check_indentation(node)
 
-      if config['allow_non_nested_indentation']
+      if @allow_non_nested_indentation
         yield # Continue linting else statement
       else
         visit(node.else) if node.else
@@ -139,51 +140,39 @@ module SCSSLint
       same_position?(node.source_range.end_pos, first_child_source.start_pos)
     end
 
-    def check_regular_indent(node, actual_indent, character_name)
+    def check_regular_indent(node, actual_indent)
       return if actual_indent == @indent
 
-      add_lint(node.line,
-               "Line should be indented #{@indent} #{character_name}s, " \
-               "but was indented #{actual_indent} #{character_name}s")
+      add_lint(node.line, lint_message(@indent, actual_indent))
       true
     end
 
-    def check_arbitrary_indent(node, actual_indent, character_name) # rubocop:disable CyclomaticComplexity, MethodLength, LineLength
-      # Allow rulesets to be indented any amount when the indent is zero, as
-      # long as it's a multiple of the indent width
-      if ruleset_under_root_node?(node)
-        unless actual_indent % @indent_width == 0
-          add_lint(node.line,
-                   "Line must be indented a multiple of #{@indent_width} " \
-                   "#{character_name}s, but was indented #{actual_indent} #{character_name}s")
-          return true
-        end
-      end
+    def check_arbitrary_indent(node, actual_indent)
+      return if check_root_ruleset_indent(node, actual_indent)
 
-      if @indent == 0
-        unless node.is_a?(Sass::Tree::RuleNode) || actual_indent == 0
-          add_lint(node.line,
-                   "Line should be indented 0 #{character_name}s, " \
-                   "but was indented #{actual_indent} #{character_name}s")
+      # Allow any root-level node (i.e. one that would normally have an indent
+      # of zero) to have an arbitrary amount of indent
+      return if @indent == 0
+
+      return if one_shift_greater_than_parent?(node, actual_indent)
+      parent_indent = node_indent(node_indent_parent(node)).length
+      expected_indent = parent_indent + @indent_width
+      add_lint(node.line, lint_message(expected_indent, actual_indent))
+      true
+    end
+
+    # Allow rulesets to be indented any amount when the indent is zero, as long
+    # as it's a multiple of the indent width
+    def check_root_ruleset_indent(node, actual_indent)
+      # Whether node is a ruleset not nested within any other ruleset.
+      if @indent == 0 && node.is_a?(Sass::Tree::RuleNode)
+        unless actual_indent % @indent_width == 0
+          add_lint(node.line, lint_message("a multiple of #{@indent_width}", actual_indent))
           return true
         end
-      elsif !one_shift_greater_than_parent?(node, actual_indent)
-        parent_indent = node_indent(node_indent_parent(node)).length
-        expected_indent = parent_indent + @indent_width
-
-        add_lint(node.line,
-                 "Line should be indented #{expected_indent} #{character_name}s, " \
-                 "but was indented #{actual_indent} #{character_name}s")
-        return true
       end
-    end
 
-    # Returns whether node is a ruleset not nested within any other ruleset.
-    #
-    # @param node [Sass::Tree::Node]
-    # @return [true,false]
-    def ruleset_under_root_node?(node)
-      @indent == 0 && node.is_a?(Sass::Tree::RuleNode)
+      false
     end
 
     # Returns whether node is indented exactly one indent width greater than its
@@ -202,7 +191,7 @@ module SCSSLint
     # @param node [Sass::Tree::Node]
     # @return [Integer]
     def node_indent(node)
-      engine.lines[node.line - 1][/^(\s*)/, 1]
+      @indentations[node] ||= engine.lines[node.line - 1][/^(\s*)/]
     end
 
     def node_indent_parent(node)
@@ -215,5 +204,10 @@ module SCSSLint
 
       node.node_parent
     end
+
+    def lint_message(expected, actual)
+      "Line should be indented #{expected} #{@indent_character}s, but was " \
+      "indented #{actual} #{@indent_character}s"
+    end
   end
 end