scss-lint 0.1

data/bin/scss-lint

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'scss_lint/cli'
+
+SCSSLint::CLI.new ARGV

data/lib/scss_lint.rb

@@ -0,0 +1,26 @@
+require 'find'
+
+module SCSSLint
+  autoload :Engine, 'scss_lint/engine'
+  autoload :Lint, 'scss_lint/lint'
+  autoload :LinterRegistry, 'scss_lint/linter_registry'
+  autoload :Linter, 'scss_lint/linter'
+  autoload :Runner, 'scss_lint/runner'
+
+  # Load all linters
+  Dir[File.expand_path('scss_lint/linter/*.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
+        end
+      end
+      files.uniq
+    end
+  end
+end

data/lib/scss_lint/cli.rb

@@ -0,0 +1,37 @@
+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)
+
+      files = SCSSLint.extract_files_from(opts)
+
+      runner = Runner.new
+      begin
+        runner.run files
+        report_lints(runner.lints)
+        exit 1 if runner.lints?
+      rescue NoFilesError => ex
+        puts ex.message
+        exit -1
+      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
+
+        puts "#{lint.line} - #{lint.description}"
+      end
+    end
+  end
+end

data/lib/scss_lint/engine.rb

@@ -0,0 +1,22 @@
+require 'sass'
+
+module SCSSLint
+  class Engine
+    ENGINE_OPTIONS = { cache: false, syntax: :scss }
+
+    attr_reader :contents, :lines, :tree
+
+    def initialize(scss_or_filename)
+      if File.exists?(scss_or_filename)
+        @engine = Sass::Engine.for_file(scss_or_filename, ENGINE_OPTIONS)
+        @contents = File.open(scss_or_filename, 'r').read
+      else
+        @engine = Sass::Engine.new(scss_or_filename, ENGINE_OPTIONS)
+        @contents = scss_or_filename
+      end
+
+      @lines = @contents.split("\n")
+      @tree = @engine.to_tree
+    end
+  end
+end

data/lib/scss_lint/lint.rb

@@ -0,0 +1,11 @@
+module SCSSLint
+  class Lint
+    attr_reader :filename, :line, :description
+
+    def initialize(filename, line, description)
+      @filename = filename
+      @line = line
+      @description = description
+    end
+  end
+end

data/lib/scss_lint/linter.rb

@@ -0,0 +1,25 @@
+module SCSSLint
+  class Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        [] # No lints
+      end
+
+      def create_lint(node)
+        Lint.new(node.filename, node.line, description)
+      end
+
+      def description
+        nil
+      end
+
+    protected
+
+      def name
+        self.class.name
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/debug_linter.rb

@@ -0,0 +1,21 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::DebugLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          lints << create_lint(node) if node.is_a?(Sass::Tree::DebugNode)
+        end
+        lints
+      end
+
+      def description
+        '@debug line'
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/declaration_order_linter.rb

@@ -0,0 +1,55 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::DeclarationOrderLinter < Linter
+    include LinterRegistry
+
+    DECLARATION_ORDER = [
+      Sass::Tree::ExtendNode,
+      Sass::Tree::MixinNode,
+      Sass::Tree::PropNode,
+      Sass::Tree::RuleNode,
+    ]
+
+    class << self
+      def run(engine)
+        lints = []
+        #engine.tree.each do |node|
+          #if node.is_a?(Sass::Tree::RuleNode)
+            #lints << check_order_of_declarations(node)
+          #end
+        #end
+        #lints.compact
+      end
+
+      def description
+        'Rule sets should start with @extend declarations, followed by ' <<
+        'mixins, properties, and nested rule sets, in that order'
+      end
+
+    private
+
+      def important_node?(node)
+        case node
+        when *DECLARATION_ORDER
+          true
+        end
+      end
+
+      def check_order_of_declarations(rule_node)
+        children = rule_node.children.select { |node| important_node?(node) }
+
+        # Horribly inefficient, but we're not sorting thousands of declarations
+        sorted_children = children.sort do |x,y|
+          DECLARATION_ORDER.index(x.class) <=> DECLARATION_ORDER.index(y.class)
+        end
+
+        if children != sorted_children
+          return create_lint(children.first)
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/empty_rule_linter.rb

@@ -0,0 +1,29 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::EmptyRuleLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          if node.is_a?(Sass::Tree::RuleNode)
+            lints << check_empty_rule(node)
+          end
+        end
+        lints.compact
+      end
+
+      def description
+        'Empty rule'
+      end
+
+    private
+
+      def check_empty_rule(rule_node)
+        create_lint(rule_node) if rule_node.children.empty?
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/hex_linter.rb

@@ -0,0 +1,45 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::HexLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          if node.is_a?(Sass::Tree::PropNode)
+            lints << check_valid_hex_value(node)
+          end
+        end
+        lints.compact
+      end
+
+      def description
+        'Hexadecimal color codes should be lowercase and in 3-digit form where possible'
+      end
+
+    private
+
+      def check_valid_hex_value(prop_node)
+        if prop_node.value.is_a?(Sass::Script::String) &&
+           prop_node.value.to_s =~ /#(\h{3,6})/
+          return create_lint(prop_node) unless valid_hex?($1)
+        end
+      end
+
+      def valid_hex?(hex)
+        [3,6].include?(hex.length) &&
+          hex.downcase == hex &&
+          !can_be_condensed(hex)
+      end
+
+      def can_be_condensed(hex)
+        hex.length == 6 &&
+          hex[0] == hex[1] &&
+          hex[2] == hex[3] &&
+          hex[4] == hex[5]
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/property_format_linter.rb

@@ -0,0 +1,30 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::PropertyFormatLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          if node.is_a?(Sass::Tree::PropNode)
+            lints << check_property_format(node, engine.lines[node.line - 1]) if node.line
+          end
+        end
+        lints.compact
+      end
+
+      def description
+        'Property declarations should always be on one line of the form ' <<
+        '`property-name: value;`'
+      end
+
+    private
+
+      def check_property_format(prop_node, line)
+        return create_lint(prop_node) unless line =~ /^\s*[\w-]+: [^\s][^;]*;/
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/sorted_properties_linter.rb

@@ -0,0 +1,39 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::SortedPropertiesLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          if node.is_a?(Sass::Tree::RuleNode)
+            lints << check_properties_sorted(node)
+          end
+        end
+        lints.compact
+      end
+
+      def description
+        'Properties should be sorted in alphabetical order'
+      end
+
+    private
+
+      def check_properties_sorted(rule_node)
+        properties = rule_node.children.select do |node|
+          node.is_a?(Sass::Tree::PropNode)
+        end
+
+        prop_names = properties.map do |prop_node|
+          prop_node.name.first.to_s
+        end
+
+        if prop_names.sort != prop_names
+          create_lint(properties.first)
+        end
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/zero_unit_linter.rb

@@ -0,0 +1,29 @@
+require 'sass'
+
+module SCSSLint
+  class Linter::ZeroUnitLinter < Linter
+    include LinterRegistry
+
+    class << self
+      def run(engine)
+        lints = []
+        engine.tree.each do |node|
+          if node.is_a?(Sass::Tree::PropNode)
+            lints << check_zero_unit(node, engine.lines[node.line - 1]) if node.line
+          end
+        end
+        lints.compact
+      end
+
+      def description
+        'Properties with a value of zero should be unit-less'
+      end
+
+    private
+
+      def check_zero_unit(prop_node, line)
+        return create_lint(prop_node) if line =~ /^\s*[\w-]+:\s*0[a-z]+;$/i
+      end
+    end
+  end
+end

data/lib/scss_lint/linter_registry.rb

@@ -0,0 +1,13 @@
+module SCSSLint
+  module LinterRegistry
+    @linters = []
+
+    class << self
+      attr_reader :linters
+
+      def included(base)
+        @linters << base
+      end
+    end
+  end
+end

data/lib/scss_lint/runner.rb

@@ -0,0 +1,36 @@
+require 'scss_lint'
+require 'sass'
+
+module SCSSLint
+  class NoFilesError < StandardError; end
+  class NoLintersError < StandardError; end
+
+  class Runner
+    attr_reader :lints
+
+    def run(files = [])
+      @lints = []
+
+      raise NoFilesError.new('No SCSS files specified') if files.empty?
+      raise NoLintersError.new('No linters specified') if LinterRegistry.linters.empty?
+
+      files.each do |file|
+        find_lints(file)
+      end
+    end
+
+    def find_lints(file)
+      engine = Engine.new(file)
+
+      LinterRegistry.linters.each do |linter|
+        @lints += linter.run(engine)
+      end
+    rescue Sass::SyntaxError => ex
+      @lints << Lint.new(ex.sass_filename, ex.sass_line, ex.to_s)
+    end
+
+    def lints?
+      @lints.any?
+    end
+  end
+end

data/lib/scss_lint/version.rb

@@ -0,0 +1,3 @@
+module SCSSLint
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: scss-lint
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Causes Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    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'
+description: Opinionated tool that tells you whether or not your SCSS is "bad"
+email:
+- eng@causes.com
+- shane@causes.com
+executables:
+- scss-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/scss_lint/version.rb
+- lib/scss_lint/runner.rb
+- lib/scss_lint/lint.rb
+- lib/scss_lint/linter.rb
+- lib/scss_lint/linter/declaration_order_linter.rb
+- lib/scss_lint/linter/empty_rule_linter.rb
+- lib/scss_lint/linter/debug_linter.rb
+- lib/scss_lint/linter/sorted_properties_linter.rb
+- lib/scss_lint/linter/property_format_linter.rb
+- lib/scss_lint/linter/zero_unit_linter.rb
+- lib/scss_lint/linter/hex_linter.rb
+- lib/scss_lint/cli.rb
+- lib/scss_lint/engine.rb
+- lib/scss_lint/linter_registry.rb
+- lib/scss_lint.rb
+- bin/scss-lint
+homepage: http://github.com/causes/scss-lint
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: SCSS lint tool
+test_files: []