scss-lint 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbee51206b106602ef0961c6c03bfb6974d4f2eb
-  data.tar.gz: 2e87d30b614973420c6a8956ff4248325dbcc05d
+  metadata.gz: c4c60cb7b446fd21b69324b554345c0d2fbb63af
+  data.tar.gz: c12498e673473f6305b6216fa0151ef755121b5a
 SHA512:
-  metadata.gz: 4c3cba3c53f301916ee8ebcdab2e6ee7167e3014c7dae55bcf0b48a490f5f091cbb9ef20335a4133ab20de8b1e8b031900f6e6bf46b293b3a95e92a997195083
-  data.tar.gz: 10fc7fe143641a411666fe6ff26b434fe98d0fad0b58ac4e99113dd24e5fa09a0299a5ffdcded16bfd0eee8fff8728eeef4187e9a49aec8f74ba2f9adcc36302
+  metadata.gz: ba86ab4dc998719d5f11e26cb6d842c3bf9aec9535f3742a93fd8cbb975b4ff300f0aaefc8f127b99ab9ff642b5ee15a4aa0320c82b003805ba3edca5cb84408
+  data.tar.gz: b1e5c3b72ab4300347138727dc13963fefbde3be4c9adb88c9bc8c3791c43a695f070268b2ca20f4b9a921a662aec822df1983587bc50341e6c22eecba700bd7

data/lib/sass/script.rb

@@ -9,4 +9,40 @@ module Sass::Script
       @name
     end
   end
+
+  # When linting colors, it's convenient to be able to inspect the original
+  # color string. This adds an attribute to the Color to keep track of the
+  # original string and provides a method which the modified lexer can use to
+  # set it.
+  class Color
+    attr_accessor :original
+
+    def self.from_string(string)
+      rgb = string.scan(/^#(..?)(..?)(..?)$/).
+                   first.
+                   map { |hex| hex.ljust(2, hex).to_i(16) }
+
+      color = Color.new(rgb, false)
+      color.original = string
+      color
+    end
+  end
+
+  class Lexer
+    # We redefine the color lexer to store the original string with the created
+    # `Color` object so that we can inspect the original string before it is
+    # normalized.
+    #
+    # This is an adapted version from the original Sass source code.
+    def color
+      return unless color_string = scan(REGULAR_EXPRESSIONS[:color])
+
+      unless [4, 7].include?(color_string.length)
+        raise ::Sass::SyntaxError,
+              "Colors must have either three or six digits: '#{color_string}'"
+      end
+
+      [:color, Color.from_string(color_string)]
+    end
+  end
 end

data/lib/sass/tree.rb

@@ -10,10 +10,17 @@ module Sass::Tree
     # numbers back in so lint reporting works for those nodes.
     def add_line_numbers_to_args(arg_list)
       arg_list.each do |variable, default_expr|
-        variable.line = line # Use line number of containing parse tree node
+        add_line_number(variable)
       end
     end
 
+    # The Sass parser sometimes doesn't assign line numbers in cases where it
+    # should. This is a helper to easily correct that.
+    def add_line_number(node)
+      node.line ||= line if node.is_a?(Sass::Script::Node)
+      node
+    end
+
     # Sometimes the parse tree doesn't return a Sass::Script::Variable, but just
     # the name of the variable. This helper takes that name and turns it back
     # into a Sass::Script::Variable that supports lint reporting.
@@ -117,7 +124,7 @@ module Sass::Tree
 
   class PropNode
     def children
-      concat_expr_lists super, extract_script_nodes(name), value
+      concat_expr_lists super, extract_script_nodes(name), add_line_number(value)
     end
   end
 

data/lib/scss_lint/linter/capitalization_in_selector.rb

@@ -2,14 +2,39 @@ module SCSSLint
   class Linter::CapitalizationInSelector < Linter
     include LinterRegistry
 
-    def visit_rule(node)
-      add_lint(node) if node.rule.first =~ /[A-Z]/
+    def visit_attribute(attribute)
+      check(attribute)
+    end
+
+    def visit_class(klass)
+      check(klass)
+    end
+
+    def visit_element(element)
+      check(element)
+    end
 
-      yield # Continue linting children
+    def visit_id(id)
+      check(id)
     end
 
-    def description
-      'Selectors should be lowercase'
+    def visit_placeholder(placeholder)
+      check(placeholder)
+    end
+
+    def visit_pseudo(pseudo)
+      check(pseudo, 'Pseudo-selector')
+    end
+
+  private
+
+    def check(node, selector_name = nil)
+      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 " <<
+                       "written in all lowercase as `#{name.downcase}`")
+      end
     end
   end
 end

data/lib/scss_lint/linter/color_keyword.rb

@@ -0,0 +1,19 @@
+module SCSSLint
+  class Linter::ColorKeyword < Linter
+    include LinterRegistry
+
+    def visit_script_string(node)
+      add_lint(node) if color_keyword?(node.value)
+    end
+
+    def description
+      'Colors should be specified as hexadecimal values, not names'
+    end
+
+  private
+
+    def color_keyword?(string)
+      !!Sass::Script::Color::COLOR_NAMES[string]
+    end
+  end
+end

data/lib/scss_lint/linter/declared_name.rb

@@ -3,34 +3,29 @@ module SCSSLint
     include LinterRegistry
 
     def visit_function(node)
-      check(node)
+      check(node, 'function')
       yield # Continue into content block of this function definition
     end
 
     def visit_mixindef(node)
-      check(node)
+      check(node, 'mixin')
       yield # Continue into content block of this mixin definition
     end
 
-    def visit_rule(node)
-      add_lint(node) if selector_has_bad_placeholder?(node.rule)
-      yield # Continue linting into content block of this rule definition
-    end
-
     def visit_variable(node)
-      check(node)
+      check(node, 'variable')
       yield # Continue into expression tree for this variable definition
     end
 
-    def description
-      'Names of variables, functions, mixins, and placeholders should be ' <<
-      'lowercase and use hyphens instead of underscores.'
-    end
-
   private
 
-    def check(node)
-      add_lint(node) if node_has_bad_name?(node)
+    def check(node, node_type)
+      if node_has_bad_name?(node)
+        fixed_name = node.name.downcase.gsub(/_/, '-')
+
+        add_lint(node, "Name of #{node_type} `#{node.name}` should " <<
+                       "be written in lowercase as `#{fixed_name}`")
+      end
     end
   end
 end

data/lib/scss_lint/linter/hex_format.rb

@@ -2,37 +2,45 @@ module SCSSLint
   class Linter::HexFormat < Linter
     include LinterRegistry
 
-    def visit_root(node)
-      # We can't do this via the parse tree because the parser automatically
-      # normalizes all colors encountered in Sass script, so we lose the ability
-      # to check the format of the color. Thus we resort to line-by-line regex
-      # matching.
-      engine.lines.each_with_index do |line, index|
-        line.scan /#(\h{3,6})/ do |match|
-          unless valid_hex?(match.first)
-            @lints << Lint.new(engine.filename, index + 1, description)
-          end
+    def visit_prop(node)
+      if node.value.is_a?(Sass::Script::String) &&
+         node.value.type == :identifier
+
+        node.value.value.scan(HEX_REGEX) do |match|
+          add_hex_lint(node, match.first) unless valid_hex_format?(match.first)
         end
       end
+
+      yield # Continue visiting children
     end
 
-    def description
-      'Hexadecimal color codes should be lowercase and in 3-digit form where possible'
+    def visit_script_color(node)
+      unless valid_hex_format?(node.original[HEX_REGEX, 1])
+        add_hex_lint(node, node.original)
+      end
     end
 
   private
 
-    def valid_hex?(hex)
-      [3,6].include?(hex.length) &&
-        hex.downcase == hex &&
-        !can_be_condensed(hex)
+    HEX_REGEX = /(#\h{3,6})/
+
+    def add_hex_lint(node, hex)
+      add_lint(node, "Color `#{hex}` should be written as `#{shortest_form(hex)}`")
+    end
+
+    def valid_hex_format?(hex)
+      hex == shortest_form(hex)
+    end
+
+    def shortest_form(hex)
+      (can_be_condensed?(hex) ? (hex[0..1] + hex[3] + hex[5]) : hex).downcase
     end
 
-    def can_be_condensed(hex)
-      hex.length == 6 &&
-        hex[0] == hex[1] &&
-        hex[2] == hex[3] &&
-        hex[4] == hex[5]
+    def can_be_condensed?(hex)
+      hex.length == 7 &&
+        hex[1] == hex[2] &&
+        hex[3] == hex[4] &&
+        hex[5] == hex[6]
     end
   end
 end

data/lib/scss_lint/linter/id_with_extraneous_selector.rb

@@ -0,0 +1,15 @@
+module SCSSLint
+  class Linter::IdWithExtraneousSelector < Linter
+    include LinterRegistry
+
+    def visit_simple_sequence(seq)
+      id_sel = seq.members.find { |simple| simple.is_a?(Sass::Selector::Id) }
+      return unless id_sel
+
+      if seq.members.any? { |simple| !simple.is_a?(Sass::Selector::Id) }
+        add_lint(seq, "Selector `#{seq}` can be simplified to `#{id_sel}`, " <<
+                      'since IDs should be uniquely identifying')
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/usage_name.rb

@@ -3,25 +3,22 @@ module SCSSLint
     include LinterRegistry
 
     def visit_extend(node)
-      add_lint(node) if selector_has_bad_placeholder?(node.selector)
+      if selector_has_bad_placeholder?(node.selector)
+        add_name_lint(node, node.selector.join, 'placeholder')
+      end
     end
 
     def visit_mixin(node)
-      check(node)
+      check(node, 'mixin')
       yield # Continue into content block of this mixin's block
     end
 
     def visit_script_funcall(node)
-      check(node) unless FUNCTION_WHITELIST.include?(node.name)
+      check(node, 'function') unless FUNCTION_WHITELIST.include?(node.name)
     end
 
     def visit_script_variable(node)
-      check(node)
-    end
-
-    def description
-      'Usages of variables, functions, mixins, and placeholders should be ' <<
-      'lowercase and use hyphens instead of underscores.'
+      check(node, 'variable')
     end
 
   private
@@ -33,8 +30,23 @@ module SCSSLint
       translateX translateY translateZ
     ].to_set
 
-    def check(node)
-      add_lint(node) if node_has_bad_name?(node)
+    def check(node, node_type)
+      add_name_lint(node, node.name, node_type) if node_has_bad_name?(node)
+    end
+
+    def add_name_lint(node, name, node_type)
+      fixed_name = name.downcase.gsub(/_/, '-')
+
+      add_lint(node, "All uses of #{node_type} `#{name}` should be written " <<
+                     "in lowercase as `#{fixed_name}`")
+    end
+
+    # Given a selector array, returns whether it contains any placeholder
+    # selectors with invalid names.
+    def selector_has_bad_placeholder?(selector_array)
+      extract_string_selectors(selector_array).any? do |selector_str|
+        selector_str =~ /%\w*#{INVALID_NAME_CHARS}/
+      end
     end
   end
 end

data/lib/scss_lint/linter/zero_unit.rb

@@ -3,12 +3,25 @@ module SCSSLint
     include LinterRegistry
 
     def visit_prop(node)
-      line = engine.lines[node.line - 1] if node.line
-      add_lint(node) if line =~ /^\s*[\w-]+:\s*0[a-z]+;$/i
+      if node.value.is_a?(Sass::Script::String) &&
+         node.value.type == :identifier
+
+        node.value.value.scan(/\b(0[a-z]+)\b/i) do |match|
+          add_lint(node, MESSAGE_FORMAT % match.first)
+        end
+      end
+
+      yield # Continue visiting children
     end
 
-    def description
-      'Properties with a value of zero should be unit-less, e.g. "0" instead of "0px"'
+    def visit_script_number(node)
+      if node.value == 0 && !node.unitless?
+        add_lint(node, MESSAGE_FORMAT % node.original)
+      end
     end
+
+  private
+
+    MESSAGE_FORMAT = '`%s` should be written without units as `0`'
   end
 end

data/lib/scss_lint/linter.rb

@@ -1,5 +1,6 @@
 module SCSSLint
   class Linter < Sass::Tree::Visitors::Base
+    include SelectorVisitor
     include Utils
 
     attr_reader :engine, :lints
@@ -13,15 +14,16 @@ module SCSSLint
       visit(engine.tree)
     end
 
+    # Define if you want a default message for your linter
     def description
       nil
     end
 
-  protected
-
     # Helper for creating lint from a parse tree node
-    def add_lint(node)
-      @lints << Lint.new(engine.filename, node.line, description)
+    def add_lint(node, message = nil)
+      @lints << Lint.new(engine.filename,
+                         node.line,
+                         message || description)
     end
 
     # Monkey-patched implementation that adds support for traversing
@@ -34,5 +36,15 @@ module SCSSLint
         super
       end
     end
+
+    # Modified so we can also visit selectors in linters
+    def visit(node)
+      # Visit the selector of a rule if parsed rules are available
+      if node.is_a?(Sass::Tree::RuleNode) && node.parsed_rules
+        visit_selector(node.parsed_rules)
+      end
+
+      super
+    end
   end
 end

data/lib/scss_lint/selector_visitor.rb

@@ -0,0 +1,32 @@
+module SCSSLint
+  # Provides functionality for conveniently visiting a Selector sequence.
+  module SelectorVisitor
+    def visit_selector(node)
+      visit_selector_node(node)
+    end
+
+  private
+
+    def visit_selector_node(node)
+      method = "visit_#{selector_node_name(node)}"
+      send(method, node) if respond_to?(method, true)
+
+      visit_members(node) if node.is_a?(Sass::Selector::AbstractSequence)
+    end
+
+    def visit_members(sequence)
+      sequence.members.each do |member|
+        visit_selector(member)
+      end
+    end
+
+    def selector_node_name(node)
+      # Converts the class name of a node into snake_case form, e.g.
+      # `Sass::Selector::SimpleSequence` -> `simple_sequence`
+      node.class.name.gsub(/.*::(.*?)$/, '\\1').
+                      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+                      gsub(/([a-z\d])([A-Z])/, '\1_\2').
+                      downcase
+    end
+  end
+end

data/lib/scss_lint/utils.rb

@@ -19,14 +19,6 @@ module SCSSLint
                      split
     end
 
-    # Given a selector array, returns whether it contains any placeholder
-    # selectors with invalid names.
-    def selector_has_bad_placeholder?(selector_array)
-      extract_string_selectors(selector_array).any? do |selector_str|
-        selector_str =~ /%\w*#{INVALID_NAME_CHARS}/
-      end
-    end
-
     def node_has_bad_name?(node)
       node.name =~ /#{INVALID_NAME_CHARS}/
     end

data/lib/scss_lint/version.rb

@@ -1,3 +1,3 @@
 module SCSSLint
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/scss_lint.rb

@@ -8,6 +8,7 @@ module SCSSLint
   autoload :Linter, 'scss_lint/linter'
   autoload :Reporter, 'scss_lint/reporter'
   autoload :Runner, 'scss_lint/runner'
+  autoload :SelectorVisitor, 'scss_lint/selector_visitor'
   autoload :Utils, 'scss_lint/utils'
   autoload :VERSION, 'scss_lint/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Causes Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 3.2.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 3.2.10
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Opinionated tool that tells you whether or not your SCSS is "bad"
+description: Opinionated tool to help write clean and consistent SCSS
 email:
 - eng@causes.com
 - shane@causes.com
@@ -83,13 +83,14 @@ files:
 - lib/scss_lint/reporter.rb
 - lib/scss_lint/lint.rb
 - lib/scss_lint/linter.rb
+- lib/scss_lint/selector_visitor.rb
 - lib/scss_lint/linter/property_format.rb
 - lib/scss_lint/linter/space_before_brace.rb
 - lib/scss_lint/linter/capitalization_in_selector.rb
 - lib/scss_lint/linter/declared_name.rb
 - lib/scss_lint/linter/sorted_properties.rb
-- lib/scss_lint/linter/type_in_id_selector.rb
 - lib/scss_lint/linter/shorthand.rb
+- lib/scss_lint/linter/id_with_extraneous_selector.rb
 - lib/scss_lint/linter/declaration_order.rb
 - lib/scss_lint/linter/no_zero_before_decimal.rb
 - lib/scss_lint/linter/zero_unit.rb
@@ -98,6 +99,7 @@ files:
 - lib/scss_lint/linter/border_zero.rb
 - lib/scss_lint/linter/debug_statement.rb
 - lib/scss_lint/linter/hex_format.rb
+- lib/scss_lint/linter/color_keyword.rb
 - lib/scss_lint/linter/comment.rb
 - lib/scss_lint/linter/empty_rule.rb
 - lib/scss_lint/linter/single_line_per_selector.rb
@@ -133,3 +135,4 @@ signing_key:
 specification_version: 4
 summary: SCSS lint tool
 test_files: []
+has_rdoc: 

data/lib/scss_lint/linter/type_in_id_selector.rb

@@ -1,18 +0,0 @@
-module SCSSLint
-  class Linter::TypeInIdSelector < Linter
-    include LinterRegistry
-
-    def visit_rule(node)
-      selectors = node.rule.first.to_s.split(',')
-      selectors.each do |selector|
-        add_lint(node) if selector.strip =~ /^[a-z0-9]+#.*/i
-      end
-
-      yield # Continue linting children
-    end
-
-    def description
-      'Avoid ID names with unnecessary type selectors (e.g. prefer `#id` over `p#id`)'
-    end
-  end
-end