scss-lint 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4383a0ff6df66ae43c6b5a3a7b83fff68515a414
-  data.tar.gz: c4dd715631578ccba0f49bc2df013bd24d8c2488
+  metadata.gz: e07cf784e2e32fc05bf8294608db2d3bcf2951b2
+  data.tar.gz: d1577b62811661ad24efa01dfeeffc6ca19a573b
 SHA512:
-  metadata.gz: 4fe2aaf47a16df5179c6a15d6559d45ed756f5d86eb90cbc8b87822c930fb2369b705f84c4faa9b5e972e0418ff2b843533fca108737e3c15dc9a73bd23adad9
-  data.tar.gz: 095e7768edce611e4d91c9444d5db04fc9bec4a3c39489ef44a2809affeff4296e7eb7f5d5bab85d1a234da602fd3db442f44d6bc7294e2091b0721fba31eae2
+  metadata.gz: a3179febbb5fce02dee1044be6ea7b05f312e833e8bb61d4c8cb23f9ab84eb07c9458f9492f6918a2766a8c42e10ae89debd3a20959ca7778bc38787eccc96e2
+  data.tar.gz: e50715f6dbbf827a29b1f079d520ec6011e8318f3b89ea9d7d31afb09c8bf68a32f3cea66ab7a8da926ab2556c4a34fb3023a8393ae10aea89ef3889e5a34f19

data/config/default.yml

@@ -52,6 +52,7 @@ linters:
 
   Indentation:
     enabled: true
+    character: space # or 'tab'
     width: 2
 
   LeadingZero:
@@ -71,6 +72,7 @@ linters:
 
   PropertySortOrder:
     enabled: true
+    ignore_unspecified: false
 
   PropertySpelling:
     enabled: true
@@ -83,6 +85,10 @@ linters:
   Shorthand:
     enabled: true
 
+  SingleLinePerProperty:
+    enabled: true
+    allow_single_line_rule_sets: true
+
   SingleLinePerSelector:
     enabled: true
 
@@ -108,12 +114,15 @@ linters:
     enabled: true
     style: single_quotes # or double_quotes
 
-  TrailingSemicolonAfterPropertyValue:
+  TrailingSemicolon:
     enabled: true
 
   UnnecessaryMantissa:
     enabled: true
 
+  UnnecessaryParentReference:
+    enabled: true
+
   UrlFormat:
     enabled: true
 

data/data/property-sort-orders/concentric.txt

@@ -0,0 +1,99 @@
+# Concentric CSS
+# http://rhodesmill.org/brandon/2011/concentric-css/
+
+display
+position
+top
+right
+bottom
+left
+
+float
+clear
+
+visibility
+opacity
+z-index
+
+margin
+margin-top
+margin-right
+margin-bottom
+margin-left
+
+outline
+
+border
+border-top
+border-right
+border-bottom
+border-left
+border-width
+border-top-width
+border-right-width
+border-bottom-width
+border-left-width
+
+border-style
+border-top-style
+border-right-style
+border-bottom-style
+border-left-style
+
+border-color
+border-top-color
+border-right-color
+border-bottom-color
+border-left-color
+
+background
+background-color
+background-image
+background-repeat
+background-position
+cursor
+
+padding
+padding-top
+padding-right
+padding-bottom
+padding-left
+
+width
+min-width
+max-width
+
+height
+min-height
+max-height
+
+overflow
+
+list-style
+caption-side
+
+table-layout
+border-collapse
+border-spacing
+empty-cells
+
+vertical-align
+
+text-align
+text-indent
+text-transform
+text-decoration
+
+line-height
+word-spacing
+letter-spacing
+white-space
+color
+
+font
+font-family
+font-size
+font-weight
+
+content
+quotes

data/lib/scss_lint.rb

@@ -1,4 +1,5 @@
 require 'scss_lint/constants'
+require 'scss_lint/exceptions'
 require 'scss_lint/config'
 require 'scss_lint/engine'
 require 'scss_lint/location'

data/lib/scss_lint/cli.rb

@@ -12,8 +12,9 @@ module SCSSLint
     # Subset of semantic exit codes conforming to `sysexits` documentation.
     EXIT_CODES = {
       ok:        0,
+      warning:   1,  # One or more warnings (but no errors) were reported
+      error:     2,  # One or more errors were reported
       usage:     64, # Command line usage error
-      data:      65, # User input was incorrect (i.e. contains lints)
       no_input:  66, # Input file did not exist or was not readable
       software:  70, # Internal software error
       config:    78, # Configuration error
@@ -93,11 +94,16 @@ module SCSSLint
       end
     end
 
-    def run
+    def run # rubocop:disable MethodLength
       runner = Runner.new(@config)
       runner.run(files_to_lint)
       report_lints(runner.lints)
-      halt :data if runner.lints.any?
+
+      if runner.lints.any? { |lint| lint.error? }
+        halt :error
+      elsif runner.lints.any?
+        halt :warning
+      end
     rescue InvalidConfiguration => ex
       puts ex
       halt :config

data/lib/scss_lint/exceptions.rb

@@ -0,0 +1,4 @@
+module SCSSLint::Exceptions
+  # Raised when an unexpected error occurs in a linter
+  class LinterError < StandardError; end
+end

data/lib/scss_lint/linter.rb

@@ -10,6 +10,8 @@ module SCSSLint
       @lints = []
     end
 
+    # Run this linter against a parsed document with a given configuration.
+    #
     # @param engine [Engine]
     # @param config [Config]
     def run(engine, config)
@@ -18,6 +20,12 @@ module SCSSLint
       visit(engine.tree)
     end
 
+    # 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('::')
+    end
+
   protected
 
     # Helper for creating lint from a parse tree node
@@ -28,7 +36,8 @@ module SCSSLint
       @lints << Lint.new(self,
                          engine.filename,
                          extract_location(node_or_line_or_location),
-                         message)
+                         message,
+                         @config.fetch('severity', :warning).to_sym)
     end
 
     # Extract {SCSSLint::Location} from a {Sass::Source::Range}.

data/lib/scss_lint/linter/capitalization_in_selector.rb

@@ -3,34 +3,42 @@ module SCSSLint
   class Linter::CapitalizationInSelector < Linter
     include LinterRegistry
 
+    def visit_root(_node)
+      @ignored_names = Array(config['ignored_names']).to_set
+      @ignored_types = Array(config['ignored_types']).to_set
+      yield
+    end
+
     def visit_attribute(attribute)
-      check(attribute)
+      check(attribute) unless @ignored_types.include?('attribute')
     end
 
     def visit_class(klass)
-      check(klass)
+      check(klass) unless @ignored_types.include?('class')
     end
 
     def visit_element(element)
-      check(element)
+      check(element) unless @ignored_types.include?('element')
     end
 
     def visit_id(id)
-      check(id)
+      check(id) unless @ignored_types.include?('id')
     end
 
     def visit_placeholder(placeholder)
-      check(placeholder)
+      check(placeholder) unless @ignored_types.include?('placeholder')
     end
 
     def visit_pseudo(pseudo)
-      check(pseudo, 'Pseudo-selector')
+      check(pseudo, 'Pseudo-selector') unless @ignored_types.include?('pseudo-selector')
     end
 
   private
 
     def check(node, selector_name = nil)
       name = node.name.join
+
+      return if @ignored_names.include?(name)
       return unless name =~ /[A-Z]/
 
       selector_name ||= node.class.name.split('::').last

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

@@ -24,17 +24,24 @@ module SCSSLint
 
     def check_for_properties_with_mixins(node)
       prop_name = node.name.join
-      return unless PROPERTIES_WITH_MIXINS.include?(prop_name)
+      return unless PROPERTIES_WITH_MIXINS.include?(prop_name) &&
+                    !ignore_compass_mixin?(prop_name)
 
       add_lint node, "Use the Compass `#{prop_name}` mixin instead of the property"
     end
 
     def check_for_inline_block(node)
       prop_name = node.name.join
-      return unless prop_name == 'display' && node.value.to_sass == 'inline-block'
+      return unless prop_name == 'display' &&
+                    node.value.to_sass == 'inline-block' &&
+                    !ignore_compass_mixin?('inline-block')
 
       add_lint node,
                'Use the Compass `inline-block` mixin instead of `display: inline-block`'
     end
+
+    def ignore_compass_mixin?(prop_name)
+      config.fetch('ignore', []).include?(prop_name)
+    end
   end
 end

data/lib/scss_lint/linter/indentation.rb

@@ -4,7 +4,8 @@ module SCSSLint
     include LinterRegistry
 
     def visit_root(_node)
-      @indent_width = config['width']
+      @indent_width = config['width'].to_i
+      @indent_character = config['character'] || 'space'
       @indent = 0
       yield
     end
@@ -27,14 +28,35 @@ 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)
+    end
+
+    def check_indent_width(node, other_character, character_name, other_character_name)
       actual_indent = engine.lines[node.line - 1][/^(\s*)/, 1]
 
-      return if actual_indent.length == @indent
+      if actual_indent.include?(other_character)
+        add_lint(node.line,
+                 "Line should be indented with #{character_name}s, " \
+                 "not #{other_character_name}s")
+        return true
+      end
+
+      unless actual_indent.length == @indent
+        add_lint(node.line,
+                 "Line should be indented #{@indent} #{character_name}s, " \
+                 "but was indented #{actual_indent.length} #{character_name}s")
+        return true
+      end
 
-      add_lint(node.line,
-               "Line should be indented #{@indent} spaces, " \
-               "but was indented #{actual_indent.length} spaces")
-      true
+      false
     end
 
     # Deal with `else` statements

data/lib/scss_lint/linter/property_sort_order.rb

@@ -3,11 +3,14 @@ module SCSSLint
   class Linter::PropertySortOrder < Linter
     include LinterRegistry
 
+    def visit_root(_node)
+      @preferred_order = extract_preferred_order_from_config
+      yield
+    end
+
     def visit_rule(node)
-      # Ignore properties that contain interpolation
       sortable_props = node.children.select do |child|
-        child.is_a?(Sass::Tree::PropNode) &&
-          child.name.all? { |part| part.is_a?(String) }
+        child.is_a?(Sass::Tree::PropNode) && !ignore_property?(child)
       end
 
       sortable_prop_info = sortable_props
@@ -23,7 +26,7 @@ module SCSSLint
       sorted_props.each_with_index do |prop, index|
         next unless prop != sortable_prop_info[index]
 
-        add_lint(sortable_props[index], MESSAGE)
+        add_lint(sortable_props[index], lint_message)
         break
       end
 
@@ -32,9 +35,6 @@ module SCSSLint
 
   private
 
-    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
     # sort order like:
     #
@@ -53,8 +53,8 @@ module SCSSLint
       if a[:property] == b[:property]
         compare_by_vendor(a, b)
       else
-        if config['order']
-          compare_by_order(a, b, config['order'])
+        if @preferred_order
+          compare_by_order(a, b, @preferred_order)
         else
           a[:property] <=> b[:property]
         end
@@ -77,5 +77,57 @@ module SCSSLint
       (order.index(a[:property]) || Float::INFINITY) <=>
         (order.index(b[:property]) || Float::INFINITY)
     end
+
+    def extract_preferred_order_from_config
+      case config['order']
+      when nil
+        nil # No custom order specified
+      when Array
+        config['order']
+      when String
+        begin
+          file = File.open(File.join(SCSS_LINT_DATA,
+                                     'property-sort-orders',
+                                     "#{config['order']}.txt"))
+          file.read.split("\n").reject { |line| line =~ /^(#|\s*$)/ }
+        rescue Errno::ENOENT
+          raise SCSSLint::LinterError,
+                "Preset property sort order '#{config['order']}' does not exist"
+        end
+      else
+        raise SCSSLint::LinterError,
+              'Invalid property sort order specified -- must be the name of a '\
+              'preset or an array of strings'
+      end
+    end
+
+    # Return whether to ignore a property in the sort order.
+    #
+    # This includes:
+    # - properties containing interpolation
+    # - properties not explicitly defined in the sort order (if ignore_unspecified is set)
+    def ignore_property?(prop_node)
+      return true if prop_node.name.any? { |part| !part.is_a?(String) }
+
+      config['ignored_unspecified'] &&
+        @preferred_order &&
+        !@preferred_order.include?(prop_node.name.join)
+    end
+
+    def preset_order?
+      config['order'].is_a?(String)
+    end
+
+    def lint_message
+      if preset_order?
+        "Properties should be sorted according to the #{config['order']} sort order"
+      elsif @preferred_order
+        'Properties should be sorted according to the custom order ' \
+        'specified by the configuration'
+      else
+        'Properties should be sorted in order, with vendor-prefixed ' \
+        'extensions before the standardized CSS property'
+      end
+    end
   end
 end