scss-lint 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe908b2051342dce6151d04897242d18a3f9bf0b
-  data.tar.gz: 785752360ba0475386ecc1c8f8d202268293f428
+  metadata.gz: 63daef837600174964f65634095dac45b13a1bb2
+  data.tar.gz: 8b8e1fdebc6d40d577c02a0092c092212f0d46ee
 SHA512:
-  metadata.gz: cd5a9205186a67350c31d52d0cbd8677510fa5ae270ca0b25fc99dd87768c8b02393ebbbf2d068cc66f19ddf89ff7fb19b467d74a99ea3702fe7ff134352ef0a
-  data.tar.gz: 8063dfc1815c2d3b4a3edb76540635282484e0e56a1ce7b71bf2a60ec493ad5b3948b17b4fae56db6e1df226aa6704802946530aaf6304bd3a5952875b6d1409
+  metadata.gz: 6ed4cbb25cacdfdf0645ea476ccc86032ae8032c22fdb1b3cf8fdd6934601bdc075aa4ed71fa1a05d2dec08785ceb591d53eeb2c6541b5567f434ff4ce161d20
+  data.tar.gz: 07a85bc0d214819857e179babe4b465193adf01391f7eecadd25611264c28605e0990911e1eb6dd75ed79b65b0cb50b6529187513e6842674e5c5abeafeca5f2

data/config/default.yml

@@ -1,5 +1,13 @@
 # Default application configuration that all configurations inherit from.
+
+scss_files: "**/*.scss"
+
 linters:
+  BangFormat:
+    enabled: true
+    space_before_bang: true
+    space_after_bang: false
+
   BorderZero:
     enabled: true
 
@@ -47,6 +55,11 @@ linters:
   IdWithExtraneousSelector:
     enabled: true
 
+  ImportPath:
+    enabled: true
+    leading_underscore: false
+    filename_extension: false
+
   Indentation:
     enabled: true
     character: space # or 'tab'
@@ -64,6 +77,10 @@ linters:
     enabled: true
     convention: hyphenated_lowercase # or 'BEM', or a regex pattern
 
+  NestingDepth:
+    enabled: true
+    max_depth: 3
+
   PlaceholderInExtend:
     enabled: true
 
@@ -75,13 +92,19 @@ linters:
     enabled: true
     extra_properties: []
 
+  QualifyingElement:
+    enabled: true
+    allow_with_attribute: false
+    allow_with_class: false
+    allow_with_id: false
+
   SelectorDepth:
     enabled: true
     max_depth: 3
 
   SelectorFormat:
     enabled: true
-    convention: hyphenated_lowercase # or 'snake_case', or 'camel_case', or a regex pattern
+    convention: hyphenated_lowercase # or 'BEM', or 'snake_case', or 'camel_case', or a regex pattern
 
   Shorthand:
     enabled: true
@@ -105,6 +128,7 @@ linters:
 
   SpaceBeforeBrace:
     enabled: true
+    style: space
     allow_single_line_padding: false
 
   SpaceBetweenParens:
@@ -133,6 +157,12 @@ linters:
   UrlQuotes:
     enabled: true
 
+  VendorPrefixes:
+    enabled: true
+    identifier_list: base
+    include: []
+    exclude: []
+
   ZeroUnit:
     enabled: true
 

data/data/prefixed-identifiers/base.txt

@@ -0,0 +1,107 @@
+# Based on Autoprefixer --info
+
+# At-Rules
+keyframes
+
+# Selectors
+selection
+placeholder
+fullscreen
+
+# Properties
+transition
+transition-property
+border-radius
+border-top-left-radius
+border-top-right-radius
+border-bottom-right-radius
+border-bottom-left-radius
+box-shadow
+animation
+animation-name
+animation-duration
+animation-delay
+animation-direction
+animation-fill-mode
+animation-iteration-count
+animation-play-state
+animation-timing-function
+transition-duration
+transition-delay
+transition-timing-function
+transform
+transform-origin
+perspective
+perspective-origin
+transform-style
+backface-visibility
+border-image
+box-sizing
+filter
+columns
+column-width
+column-gap
+column-rule
+column-rule-color
+column-rule-width
+column-count
+column-rule-style
+column-span
+column-fill
+break-before
+break-after
+break-inside
+user-select
+flex
+flex-grow
+flex-shrink
+flex-basis
+flex-direction
+flex-wrap
+flex-flow
+justify-content
+order
+align-items
+align-self
+align-content
+background-clip
+background-origin
+background-size
+font-feature-settings
+font-variant-ligatures
+font-language-override
+font-kerning
+hyphens
+tab-size
+touch-action
+text-decoration-style
+text-decoration-line
+text-decoration-color
+text-size-adjust
+clip-path
+mask
+mask-clip
+mask-composite
+mask-image
+mask-origin
+mask-position
+mask-repeat
+mask-size
+
+# Values
+linear-gradient
+repeating-linear-gradient
+radial-gradient
+repeating-radial-gradient
+flex
+inline-flex
+calc
+max-content
+min-content
+fit-content
+fill-available
+zoom-in
+zoom-out
+grab
+grabbing
+sticky

data/data/prefixed-identifiers/bourbon.txt

@@ -0,0 +1,71 @@
+# Identifiers covered by Bourbon mixins
+
+# At-Rules
+keyframes
+
+# Selectors
+placeholder
+
+# Properties
+animation
+animation-delay
+animation-direction
+animation-duration
+animation-fill-mode
+animation-iteration-count
+animation-name
+animation-play-state
+animation-timing-function
+appearance
+backface-visibility
+background
+border-image
+border-top-left-radius
+border-top-right-radius
+border-bottom-right-radius
+border-bottom-left-radius
+box-sizing
+calc
+columns
+column-width
+column-gap
+column-rule
+column-rule-color
+column-rule-width
+column-count
+column-rule-style
+column-span
+column-fill
+filter
+flex
+flex-grow
+flex-shrink
+flex-basis
+flex-direction
+flex-wrap
+flex-flow
+justify-content
+order
+align-items
+align-self
+align-content
+font-feature-settings
+hyphens
+perspective
+perspective-origin
+transform
+transform-origin
+transform-style
+transition
+transition-property
+transition-duration
+transition-delay
+transition-timing-function
+user-select
+
+
+# Values
+crisp-edges
+optimize-contrast
+linear-gradient
+radial-gradient

data/lib/scss_lint/cli.rb

@@ -20,10 +20,12 @@ module SCSSLint
       config:    78, # Configuration error
     }
 
+    DEFAULT_REPORTER = [SCSSLint::Reporter::DefaultReporter, :stdout]
+
     # @param args [Array]
     def initialize(args = [])
       @args    = args
-      @options = {}
+      @options = { reporters: [DEFAULT_REPORTER] }
       @config  = Config.default
     end
 
@@ -32,7 +34,13 @@ module SCSSLint
         options_parser.parse!(@args)
 
         # Take the rest of the arguments as files/directories
-        @options[:files] = @args
+
+        if @args.empty?
+          @options[:files] = @config.scss_files
+        else
+          @options[:files] = @args
+        end
+
       rescue OptionParser::InvalidOption => ex
         print_help options_parser.help, ex
       end
@@ -66,6 +74,14 @@ module SCSSLint
           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
@@ -192,20 +208,31 @@ module SCSSLint
     # @param lints [Array<Lint>]
     def report_lints(lints)
       sorted_lints = lints.sort_by { |l| [l.filename, l.location] }
-      reporter = @options.fetch(:reporter, SCSSLint::Reporter::DefaultReporter)
-                         .new(sorted_lints)
-      output = reporter.report_lints
-      print output if 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)
-      @options[:reporter] = SCSSLint::Reporter.const_get(format + 'Reporter')
+      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]
+      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
       puts 'Installed formatters:'
 

data/lib/scss_lint/config.rb

@@ -175,7 +175,9 @@ module SCSSLint
         if relative_include_path.start_with?('/')
           relative_include_path
         else
-          File.join(File.dirname(base_config_path), relative_include_path)
+          path = File.join(File.dirname(base_config_path), relative_include_path)
+          # Remove double backslashes appearing in Windows paths.
+          path.gsub(%r{^//}, File::SEPARATOR)
         end
       end
 
@@ -262,6 +264,15 @@ module SCSSLint
       @options['exclude'] << abs_path
     end
 
+    # @return Array
+    def scss_files
+      if path = @options['scss_files']
+        Dir[path]
+      else
+        []
+      end
+    end
+
   private
 
     def validate_linters

data/lib/scss_lint/engine.rb

@@ -20,7 +20,9 @@ module SCSSLint
         @contents = scss_or_filename
       end
 
-      @lines = @contents.lines.to_a # Need `to_a` for Ruby 1.9.3
+      # Need to force encoding to avoid Windows-related bugs.
+      # Need `to_a` for Ruby 1.9.3.
+      @lines = @contents.force_encoding('UTF-8').lines.to_a
       @tree = @engine.to_tree
     rescue Encoding::UndefinedConversionError, Sass::SyntaxError => error
       if error.is_a?(Encoding::UndefinedConversionError) ||

data/lib/scss_lint/linter/bang_format.rb

@@ -0,0 +1,40 @@
+module SCSSLint
+  # Checks spacing of ! declarations, like !important and !default
+  class Linter::BangFormat < Linter
+    include LinterRegistry
+
+    def visit_prop(node)
+      return unless node.to_sass.include?('!')
+      return unless check_spacing(node)
+
+      before_qualifier = config['space_before_bang'] ? '' : 'not '
+      after_qualifier = config['space_after_bang'] ? '' : 'not '
+
+      add_lint(node, "! should #{before_qualifier}be preceeded by a space, " \
+                     "and should #{after_qualifier}be followed by a space")
+    end
+
+  private
+
+    def find_bang_offset(range)
+      offset = 0
+      offset += 1 while character_at(range.start_pos, offset) != '!'
+      offset
+    end
+
+    def check_spacing(node)
+      range = node.value_source_range
+      offset = find_bang_offset(range)
+
+      before_expected = config['space_before_bang'] ? / / : /[^ ]/
+      before_actual = character_at(range.start_pos, offset - 1)
+      before_is_wrong = (before_actual =~ before_expected).nil?
+
+      after_expected = config['space_after_bang'] ? / / : /[^ ]/
+      after_actual = character_at(range.start_pos, offset + 1)
+      after_is_wrong = (after_actual =~ after_expected).nil?
+
+      before_is_wrong || after_is_wrong
+    end
+  end
+end

data/lib/scss_lint/linter/declaration_order.rb

@@ -3,35 +3,56 @@ module SCSSLint
   class Linter::DeclarationOrder < Linter
     include LinterRegistry
 
+    def check_order(node)
+      check_node(node)
+      yield # Continue linting children
+    end
+
+    alias_method :visit_rule, :check_order
+    alias_method :visit_mixin, :check_order
+
+  private
+
+    MESSAGE =
+      'Rule sets should be ordered as follows: '\
+      '@extends, @includes without @content, ' \
+      'properties, @includes with @content, ' \
+      'nested rule sets'
+
+    MIXIN_WITH_CONTENT = 'mixin_with_content'
+
     DECLARATION_ORDER = [
       Sass::Tree::ExtendNode,
+      Sass::Tree::MixinNode,
       Sass::Tree::PropNode,
+      MIXIN_WITH_CONTENT,
       Sass::Tree::RuleNode,
     ]
 
-    def visit_rule(node)
+    def important_node?(node)
+      DECLARATION_ORDER.include?(node.class)
+    end
+
+    def check_node(node)
       children = node.children.select { |n| important_node?(n) }
-                              .map(&:class)
+                              .map { |n| node_declaration_type(n) }
 
       sorted_children = children.sort do |a, b|
         DECLARATION_ORDER.index(a) <=> DECLARATION_ORDER.index(b)
       end
 
-      if children != sorted_children
-        add_lint(node.children.first, MESSAGE)
-      end
-
-      yield # Continue linting children
+      return unless children != sorted_children
+      add_lint(node.children.first, MESSAGE)
     end
 
-  private
-
-    MESSAGE =
-      'Rule sets should start with @extend declarations, followed by ' \
-      'properties and nested rule sets, in that order'
+    def node_declaration_type(node)
+      # If the node has no children, return the class.
+      return node.class unless node.has_children
 
-    def important_node?(node)
-      DECLARATION_ORDER.include? node.class
+      # If the node is a mixin with children, indicate that;
+      # otherwise, just return the class.
+      return node.class unless node.is_a?(Sass::Tree::MixinNode)
+      MIXIN_WITH_CONTENT
     end
   end
 end