scss-lint 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1649ab811a945a99099b9d000b14059532b28365
-  data.tar.gz: fae32ee4b1704070dd7a84f3a4b2a1e353d0c0ad
+  metadata.gz: 05986225943272819dc966c20d294f39f54bd7ef
+  data.tar.gz: c5fb97b91c46be45d9a4bb72573356639e1f5afb
 SHA512:
-  metadata.gz: cbb264e07bd5c093f54bcd5dad3ff02e990441a734684bee27dbdf1404ea71e7b14d0234bf551ad48bc2ba050478b5fc9ee1feed028a55e01e1d9a08970b8d28
-  data.tar.gz: 9334e0f4b9bedfcdcfb02edb653fbd0d3136986815647047ca19b1607f5f569398473feb7efead4d62d19efb942bfe0b161440a48d2b184f43c74c2b370a4bd2
+  metadata.gz: b38f342599f822cb5d26617986f264e5ef2ad00ddddc10c049a57369a191706e77b38b9a97b9735daaa424703d19b93829a33f0a09b2ebac208bec52a5874eba
+  data.tar.gz: 45ecd691b23e170805dd1e45f509fbff7891c0f32880c1eeb4ff9d4967d7b7733128d1a3dcad4f367ac44309eca8ab79884dda18fe0436654c95d985a4f639b0

data/config/default.yml

@@ -0,0 +1,77 @@
+# Default application configuration that all configurations inherit from.
+linters:
+  BorderZero:
+    enabled: true
+
+  CapitalizationInSelector:
+    enabled: true
+
+  ColorKeyword:
+    enabled: true
+
+  Comment:
+    enabled: true
+
+  DebugStatement:
+    enabled: true
+
+  DeclarationOrder:
+    enabled: true
+
+  DeclaredName:
+    enabled: true
+
+  DuplicateProperty:
+    enabled: true
+
+  EmptyRule:
+    enabled: true
+
+  HexFormat:
+    enabled: true
+
+  IdWithExtraneousSelector:
+    enabled: true
+
+  Indentation:
+    enabled: true
+    width: 2
+
+  LeadingZero:
+    enabled: true
+
+  PlaceholderInExtend:
+    enabled: true
+
+  Shorthand:
+    enabled: true
+
+  SingleLinePerSelector:
+    enabled: true
+
+  SortedProperties:
+    enabled: true
+
+  SpaceAfterComma:
+    enabled: true
+
+  SpaceAfterPropertyColon:
+    enabled: true
+
+  SpaceAfterPropertyName:
+    enabled: true
+
+  SpaceBeforeBrace:
+    enabled: true
+
+  TrailingSemicolonAfterPropertyValue:
+    enabled: true
+
+  UsageName:
+    enabled: true
+
+  ZeroUnit:
+    enabled: true
+
+  Compass::*:
+    enabled: false

data/lib/scss_lint.rb

@@ -1,5 +1,6 @@
 require 'scss_lint/constants'
 require 'scss_lint/cli'
+require 'scss_lint/config'
 require 'scss_lint/engine'
 require 'scss_lint/lint'
 require 'scss_lint/linter_registry'

data/lib/scss_lint/cli.rb

@@ -5,33 +5,66 @@ module SCSSLint
   # Responsible for parsing command-line options and executing the appropriate
   # application logic based on the options specified.
   class CLI
-    attr_accessor :options
+    attr_reader :config, :options
+
+    # Subset of semantic exit codes conforming to `sysexits` documentation.
+    EXIT_CODES = {
+      ok: 0,
+      usage: 64,      # Command line usage error
+      data: 65,       # User input was incorrect (i.e. contains lints)
+      no_input: 66,   # Input file did not exist or was not readable
+      software: 70,   # Internal software error
+      config: 78,     # Configuration error
+    }
 
     def initialize(args = [])
       @args = args
       @options = {}
+      @config = Config.default
     end
 
     def parse_arguments
-      parser = OptionParser.new do |opts|
+      begin
+        options_parser.parse!(@args)
+
+        # Take the rest of the arguments as files/directories
+        @options[:files] = @args
+      rescue OptionParser::InvalidOption => ex
+        print_help options_parser.help, ex
+      end
+
+      begin
+        setup_configuration
+      rescue NoSuchLinter => ex
+        puts ex.message
+        halt :config
+      end
+    end
+
+    def options_parser
+      @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
+          @options[:excluded_files] = files
         end
 
         opts.on('-i', '--include-linter linter,...', Array,
                 'Specify which linters you want to run') do |linters|
-          options[:included_linters] = 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
+          @options[:excluded_linters] = linters
         end
 
         opts.on_tail('--show-linters', 'Shows available linters') do
@@ -47,42 +80,73 @@ module SCSSLint
         end
 
         opts.on('--xml', 'Output the results in XML format') do
-          options[:reporter] = SCSSLint::Reporter::XMLReporter
+          @options[:reporter] = SCSSLint::Reporter::XMLReporter
         end
       end
-
-      begin
-        parser.parse!(@args)
-
-        # Take the rest of the arguments as files/directories
-        options[:files] = @args
-      rescue OptionParser::InvalidOption => ex
-        print_help parser.help, ex
-      end
     end
 
     def run
-      runner = Runner.new(options)
-      runner.run(find_files)
+      runner = Runner.new(@config)
+      runner.run(files_to_lint)
       report_lints(runner.lints)
-      halt(1) if runner.lints?
-    rescue NoFilesError, NoSuchLinter, Errno::ENOENT => ex
+      halt :data if runner.lints.any?
+    rescue NoFilesError, Errno::ENOENT => ex
       puts ex.message
-      halt(-1)
+      halt :no_input
+    rescue NoSuchLinter => ex
+      puts ex.message
+      halt :usage
     rescue => ex
       puts ex.message
       puts ex.backtrace
       puts 'Report this bug at '.yellow + BUG_REPORT_URL.cyan
-      halt(-1)
+      halt :software
     end
 
   private
 
-    def find_files
-      excluded_files = options.fetch(:excluded_files, [])
+    def setup_configuration
+      if @options[:config_file]
+        @config = Config.load(@options[:config_file])
+        @config.preferred = true
+      end
 
-      extract_files_from(options[:files]).reject do |file|
-        excluded_files.include?(file)
+      merge_command_line_flags_with_config(@config)
+    end
+
+    def merge_command_line_flags_with_config(config)
+      if @options[:excluded_files]
+        @options[:excluded_files].each do |file|
+          config.exclude_file(file)
+        end
+      end
+
+      if @options[:included_linters]
+        config.disable_all_linters
+        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|
+          config.disable_linter(linter)
+        end
+      end
+
+      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)
+          else
+            @config
+          end
+
+        config.excluded_file?(file)
       end
     end
 
@@ -105,7 +169,8 @@ module SCSSLint
 
     def report_lints(lints)
       sorted_lints = lints.sort_by { |l| [l.filename, l.line] }
-      reporter = options.fetch(:reporter, Reporter::DefaultReporter).new(sorted_lints)
+      reporter = @options.fetch(:reporter, Reporter::DefaultReporter)
+                         .new(sorted_lints)
       output = reporter.report_lints
       print output if output
     end
@@ -127,7 +192,7 @@ module SCSSLint
     def print_help(help_message, err = nil)
       puts err, '' if err
       puts help_message
-      halt
+      halt(err ? :usage : :ok)
     end
 
     def print_version(program_name, version)
@@ -136,8 +201,8 @@ module SCSSLint
     end
 
     # Used for ease-of testing
-    def halt(exit_status = 0)
-      exit exit_status
+    def halt(exit_status = :ok)
+      exit(EXIT_CODES[exit_status])
     end
   end
 end

data/lib/scss_lint/config.rb

@@ -0,0 +1,223 @@
+require 'pathname'
+require 'yaml'
+
+module SCSSLint
+  # Loads and manages application configuration.
+  class Config
+    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
+      def default
+        load(DEFAULT_FILE, merge_with_default: false)
+      end
+
+      # Loads a configuration from a file, merging it with the default
+      # configuration.
+      def load(file, options = {})
+        config_options = load_options_hash_from_file(file)
+
+        if options.fetch(:merge_with_default, true)
+          config_options = smart_merge(default_options_hash, config_options)
+        end
+
+        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 { |path| path.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('::')
+      end
+
+    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
+
+      # Recursively load config files, fetching files specified by `include`
+      # directives and merging the file's config with the files specified.
+      def load_options_hash_from_file(file)
+        file_contents = load_file_contents(file)
+
+        options =
+          if file_contents.strip.empty?
+            {}
+          else
+            YAML.load(file_contents).to_hash
+          end
+
+        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_form since this allows us to merge the excludes from that,
+          # rather than overwriting them.
+          options['exclude'] = [options['exclude']].flatten
+        end
+
+        if options['inherit_from']
+          includes = [options.delete('inherit_from')].flatten.map do |include_file|
+            load_options_hash_from_file(path_relative_to_config(include_file, file))
+          end
+
+          merged_includes = includes[1..-1].inject(includes.first) do |merged, include_file|
+            smart_merge(merged, include_file)
+          end
+
+          options = smart_merge(merged_includes, options)
+        end
+
+        # Merge options from wildcard linters into individual linter configs
+        options.fetch('linters', {}).keys.each do |class_name|
+          next unless class_name.include?('*')
+
+          class_name_regex = /#{class_name.gsub('*', '[^:]+')}/
+
+          wildcard_options = options['linters'].delete(class_name)
+
+          LinterRegistry.linters.each do |linter_class|
+            name = linter_name(linter_class)
+
+            if name.match(class_name_regex)
+              old_options = options['linters'].fetch(name, {})
+              options['linters'][name] = smart_merge(old_options, wildcard_options)
+            end
+          end
+        end
+
+        # Ensure all excludes are absolute paths
+        if options['exclude']
+          excludes = [options['exclude']].flatten
+
+          options['exclude'] = excludes.map do |exclusion_glob|
+            if exclusion_glob.start_with?('/')
+              exclusion_glob
+            else
+              # Expand the path assuming it is relative to the config file itself
+              File.expand_path(exclusion_glob, File.expand_path(File.dirname(file)))
+            end
+          end
+        end
+
+        options
+      end
+
+      def path_relative_to_config(relative_include_path, base_config_path)
+        if relative_include_path.start_with?('/')
+          relative_include_path
+        else
+          File.join(File.dirname(base_config_path), relative_include_path)
+        end
+      end
+
+      # For easy stubbing in tests
+      def load_file_contents(file)
+        File.open(file, 'r').read
+      end
+
+      # Merge two hashes, concatenating lists and further merging nested hashes.
+      def smart_merge(parent, child)
+        parent.merge(child) do |key, old, new|
+          case old
+          when Array
+            old + new
+          when Hash
+            smart_merge(old, new)
+          else
+            new
+          end
+        end
+      end
+    end
+
+    def initialize(options)
+      @options = options
+      @warnings = []
+
+      validate_linters
+    end
+
+    def ==(other)
+      super || @options == other.options
+    end
+    alias :eql? :==
+
+    def enabled_linters
+      LinterRegistry.extract_linters_from(@options['linters'].keys).select do |linter|
+        linter_options(linter)['enabled']
+      end
+    end
+
+    def linter_enabled?(linter)
+      linter_options(linter)['enabled']
+    end
+
+    def enable_linter(linter)
+      linter_options(linter)['enabled'] = true
+    end
+
+    def disable_linter(linter)
+      linter_options(linter)['enabled'] = false
+    end
+
+    def disable_all_linters
+      @options['linters'].values.each do |linter_config|
+        linter_config['enabled'] = false
+      end
+    end
+
+    def linter_options(linter)
+      @options['linters'][self.class.linter_name(linter)]
+    end
+
+    def excluded_file?(file_path)
+      abs_path = File.expand_path(file_path)
+
+      @options.fetch('exclude', []).any? do |exclusion_glob|
+        File.fnmatch(exclusion_glob, abs_path)
+      end
+    end
+
+    def exclude_file(file_path)
+      abs_path = File.expand_path(file_path)
+
+      @options['exclude'] ||= []
+      @options['exclude'] << abs_path
+    end
+
+  private
+
+    def validate_linters
+      return unless linters = @options['linters']
+
+      linters.keys.each do |name|
+        begin
+          Linter.const_get(name)
+        rescue NameError
+          @warnings << "Linter #{name} does not exist; ignoring"
+        end
+      end
+    end
+  end
+end

data/lib/scss_lint/constants.rb

@@ -1,5 +1,7 @@
 # Global application constants.
 module SCSSLint
+  SCSS_LINT_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+
   REPO_URL = 'https://github.com/causes/scss-lint'
   BUG_REPORT_URL = "#{REPO_URL}/issues"
 end

data/lib/scss_lint/linter.rb

@@ -1,15 +1,17 @@
 module SCSSLint
+  # Defines common functionality available to all linters.
   class Linter < Sass::Tree::Visitors::Base
     include SelectorVisitor
     include Utils
 
-    attr_reader :engine, :lints
+    attr_reader :config, :engine, :lints
 
     def initialize
       @lints = []
     end
 
-    def run(engine)
+    def run(engine, config)
+      @config = config
       @engine = engine
       visit(engine.tree)
     end

data/lib/scss_lint/linter/indentation.rb

@@ -4,6 +4,7 @@ module SCSSLint
     include LinterRegistry
 
     def visit_root(node)
+      @indent_width = config['width']
       @indent = 0
       yield
     end
@@ -14,9 +15,9 @@ module SCSSLint
       # indentation problems as that would likely make the lint too noisy.
       return if check_indentation(node)
 
-      @indent += INDENT_WIDTH
+      @indent += @indent_width
       yield
-      @indent -= INDENT_WIDTH
+      @indent -= @indent_width
     end
 
     def check_indentation(node)
@@ -64,9 +65,5 @@ module SCSSLint
     alias :visit_return     :check_indentation
     alias :visit_variable   :check_indentation
     alias :visit_warn       :check_indentation
-
-  private
-
-    INDENT_WIDTH = 2
   end
 end

data/lib/scss_lint/runner.rb

@@ -1,52 +1,42 @@
 module SCSSLint
   class LinterError < StandardError; end
   class NoFilesError < StandardError; end
-  class NoLintersError < StandardError; end
 
   # Finds and aggregates all lints found by running the registered linters
   # against a set of SCSS files.
   class Runner
-    attr_reader :linters, :lints
+    attr_reader :lints
 
-    def initialize(options = {})
+    def initialize(config)
+      @config = config
       @lints = []
-
-      included_linters = LinterRegistry.
-        extract_linters_from(options.fetch(:included_linters, []))
-
-      included_linters = LinterRegistry.linters if included_linters.empty?
-
-      excluded_linters = LinterRegistry.
-        extract_linters_from(options.fetch(:excluded_linters, []))
-
-      @linters = (included_linters - excluded_linters).map(&:new)
+      @linters = LinterRegistry.linters.map(&:new)
     end
 
-    def run(files = [])
+    def run(files)
       raise NoFilesError, 'No SCSS files specified' if files.empty?
-      raise NoLintersError, 'No linters specified' if linters.empty?
 
       files.each do |file|
         find_lints(file)
       end
 
-      linters.each do |linter|
+      @linters.each do |linter|
         @lints += linter.lints
       end
     end
 
-    def lints?
-      lints.any?
-    end
-
   private
 
     def find_lints(file)
       engine = Engine.new(file)
+      config = @config.preferred ? @config : Config.for_file(file)
+      config ||= @config
+
+      @linters.each do |linter|
+        next unless config.linter_enabled?(linter)
 
-      linters.each do |linter|
         begin
-          linter.run(engine)
+          linter.run(engine, config.linter_options(linter))
         rescue => error
           raise LinterError,
                 "#{linter.class} raised unexpected error linting file #{file}: " <<

data/lib/scss_lint/version.rb

@@ -1,3 +1,3 @@
 module SCSSLint
-  VERSION = '0.12.1'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -76,6 +76,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- config/default.yml
 - lib/scss_lint/version.rb
 - lib/scss_lint/constants.rb
 - lib/scss_lint/utils.rb
@@ -88,6 +89,7 @@ files:
 - lib/scss_lint/selector_visitor.rb
 - lib/scss_lint/sass/tree.rb
 - lib/scss_lint/sass/script.rb
+- lib/scss_lint/config.rb
 - lib/scss_lint/linter/compass.rb
 - lib/scss_lint/linter/space_after_comma.rb
 - lib/scss_lint/linter/space_before_brace.rb