scss_lint 0.39.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 246cc4b3c9ca9fe6b52f8ef4edd262694b701809
-  data.tar.gz: 18a0b888b01b4ddc391a17719b3853a77075ff92
+  metadata.gz: 2875735c6ff15b0a0c04496ae19043825c289c95
+  data.tar.gz: abf49a6521c68efcedcf413a15208983bd116914
 SHA512:
-  metadata.gz: 49174f90f307f91898c0c409b4e8e711f9b0d99088005f5e1e979a1663b9be89c953a2a2431497c06b224a48d3e9dd7113392ac891c6bba6e08f9b0c67a2263b
-  data.tar.gz: 14098a3c8478fc0a65c222052054f3190a623a0bfc85fc4b107bb15b4cc5d802a1f95f341413a0dafe9f06d8fef74f6a9e845e1587c0ef1e317034c39dac2d15
+  metadata.gz: f14a4ee19fc7124cadc19e33fa9f3ee8232f9b34c27bb2824100d4400d998e590004b214ccefc3b37b97490f167aef0950dc1775467e84d5fe2fa63ad6f37798
+  data.tar.gz: 56abaad1303a536a32d57a6cfc3862144c05e5a4c6140e377745a7a801bbd9ba9bd43fdb397527532918aa3203579473dcd0336f0e387e15e223d7194eef8628

data/config/default.yml

@@ -1,6 +1,11 @@
 # Default application configuration that all configurations inherit from.
 
 scss_files: "**/*.scss"
+plugin_directories: ['.scss-linters']
+
+# List of gem names to load custom linters from (make sure they are already
+# installed)
+plugin_gems: []
 
 linters:
   BangFormat:
@@ -45,6 +50,9 @@ linters:
   EmptyRule:
     enabled: true
 
+  ExtendDirective:
+    enabled: false
+
   FinalNewline:
     enabled: true
     present: true
@@ -93,6 +101,7 @@ linters:
   NestingDepth:
     enabled: true
     max_depth: 3
+    ignore_parent_selectors: false
 
   PlaceholderInExtend:
     enabled: true
@@ -160,6 +169,9 @@ linters:
   SpaceAfterPropertyName:
     enabled: true
 
+  SpaceAfterVariableName:
+    enabled: true
+
   SpaceBeforeBrace:
     enabled: true
     style: space # or 'new_line'
@@ -176,6 +188,9 @@ linters:
   TrailingSemicolon:
     enabled: true
 
+  TrailingWhitespace:
+    enabled: true
+
   TrailingZero:
     enabled: false
 

data/lib/scss_lint.rb

@@ -11,6 +11,7 @@ require 'scss_lint/selector_visitor'
 require 'scss_lint/control_comment_processor'
 require 'scss_lint/version'
 require 'scss_lint/utils'
+require 'scss_lint/plugins'
 
 # Load Sass classes and then monkey patch them
 require 'sass'

data/lib/scss_lint/cli.rb

@@ -20,6 +20,7 @@ module SCSSLint
       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
     }
 
     def run(args)
@@ -39,13 +40,16 @@ module SCSSLint
         print_help(options)
       elsif options[:version]
         print_version
-      elsif options[:show_linters]
-        print_linters
       elsif options[:show_formatters]
         print_formatters
       else
         config = setup_configuration(options)
-        scan_for_lints(options, config)
+
+        if options[:show_linters]
+          print_linters
+        else
+          scan_for_lints(options, config)
+        end
       end
     end
 
@@ -81,6 +85,9 @@ module SCSSLint
       when SCSSLint::Exceptions::NoFilesError
         puts exception.message
         halt :no_files
+      when SCSSLint::Exceptions::PluginGemLoadError
+        puts exception.message
+        halt :plugin
       when Errno::ENOENT
         puts exception.message
         halt :no_input

data/lib/scss_lint/config.rb

@@ -18,11 +18,18 @@ module SCSSLint
       def load(file, options = {})
         config_options = load_options_hash_from_file(file)
 
+        config = new(config_options)
+
+        # Need to call this before merging with the default configuration so
+        # that plugins can override the default configuration while still being
+        # overridden by the repo's configuration.
+        config.load_plugins
+
         if options.fetch(:merge_with_default, true)
-          config_options = smart_merge(default_options_hash, config_options)
+          config = default.extend(config)
         end
 
-        Config.new(config_options)
+        config
       end
 
       # Returns the location of the user-wide scss-lint configuration.
@@ -178,6 +185,32 @@ module SCSSLint
       validate_linters
     end
 
+    def [](key)
+      @options[key]
+    end
+
+    # Compares this configuration with another.
+    #
+    # @param other [SCSSLint::Config]
+    # @return [true,false]
+    def ==(other)
+      super || @options == other.options
+    end
+    alias_method :eql?, :==
+
+    # Extend this {Config} with another configuration.
+    #
+    # @return [SCSSLint::Config]
+    def extend(config)
+      @options = self.class.send(:smart_merge, @options, config.options)
+      @warnings += config.warnings
+      self
+    end
+
+    def load_plugins
+      load_plugins_and_merge_config.tap { ensure_plugins_have_default_options }
+    end
+
     def enabled_linters
       LinterRegistry.extract_linters_from(@options['linters'].keys).select do |linter|
         linter_options(linter)['enabled']
@@ -255,5 +288,24 @@ module SCSSLint
         end
       end
     end
+
+    def load_plugins_and_merge_config
+      SCSSLint::Plugins.new(self).load.each do |plugin|
+        # Have the plugin options be overrideable by the local configuration
+        @options = self.class.send(:smart_merge, plugin.config.options, @options)
+      end
+    end
+
+    def ensure_plugins_have_default_options
+      LinterRegistry.linters.each do |linter|
+        if linter_options(linter).nil?
+          @options['linters'].merge!(default_plugin_options(linter))
+        end
+      end
+    end
+
+    def default_plugin_options(linter)
+      { self.class.linter_name(linter) => { 'enabled' => true } }
+    end
   end
 end

data/lib/scss_lint/control_comment_processor.rb

@@ -82,10 +82,21 @@ module SCSSLint
       return unless comment_node = @disable_stack.pop
 
       start_line = comment_node.line
+      if comment_node.class.node_name == :rule
+        end_line = start_line
+      elsif node.class.node_name == :root
+        end_line = @linter.engine.lines.length
+      else
+        end_line = end_line(node)
+      end
+
+      @disabled_lines.merge(start_line..end_line)
+    end
 
-      # Find the deepest child that has a line number to which a lint might
-      # apply (if it is a control comment enable node, it will be the line of
-      # the comment itself).
+    # Find the deepest child that has a line number to which a lint might
+    # apply (if it is a control comment enable node, it will be the line of
+    # the comment itself).
+    def end_line(node)
       child = node
       prev_child = node
       until [nil, prev_child].include?(child = last_child(child))
@@ -94,9 +105,7 @@ module SCSSLint
 
       # Fall back to prev_child if last_child() returned nil (i.e. node had no
       # children with line numbers)
-      end_line = (child || prev_child).line
-
-      @disabled_lines.merge(start_line..end_line)
+      (child || prev_child).line
     end
 
     # Gets the child of the node that resides on the lowest line in the file.

data/lib/scss_lint/exceptions.rb

@@ -18,4 +18,7 @@ module SCSSLint::Exceptions
 
   # Raised when a required library (specified via command line) does not exist.
   class RequiredLibraryMissingError < StandardError; end
+
+  # Raised when a linter gem plugin is required but not installed.
+  class PluginGemLoadError < StandardError; end
 end

data/lib/scss_lint/linter/color_variable.rb

@@ -23,6 +23,13 @@ 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
+
   private
 
     def record_lint(node, color)

data/lib/scss_lint/linter/else_placement.rb

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

data/lib/scss_lint/linter/extend_directive.rb

@@ -0,0 +1,11 @@
+module SCSSLint
+  # Checks that `@extend` is never used.
+  class Linter::ExtendDirective < Linter
+    include LinterRegistry
+
+    def visit_extend(node)
+      add_lint(node, 'Do not use the @extend directive (@include a @mixin ' \
+                     'instead)')
+    end
+  end
+end

data/lib/scss_lint/linter/final_newline.rb

@@ -15,6 +15,7 @@ module SCSSLint
         add_lint(engine.lines.count,
                  'Files should not end with a trailing newline') if ends_with_newline
       end
+      yield
     end
   end
 end

data/lib/scss_lint/linter/name_format.rb

@@ -1,13 +1,8 @@
 module SCSSLint
-  # Checks the format of declared names of functions, mixins, variables, and
-  # placeholders.
+  # Checks the format of declared names of functions, mixins, and variables.
   class Linter::NameFormat < Linter
     include LinterRegistry
 
-    def visit_extend(node)
-      check_placeholder(node)
-    end
-
     def visit_function(node)
       check_name(node, 'function')
       yield # Continue into content block of this function definition
@@ -63,12 +58,6 @@ module SCSSLint
       name
     end
 
-    def check_placeholder(node)
-      extract_string_selectors(node.selector).any? do |selector_str|
-        check_name(node, 'placeholder', selector_str.gsub('%', ''))
-      end
-    end
-
     CONVENTIONS = {
       'camel_case' => {
         explanation: 'should be written in camelCase format',

data/lib/scss_lint/linter/nesting_depth.rb

@@ -3,6 +3,8 @@ module SCSSLint
   class Linter::NestingDepth < Linter
     include LinterRegistry
 
+    IGNORED_SELECTORS = [Sass::Selector::Parent, Sass::Selector::Pseudo]
+
     def visit_root(_node)
       @max_depth = config['max_depth']
       @depth = 1
@@ -10,8 +12,11 @@ module SCSSLint
     end
 
     def visit_rule(node)
+      return yield if ignore_selectors?(node)
+
       if @depth > @max_depth
-        add_lint(node, "Nesting should be no greater than #{@max_depth}, but was #{@depth}")
+        add_lint node, "Nesting should be no greater than #{@max_depth}, " \
+                       "but was #{@depth}"
       else
         # Only continue if we didn't exceed the max depth already (this makes
         # the lint less noisy)
@@ -20,5 +25,21 @@ module SCSSLint
         @depth -= 1
       end
     end
+
+  private
+
+    def ignore_selectors?(node)
+      return unless config['ignore_parent_selectors']
+
+      simple_selectors(node.parsed_rules).all? do |selector|
+        IGNORED_SELECTORS.include?(selector.class)
+      end
+    end
+
+    def simple_selectors(node)
+      node.members.flat_map(&:members).reject do |simple_sequence|
+        simple_sequence.is_a?(String)
+      end.flat_map(&:members)
+    end
   end
 end

data/lib/scss_lint/linter/property_sort_order.rb

@@ -80,6 +80,10 @@ module SCSSLint
         .sort { |a, b| compare_properties(a, b) }
 
       sorted_props.each_with_index do |prop, index|
+        # Once we reach the portion of the list with unspecified properties, we
+        # can stop checking since we don't care about order after that point
+        break unless specified_property?(prop[:property])
+
         next unless prop != sortable_prop_info[index]
 
         add_lint(sortable_prop_info[index][:node], lint_message(sorted_props))
@@ -186,6 +190,10 @@ module SCSSLint
         !@preferred_order.include?(prop_node.name.join)
     end
 
+    def specified_property?(prop_name)
+      !@preferred_order || @preferred_order.include?(prop_name)
+    end
+
     def preset_order?
       config['order'].is_a?(String)
     end

data/lib/scss_lint/linter/property_units.rb

@@ -3,6 +3,20 @@ module SCSSLint
   class Linter::PropertyUnits < Linter
     include LinterRegistry
 
+    NUMBER_WITH_UNITS_REGEX = /
+      (?:
+       (["']).+?\1 # [0: quote mark] quoted string, e.g. "hi there"
+       |           # or
+       (?:^|\s)    # beginning of value or whitespace
+       (?:
+        \d+        # any number of digits, e.g. 123
+        |          # or
+        \d*\.?\d+  # any number of digits with decimal, e.g. 1.23 or .123
+       )
+       ([a-z%]+)   # [1: units] letters or percent sign, e.g. px or %
+      )
+    /ix
+
     def visit_root(_node)
       @globally_allowed_units = config['global'].to_set
       @allowed_units_for_property = config['properties']
@@ -18,9 +32,13 @@ module SCSSLint
         property = "#{@nested_under}-#{property}"
       end
 
-      if node.value.respond_to?(:value) &&
-         units = node.value.value.to_s[/(?:^|\s)(?:\d+|\d*\.?\d+)([a-z%]+)/i, 1]
-        check_units(node, property, units)
+      if node.value.respond_to?(:value)
+        node.value.value.to_s.scan(NUMBER_WITH_UNITS_REGEX).each do |matches|
+          is_quoted_value = !matches[0].nil?
+          next if is_quoted_value
+          units = matches[1]
+          check_units(node, property, units)
+        end
       end
 
       @nested_under = property

data/lib/scss_lint/linter/space_after_variable_name.rb

@@ -0,0 +1,18 @@
+module SCSSLint
+  # Checks for spaces following the name of a variable and before the colon
+  # separating the variables's name from its value.
+  class SpaceAfterVariableName < Linter
+    include LinterRegistry
+
+    def visit_variable(node)
+      return unless spaces_before_colon?(node)
+      add_lint(node, 'Variable names should be followed immediately by a colon')
+    end
+
+  private
+
+    def spaces_before_colon?(node)
+      source_from_range(node.source_range) =~ /\s+:/
+    end
+  end
+end

data/lib/scss_lint/linter/space_between_parens.rb

@@ -18,6 +18,7 @@ module SCSSLint
           check(match[2], index) if match[2]
         end
       end
+      yield
     end
 
   private

data/lib/scss_lint/linter/trailing_whitespace.rb

@@ -0,0 +1,15 @@
+module SCSSLint
+  # Checks for trailing whitespace on a line.
+  class Linter::TrailingWhitespace < Linter
+    include LinterRegistry
+
+    def visit_root(_node)
+      engine.lines.each_with_index do |line, index|
+        next unless line =~ /[ \t]+$/
+
+        add_lint(index + 1, 'Line contains trailing whitespace')
+      end
+      yield
+    end
+  end
+end