scss-lint 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62980ca32775a70ec7170fc8b7399eb13b304c7b
-  data.tar.gz: 76fa2ea621edad2ad9ebc9d0e2b302b57c43a70d
+  metadata.gz: 5efc8809d431b7de019112e2771839116d88df95
+  data.tar.gz: d54b6ba942585c4fbdc969c389af86e0da47088c
 SHA512:
-  metadata.gz: ce7dfa08c1c68044da63de6f376a3ce483e5145eaa7854668b616dbd0b1596c983e7dbc5f510c8cdbf3d27f47658b21cebe5f0caa63b9c9a888ef0d0df772729
-  data.tar.gz: dae5b62b186b24c851394b7e18c16e45f4f1281a2046c7f6a00513deb94d8300df30e8a5e7e1d3845c77f9efe68f1fef5c9e4f059239499b55e56cf4ff24f0c4
+  metadata.gz: 406a4cd62baa39e5dc561c5cd84cedc7ef7b4d64a0b8813a693c22fb3192640f0382b3a839f317fdbe0f75738c6ed53b3f494bd5e9c32ed50f79833841e76f43
+  data.tar.gz: e0c8b74d3cf6bb80f592cfacc9ed25fe642b397e36ca9e965ee31a4889a8291ea2b88334aba45aae0c4eaf5cf52c610150bf6bc0b2ecd5b6af92aa4547ea21b5

data/lib/scss_lint.rb

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

data/lib/scss_lint/cli.rb

@@ -1,6 +1,8 @@
 require 'optparse'
 
 module SCSSLint
+  # Responsible for parsing command-line options and executing the appropriate
+  # application logic based on the options specified.
   class CLI
     attr_accessor :options
 
@@ -62,10 +64,15 @@ module SCSSLint
       runner = Runner.new(options)
       runner.run(find_files)
       report_lints(runner.lints)
-      halt 1 if runner.lints?
+      halt(1) if runner.lints?
     rescue NoFilesError, NoSuchLinter, Errno::ENOENT => ex
       puts ex.message
-      halt -1
+      halt(-1)
+    rescue => ex
+      puts ex.message
+      puts ex.backtrace
+      puts 'Report this bug at '.yellow + BUG_REPORT_URL.cyan
+      halt(-1)
     end
 
   private

data/lib/scss_lint/constants.rb

@@ -0,0 +1,5 @@
+# Global application constants.
+module SCSSLint
+  REPO_URL = 'https://github.com/causes/scss-lint'
+  BUG_REPORT_URL = "#{REPO_URL}/issues"
+end

data/lib/scss_lint/linter.rb

@@ -28,6 +28,17 @@ module SCSSLint
                          message || description)
     end
 
+    # Returns 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
+
+      # Return a newline if offset points at the very end of the line
+      return "\n" if actual_offset == engine.lines[actual_line].length
+
+      engine.lines[actual_line][actual_offset]
+    end
+
     # Monkey-patched implementation that adds support for traversing
     # Sass::Script::Nodes (original implementation only supports
     # Sass::Tree::Nodes).

data/lib/scss_lint/linter/border_zero.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Reports when `border: 0` can be used instead of `border: none`.
   class Linter::BorderZero < Linter
     include LinterRegistry
 
@@ -10,13 +11,13 @@ module SCSSLint
     def description
       '`border: 0;` is preferred over `border: none;`'
     end
-  end
 
-private
+  private
 
-   BORDER_PROPERTIES = %w[border
-                          border-top
-                          border-right
-                          border-bottom
-                          border-left]
+     BORDER_PROPERTIES = %w[border
+                            border-top
+                            border-right
+                            border-bottom
+                            border-left]
+  end
 end

data/lib/scss_lint/linter/capitalization_in_selector.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for capitalized letters in IDs, classes, types, etc. in selectors.
   class Linter::CapitalizationInSelector < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/color_keyword.rb

@@ -1,4 +1,6 @@
 module SCSSLint
+  # Checks for uses of a color keyword instead of the preferred hexadecimal
+  # form.
   class Linter::ColorKeyword < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/comment.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for uses of renderable comments (/* ... */)
   class Linter::Comment < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/debug_statement.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for leftover `@debug` statements.
   class Linter::DebugStatement < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/declaration_order.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks the order of nested items within a rule set.
   class Linter::DeclarationOrder < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/declared_name.rb

@@ -1,4 +1,6 @@
 module SCSSLint
+  # Checks that the declared names of functions, mixins, and variables are all
+  # lowercase and use hyphens instead of underscores.
   class Linter::DeclaredName < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/id_with_extraneous_selector.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for a selector with an ID combined with some other selector.
   class Linter::IdWithExtraneousSelector < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/indentation.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for consistent indentation of nested declarations and rule sets.
   class Linter::Indentation < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/leading_zero.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for unnecessary leading zeros in numeric values with decimal points.
   class Linter::LeadingZero < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/placeholder_in_extend.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks that `@extend` is always used with a placeholder selector.
   class Linter::PlaceholderInExtend < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/shorthand.rb

@@ -1,4 +1,6 @@
 module SCSSLint
+  # Checks for the use of the shortest form for properties that can be written
+  # in shorthand.
   class Linter::Shorthand < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/single_line_per_selector.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks that selector sequences are split over multiple lines by comma.
   class Linter::SingleLinePerSelector < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/sorted_properties.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks the declaration order of properties.
   class Linter::SortedProperties < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/space_after_comma.rb

@@ -0,0 +1,87 @@
+module SCSSLint
+  # Checks for spaces after commas in argument lists.
+  class Linter::SpaceAfterComma < Linter
+    include LinterRegistry
+
+    def visit_mixindef(node)
+      check_definition(node, :mixin)
+      yield
+    end
+
+    def visit_mixin(node)
+      check_invocation(node, :mixin)
+      yield
+    end
+
+    def visit_function(node)
+      check_definition(node, :function)
+      yield
+    end
+
+    def visit_script_funcall(node)
+      check_invocation(node, :function)
+      yield
+    end
+
+    def visit_script_listliteral(node)
+      check_commas_after_args(node.elements, 'lists') if node.separator == :comma
+      yield
+    end
+
+  private
+
+    # Check parameters of a function/mixin definition
+    def check_definition(node, type)
+      # Use the default value's source range if one is defined, since that will
+      # be the item with the comma after it
+      args = node.args.map { |name, default_value| default_value || name }
+      args << node.splat if node.splat
+
+      check_commas_after_args(args, "#{type} parameters")
+    end
+
+    # Check arguments passed to a function/mixin invocation
+    def check_invocation(node, type)
+      args = sort_args_by_position(node.args,
+                                   node.splat,
+                                   node.keywords.values,
+                                   node.kwarg_splat)
+
+      check_commas_after_args(args, "#{type} arguments")
+    end
+
+    # Since keyword arguments are not guaranteed to be in order, use the source
+    # range to order arguments so we check them in the order they were declared.
+    def sort_args_by_position(*args)
+      args.flatten.compact.sort_by do |arg|
+        pos = arg.source_range.end_pos
+        [pos.line, pos.offset]
+      end
+    end
+
+    EXPECTED_SPACES_AFTER_COMMA = 1
+
+    # Check the comma after each argument in a list for a space following it,
+    # reporting a lint using the given [arg_type].
+    def check_commas_after_args(args, arg_type)
+      # For each arg except the last, check the character following the comma
+      args[0..-2].each do |arg|
+        # Find the first comma following the arg
+        offset = 1
+        offset += 1 while character_at(arg.source_range.end_pos, offset - 1) != ','
+
+        # Check for space or newline after arg (we allow arguments to be split
+        # up over multiple lines).
+        spaces = 0
+        while character_at(arg.source_range.end_pos, offset) =~ / |\n/
+          spaces += 1
+          offset += 1
+        end
+
+        if spaces != EXPECTED_SPACES_AFTER_COMMA
+          add_lint arg, 'Commas in %s should be followed by a single space' % arg_type
+        end
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/space_after_property_colon.rb

@@ -0,0 +1,39 @@
+module SCSSLint
+  # Checks for spaces following the colon that separates a property's name from
+  # its value.
+  class Linter::SpaceAfterPropertyColon < Linter
+    include LinterRegistry
+
+    EXPECTED_SPACES_AFTER_COLON = 1
+
+    def visit_prop(node)
+      spaces = spaces_after_colon(node)
+
+      if spaces != EXPECTED_SPACES_AFTER_COLON
+        add_lint node, 'Colon after property should be followed by ' <<
+                       "#{pluralize(EXPECTED_SPACES_AFTER_COLON, 'space')} instead of " <<
+                       pluralize(spaces, 'space')
+      end
+    end
+
+  private
+
+    def spaces_after_colon(node)
+      spaces = 0
+      offset = 1
+
+      # Handle quirk where Sass parser doesn't include colon in source range
+      # when property name is followed by spaces
+      if character_at(node.name_source_range.end_pos, offset) == ':'
+        offset += 1
+      end
+
+      while character_at(node.name_source_range.end_pos, offset) == ' '
+        spaces += 1
+        offset += 1
+      end
+
+      spaces
+    end
+  end
+end

data/lib/scss_lint/linter/space_after_property_name.rb

@@ -0,0 +1,13 @@
+module SCSSLint
+  # Checks for spaces following the name of a property and before the colon
+  # separating the property's name from its value.
+  class Linter::SpaceAfterPropertyName < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      if character_at(node.name_source_range.end_pos) != ':'
+        add_lint node, 'Property name should be immediately followed by a colon'
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/space_before_brace.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for the presence of a single space before an opening brace.
   class Linter::SpaceBeforeBrace < Linter
     include LinterRegistry
 

data/lib/scss_lint/linter/trailing_semicolon_after_property_value.rb

@@ -0,0 +1,29 @@
+module SCSSLint
+  # Checks properties for a trailing semicolon (unless that property is a
+  # namespace which has nested properties).
+  class Linter::TrailingSemicolonAfterPropertyValue < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      has_nested_props = has_nested_properties?(node)
+
+      if !has_nested_props && !ends_with_semicolon?(node)
+        add_lint node.line, 'Property declaration should end with a semicolon'
+      end
+
+      yield if has_nested_props
+    end
+
+  private
+
+    def has_nested_properties?(node)
+      node.children.any? { |n| n.is_a?(Sass::Tree::PropNode) }
+    end
+
+    # Checks that the property is ended by a semicolon (with no whitespace)
+    def ends_with_semicolon?(node)
+      character_at(node.source_range.end_pos) == ';' &&
+        character_at(node.source_range.end_pos, -1) !~ /\s/
+    end
+  end
+end

data/lib/scss_lint/linter/zero_unit.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Checks for unnecessary units on zero values.
   class Linter::ZeroUnit < Linter
     include LinterRegistry
 

data/lib/scss_lint/runner.rb

@@ -1,7 +1,10 @@
 module SCSSLint
+  class LinterError < StandardError; end
   class NoFilesError < StandardError; end
   class NoLintersError < StandardError; end
 
+  # Finds and aggregates all lints found by running the registered linters
+  # against a set of SCSS files.
   class Runner
     attr_reader :linters, :lints
 
@@ -20,8 +23,8 @@ module SCSSLint
     end
 
     def run(files = [])
-      raise NoFilesError.new('No SCSS files specified') if files.empty?
-      raise NoLintersError.new('No linters specified') if linters.empty?
+      raise NoFilesError, 'No SCSS files specified' if files.empty?
+      raise NoLintersError, 'No linters specified' if linters.empty?
 
       files.each do |file|
         find_lints(file)
@@ -32,18 +35,26 @@ module SCSSLint
       end
     end
 
+    def lints?
+      lints.any?
+    end
+
+  private
+
     def find_lints(file)
       engine = Engine.new(file)
 
       linters.each do |linter|
-        linter.run(engine)
+        begin
+          linter.run(engine)
+        rescue => error
+          raise LinterError,
+                "#{linter.class} raised unexpected error: '#{error.message}'",
+                error.backtrace
+        end
       end
     rescue Sass::SyntaxError => ex
       @lints << Lint.new(ex.sass_filename, ex.sass_line, ex.to_s, :error)
     end
-
-    def lints?
-      lints.any?
-    end
   end
 end

data/lib/scss_lint/utils.rb

@@ -1,4 +1,5 @@
 module SCSSLint
+  # Collection of helpers used across a variety of linters.
   module Utils
     # Given a selector array which is a list of strings with Sass::Script::Nodes
     # interspersed within them, return an array of strings representing those
@@ -55,6 +56,10 @@ module SCSSLint
       end
     end
 
+    def pluralize(value, word)
+      value == 1 ? "#{value} #{word}" : "#{value} #{word}s"
+    end
+
   private
 
     INVALID_NAME_CHARS = '[_A-Z]'

data/lib/scss_lint/version.rb

@@ -1,3 +1,3 @@
 module SCSSLint
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/scss_lint/version.rb
+- lib/scss_lint/constants.rb
 - lib/scss_lint/utils.rb
 - lib/scss_lint/reporter/xml_reporter.rb
 - lib/scss_lint/reporter/default_reporter.rb
@@ -85,19 +86,24 @@ files:
 - 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/sass/tree.rb
+- lib/scss_lint/sass/script.rb
+- lib/scss_lint/linter/space_after_comma.rb
 - lib/scss_lint/linter/space_before_brace.rb
 - lib/scss_lint/linter/capitalization_in_selector.rb
 - lib/scss_lint/linter/indentation.rb
 - lib/scss_lint/linter/declared_name.rb
 - lib/scss_lint/linter/sorted_properties.rb
+- lib/scss_lint/linter/trailing_semicolon_after_property_value.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/zero_unit.rb
 - lib/scss_lint/linter/placeholder_in_extend.rb
+- lib/scss_lint/linter/space_after_property_name.rb
 - lib/scss_lint/linter/usage_name.rb
 - lib/scss_lint/linter/border_zero.rb
+- lib/scss_lint/linter/space_after_property_colon.rb
 - lib/scss_lint/linter/debug_statement.rb
 - lib/scss_lint/linter/duplicate_property.rb
 - lib/scss_lint/linter/hex_format.rb
@@ -109,11 +115,9 @@ files:
 - lib/scss_lint/cli.rb
 - lib/scss_lint/engine.rb
 - lib/scss_lint/linter_registry.rb
-- lib/sass/tree.rb
-- lib/sass/script.rb
 - lib/scss_lint.rb
 - bin/scss-lint
-homepage: http://github.com/causes/scss-lint
+homepage: https://github.com/causes/scss-lint
 licenses:
 - MIT
 metadata: {}

data/lib/scss_lint/linter/property_format.rb

@@ -1,29 +0,0 @@
-module SCSSLint
-  class Linter::PropertyFormat < Linter
-    include LinterRegistry
-
-    def visit_prop(node)
-      line = engine.lines[node.line - 1] if node.line
-
-      add_lint(node) unless line =~ PROPERTY_RE
-    end
-
-    def description
-      'Property declarations should always be on one line of the form ' <<
-      '`name: value;` or `name: [value] {` ' <<
-      '(are you missing a trailing semi-colon?)'
-    end
-
-  private
-
-    VALUE_RE = %r{(\S+\s)*\S+} # eg. "10px", "10px normal"
-    PROPERTY_RE = %r{
-      ^\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
-end