scss-lint 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851fc6dcdb6402f514538367d2a2e10afa223a23
-  data.tar.gz: f9c630b4c98aaf277a4277abb003144ba65e5bd8
+  metadata.gz: 9afb9a82ced2ebf876f8b1a56d829d1360c806fb
+  data.tar.gz: fc5bdfbcb4565f704792b0e5f0ccad90230476bd
 SHA512:
-  metadata.gz: 9016d101642210006cda461af3c990c6c0bb04e254ff49dd50e19ee3a04dbc87db450b8d687ae47972015bdc564cb3d2bd93aea9131065a79665777e016eff45
-  data.tar.gz: 3c9cffd85b8d147e1bcf4c7617a2cda7ea8cf81e50ff33a059b1ad0ca0634835c200802ade936fefdf6c89a283d37bc35fa41a719078fdbba4cb4147dbf15e13
+  metadata.gz: 64348900df0980e60f076434c46e0475924086124b1b8e5960c4e67d9c64b87519e2cd343a90643b424a57630c9cde537fd9ef7d8c23f3a580bc7245237030cc
+  data.tar.gz: 32a3dcb769845f9dba7ad7d07187c754d20ba4156c3c41eb06a59ef0193fe2d9df7ed9dbb19550b26ddb73bde87ef8f0b0afc3f0afcca94aec86406e0ac8d0a4

data/config/default.yml

@@ -39,9 +39,11 @@ linters:
 
   LeadingZero:
     enabled: true
+    style: exclude_zero # or 'include_zero'
 
   NameFormat:
     enabled: true
+    convention: hyphenated_lowercase # or 'BEM', or a regex pattern
 
   PlaceholderInExtend:
     enabled: true

data/lib/scss_lint/linter/color_keyword.rb

@@ -5,7 +5,9 @@ module SCSSLint
     include LinterRegistry
 
     def visit_script_color(node)
-      add_color_lint(node, node.original_string) if color_keyword?(node.original_string)
+      color = source_from_range(node.source_range)[COLOR_REGEX, 1]
+
+      add_color_lint(node, color) if color_keyword?(color)
     end
 
     def visit_script_string(node)
@@ -18,6 +20,8 @@ module SCSSLint
 
   private
 
+    COLOR_REGEX = /(#?[a-f0-9]{3,6}|[a-z]+)/i
+
     def add_color_lint(node, original)
       hex_form = Sass::Script::Value::Color.new(color_rgb(original)).tap do |color|
         color.options = {} # `inspect` requires options to be set

data/lib/scss_lint/linter/hex_format.rb

@@ -4,10 +4,10 @@ module SCSSLint
     include LinterRegistry
 
     def visit_script_color(node)
-      return unless node.original_string && node.original_string.match(HEX_REGEX)
+      return unless color = source_from_range(node.source_range)[HEX_REGEX, 1]
 
-      unless valid_hex_format?(node.original_string[HEX_REGEX, 1])
-        add_hex_lint(node, node.original_string)
+      unless valid_hex_format?(color)
+        add_hex_lint(node, color)
       end
     end
 

data/lib/scss_lint/linter/leading_zero.rb

@@ -9,25 +9,44 @@ module SCSSLint
       non_string_values = remove_quoted_strings(node.value).split
 
       non_string_values.each do |value|
-        if number = value[/\b(0\.\d+)/, 1]
-          add_leading_zero_lint(node, number)
+        if number = value[FRACTIONAL_DIGIT_REGEX, 1]
+          check_number(node, number)
         end
       end
     end
 
     def visit_script_number(node)
-      if node.original_string =~ /^0\./
-        add_leading_zero_lint(node, node.original_string)
-      end
+      return unless number = source_from_range(node.source_range)[FRACTIONAL_DIGIT_REGEX, 1]
+
+      check_number(node, number)
     end
 
   private
 
-    def add_leading_zero_lint(node, number)
-      trimmed_number = number[/^[^\.]+(.*)$/, 1]
+    FRACTIONAL_DIGIT_REGEX = /^-?(0?\.\d+)/
+
+    CONVENTIONS = {
+      'exclude_zero' => {
+        explanation: '`%s` should be written without a leading zero as `%s`',
+        validator: ->(original) { original =~ /^\.\d+$/ },
+        converter: ->(original) { original[1..-1] },
+      },
+      'include_zero' => {
+        explanation: '`%s` should be written with a leading zero as `%s`',
+        validator: ->(original) { original =~ /^0\.\d+$/ },
+        converter: ->(original) { "0#{original}" }
+      },
+    }
 
-      add_lint(node, "`#{number}` should be written without a leading zero " <<
-                     "as `#{trimmed_number}`")
+    def check_number(node, original_number)
+      style = config.fetch('style', 'exclude_zero')
+      convention = CONVENTIONS[style]
+
+      unless convention[:validator].call(original_number)
+        corrected = convention[:converter].call(original_number)
+
+        add_lint(node, convention[:explanation] % [original_number, corrected])
+      end
     end
   end
 end

data/lib/scss_lint/linter/name_format.rb

@@ -5,36 +5,34 @@ module SCSSLint
     include LinterRegistry
 
     def visit_extend(node)
-      if selector_has_bad_placeholder?(node.selector)
-        add_name_lint(node, node.selector.join, 'placeholder')
-      end
+      check_placeholder(node)
     end
 
     def visit_function(node)
-      check_declared_name(node, 'function')
+      check_name(node, 'function')
       yield # Continue into content block of this function definition
     end
 
     def visit_mixin(node)
-      check_name_use(node, 'mixin')
+      check_name(node, 'mixin')
       yield # Continue into content block of this mixin's block
     end
 
     def visit_mixindef(node)
-      check_declared_name(node, 'mixin')
+      check_name(node, 'mixin')
       yield # Continue into content block of this mixin definition
     end
 
     def visit_script_funcall(node)
-      check_name_use(node, 'function') unless FUNCTION_WHITELIST.include?(node.name)
+      check_name(node, 'function') unless FUNCTION_WHITELIST.include?(node.name)
     end
 
     def visit_script_variable(node)
-      check_name_use(node, 'variable')
+      check_name(node, 'variable')
     end
 
     def visit_variable(node)
-      check_declared_name(node, 'variable')
+      check_name(node, 'variable')
       yield # Continue into expression tree for this variable definition
     end
 
@@ -47,32 +45,40 @@ module SCSSLint
       translateX translateY translateZ
     ].to_set
 
-    def check_declared_name(node, node_type)
-      if node_has_bad_name?(node)
-        fixed_name = node.name.downcase.gsub(/_/, '-')
-
-        add_lint(node, "Name of #{node_type} `#{node.name}` should " <<
-                       "be written in lowercase as `#{fixed_name}`")
+    def check_name(node, node_type, node_text = node.name)
+      if convention = violated_convention(node_text)
+        add_lint(node, "Name of #{node_type} `#{node_text}` should be " <<
+                       "written #{convention[:explanation]}")
       end
     end
 
-    def check_name_use(node, node_type)
-      add_name_lint(node, node.name, node_type) if node_has_bad_name?(node)
+    def check_placeholder(node)
+      extract_string_selectors(node.selector).any? do |selector_str|
+        check_name(node, 'placeholder', selector_str.gsub('%', ''))
+      end
     end
 
-    def add_name_lint(node, name, node_type)
-      fixed_name = name.downcase.gsub(/_/, '-')
+    CONVENTIONS = {
+      'hyphenated_lowercase' => {
+        explanation: 'in lowercase with hyphens instead of underscores',
+        validator: ->(name) { name !~ /[_A-Z]/ },
+      },
+      'BEM' => {
+        explanation: 'in BEM (Block Element Modifier) format',
+        validator: ->(name) { name !~ /[A-Z]|-{3}|_{3}|[^_]_[^_]/ },
+      },
+    }
 
-      add_lint(node, "All uses of #{node_type} `#{name}` should be written " <<
-                     "in lowercase as `#{fixed_name}`")
-    end
+    # Checks the given name and returns the violated convention if it failed.
+    def violated_convention(name_string)
+      convention_name = config['convention'] || 'hyphenated_lowercase'
 
-    # 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
+      convention = CONVENTIONS[convention_name] || {
+        explanation: "must match regex /#{convention_name}/",
+        validator: ->(name) { name =~ /#{convention_name}/ }
+      }
+
+      convention unless convention[:validator].call(name_string)
     end
   end
 end

data/lib/scss_lint/linter/space_between_parens.rb

@@ -5,8 +5,9 @@ module SCSSLint
 
     def visit_root(node)
       @spaces = config['spaces']
+
       engine.lines.each_with_index do |line, index|
-        line.scan(/
+        line.gsub(%r{((//|/\*).*$)}, '').scan(/
           (^(\t|\s)*\))?  # Capture leading spaces and tabs followed by a `)`
           (
             \([ ]*(?!$)   # Find `( ` as long as its not EOL )

data/lib/scss_lint/linter/zero_unit.rb

@@ -4,19 +4,23 @@ module SCSSLint
     include LinterRegistry
 
     def visit_script_string(node)
-      node.value.scan(/\b(0[a-z]+)\b/i) do |match|
+      node.value.scan(ZERO_UNIT_REGEX) do |match|
         add_lint(node, MESSAGE_FORMAT % match.first)
       end
     end
 
     def visit_script_number(node)
-      if node.value == 0 && zero_with_units?(source_from_range(node.source_range))
-        add_lint(node, MESSAGE_FORMAT % node.original_string)
+      length = source_from_range(node.source_range)[ZERO_UNIT_REGEX, 1]
+
+      if node.value == 0 && zero_with_units?(length)
+        add_lint(node, MESSAGE_FORMAT % length)
       end
     end
 
   private
 
+    ZERO_UNIT_REGEX = /\b(0[a-z]+)\b/i
+
     MESSAGE_FORMAT = '`%s` should be written without units as `0`'
 
     def zero_with_units?(string)

data/lib/scss_lint/rake_task.rb

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/tasklib'
+
+module SCSSLint
+  # Provide task for invoking scss-lint via Rake.
+  #
+  # @example
+  #   require 'scss_lint/rake_task'
+  #   SCSSLint::RakeTask.new
+  class RakeTask < Rake::TaskLib
+    # The name of the task (default 'scss-lint')
+    attr_accessor :name
+
+    def initialize(*args, &task_block)
+      @name = args.shift || :scss_lint
+
+      desc 'Run scss-lint' unless ::Rake.application.last_comment
+
+      task(name, *args) do |_, task_args|
+        if task_block
+          task_block.call(*[self, task_args].slice(0, task_block.arity))
+        end
+        run_task
+      end
+    end
+
+    def run_task
+      # Lazy load so task doesn't impact load time of Rakefile
+      require 'scss_lint'
+
+      CLI.new([]).tap do |cli|
+        cli.parse_arguments
+        cli.run
+      end
+    rescue SystemExit => ex
+      if ex.status == CLI::EXIT_CODES[:data]
+        abort('scss-lint found lints')
+      elsif ex.status != 0
+        abort('scss-lint failed with an error')
+      end
+    end
+  end
+end

data/lib/scss_lint/sass/script.rb

@@ -2,47 +2,6 @@
 # rubocop:disable Documentation
 
 module Sass::Script
-  # Redefine some of the lexer helpers in order to store the original string
-  # with the created object so that the original string can be inspected rather
-  # than a typically normalized version.
-  class Lexer
-    def color
-      return unless color_string = scan(REGULAR_EXPRESSIONS[:color])
-
-      unless [4, 7].include?(color_string.length)
-        raise ::Sass::SyntaxError,
-              "Colors must have either three or six digits: '#{color_string}'"
-      end
-
-      [:color, Value::Color.from_string(color_string)]
-    end
-
-    def number
-      return unless scan(REGULAR_EXPRESSIONS[:number])
-      value = @scanner[2] ? @scanner[2].to_f : @scanner[3].to_i
-      value = -value if @scanner[1]
-
-      number = Value::Number.new(value, Array(@scanner[4])).tap do |num|
-        num.original_string = @scanner[0]
-      end
-      [:number, number]
-    end
-  end
-
-  class Parser
-    # We redefine the ident parser to specially handle color keywords.
-    def ident
-      return funcall unless @lexer.peek && @lexer.peek.type == :ident
-      return if @stop_at && @stop_at.include?(@lexer.peek.value)
-
-      name = @lexer.next
-      if (color = Value::Color::COLOR_NAMES[name.value.downcase])
-        return literal_node(Value::Color.from_string(name.value, color), name.source_range)
-      end
-      literal_node(Value::String.new(name.value, :identifier), name.source_range)
-    end
-  end
-
   # Since the Sass library is already loaded at this point.
   # Define the `node_name` and `visit_method` class methods for each Sass Script
   # parse tree node type so that our custom visitor can seamless traverse the
@@ -91,30 +50,6 @@ module Sass::Script
     end
   end
 
-  # When linting colors, it's convenient to be able to inspect the original
-  # color string. This adds an attribute to the Color to keep track of the
-  # original string and provides a method which the modified lexer can use to
-  # set it.
-  class Value::Color
-    attr_accessor :original_string
-
-    def self.from_string(string, rgb = nil)
-      unless rgb
-        rgb = string.scan(/^#(..?)(..?)(..?)$/).
-                     first.
-                     map { |hex| hex.ljust(2, hex).to_i(16) }
-      end
-
-      color = new(rgb, false)
-      color.original_string = string
-      color
-    end
-  end
-
-  class Value::Number
-    attr_accessor :original_string
-  end
-
   # Contains extensions of Sass::Script::Tree::Nodes to add support for
   # accessing various parts of the parse tree not provided out-of-the-box.
   module Tree

data/lib/scss_lint/utils.rb

@@ -20,10 +20,6 @@ module SCSSLint
                      split
     end
 
-    def node_has_bad_name?(node)
-      node.name =~ /#{INVALID_NAME_CHARS}/
-    end
-
     def shortest_hex_form(hex)
       (can_be_condensed?(hex) ? (hex[0..1] + hex[3] + hex[5]) : hex).downcase
     end
@@ -59,9 +55,5 @@ module SCSSLint
     def pluralize(value, word)
       value == 1 ? "#{value} #{word}" : "#{value} #{word}s"
     end
-
-  private
-
-    INVALID_NAME_CHARS = '[_A-Z]'
   end
 end

data/lib/scss_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SCSSLint
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -88,6 +88,7 @@ files:
 - lib/scss_lint/reporter.rb
 - lib/scss_lint/lint.rb
 - lib/scss_lint/linter.rb
+- lib/scss_lint/rake_task.rb
 - lib/scss_lint/selector_visitor.rb
 - lib/scss_lint/sass/tree.rb
 - lib/scss_lint/sass/script.rb