scss-lint 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1109af5e1f6cd4016185ea4d079a4188774f2d3
-  data.tar.gz: 41389f3cfc6b63b002101e8608b4b2f5eda48ec6
+  metadata.gz: d9d896111a17640c23d31de062d34329fd52a56a
+  data.tar.gz: 6f34a07866cd4b7c77a18137f2bec2570e9f31e5
 SHA512:
-  metadata.gz: 9120548dc3302ae1c7922e4b46166d6fa9238f4bf755824abad0176dec920d4722c0b4b67042258c7f73ed99903785a4f8bde6e6471809093c74cf0a7f0fbfbb
-  data.tar.gz: 046761b2017cbb1f333e446cae0fda6fb52a5fd8055764e91797b3eccb9eddcf862a18597c7a24ebe5dcd2e6f76d40397b6144298bbcd78d5a4574c88fe774d3
+  metadata.gz: d100dfddcde8591cbff342d88bc37f685ac337eb32b9193b87f09c46cf50dc61c04717a4e67fe843f6135fb186f8c5e43b7c6711680d67e766e56e71bb04ff94
+  data.tar.gz: 65e67618d2e00e428a38adb5243236dea6464f17df75914937da60afbf3eded4f3b0e7be4d526b4d05c264c9a0ef5f5ed1cc13cbab3dac4a5cde3673f4e991d0

data/config/default.yml

@@ -10,10 +10,14 @@ linters:
 
   BorderZero:
     enabled: true
+    convention: zero # or `none`
 
   ColorKeyword:
     enabled: true
 
+  ColorVariable:
+    enabled: true
+
   Comment:
     enabled: true
 
@@ -55,6 +59,9 @@ linters:
   IdSelector:
     enabled: true
 
+  ImportantRule:
+    enabled: true
+
   ImportPath:
     enabled: true
     leading_underscore: false
@@ -62,6 +69,7 @@ linters:
 
   Indentation:
     enabled: true
+    allow_non_nested_indentation: false
     character: space # or 'tab'
     width: 2
 
@@ -85,9 +93,15 @@ linters:
   PlaceholderInExtend:
     enabled: true
 
+  PropertyCount:
+    enabled: false
+    include_nested: false
+    max_properties: 10
+
   PropertySortOrder:
     enabled: true
     ignore_unspecified: false
+    separate_groups: false
 
   PropertySpelling:
     enabled: true
@@ -129,7 +143,7 @@ linters:
 
   SpaceBeforeBrace:
     enabled: true
-    style: space
+    style: space # or 'new_line'
     allow_single_line_padding: false
 
   SpaceBetweenParens:
@@ -158,6 +172,10 @@ linters:
   UrlQuotes:
     enabled: true
 
+  VariableForProperty:
+    enabled: false
+    properties: []
+
   VendorPrefixes:
     enabled: true
     identifier_list: base

data/data/properties.txt

@@ -102,6 +102,9 @@ box-pack
 box-reflect
 box-shadow
 box-sizing
+break-after
+break-before
+break-inside
 buffered-rendering
 caption-side
 clear
@@ -418,6 +421,7 @@ text-overline-style
 text-overline-width
 text-rendering
 text-security
+text-size-adjust
 text-shadow
 text-stroke
 text-stroke-color

data/lib/scss_lint.rb

@@ -5,6 +5,7 @@ require 'scss_lint/engine'
 require 'scss_lint/location'
 require 'scss_lint/lint'
 require 'scss_lint/linter_registry'
+require 'scss_lint/file_finder'
 require 'scss_lint/runner'
 require 'scss_lint/selector_visitor'
 require 'scss_lint/control_comment_processor'

data/lib/scss_lint/cli.rb

@@ -1,4 +1,3 @@
-require 'find'
 require 'rainbow'
 require 'rainbow/ext/string'
 require 'scss_lint/options'
@@ -49,7 +48,7 @@ module SCSSLint
 
     def scan_for_lints(options, config)
       runner = Runner.new(config)
-      runner.run(files_to_lint(options, config))
+      runner.run(FileFinder.new(config).find(options[:files]))
       report_lints(options, runner.lints)
 
       if runner.lints.any?(&:error?)
@@ -87,9 +86,9 @@ module SCSSLint
     def setup_configuration(options)
       config =
         if options[:config_file]
-          Config.load(options[:config_file]).tap do |conf|
-            conf.preferred = true
-          end
+          Config.load(options[:config_file])
+        elsif File.exist?(Config::FILE_NAME)
+          Config.load(Config::FILE_NAME)
         else
           Config.default
         end
@@ -123,43 +122,6 @@ module SCSSLint
       config
     end
 
-    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
-          end
-
-        actual_config.excluded_file?(file)
-      end
-    end
-
-    # @param list [Array]
-    def extract_files_from(list)
-      files = []
-      list.each do |file|
-        Find.find(file) do |f|
-          files << f if scssish_file?(f)
-        end
-      end
-      files.uniq
-    end
-
-    VALID_EXTENSIONS = %w[.css .scss]
-    # @param file [String]
-    # @return [Boolean]
-    def scssish_file?(file)
-      return false unless FileTest.file?(file)
-
-      VALID_EXTENSIONS.include?(File.extname(file))
-    end
-
     # @param options [Hash]
     # @param lints [Array<Lint>]
     def report_lints(options, lints)

data/lib/scss_lint/config.rb

@@ -1,4 +1,3 @@
-require 'pathname'
 require 'yaml'
 
 module SCSSLint
@@ -7,7 +6,6 @@ module SCSSLint
     FILE_NAME = '.scss-lint.yml'
     DEFAULT_FILE = File.join(SCSS_LINT_HOME, 'config', 'default.yml')
 
-    attr_accessor :preferred # If this config should be preferred over others
     attr_reader :options, :warnings
 
     class << self
@@ -27,17 +25,6 @@ module SCSSLint
         Config.new(config_options)
       end
 
-      # Loads the configuration for a given file.
-      def for_file(file_path)
-        directory = File.dirname(File.expand_path(file_path))
-        @dir_to_config ||= {}
-        @dir_to_config[directory] ||=
-          begin
-            config_file = possible_config_files(directory).find(&:file?)
-            Config.load(config_file.to_s) if config_file
-          end
-      end
-
       def linter_name(linter)
         linter = linter.is_a?(Class) ? linter : linter.class
         linter.name.split('::')[2..-1].join('::')
@@ -45,13 +32,6 @@ module SCSSLint
 
     private
 
-      def possible_config_files(directory)
-        files = Pathname.new(directory)
-                        .enum_for(:ascend)
-                        .map { |path| path + FILE_NAME }
-        files << Pathname.new(FILE_NAME)
-      end
-
       def default_options_hash
         @default_options_hash ||= load_options_hash_from_file(DEFAULT_FILE)
       end
@@ -74,7 +54,6 @@ module SCSSLint
         end
 
         options = convert_single_options_to_arrays(options)
-        options = extend_inherited_configs(options, file)
         options = merge_wildcard_linter_options(options)
         options = ensure_exclude_paths_are_absolute(options, file)
         options = ensure_linter_exclude_paths_are_absolute(options, file)
@@ -88,31 +67,13 @@ module SCSSLint
 
         if options['exclude']
           # Ensure exclude is an array, since we allow user to specify a single
-          # string. We do this before merging with the config loaded via
-          # inherit_from since this allows us to merge the excludes from that,
-          # rather than overwriting them.
+          # string.
           options['exclude'] = [options['exclude']].flatten
         end
 
         options
       end
 
-      # Loads and extends a list of inherited options with the given options.
-      def extend_inherited_configs(options, original_file)
-        return options unless options['inherit_from']
-        options = options.dup
-
-        includes = [options.delete('inherit_from')].flatten.map do |include_file|
-          load_options_hash_from_file(path_relative_to_config(include_file, original_file))
-        end
-
-        merged_includes = includes[1..-1].inject(includes.first) do |merged, include_file|
-          smart_merge(merged, include_file)
-        end
-
-        smart_merge(merged_includes, options)
-      end
-
       # Merge options from wildcard linters into individual linter configs
       def merge_wildcard_linter_options(options)
         options = options.dup
@@ -211,11 +172,6 @@ module SCSSLint
       validate_linters
     end
 
-    def ==(other)
-      super || @options == other.options
-    end
-    alias_method :eql?, :==
-
     def enabled_linters
       LinterRegistry.extract_linters_from(@options['linters'].keys).select do |linter|
         linter_options(linter)['enabled']

data/lib/scss_lint/control_comment_processor.rb

@@ -20,25 +20,18 @@ module SCSSLint
     #
     # @param node [Sass::Tree::Node]
     def before_node_visit(node)
-      return unless node.is_a?(Sass::Tree::CommentNode)
+      return unless command = extract_command(node)
 
-      return unless match = /(?x)
-        \*\s* # Comment line start marker
-        scss-lint:
-        (?<command>disable|enable)\s+
-        (?<linters>.*?)
-        \s*(?:\*\/|\n) # Comment end marker or end of line
-      /.match(node.value.first)
-
-      linters = match[:linters].split(/\s*,\s*|\s+/)
+      linters = command[:linters]
       return unless linters.include?('all') || linters.include?(@linter.name)
 
-      process_command(match[:command], node)
+      process_command(command[:action], node)
 
       # Is the control comment the only thing on this line?
-      return if %r{^\s*(//|/\*)}.match(@linter.engine.lines[node.line - 1])
+      return if node.is_a?(Sass::Tree::RuleNode) ||
+                %r{^\s*(//|/\*)}.match(@linter.engine.lines[node.line - 1])
 
-      # If so, pop since we only want the comment to apply to the single line
+      # Otherwise, pop since we only want comment to apply to the single line
       pop_control_comment_stack(node)
     end
 
@@ -53,6 +46,29 @@ module SCSSLint
 
   private
 
+    def extract_command(node)
+      comment =
+        case node
+        when Sass::Tree::CommentNode
+          node.value.first
+        when Sass::Tree::RuleNode
+          node.rule.select { |chunk| chunk.is_a?(String) }.join
+        end
+
+      return unless match = %r{
+        (/|\*)\s* # Comment start marker
+        scss-lint:
+        (?<action>disable|enable)\s+
+        (?<linters>.*?)
+        \s*(?:\*/|\n) # Comment end marker or end of line
+      }x.match(comment)
+
+      {
+        action: match[:action],
+        linters: match[:linters].split(/\s*,\s*|\s+/),
+      }
+    end
+
     def process_command(command, node)
       case command
       when 'disable'
@@ -71,13 +87,29 @@ module SCSSLint
       # apply (if it is a control comment enable node, it will be the line of
       # the comment itself).
       child = node
-      while child.children.last.is_a?(Sass::Tree::Node)
-        child = child.children.last
+      prev_child = node
+      while (child = last_child(child)) != prev_child
+        prev_child = child
       end
 
       end_line = child.line
 
       @disabled_lines.merge(start_line..end_line)
     end
+
+    # Gets the child of the node that resides on the lowest line in the file.
+    #
+    # This is necessary due to the fact that our monkey patching of the parse
+    # tree's {#children} method does not return nodes sorted by their line
+    # number.
+    #
+    # @param node [Sass::Tree::Node, Sass::Script::Tree::Node]
+    # @return [Sass::Tree::Node, Sass::Script::Tree::Node]
+    def last_child(node)
+      node.children.inject(node) do |lowest, child|
+        return lowest unless child.respond_to?(:line)
+        lowest.line < child.line ? child : lowest
+      end
+    end
   end
 end

data/lib/scss_lint/file_finder.rb

@@ -0,0 +1,57 @@
+require 'find'
+
+module SCSSLint
+  # Finds all SCSS files that should be linted given a set of paths, globs, and
+  # configuration.
+  class FileFinder
+    # List of extensions of files to include when only a directory is specified
+    # as a path.
+    VALID_EXTENSIONS = %w[.css .scss]
+
+    # Create a {FileFinder}.
+    #
+    # @param config [SCSSLint::Config]
+    def initialize(config)
+      @config = config
+    end
+
+    # Find all files that match given the specified options.
+    #
+    # @param patterns [Array<String>] a list of file paths and glob patterns
+    def find(patterns)
+      # If no explicit patterns given, use patterns listed in config
+      patterns = @config.scss_files if patterns.empty?
+
+      extract_files_from(patterns).reject do |file|
+        @config.excluded_file?(file)
+      end
+    end
+
+  private
+
+    # @param list [Array]
+    def extract_files_from(list)
+      files = []
+
+      list.each do |file|
+        if File.directory?(file)
+          Find.find(file) do |f|
+            files << f if scssish_file?(f)
+          end
+        else
+          files << file # Otherwise include file as-is
+        end
+      end
+
+      files.uniq
+    end
+
+    # @param file [String]
+    # @return [true,false]
+    def scssish_file?(file)
+      return false unless FileTest.file?(file)
+
+      VALID_EXTENSIONS.include?(File.extname(file))
+    end
+  end
+end

data/lib/scss_lint/linter/bang_format.rb

@@ -6,7 +6,7 @@ module SCSSLint
     STOPPING_CHARACTERS = ['!', "'", '"', nil]
 
     def visit_prop(node)
-      return unless node.to_sass.include?('!')
+      return unless source_from_range(node.source_range).include?('!')
       return unless check_spacing(node)
 
       before_qualifier = config['space_before_bang'] ? '' : 'not '

data/lib/scss_lint/linter/border_zero.rb

@@ -1,16 +1,12 @@
 module SCSSLint
-  # Reports when `border: 0` can be used instead of `border: none`.
+  # Enforce a particular value for empty borders.
   class Linter::BorderZero < Linter
     include LinterRegistry
 
-    def visit_prop(node)
-      return unless BORDER_PROPERTIES.include?(node.name.first.to_s)
-      return unless node.value.to_sass.strip == 'none'
-
-      add_lint(node, '`border: 0;` is preferred over `border: none;`')
-    end
-
-  private
+    CONVENTION_TO_PREFERENCE = {
+      'zero' => %w[0 none],
+      'none' => %w[none 0],
+    }
 
     BORDER_PROPERTIES = %w[
       border
@@ -19,5 +15,25 @@ module SCSSLint
       border-bottom
       border-left
     ]
+
+    def visit_root(_node)
+      @preference = CONVENTION_TO_PREFERENCE[config['convention']]
+      yield # Continue linting children
+    end
+
+    def visit_prop(node)
+      return unless BORDER_PROPERTIES.include?(node.name.first.to_s)
+      check_border(node, node.value.to_sass.strip)
+    end
+
+  private
+
+    def check_border(node, border)
+      return unless %w[0 none].include?(border)
+      return if @preference[0] == border
+
+      add_lint(node, "`border: #{@preference[0]} is preferred over " \
+                     "`border: #{@preference[1]}`")
+    end
   end
 end