scss-lint 0.6.7 → 0.7.0

data/lib/sass/tree.rb

@@ -0,0 +1,148 @@
+# Contains extensions of Sass::Tree::Nodes to add support for traversing the
+# Sass::Script::Node parse trees contained within the nodes. This probably
+# breaks the Sass compiler, but since we're only doing lints this is fine for
+# now.
+module Sass::Tree
+  # Define some common helper code for use in the various monkey patchings.
+  class Node
+    # The `args` field of some Sass::Tree::Node classes returns
+    # Sass::Script::Variable nodes with no line numbers. This adds the line
+    # 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
+      end
+    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.
+    def create_variable(var_name)
+      Sass::Script::Variable.new(var_name).tap do |v|
+        v.line = line # Use line number of the containing parse tree node
+      end
+    end
+
+    # A number of tree nodes return lists that have strings and
+    # Sass::Script::Nodes interspersed within them. This returns a filtered list
+    # of just those nodes.
+    def extract_script_nodes(list)
+      list.select { |item| item.is_a? Sass::Script::Node }
+    end
+
+    # Takes a list of arguments, be they arrays or individual objects, and
+    # returns a single flat list that can be passed to
+    # Sass::Tree::Visitors::Base#visit_children.
+    def concat_expr_lists(*expr_lists)
+      expr_lists.flatten.compact
+    end
+  end
+
+  class CommentNode
+    def children
+      concat_expr_lists super, extract_script_nodes(value)
+    end
+  end
+
+  class DebugNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+
+  class DirectiveNode
+    def children
+      concat_expr_lists super, extract_script_nodes(value)
+    end
+  end
+
+  class EachNode
+    def children
+      concat_expr_lists super, create_variable(var), list
+    end
+  end
+
+  class ExtendNode
+    def children
+      concat_expr_lists super, extract_script_nodes(selector)
+    end
+  end
+
+  class ForNode
+    def children
+      concat_expr_lists super, create_variable(var), from, to
+    end
+  end
+
+  class FunctionNode
+    def children
+      add_line_numbers_to_args(args)
+
+      concat_expr_lists super, args, splat
+    end
+  end
+
+  class IfNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+
+  class MixinDefNode
+    def children
+      add_line_numbers_to_args(args)
+
+      concat_expr_lists super, args, splat
+    end
+  end
+
+  class MixinNode
+    def children
+      add_line_numbers_to_args(args)
+
+      # Keyword mapping is String -> Expr, so convert the string to a variable
+      # node that supports lint reporting
+      keyword_exprs = keywords.map do |var_name, var_expr|
+        [create_variable(var_name), var_expr]
+      end
+
+      concat_expr_lists super, args, keyword_exprs, splat
+    end
+  end
+
+  class PropNode
+    def children
+      concat_expr_lists super, extract_script_nodes(name), value
+    end
+  end
+
+  class ReturnNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+
+  class RuleNode
+    def children
+      concat_expr_lists super, extract_script_nodes(rule)
+    end
+  end
+
+  class VariableNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+
+  class WarnNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+
+  class WhileNode
+    def children
+      concat_expr_lists super, expr
+    end
+  end
+end

data/lib/scss_lint/engine.rb

@@ -4,10 +4,11 @@ module SCSSLint
   class Engine
     ENGINE_OPTIONS = { cache: false, syntax: :scss }
 
-    attr_reader :contents, :lines, :tree
+    attr_reader :contents, :filename, :lines, :tree
 
     def initialize(scss_or_filename)
       if File.exists?(scss_or_filename)
+        @filename = scss_or_filename
         @engine = Sass::Engine.for_file(scss_or_filename, ENGINE_OPTIONS)
         @contents = File.open(scss_or_filename, 'r').read
       else

data/lib/scss_lint/linter/border_zero_linter.rb

@@ -0,0 +1,24 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::BorderZeroLinter < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      return unless BORDER_PROPERTIES.include? node.name.first.to_s
+      add_lint(node) if node.value.to_sass.strip == 'none'
+    end
+
+    def description
+      '`border: 0;` is preferred over `border: none;`'
+    end
+  end
+
+private
+
+   BORDER_PROPERTIES = %w[border
+                          border-top
+                          border-right
+                          border-bottom
+                          border-left]
+end

data/lib/scss_lint/linter/comment_linter.rb

@@ -0,0 +1,15 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::CommentLinter < Linter
+    include LinterRegistry
+
+    def visit_comment(node)
+      add_lint(node) unless node.invisible?
+    end
+
+    def description
+      'Use // comments everywhere'
+    end
+  end
+end

data/lib/scss_lint/linter/declared_name_linter.rb

@@ -0,0 +1,45 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::DeclaredNameLinter < Linter
+    include LinterRegistry
+
+    def visit_function(node)
+      check(node)
+      yield # Continue into content block of this function definition
+    end
+
+    def visit_mixin(node)
+      check(node)
+      yield # Continue into content block of this mixin's block
+    end
+
+    def visit_mixindef(node)
+      check(node)
+      yield # Continue into content block of this mixin definition
+    end
+
+    def visit_variable(node)
+      check(node)
+      yield # Continue into expression tree for this variable definition
+    end
+
+    def visit_script_funcall(node)
+      check(node)
+    end
+
+    def visit_script_variable(node)
+      check(node)
+    end
+
+    def description
+      'Names of variables, functions, and mixins should be lowercase and not contain underscores. Use hyphens instead.'
+    end
+
+  private
+
+    def check(node)
+      add_lint(node) if node.name =~ /[_A-Z]/
+    end
+  end
+end

data/lib/scss_lint/linter/hex_linter.rb

@@ -4,10 +4,17 @@ module SCSSLint
   class Linter::HexLinter < Linter
     include LinterRegistry
 
-    def visit_prop(node)
-      if node.value.is_a?(Sass::Script::String) &&
-         node.value.to_s =~ /#(\h{3,6})/
-        add_lint(node) unless valid_hex?($1)
+    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
+        end
       end
     end
 

data/lib/scss_lint/linter/property_format_linter.rb

@@ -6,6 +6,7 @@ module SCSSLint
 
     def visit_prop(node)
       line = engine.lines[node.line - 1] if node.line
+
       add_lint(node) unless line =~ PROPERTY_RE
     end
 
@@ -19,11 +20,11 @@ module SCSSLint
 
     VALUE_RE = %r{(\S+\s)*\S+} # eg. "10px", "10px normal"
     PROPERTY_RE = %r{
-      ^\s*[\w-]+:\s           # property name, colon, one space
-        (                     # followed by
-        #{VALUE_RE};          # property and terminating semi-colon eg. a b c;
-        |                     # or
-        ((#{VALUE_RE}\s)?\{)  # nested property, optional value, trailing curly
+      ^\s*[^:]+(?<!\s):\s       # property name, colon not preceded by a space, one space
+        (                       # followed by
+          #{VALUE_RE};          # property and terminating semi-colon eg. a b c;
+          |                     # or
+          ((#{VALUE_RE}\s)?\{)  # nested property, optional value, trailing curly
         )
     }x
   end

data/lib/scss_lint/linter/shorthand_linter.rb

@@ -5,12 +5,18 @@ module SCSSLint
     include LinterRegistry
 
     def visit_prop(node)
-      unless SHORTHANDABLE_PROPERTIES.include? node.name.first.to_s
-        return
-      end
-
-      if node.value.to_sass.strip =~ /\A(\S+\s+\S+(\s+\S+){0,2})\Z/
-        add_lint(node) unless valid_shorthand?($1)
+      return unless SHORTHANDABLE_PROPERTIES.include? node.name.first.to_s
+
+      case node.value
+      when Sass::Script::List
+        items = node.value.children
+        if (2..4).member?(items.count)
+          add_lint(node) unless valid_shorthand?(*items.map(&:to_sass))
+        end
+      when Sass::Script::String
+        if node.value.to_sass.strip =~ /\A(\S+\s+\S+(\s+\S+){0,2})\Z/
+          add_lint(node) unless valid_shorthand?(*$1.split(/\s+/))
+        end
       end
     end
 
@@ -27,10 +33,7 @@ module SCSSLint
                                   margin
                                   padding]
 
-    def valid_shorthand?(shorthand)
-      values = shorthand.split(/\s+/)
-      top, right, bottom, left = values
-
+    def valid_shorthand?(top, right, bottom = nil, left = nil)
       if top == right && right == bottom && bottom == left
         false
       elsif top == right && bottom.nil? && left.nil?

data/lib/scss_lint/linter/single_line_per_selector_linter.rb

@@ -5,12 +5,36 @@ module SCSSLint
     include LinterRegistry
 
     def visit_rule(node)
-      add_lint(node) unless node.rule.grep(/,[^\n]/).empty?
+      add_lint(node) if invalid_comma_placement? node
       yield # Continue linting children
     end
 
     def description
       'Each selector should be on its own line'
     end
+
+  private
+
+    # A comma is invalid if it starts the line or is not the end of the line
+    def invalid_comma_placement?(node)
+      normalize_spacing(condense_to_string(node.rule)) =~ /\n,|,[^\n]/
+    end
+
+    # Since RuleNode.rule returns an array containing both String and
+    # Sass::Script::Nodes, we need to condense it into a single string that we
+    # can run a regex against.
+    def condense_to_string(sequence_list)
+      sequence_list.inject('') do |combined, string_or_script|
+        combined + (string_or_script.is_a?(String) ? string_or_script
+                                                   : string_or_script.to_sass)
+      end
+    end
+
+    # Removes extra spacing between lines in a comma-separated sequence due to
+    # comments being removed in the parse phase. This makes it easy to check if
+    # a comma is where belongs.
+    def normalize_spacing(string_sequence)
+      string_sequence.gsub(/,[^\S\n]*\n\s*/, ",\n")
+    end
   end
 end

data/lib/scss_lint/linter.rb

@@ -21,7 +21,18 @@ module SCSSLint
 
     # Helper for creating lint from a parse tree node
     def add_lint(node)
-      @lints << Lint.new(node.filename, node.line, description)
+      @lints << Lint.new(engine.filename, node.line, description)
+    end
+
+    # Monkey-patched implementation that adds support for traversing
+    # Sass::Script::Nodes (original implementation only supports
+    # Sass::Tree::Nodes).
+    def node_name(node)
+      if node.is_a?(Sass::Script::Node)
+        "script_#{node.class.name.gsub(/.*::(.*?)$/, '\\1').downcase}"
+      else
+        super
+      end
     end
   end
 end

data/lib/scss_lint/version.rb

@@ -1,3 +1,3 @@
 module SCSSLint
-  VERSION = '0.6.7'
+  VERSION = '0.7.0'
 end

data/lib/scss_lint.rb

@@ -10,6 +10,10 @@ module SCSSLint
   autoload :Runner, 'scss_lint/runner'
   autoload :VERSION, 'scss_lint/version'
 
+  # Preload Sass so we can monkey patch it
+  require 'sass'
+  require 'sass/tree'
+
   # Load all linters
   Dir[File.expand_path('scss_lint/linter/*.rb', File.dirname(__FILE__))].each do |file|
     require file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -84,13 +84,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sass/tree.rb
 - lib/scss_lint.rb
 - lib/scss_lint/cli.rb
 - lib/scss_lint/engine.rb
 - lib/scss_lint/lint.rb
 - lib/scss_lint/linter.rb
+- lib/scss_lint/linter/border_zero_linter.rb
+- lib/scss_lint/linter/comment_linter.rb
 - lib/scss_lint/linter/debug_linter.rb
 - lib/scss_lint/linter/declaration_order_linter.rb
+- lib/scss_lint/linter/declared_name_linter.rb
 - lib/scss_lint/linter/empty_rule_linter.rb
 - lib/scss_lint/linter/hex_linter.rb
 - lib/scss_lint/linter/property_format_linter.rb
@@ -107,7 +111,8 @@ files:
 - lib/scss_lint/version.rb
 - bin/scss-lint
 homepage: http://github.com/causes/scss-lint
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: