scss_lint 0.43.2 → 0.44.0

data/lib/scss_lint/linter/space_before_brace.rb

@@ -14,14 +14,14 @@ module SCSSLint
       yield
     end
 
-    alias_method :visit_function, :check_node
-    alias_method :visit_each, :check_node
-    alias_method :visit_for, :check_node
-    alias_method :visit_function, :check_node
-    alias_method :visit_mixindef, :check_node
-    alias_method :visit_mixin, :check_node
-    alias_method :visit_rule, :check_node
-    alias_method :visit_while, :check_node
+    alias visit_function check_node
+    alias visit_each check_node
+    alias visit_for check_node
+    alias visit_function check_node
+    alias visit_mixindef check_node
+    alias visit_mixin check_node
+    alias visit_rule check_node
+    alias visit_while check_node
 
   private
 

data/lib/scss_lint/linter/space_between_parens.rb

@@ -10,13 +10,13 @@ module SCSSLint
       yield
     end
 
-    alias_method :visit_atroot,           :check_node
-    alias_method :visit_cssimport,        :check_node
-    alias_method :visit_function,         :check_node
-    alias_method :visit_media,            :check_node
-    alias_method :visit_mixindef,         :check_node
-    alias_method :visit_mixin,            :check_node
-    alias_method :visit_script_funcall,   :check_node
+    alias visit_atroot check_node
+    alias visit_cssimport check_node
+    alias visit_function check_node
+    alias visit_media check_node
+    alias visit_mixindef check_node
+    alias visit_mixin check_node
+    alias visit_script_funcall check_node
 
     def feel_for_parens_and_check_node(node)
       source = feel_for_enclosing_parens(node)
@@ -24,10 +24,10 @@ module SCSSLint
       yield
     end
 
-    alias_method :visit_script_listliteral,  :feel_for_parens_and_check_node
-    alias_method :visit_script_mapliteral,  :feel_for_parens_and_check_node
-    alias_method :visit_script_operation,   :feel_for_parens_and_check_node
-    alias_method :visit_script_string,      :feel_for_parens_and_check_node
+    alias visit_script_listliteral feel_for_parens_and_check_node
+    alias visit_script_mapliteral feel_for_parens_and_check_node
+    alias visit_script_operation feel_for_parens_and_check_node
+    alias visit_script_string feel_for_parens_and_check_node
 
   private
 

data/lib/scss_lint/linter/string_quotes.rb

@@ -12,8 +12,9 @@ module SCSSLint
       #
       # Thus we manually skip the substrings in the string interpolation and
       # visit the expressions in the interpolation itself.
-      node.children.reject { |child| child.is_a?(Sass::Script::Tree::Literal) }
-                   .each { |child| visit(child) }
+      node.children
+          .reject { |child| child.is_a?(Sass::Script::Tree::Literal) }
+          .each { |child| visit(child) }
     end
 
     def visit_script_string(node)
@@ -27,7 +28,7 @@ module SCSSLint
 
     def visit_charset(node)
       # `@charset` source range includes entire declaration, so exclude that prefix
-      source = source_from_range(node.source_range)[(CHARSET_DIRECTIVE_LENGTH)..-1]
+      source = source_from_range(node.source_range)[CHARSET_DIRECTIVE_LENGTH..-1]
 
       check_quotes(node, source)
     end
@@ -63,11 +64,9 @@ module SCSSLint
     def check_double_quotes(node, string)
       if config['style'] == 'single_quotes'
         add_lint(node, 'Prefer single quoted strings') if string !~ /'/
-      else
-        if string =~ /(?<! \\) \\"/x && string !~ /'/
-          add_lint(node, 'Use single-quoted strings when writing double ' \
-                         'quotes to avoid having to escape the double quotes')
-        end
+      elsif string =~ /(?<! \\) \\"/x && string !~ /'/
+        add_lint(node, 'Use single-quoted strings when writing double ' \
+                       'quotes to avoid having to escape the double quotes')
       end
     end
 
@@ -79,8 +78,8 @@ module SCSSLint
         elsif string =~ /(?<! \\) \\"/x
           add_lint(node, "Don't escape double quotes in single-quoted strings")
         end
-      else
-        add_lint(node, 'Prefer double-quoted strings') if string !~ /"/
+      elsif string !~ /"/
+        add_lint(node, 'Prefer double-quoted strings')
       end
     end
   end

data/lib/scss_lint/linter/trailing_zero.rb

@@ -15,7 +15,7 @@ module SCSSLint
 
     def visit_script_number(node)
       return unless number =
-        source_from_range(node.source_range)[FRACTIONAL_DIGIT_REGEX, 1]
+                      source_from_range(node.source_range)[FRACTIONAL_DIGIT_REGEX, 1]
 
       check_for_trailing_zeros(node, number)
     end

data/lib/scss_lint/linter/transition_all.rb

@@ -6,7 +6,7 @@ module SCSSLint
     TRANSITION_PROPERTIES = %w[
       transition
       transition-property
-    ]
+    ].freeze
 
     def visit_prop(node)
       property = node.name.first.to_s

data/lib/scss_lint/linter/unnecessary_mantissa.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SCSSLint
   # Checks for the unnecessary inclusion of a zero-value mantissa in numbers.
   # (e.g. `4.0` could be written as just `4`)
@@ -34,7 +36,7 @@ module SCSSLint
       )\b
     /ix
 
-    MESSAGE_FORMAT = '`%s` should be written without the mantissa as `%s%s`'
+    MESSAGE_FORMAT = '`%s` should be written without the mantissa as `%s%s`'.freeze
 
     def unnecessary_mantissa?(mantissa)
       mantissa !~ /[^0]/

data/lib/scss_lint/linter/unnecessary_parent_reference.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SCSSLint
   # Checks for unnecessary uses of the parent reference (&) in nested selectors.
   class Linter::UnnecessaryParentReference < Linter
     include LinterRegistry
 
-    MESSAGE = 'Unnecessary parent selector (&)'
+    MESSAGE = 'Unnecessary parent selector (&)'.freeze
 
     def visit_comma_sequence(comma_sequence)
       @multiple_sequences = comma_sequence.members.size > 1
@@ -22,7 +24,7 @@ module SCSSLint
       # element {
       #   & + & { ... }
       # }
-      return if sequence.members[1..-1].any? { |ss| sequence_starts_with_parent?(ss) }
+      return if sequence.members[1..-1].any? { |ss| sequence_contains_parent_reference?(ss) }
 
       # Special case: allow an isolated parent to appear if it is part of a
       # comma sequence of more than one sequence, as this could be used to DRY
@@ -45,5 +47,10 @@ module SCSSLint
       first.is_a?(Sass::Selector::Parent) &&
         first.suffix.nil? # Ignore concatenated selectors, like `&-something`
     end
+
+    def sequence_contains_parent_reference?(simple_sequence)
+      return unless simple_sequence.is_a?(Sass::Selector::SimpleSequence)
+      simple_sequence.members.any? { |s| s.is_a?(Sass::Selector::Parent) }
+    end
   end
 end

data/lib/scss_lint/linter/url_quotes.rb

@@ -8,8 +8,10 @@ module SCSSLint
       when Sass::Script::Tree::Literal
         check(node, node.value.value.to_s)
       when Sass::Script::Tree::ListLiteral
-        node.value.children.select { |child| child.is_a?(Sass::Script::Tree::Literal) }
-                           .each { |child| check(node, child.value.to_s) }
+        node.value
+            .children
+            .select { |child| child.is_a?(Sass::Script::Tree::Literal) }
+            .each { |child| check(node, child.value.to_s) }
       end
 
       yield

data/lib/scss_lint/linter/variable_for_property.rb

@@ -3,7 +3,7 @@ module SCSSLint
   class Linter::VariableForProperty < Linter
     include LinterRegistry
 
-    IGNORED_VALUES = %w[currentColor inherit transparent]
+    IGNORED_VALUES = %w[currentColor inherit initial transparent].freeze
 
     def visit_root(_node)
       @properties = Set.new(config['properties'])

data/lib/scss_lint/linter/vendor_prefix.rb

@@ -20,9 +20,9 @@ module SCSSLint
       check_identifier(node, source_from_range(node.value.source_range))
     end
 
-    alias_method :visit_prop, :check_node
-    alias_method :visit_pseudo, :check_node
-    alias_method :visit_directive, :check_node
+    alias visit_prop check_node
+    alias visit_pseudo check_node
+    alias visit_directive check_node
 
   private
 

data/lib/scss_lint/linter/zero_unit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SCSSLint
   # Checks for unnecessary units on zero values.
   class Linter::ZeroUnit < Linter
@@ -28,7 +30,7 @@ module SCSSLint
       \b
     /ix
 
-    MESSAGE_FORMAT = '`%s` should be written without units as `0`'
+    MESSAGE_FORMAT = '`%s` should be written without units as `0`'.freeze
 
     LENGTH_UNITS = %w[em ex ch rem vw vh vmin vmax cm mm in pt pc px].to_set
 

data/lib/scss_lint/location.rb

@@ -24,7 +24,7 @@ module SCSSLint
       end
     end
 
-    alias_method :eql?, :==
+    alias eql? ==
 
     def <=>(other)
       [:line, :column, :length].each do |attr|

data/lib/scss_lint/logger.rb

@@ -0,0 +1,149 @@
+module SCSSLint
+  # Encapsulates all communication to an output source.
+  class Logger
+    # Whether colored output via ANSI escape sequences is enabled.
+    # @return [true,false]
+    attr_accessor :color_enabled
+
+    # Creates a logger which outputs nothing.
+    # @return [SCSSLint::Logger]
+    def self.silent
+      new(File.open('/dev/null', 'w'))
+    end
+
+    # Creates a new {SCSSLint::Logger} instance.
+    #
+    # @param out [IO] the output destination.
+    def initialize(out)
+      @out = out
+    end
+
+    # Print the specified output.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def log(output, newline = true)
+      @out.print(output)
+      @out.print("\n") if newline
+    end
+
+    # Print the specified output in a color indicative of error.
+    # If output destination is not a TTY, behaves the same as {#log}.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def error(output, newline = true)
+      log(red(output), newline)
+    end
+
+    # Print the specified output in a bold face and color indicative of error.
+    # If output destination is not a TTY, behaves the same as {#log}.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def bold_error(output, newline = true)
+      log(bold_red(output), newline)
+    end
+
+    # Print the specified output in a color indicative of success.
+    # If output destination is not a TTY, behaves the same as {#log}.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def success(output, newline = true)
+      log(green(output), newline)
+    end
+
+    # Print the specified output in a color indicative of a warning.
+    # If output destination is not a TTY, behaves the same as {#log}.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def warning(output, newline = true)
+      log(yellow(output), newline)
+    end
+
+    # Print the specified output in a color indicating information.
+    # If output destination is not a TTY, behaves the same as {#log}.
+    #
+    # @param output [String] the output to send
+    # @param newline [true,false] whether to append a newline
+    def info(output, newline = true)
+      log(cyan(output), newline)
+    end
+
+    # Print a blank line.
+    def newline
+      log('')
+    end
+
+    # Mark the specified output in bold face.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def bold(output)
+      color('1', output)
+    end
+
+    # Mark the specified output in bold red.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def bold_red(output)
+      color('1;31', output)
+    end
+
+    # Mark the specified output in red.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def red(output)
+      color(31, output)
+    end
+
+    # Mark the specified output in green.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def green(output)
+      color(32, output)
+    end
+
+    # Mark the specified output in yellow.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def yellow(output)
+      color(33, output)
+    end
+
+    # Mark the specified output in magenta.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def magenta(output)
+      color(35, output)
+    end
+
+    # Mark the specified output in cyan.
+    # If output destination is not a TTY, this is a noop.
+    #
+    # @param output [String] the output to format
+    def cyan(output)
+      color(36, output)
+    end
+
+    # Whether this logger is outputting to a TTY.
+    #
+    # @return [true,false]
+    def tty?
+      @out.respond_to?(:tty?) && @out.tty?
+    end
+
+  private
+
+    def color(code, output)
+      color_enabled ? "\033[#{code}m#{output}\033[0m" : output
+    end
+  end
+end

data/lib/scss_lint/options.rb

@@ -3,7 +3,7 @@ require 'optparse'
 module SCSSLint
   # Handles option parsing for the command line application.
   class Options
-    DEFAULT_REPORTER = ['Default', :stdout]
+    DEFAULT_REPORTER = ['Default', :stdout].freeze
 
     # Parses command line options into an options hash.
     #
@@ -102,6 +102,10 @@ module SCSSLint
         @options[:show_linters] = true
       end
 
+      parser.on('--[no-]color', 'Force output to be colorized') do |color|
+        @options[:color] = color
+      end
+
       parser.on_tail('-h', '--help', 'Display help documentation') do
         @options[:help] = parser.help
       end

data/lib/scss_lint/rake_task.rb

@@ -42,6 +42,11 @@ module SCSSLint
     # @return [Array<String>]
     attr_accessor :files
 
+    # Whether output from SCSS-lint should not be displayed to the standard out
+    # stream.
+    # @return [true,false]
+    attr_accessor :quiet
+
     # Create the task so it is accessible via +Rake::Task['scss_lint']+.
     def initialize(name = :scss_lint)
       @name = name
@@ -68,10 +73,12 @@ module SCSSLint
       end
     end
 
-    def run_cli(task_args)
+    def run_cli(task_args) # rubocop:disable AbcSize
       cli_args = ['--config', config] if config
 
-      result = SCSSLint::CLI.new.run(Array(cli_args) + Array(args) + files_to_lint(task_args))
+      logger = quiet ? SCSSLint::Logger.silent : SCSSLint::Logger.new(STDOUT)
+      run_args = Array(cli_args) + Array(args) + files_to_lint(task_args)
+      result = SCSSLint::CLI.new(logger).run(run_args)
 
       message =
         case result
@@ -83,7 +90,7 @@ module SCSSLint
           'scss-lint failed with an error'
         end
 
-      puts message
+      logger.log message
       exit result unless result == 0
     end
 

data/lib/scss_lint/reporter.rb

@@ -1,7 +1,7 @@
 module SCSSLint
   # Responsible for displaying lints to the user in some format.
   class Reporter
-    attr_reader :lints, :files
+    attr_reader :lints, :files, :log
 
     def self.descendants
       ObjectSpace.each_object(Class).select { |klass| klass < self }
@@ -9,9 +9,11 @@ module SCSSLint
 
     # @param lints [List<Lint>] a list of Lints sorted by file and line number
     # @param files [List<String>] a list of the files that were linted
-    def initialize(lints, files)
+    # @param logger [SCSSLint::Logger]
+    def initialize(lints, files, logger)
       @lints = lints
       @files = files
+      @log = logger
     end
 
     def report_lints