scss-lint 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63daef837600174964f65634095dac45b13a1bb2
-  data.tar.gz: 8b8e1fdebc6d40d577c02a0092c092212f0d46ee
+  metadata.gz: 67663cf8293192d8f0962e8fe04c86d2b2dafddb
+  data.tar.gz: 92271e0c11e57a9088be1bd94437b7c07c31e205
 SHA512:
-  metadata.gz: 6ed4cbb25cacdfdf0645ea476ccc86032ae8032c22fdb1b3cf8fdd6934601bdc075aa4ed71fa1a05d2dec08785ceb591d53eeb2c6541b5567f434ff4ce161d20
-  data.tar.gz: 07a85bc0d214819857e179babe4b465193adf01391f7eecadd25611264c28605e0990911e1eb6dd75ed79b65b0cb50b6529187513e6842674e5c5abeafeca5f2
+  metadata.gz: 7048b50c46c68b5d7cae9dea14a37791e550a40092b7d3443d266076fb5bfebf1d858b66eb8f6d8c147a75f54deafcbc3d72eb03740ed51f1b79a9406e925217
+  data.tar.gz: e89a5be79049adc3e1aa69e761a961ba711cab010843a54031e7ecdfc546c12c5647ff7b407f875be6577c3d22e817976cdb71fd39f3dc0d7f4bd045e2dfdca1

data/bin/scss-lint

@@ -3,7 +3,4 @@
 require 'scss_lint'
 require 'scss_lint/cli'
 
-SCSSLint::CLI.new(ARGV).tap do |cli|
-  cli.parse_arguments
-  cli.run
-end
+exit SCSSLint::CLI.new.run(ARGV)

data/config/default.yml

@@ -52,7 +52,7 @@ linters:
   HexValidation:
     enabled: true
 
-  IdWithExtraneousSelector:
+  IdSelector:
     enabled: true
 
   ImportPath:
@@ -75,6 +75,7 @@ linters:
 
   NameFormat:
     enabled: true
+    allow_leading_underscore: true
     convention: hyphenated_lowercase # or 'BEM', or a regex pattern
 
   NestingDepth:
@@ -94,9 +95,9 @@ linters:
 
   QualifyingElement:
     enabled: true
-    allow_with_attribute: false
-    allow_with_class: false
-    allow_with_id: false
+    allow_element_with_attribute: false
+    allow_element_with_class: false
+    allow_element_with_id: false
 
   SelectorDepth:
     enabled: true

data/data/property-sort-orders/recess.txt

@@ -0,0 +1,149 @@
+# RECESS Property Order
+# https://github.com/twitter/recess
+
+position
+top
+right
+bottom
+left
+z-index
+display
+float
+width
+height
+max-width
+max-height
+min-width
+min-height
+padding
+padding-top
+padding-right
+padding-bottom
+padding-left
+margin
+margin-top
+margin-right
+margin-bottom
+margin-left
+margin-collapse
+margin-top-collapse
+margin-right-collapse
+margin-bottom-collapse
+margin-left-collapse
+overflow
+overflow-x
+overflow-y
+clip
+clear
+font
+font-family
+font-size
+font-smoothing
+osx-font-smoothing
+font-style
+font-weight
+hyphens
+src
+line-height
+letter-spacing
+word-spacing
+color
+text-align
+text-decoration
+text-indent
+text-overflow
+text-rendering
+text-size-adjust
+text-shadow
+text-transform
+word-break
+word-wrap
+white-space
+vertical-align
+list-style
+list-style-type
+list-style-position
+list-style-image
+pointer-events
+cursor
+background
+background-attachment
+background-color
+background-image
+background-position
+background-repeat
+background-size
+border
+border-collapse
+border-top
+border-right
+border-bottom
+border-left
+border-color
+border-image
+border-top-color
+border-right-color
+border-bottom-color
+border-left-color
+border-spacing
+border-style
+border-top-style
+border-right-style
+border-bottom-style
+border-left-style
+border-width
+border-top-width
+border-right-width
+border-bottom-width
+border-left-width
+border-radius
+border-top-right-radius
+border-bottom-right-radius
+border-bottom-left-radius
+border-top-left-radius
+border-radius-topright
+border-radius-bottomright
+border-radius-bottomleft
+border-radius-topleft
+content
+quotes
+outline
+outline-offset
+opacity
+filter
+visibility
+size
+zoom
+transform
+box-align
+box-flex
+box-orient
+box-pack
+box-shadow
+box-sizing
+table-layout
+animation
+animation-delay
+animation-duration
+animation-iteration-count
+animation-name
+animation-play-state
+animation-timing-function
+animation-fill-mode
+transition
+transition-delay
+transition-duration
+transition-property
+transition-timing-function
+background-clip
+backface-visibility
+resize
+appearance
+user-select
+interpolation-mode
+direction
+marks
+page
+set-link-source
+unicode-bidi
+speak

data/data/property-sort-orders/smacss.txt

@@ -0,0 +1,138 @@
+# SMACSS Property Order
+# http://smacss.com/book/formatting
+
+# Box
+
+display
+position
+top
+right
+bottom
+left
+
+width
+min-width
+max-width
+
+height
+min-height
+max-height
+
+margin
+margin-top
+margin-right
+margin-bottom
+margin-left
+
+padding
+padding-top
+padding-right
+padding-bottom
+padding-left
+
+float
+clear
+
+columns
+column-gap
+column-fill
+column-rule
+column-span
+column-count
+column-width
+
+transform
+transition
+
+# Border
+
+border
+border-top
+border-right
+border-bottom
+border-left
+border-width
+border-top-width
+border-right-width
+border-bottom-width
+border-left-width
+
+border-style
+border-top-style
+border-right-style
+border-bottom-style
+border-left-style
+
+border-radius
+border-top-left-radius
+border-top-right-radius
+border-bottom-left-radius
+border-bottom-right-radius
+
+border-color
+border-top-color
+border-right-color
+border-bottom-color
+border-left-color
+
+outline
+outline-color
+outline-offset
+outline-style
+outline-width
+
+# Background
+
+background
+background-color
+background-image
+background-repeat
+background-position
+background-size
+cursor
+
+# Text
+
+color
+
+font
+font-family
+font-size
+font-smoothing
+font-style
+font-variant
+font-weight
+
+letter-spacing
+line-height
+list-style
+
+text-align
+text-decoration
+text-indent
+text-overflow
+text-rendering
+text-shadow
+text-transform
+text-wrap
+
+white-space
+word-spacing
+
+# Other
+
+border-collapse
+border-spacing
+box-shadow
+caption-side
+content
+cursor
+empty-cells
+opacity
+overflow
+quotes
+speak
+table-layout
+vertical-align
+visibility
+z-index

data/lib/scss_lint.rb

@@ -7,6 +7,7 @@ require 'scss_lint/lint'
 require 'scss_lint/linter_registry'
 require 'scss_lint/runner'
 require 'scss_lint/selector_visitor'
+require 'scss_lint/control_comment_processor'
 require 'scss_lint/version'
 require 'scss_lint/utils'
 

data/lib/scss_lint/cli.rb

@@ -1,7 +1,7 @@
 require 'find'
-require 'optparse'
 require 'rainbow'
 require 'rainbow/ext/string'
+require 'scss_lint/options'
 
 module SCSSLint
   # Responsible for parsing command-line options and executing the appropriate
@@ -20,151 +20,101 @@ module SCSSLint
       config:    78, # Configuration error
     }
 
-    DEFAULT_REPORTER = [SCSSLint::Reporter::DefaultReporter, :stdout]
-
-    # @param args [Array]
-    def initialize(args = [])
-      @args    = args
-      @options = { reporters: [DEFAULT_REPORTER] }
-      @config  = Config.default
-    end
-
-    def parse_arguments
-      begin
-        options_parser.parse!(@args)
-
-        # Take the rest of the arguments as files/directories
-
-        if @args.empty?
-          @options[:files] = @config.scss_files
-        else
-          @options[:files] = @args
-        end
-
-      rescue OptionParser::InvalidOption => ex
-        print_help options_parser.help, ex
-      end
-
-      begin
-        setup_configuration
-      rescue InvalidConfiguration, NoSuchLinter => ex
-        puts ex.message
-        halt :config
-      end
+    def run(args)
+      options = SCSSLint::Options.new.parse(args)
+      act_on_options(options)
+    rescue => ex
+      handle_runtime_exception(ex)
     end
 
-    # @return [OptionParser]
-    def options_parser # rubocop:disable MethodLength
-      @options_parser ||= OptionParser.new do |opts|
-        opts.banner = "Usage: #{opts.program_name} [options] [scss-files]"
-
-        opts.separator ''
-        opts.separator 'Common options:'
-
-        opts.on('-c', '--config file', 'Specify configuration file', String) do |file|
-          @options[:config_file] = file
-        end
-
-        opts.on('-e', '--exclude file,...', Array,
-                'List of file names to exclude') do |files|
-          @options[:excluded_files] = files
-        end
-
-        opts.on('-f', '--format Formatter', 'Specify how to display lints', String) do |format|
-          define_output_format(format)
-        end
-
-        opts.on('-o', '--out path', 'Write output to a file instead of STDOUT', String) do |path|
-          define_output_path(path)
-        end
-
-        opts.on('-r', '--require path', 'Require Ruby file', String) do |path|
-          require path
-        end
-
-        opts.on_tail('--show-formatters', 'Shows available formatters') do
-          print_formatters
-        end
-
-        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[:excluded_linters] = linters
-        end
-
-        opts.on_tail('--show-linters', 'Shows available linters') do
-          print_linters
-        end
+  private
 
-        opts.on_tail('-h', '--help', 'Show this message') do
-          print_help opts.help
-        end
+    def act_on_options(options)
+      load_required_paths(options)
 
-        opts.on_tail('-v', '--version', 'Show version') do
-          print_version opts.program_name, VERSION
-        end
+      if options[:help]
+        print_help(options)
+      elsif options[:version]
+        print_version
+      elsif options[:show_linters]
+        print_linters
+      elsif options[:show_formatters]
+        print_formatters
+      else
+        config = setup_configuration(options)
+        scan_for_lints(options, config)
       end
     end
 
-    def run # rubocop:disable MethodLength
-      runner = Runner.new(@config)
-      runner.run(files_to_lint)
-      report_lints(runner.lints)
+    def scan_for_lints(options, config)
+      runner = Runner.new(config)
+      runner.run(files_to_lint(options, config))
+      report_lints(options, runner.lints)
 
       if runner.lints.any?(&:error?)
         halt :error
       elsif runner.lints.any?
         halt :warning
+      else
+        halt :ok
       end
-    rescue InvalidConfiguration => ex
-      puts ex
-      halt :config
-    rescue NoFilesError, Errno::ENOENT => ex
-      puts ex.message
-      halt :no_input
-    rescue NoSuchLinter => ex
-      puts ex.message
-      halt :usage
-    rescue => ex
-      puts ex.message
-      puts ex.backtrace
-      puts 'Report this bug at '.color(:yellow) + BUG_REPORT_URL.color(:cyan)
-      halt :software
     end
 
-  private
-
-    def setup_configuration
-      if @options[:config_file]
-        @config = Config.load(@options[:config_file])
-        @config.preferred = true
-      end
+    def handle_runtime_exception(exception) # rubocop:disable Metrics/AbcSize
+      case exception
+      when SCSSLint::Exceptions::InvalidCLIOption
+        puts exception.message
+        puts 'Run `scss-lint --help` for usage documentation'
+        halt :usage
+      when SCSSLint::Exceptions::InvalidConfiguration
+        puts exception.message
+        halt :config
+      when NoFilesError, Errno::ENOENT
+        puts exception.message
+        halt :no_input
+      when NoSuchLinter
+        puts exception.message
+        halt :usage
+      else
+        puts exception.message
+        puts exception.backtrace
+        puts 'Report this bug at '.color(:yellow) + BUG_REPORT_URL.color(:cyan)
+        halt :software
+      end
+    end
+
+    def setup_configuration(options)
+      config =
+        if options[:config_file]
+          Config.load(options[:config_file]).tap do |conf|
+            conf.preferred = true
+          end
+        else
+          Config.default
+        end
 
-      merge_command_line_flags_with_config(@config)
+      merge_options_with_config(options, config)
     end
 
+    # @param options [Hash]
     # @param config [Config]
     # @return [Config]
-    def merge_command_line_flags_with_config(config)
-      if @options[:excluded_files]
-        @options[:excluded_files].each do |file|
+    def merge_options_with_config(options, config)
+      if options[:excluded_files]
+        options[:excluded_files].each do |file|
           config.exclude_file(file)
         end
       end
 
-      if @options[:included_linters]
+      if options[:included_linters]
         config.disable_all_linters
-        LinterRegistry.extract_linters_from(@options[:included_linters]).each do |linter|
+        LinterRegistry.extract_linters_from(options[:included_linters]).each do |linter|
           config.enable_linter(linter)
         end
       end
 
-      if @options[:excluded_linters]
-        LinterRegistry.extract_linters_from(@options[:excluded_linters]).each do |linter|
+      if options[:excluded_linters]
+        LinterRegistry.extract_linters_from(options[:excluded_linters]).each do |linter|
           config.disable_linter(linter)
         end
       end
@@ -172,16 +122,20 @@ module SCSSLint
       config
     end
 
-    def files_to_lint
-      extract_files_from(@options[:files]).reject do |file|
-        config =
-          if !@config.preferred && (config_for_file = Config.for_file(file))
-            merge_command_line_flags_with_config(config_for_file.dup)
+    def files_to_lint(options, config)
+      if options[:files].empty?
+        options[:files] = config.scss_files
+      end
+
+      extract_files_from(options[:files]).reject do |file|
+        actual_config =
+          if !config.preferred && (config_for_file = Config.for_file(file))
+            merge_options_with_config(options, config_for_file.dup)
           else
-            @config
+            config
           end
 
-        config.excluded_file?(file)
+        actual_config.excluded_file?(file)
       end
     end
 
@@ -205,32 +159,21 @@ module SCSSLint
       VALID_EXTENSIONS.include?(File.extname(file))
     end
 
+    # @param options [Hash]
     # @param lints [Array<Lint>]
-    def report_lints(lints)
+    def report_lints(options, lints)
       sorted_lints = lints.sort_by { |l| [l.filename, l.location] }
-      @options.fetch(:reporters).each do |reporter, output|
+      options.fetch(:reporters).each do |reporter, output|
         results = reporter.new(sorted_lints).report_lints
         io = (output == :stdout ? $stdout : File.new(output, 'w+'))
         io.print results if results
       end
     end
 
-    # @param format [String]
-    def define_output_format(format)
-      unless @options[:reporters] == [DEFAULT_REPORTER] && format == 'Default'
-        @options[:reporters].reject! { |i| i == DEFAULT_REPORTER }
-        reporter = SCSSLint::Reporter.const_get(format + 'Reporter')
-        @options[:reporters] << [reporter, :stdout]
+    def load_required_paths(options)
+      Array(options[:required_paths]).each do |path|
+        require path
       end
-    rescue NameError
-      puts "Invalid output format specified: #{format}"
-      halt :config
-    end
-
-    # @param path [String]
-    def define_output_path(path)
-      last_reporter, _output = @options[:reporters].pop
-      @options[:reporters] << [last_reporter, path]
     end
 
     def print_formatters
@@ -261,25 +204,22 @@ module SCSSLint
       halt
     end
 
-    # @param help_message [String]
-    # @param err [Exception]
-    def print_help(help_message, err = nil)
-      puts err, '' if err
-      puts help_message
-      halt(err ? :usage : :ok)
+    # @param options [Hash]
+    def print_help(options)
+      puts options[:help]
+      halt :ok
     end
 
-    # @param program_name [String]
-    # @param version [String]
-    def print_version(program_name, version)
-      puts "#{program_name} #{version}"
-      halt
+    # @param options [Hash]
+    def print_version
+      puts "scss-lint #{SCSSLint::VERSION}"
+      halt :ok
     end
 
     # Used for ease-of testing
     # @param exit_status [Symbol]
     def halt(exit_status = :ok)
-      exit(EXIT_CODES[exit_status])
+      EXIT_CODES[exit_status]
     end
   end
 end