scss-lint 0.5.2 → 0.6

data/bin/scss-lint

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
-require 'scss_lint/cli'
+require 'scss_lint'
 
-SCSSLint::CLI.new ARGV
+SCSSLint::CLI.new(ARGV).tap do |cli|
+  cli.parse_arguments
+  cli.run
+end

data/lib/scss_lint.rb

@@ -1,10 +1,12 @@
 require 'find'
 
 module SCSSLint
+  autoload :CLI, 'scss_lint/cli'
   autoload :Engine, 'scss_lint/engine'
   autoload :Lint, 'scss_lint/lint'
   autoload :LinterRegistry, 'scss_lint/linter_registry'
   autoload :Linter, 'scss_lint/linter'
+  autoload :Reporter, 'scss_lint/reporter'
   autoload :Runner, 'scss_lint/runner'
 
   # Load all linters
@@ -12,15 +14,29 @@ module SCSSLint
     require file
   end
 
+  # Load all reporters
+  Dir[File.expand_path('scss_lint/reporter/*.rb', File.dirname(__FILE__))].each do |file|
+    require file
+  end
+
   class << self
     def extract_files_from(list)
       files = []
       list.each do |file|
         Find.find(file) do |f|
-          files << f
+          files << f if scssish_file?(f)
         end
       end
       files.uniq
     end
+
+  private
+
+    VALID_EXTENSIONS = %w[.css .scss]
+    def scssish_file?(file)
+      return false unless FileTest.file?(file)
+
+      VALID_EXTENSIONS.include?(File.extname(file))
+    end
   end
 end

data/lib/scss_lint/cli.rb

@@ -1,37 +1,95 @@
 require 'scss_lint'
-require 'colorize'
 require 'optparse'
 
 module SCSSLint
   class CLI
-    def initialize(args)
-      opts = OptionParser.new do |opts|
-        opts.banner = 'Usage: scss-lint [scss-files]'
-      end.parse!(args)
+    attr_accessor :options
 
-      files = SCSSLint.extract_files_from(opts)
+    def initialize(args = [])
+      @args = args
+      @options = {}
+    end
+
+    def parse_arguments
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{opts.program_name} [options] [scss-files]"
+
+        opts.separator ''
+        opts.separator 'Common options:'
+
+        opts.on('-e', '--exclude file,...', Array,
+                'List of file names to exclude') do |files|
+          options[:excluded_files] = files
+        end
+
+        opts.on('-i', '--ignore-linter linter,...', Array,
+                "Specify which linters you don't want to run") do |linters|
+          options[:ignored_linters] = linters
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          print_help opts.help
+        end
+
+        opts.on_tail('-v', '--version', 'Show version') do
+          print_version opts.program_name, VERSION
+        end
+
+        opts.on('-x', '--xml', 'Output the results in XML format') do
+          options[:reporter] = SCSSLint::Reporter::XMLReporter
+        end
+      end
 
-      runner = Runner.new
       begin
-        runner.run files
-        report_lints(runner.lints)
-        exit 1 if runner.lints?
-      rescue NoFilesError => ex
-        puts ex.message
-        exit -1
+        parser.parse!(@args)
+
+        # Take the rest of the arguments as files/directories
+        options[:files] = @args
+      rescue OptionParser::InvalidOption => ex
+        print_help parser.help, ex
       end
     end
 
-    def report_lints(lints)
-      lints.sort_by { |l| [l.filename, l.line] }.each do |lint|
-        if lint.filename
-          print "#{lint.filename}:".yellow
-        else
-          print 'line'.yellow
-        end
+    def run
+      runner = Runner.new(options)
+      runner.run(find_files)
+      report_lints(runner.lints)
+      halt 1 if runner.lints?
+    rescue NoFilesError, NoSuchLinter => ex
+      puts ex.message
+      halt -1
+    end
+
+  private
 
-        puts "#{lint.line} - #{lint.description}"
+    def find_files
+      excluded_files = options.fetch(:excluded_files, [])
+
+      SCSSLint.extract_files_from(options[:files]).reject do |file|
+        excluded_files.include?(file)
       end
     end
+
+    def report_lints(lints)
+      sorted_lints = lints.sort_by { |l| [l.filename, l.line] }
+      reporter = options.fetch(:reporter, Reporter::DefaultReporter).new(sorted_lints)
+      puts reporter.report_lints
+    end
+
+    def print_help(help_message, err = nil)
+      puts err, '' if err
+      puts help_message
+      halt
+    end
+
+    def print_version(program_name, version)
+      puts "#{program_name} #{version}"
+      halt
+    end
+
+    # Used for ease-of testing
+    def halt(exit_status = 0)
+      exit exit_status
+    end
   end
 end

data/lib/scss_lint/linter/property_format_linter.rb

@@ -17,7 +17,8 @@ module SCSSLint
 
       def description
         'Property declarations should always be on one line of the form ' <<
-        '`name: value;` or `name: [value] {`'
+        '`name: value;` or `name: [value] {` ' <<
+        '(are you missing a trailing semi-colon?)'
       end
 
     private

data/lib/scss_lint/linter/shorthand_linter.rb

@@ -20,10 +20,19 @@ module SCSSLint
       end
 
     private
+      SHORTHANDABLE_PROPERTIES = %w[border-color
+                                    border-radius
+                                    border-style
+                                    border-width
+                                    margin
+                                    padding]
 
       def check_valid_shorthand_value(prop_node)
-        if prop_node.value.is_a?(Sass::Script::String) &&
-           prop_node.value.to_s.strip =~ /\A(\S+\s+\S+(\s+\S+){0,2})\Z/
+        unless SHORTHANDABLE_PROPERTIES.include? prop_node.name.first.to_s
+          return
+        end
+
+        if prop_node.value.to_s.strip =~ /\A(\S+\s+\S+(\s+\S+){0,2})\Z/
           return create_lint(prop_node) unless valid_shorthand?($1)
         end
       end

data/lib/scss_lint/linter_registry.rb

@@ -1,4 +1,6 @@
 module SCSSLint
+  class NoSuchLinter < StandardError; end
+
   module LinterRegistry
     @linters = []
 
@@ -8,6 +10,17 @@ module SCSSLint
       def included(base)
         @linters << base
       end
+
+      def extract_linters_from(linter_names)
+        linter_names.map do |linter_name|
+          begin
+            linter_class = linter_name.split('_').map(&:capitalize).join('')
+            Kernel.const_get(linter_class)
+          rescue NameError
+            raise NoSuchLinter.new("Linter #{linter_class} does not exist")
+          end
+        end
+      end
     end
   end
 end

data/lib/scss_lint/reporter.rb

@@ -0,0 +1,13 @@
+module SCSSLint
+  class Reporter
+    attr_reader :lints
+
+    def initialize(lints)
+      @lints = lints
+    end
+
+    def report_lints
+      raise NotImplementedError, 'You must implement report_lints'
+    end
+  end
+end

data/lib/scss_lint/reporter/default_reporter.rb

@@ -0,0 +1,11 @@
+require 'colorize'
+
+module SCSSLint
+  class Reporter::DefaultReporter < Reporter
+    def report_lints
+      lints.map do |lint|
+        "#{lint.filename}:".yellow + "#{lint.line} - #{lint.description}"
+      end.join("\n")
+    end
+  end
+end

data/lib/scss_lint/reporter/xml_reporter.rb

@@ -0,0 +1,21 @@
+module SCSSLint
+  class Reporter::XMLReporter < Reporter
+    def report_lints
+      output = '<?xml version="1.0" encoding="utf-8"?>'
+
+      output << '<lint>'
+      lints.group_by(&:filename).each do |filename, file_lints|
+        output << "<file name='#{filename}'>"
+
+        file_lints.each do |lint|
+          output << "<issue line='#{lint.line}' severity='warning' reason='#{lint.description}' />"
+        end
+
+        output << '</file>'
+      end
+      output << '</lint>'
+
+      output
+    end
+  end
+end

data/lib/scss_lint/runner.rb

@@ -6,13 +6,22 @@ module SCSSLint
   class NoLintersError < StandardError; end
 
   class Runner
-    attr_reader :lints
+    attr_reader :linters, :lints
 
-    def run(files = [])
+    def initialize(options = {})
       @lints = []
 
+      ignored_linters = LinterRegistry.
+        extract_linters_from(options.fetch(:ignored_linters, []))
+
+      @linters = LinterRegistry.linters.reject do |linter|
+        ignored_linters.include?(linter)
+      end
+    end
+
+    def run(files = [])
       raise NoFilesError.new('No SCSS files specified') if files.empty?
-      raise NoLintersError.new('No linters specified') if LinterRegistry.linters.empty?
+      raise NoLintersError.new('No linters specified') if linters.empty?
 
       files.each do |file|
         find_lints(file)
@@ -22,7 +31,7 @@ module SCSSLint
     def find_lints(file)
       engine = Engine.new(file)
 
-      LinterRegistry.linters.each do |linter|
+      linters.each do |linter|
         @lints += linter.run(engine)
       end
     rescue Sass::SyntaxError => ex

data/lib/scss_lint/version.rb

@@ -1,3 +1,3 @@
 module SCSSLint
-  VERSION = '0.5.2'
+  VERSION = '0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +100,9 @@ files:
 - lib/scss_lint/linter/type_in_id_selector_linter.rb
 - lib/scss_lint/linter/zero_unit_linter.rb
 - lib/scss_lint/linter_registry.rb
+- lib/scss_lint/reporter.rb
+- lib/scss_lint/reporter/default_reporter.rb
+- lib/scss_lint/reporter/xml_reporter.rb
 - lib/scss_lint/runner.rb
 - lib/scss_lint/version.rb
 - bin/scss-lint