scss-lint 0.7.1 → 0.9.0

checksums.yaml

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

data/lib/sass/script.rb

@@ -0,0 +1,12 @@
+# Contains extensions of Sass::Script::Nodes to add support for accessing
+# various parts of the parse tree not provided out-of-the-box.
+module Sass::Script
+  class Variable
+    # When accessing keyword arguments, the Sass parser treats the underscored
+    # name as canonical. Since this only matters during the compilation step, we
+    # can safely override the behaviour to return the original name.
+    def underscored_name
+      @name
+    end
+  end
+end

data/lib/scss_lint.rb

@@ -8,11 +8,13 @@ module SCSSLint
   autoload :Linter, 'scss_lint/linter'
   autoload :Reporter, 'scss_lint/reporter'
   autoload :Runner, 'scss_lint/runner'
+  autoload :Utils, 'scss_lint/utils'
   autoload :VERSION, 'scss_lint/version'
 
   # Preload Sass so we can monkey patch it
   require 'sass'
-  require 'sass/tree'
+  require File.expand_path('sass/script', File.dirname(__FILE__))
+  require File.expand_path('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,4 +1,3 @@
-require 'scss_lint'
 require 'optparse'
 
 module SCSSLint
@@ -22,9 +21,18 @@ module SCSSLint
           options[:excluded_files] = files
         end
 
-        opts.on('-i', '--ignore-linter linter,...', Array,
+        opts.on('-i', '--include-linter linter,...', Array,
+                'Specify which linters you want to run') do |linters|
+          options[:included_linters] = linters
+        end
+
+        opts.on('-x', '--exclude-linter linter,...', Array,
                 "Specify which linters you don't want to run") do |linters|
-          options[:ignored_linters] = linters
+          options[:excluded_linters] = linters
+        end
+
+        opts.on_tail('--show-linters', 'Shows available linters') do
+          print_linters
         end
 
         opts.on_tail('-h', '--help', 'Show this message') do
@@ -35,7 +43,7 @@ module SCSSLint
           print_version opts.program_name, VERSION
         end
 
-        opts.on('-x', '--xml', 'Output the results in XML format') do
+        opts.on('--xml', 'Output the results in XML format') do
           options[:reporter] = SCSSLint::Reporter::XMLReporter
         end
       end
@@ -55,7 +63,7 @@ module SCSSLint
       runner.run(find_files)
       report_lints(runner.lints)
       halt 1 if runner.lints?
-    rescue NoFilesError, NoSuchLinter => ex
+    rescue NoFilesError, NoSuchLinter, Errno::ENOENT => ex
       puts ex.message
       halt -1
     end
@@ -77,6 +85,20 @@ module SCSSLint
       print output if output
     end
 
+    def print_linters
+      puts 'Installed linters:'
+
+      linter_names = LinterRegistry.linters.map do |linter|
+        linter.name.split('::').last
+      end
+
+      linter_names.sort.each do |linter_name|
+        puts " - #{linter_name}"
+      end
+
+      halt
+    end
+
     def print_help(help_message, err = nil)
       puts err, '' if err
       puts help_message

data/lib/scss_lint/linter.rb

@@ -1,6 +1,6 @@
 module SCSSLint
   class Linter < Sass::Tree::Visitors::Base
-    include LinterRegistry
+    include Utils
 
     attr_reader :engine, :lints
 

data/lib/scss_lint/linter/{border_zero_linter.rb → border_zero.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::BorderZeroLinter < Linter
+  class Linter::BorderZero < Linter
     include LinterRegistry
 
     def visit_prop(node)

data/lib/scss_lint/linter/capitalization_in_selector.rb

@@ -0,0 +1,15 @@
+module SCSSLint
+  class Linter::CapitalizationInSelector < Linter
+    include LinterRegistry
+
+    def visit_rule(node)
+      add_lint(node) if node.rule.first =~ /[A-Z]/
+
+      yield # Continue linting children
+    end
+
+    def description
+      'Selectors should be lowercase'
+    end
+  end
+end

data/lib/scss_lint/linter/{comment_linter.rb → comment.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::CommentLinter < Linter
+  class Linter::Comment < Linter
     include LinterRegistry
 
     def visit_comment(node)

data/lib/scss_lint/linter/{debug_linter.rb → debug_statement.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::DebugLinter < Linter
+  class Linter::DebugStatement < Linter
     include LinterRegistry
 
     def visit_debug(node)

data/lib/scss_lint/linter/{declaration_order_linter.rb → declaration_order.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::DeclarationOrderLinter < Linter
+  class Linter::DeclarationOrder < Linter
     include LinterRegistry
 
     DECLARATION_ORDER = [

data/lib/scss_lint/linter/{declared_name_linter.rb → declared_name.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::DeclaredNameLinter < Linter
+  class Linter::DeclaredName < Linter
     include LinterRegistry
 
     def visit_function(node)
@@ -9,37 +7,30 @@ module SCSSLint
       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)
+    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_script_variable(node)
+    def visit_variable(node)
       check(node)
+      yield # Continue into expression tree for this variable definition
     end
 
     def description
-      'Names of variables, functions, and mixins should be lowercase and not contain underscores. Use hyphens instead.'
+      '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.name =~ /[_A-Z]/
+      add_lint(node) if node_has_bad_name?(node)
     end
   end
 end

data/lib/scss_lint/linter/{empty_rule_linter.rb → empty_rule.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::EmptyRuleLinter < Linter
+  class Linter::EmptyRule < Linter
     include LinterRegistry
 
     def visit_rule(node)

data/lib/scss_lint/linter/{hex_linter.rb → hex_format.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::HexLinter < Linter
+  class Linter::HexFormat < Linter
     include LinterRegistry
 
     def visit_root(node)

data/lib/scss_lint/linter/no_zero_before_decimal.rb

@@ -0,0 +1,22 @@
+module SCSSLint
+  class Linter::NoZeroBeforeDecimal < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      # Misleading, but anything that isn't Sass Script is considered an
+      # `identifier` in the context of a Sass::Script::String.
+      return unless node.value.is_a?(Sass::Script::String) && node.value.type == :identifier
+
+      # Remove string chunks (e.g. `"hello" 3 'world'` -> `3`
+      non_string_values = node.value.value.gsub(/"[^"]*"|'[^']'/, '').split
+
+      non_string_values.each do |value|
+        add_lint(node) if value =~ /\b0\.\d+/
+      end
+    end
+
+    def description
+      'Leading zero should be omitted in fractional values'
+    end
+  end
+end

data/lib/scss_lint/linter/placeholder_in_extend.rb

@@ -0,0 +1,17 @@
+module SCSSLint
+  class Linter::PlaceholderInExtend < Linter
+    include LinterRegistry
+
+    def visit_extend(node)
+      # The array returned by the parser is a bit awkward in that it splits on
+      # every word boundary (so %placeholder becomes ['%', 'placeholder']).
+      selector = node.selector.join
+
+      add_lint(node) unless selector.start_with?('%')
+    end
+
+    def description
+      'Always use placeholder selectors (e.g. %some-placeholder) with @extend'
+    end
+  end
+end

data/lib/scss_lint/linter/{property_format_linter.rb → property_format.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::PropertyFormatLinter < Linter
+  class Linter::PropertyFormat < Linter
     include LinterRegistry
 
     def visit_prop(node)

data/lib/scss_lint/linter/{shorthand_linter.rb → shorthand.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::ShorthandLinter < Linter
+  class Linter::Shorthand < Linter
     include LinterRegistry
 
     def visit_prop(node)

data/lib/scss_lint/linter/{single_line_per_selector_linter.rb → single_line_per_selector.rb}

@@ -1,5 +1,3 @@
-require 'sass'
-
 module SCSSLint
   class Linter::SingleLinePerSelector < Linter
     include LinterRegistry

data/lib/scss_lint/linter/sorted_properties.rb

@@ -0,0 +1,68 @@
+module SCSSLint
+  class Linter::SortedProperties < Linter
+    include LinterRegistry
+
+    def visit_rule(node)
+      # Ignore properties that contain interpolation
+      sortable_props = node.children.select do |child|
+        child.is_a?(Sass::Tree::PropNode) &&
+          child.name.all? { |part| part.is_a?(String) }
+      end
+
+      sortable_prop_names = sortable_props.map { |child| child.name.join }
+
+      sorted_prop_names = sortable_prop_names.map do |name|
+        /^(?<vendor>-\w+-)?(?<property>.+)/ =~ name
+        { name: name, vendor: vendor, property: property }
+      end.sort { |a, b| compare_properties(a, b) }
+         .map { |fields| fields[:name] }
+
+      sorted_prop_names.each_with_index do |name, index|
+        # Report the first property out of order with the sorted list
+        if name != sortable_prop_names[index]
+          add_lint(sortable_props[index])
+          break
+        end
+      end
+
+      yield # Continue linting children
+    end
+
+    def description
+      'Properties should be sorted in alphabetical order, with ' <<
+      'vendor-prefixed extensions before the standardized CSS property'
+    end
+
+  private
+
+    # Compares two properties which can contain a vendor prefix. It allows for a
+    # sort order like:
+    #
+    #   p {
+    #     border: ...
+    #     -moz-border-radius: ...
+    #     -o-border-radius: ...
+    #     -webkit-border-radius: ...
+    #     border-radius: ...
+    #     color: ...
+    #   }
+    #
+    # ...where vendor-prefixed properties come before the standard property, and
+    # are ordered amongst themselves by vendor prefix.
+    def compare_properties(a, b)
+      if a[:property] == b[:property]
+        if a[:vendor] && b[:vendor]
+          a[:vendor] <=> b[:vendor]
+        elsif a[:vendor]
+          -1
+        elsif b[:vendor]
+          1
+        else
+          0
+        end
+      else
+        a[:property] <=> b[:property]
+      end
+    end
+  end
+end

data/lib/scss_lint/linter/space_before_brace.rb

@@ -0,0 +1,17 @@
+module SCSSLint
+  class Linter::SpaceBeforeBrace < Linter
+    include LinterRegistry
+
+    def visit_root(node)
+      engine.lines.each_with_index do |line, index|
+        line.scan /(?<![^ ] )\{$/ do |match|
+          @lints << Lint.new(engine.filename, index + 1, description)
+        end
+      end
+    end
+
+    def description
+      'Opening curly braces ({) must be preceded by one space'
+    end
+  end
+end

data/lib/scss_lint/linter/{type_in_id_selector_linter.rb → type_in_id_selector.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::TypeInIdSelectorLinter < Linter
+  class Linter::TypeInIdSelector < Linter
     include LinterRegistry
 
     def visit_rule(node)

data/lib/scss_lint/linter/usage_name.rb

@@ -0,0 +1,40 @@
+module SCSSLint
+  class Linter::UsageName < Linter
+    include LinterRegistry
+
+    def visit_extend(node)
+      add_lint(node) if selector_has_bad_placeholder?(node.selector)
+    end
+
+    def visit_mixin(node)
+      check(node)
+      yield # Continue into content block of this mixin's block
+    end
+
+    def visit_script_funcall(node)
+      check(node) 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.'
+    end
+
+  private
+
+    FUNCTION_WHITELIST = %w[
+      rotateX rotateY rotateZ
+      scaleX scaleY scaleZ
+      skewX skewY
+      translateX translateY translateZ
+    ].to_set
+
+    def check(node)
+      add_lint(node) if node_has_bad_name?(node)
+    end
+  end
+end

data/lib/scss_lint/linter/{zero_unit_linter.rb → zero_unit.rb}

@@ -1,7 +1,5 @@
-require 'sass'
-
 module SCSSLint
-  class Linter::ZeroUnitLinter < Linter
+  class Linter::ZeroUnit < Linter
     include LinterRegistry
 
     def visit_prop(node)

data/lib/scss_lint/linter_registry.rb

@@ -14,10 +14,9 @@ module SCSSLint
       def extract_linters_from(linter_names)
         linter_names.map do |linter_name|
           begin
-            linter_class = linter_name.split('_').map(&:capitalize).join('')
-            Linter.const_get(linter_class)
+            Linter.const_get(linter_name)
           rescue NameError
-            raise NoSuchLinter.new("Linter #{linter_class} does not exist")
+            raise NoSuchLinter.new("Linter #{linter_name} does not exist")
           end
         end
       end

data/lib/scss_lint/runner.rb

@@ -1,6 +1,3 @@
-require 'scss_lint'
-require 'sass'
-
 module SCSSLint
   class NoFilesError < StandardError; end
   class NoLintersError < StandardError; end
@@ -11,14 +8,15 @@ module SCSSLint
     def initialize(options = {})
       @lints = []
 
-      ignored_linters = LinterRegistry.
-        extract_linters_from(options.fetch(:ignored_linters, []))
+      included_linters = LinterRegistry.
+        extract_linters_from(options.fetch(:included_linters, []))
 
-      @linters = LinterRegistry.linters.reject do |linter|
-        ignored_linters.include?(linter)
-      end.map do |linter_class|
-        linter_class.new
-      end
+      included_linters = LinterRegistry.linters if included_linters.empty?
+
+      excluded_linters = LinterRegistry.
+        extract_linters_from(options.fetch(:excluded_linters, []))
+
+      @linters = (included_linters - excluded_linters).map(&:new)
     end
 
     def run(files = [])

data/lib/scss_lint/utils.rb

@@ -0,0 +1,38 @@
+module SCSSLint
+  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
+    # selectors with the Sass::Script::Nodes removed (i.e., ignoring
+    # interpolation). For example:
+    #
+    # .selector-one, .selector-#{$var}-two
+    #
+    # becomes:
+    #
+    # .selector-one, .selector--two
+    #
+    # This is useful for lints that wish to ignore interpolation, since
+    # interpolation can't be resolved at this step.
+    def extract_string_selectors(selector_array)
+      selector_array.reject { |item| item.is_a? Sass::Script::Node }.
+                     join.
+                     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
+
+  private
+
+    INVALID_NAME_CHARS = '[_A-Z]'
+  end
+end

data/lib/scss_lint/version.rb

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

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.7.1
-  prerelease: 
+  version: 0.9.0
 platform: ruby
 authors:
 - Causes Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-09-03 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
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -46,33 +41,29 @@ dependencies:
 - !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
-    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"
@@ -85,54 +76,60 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/scss_lint/version.rb
+- lib/scss_lint/utils.rb
 - lib/scss_lint/reporter/xml_reporter.rb
 - lib/scss_lint/reporter/default_reporter.rb
 - lib/scss_lint/runner.rb
 - lib/scss_lint/reporter.rb
 - lib/scss_lint/lint.rb
 - lib/scss_lint/linter.rb
-- lib/scss_lint/linter/declaration_order_linter.rb
-- lib/scss_lint/linter/border_zero_linter.rb
-- lib/scss_lint/linter/comment_linter.rb
-- lib/scss_lint/linter/empty_rule_linter.rb
-- lib/scss_lint/linter/debug_linter.rb
-- lib/scss_lint/linter/single_line_per_selector_linter.rb
-- lib/scss_lint/linter/sorted_properties_linter.rb
-- lib/scss_lint/linter/shorthand_linter.rb
-- lib/scss_lint/linter/type_in_id_selector_linter.rb
-- lib/scss_lint/linter/property_format_linter.rb
-- lib/scss_lint/linter/zero_unit_linter.rb
-- lib/scss_lint/linter/declared_name_linter.rb
-- lib/scss_lint/linter/hex_linter.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/declaration_order.rb
+- lib/scss_lint/linter/no_zero_before_decimal.rb
+- lib/scss_lint/linter/zero_unit.rb
+- lib/scss_lint/linter/placeholder_in_extend.rb
+- lib/scss_lint/linter/usage_name.rb
+- 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/comment.rb
+- lib/scss_lint/linter/empty_rule.rb
+- lib/scss_lint/linter/single_line_per_selector.rb
 - 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
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SCSS lint tool
 test_files: []

data/lib/scss_lint/linter/sorted_properties_linter.rb

@@ -1,27 +0,0 @@
-require 'sass'
-
-module SCSSLint
-  class Linter::SortedPropertiesLinter < Linter
-    include LinterRegistry
-
-    def visit_rule(node)
-      properties = node.children.select do |child|
-        child.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
-        add_lint(properties.first)
-      end
-
-      yield # Continue linting children
-    end
-
-    def description
-      'Properties should be sorted in alphabetical order'
-    end
-  end
-end