pre-commit 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7355c40a01a77e3e1a80b3aa54e0fad68f14384
-  data.tar.gz: 523aafecb538cb6ee6212a8aec9b3bb272475c53
+  metadata.gz: 782f5d2ee7b13c81a4d4382a7c12490b04f1c17b
+  data.tar.gz: d6a4fb5f128b0ab9bb04a4b3964d11c96334576d
 SHA512:
-  metadata.gz: 442f543f6a1c50f4346bbb7ff94e0340c255ba81baff3f7a24ed9159f183173302ada1b5dfe92186c86fa587c2501c8318b6483dfbf94f65d032612ed9546f1c
-  data.tar.gz: 066024f84516424170d618568f1177d8ce34c3293131f348772af247143787033e0082341a9979aa6621470cb6b29b8aae88736e9068f60b0068efff0ec733ab
+  metadata.gz: 50cdddbe3e934bb06d4730d50e616d1676e4f36017308e1ce30d549d2054a04cf8cfdcca0b18646e682668baed30eb7d82bf27c5f05ea7e9b42ee12177b14706
+  data.tar.gz: b8bc8820e844b36a4344bff7afb97788a9ea72f81369be45b2f972ab3c05de5cc24cabafd05516f346f4c1b8946b2f4641c29a8950ffe6f70e02034733073502

data/README.md

@@ -20,7 +20,7 @@ Use the pre-commit command to generate a stub pre-commit hook
 
 This creates a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.
 
-## Configuration
+## Available checks
 
 These are the available checks:
 
@@ -43,29 +43,52 @@ These are the available checks:
 * before_all (Check your RSpec tests for the use of `before(:all)`)
 * coffeelint (Check your coffeescript files using the [coffeelint gem.](https://github.com/clutchski/coffeelint))
 
-To configure which checks you would like to run, simply set the `pre-commit.checks` git configuration setting.
+## Default checks
 
-To enable `white_space` and `tab` checks:
+Use `pre-commit list` to see the list of default and enabled checks and warnings.
 
-    # From your git repo
-    $ git config "pre-commit.checks" "white_space, tabs"
+## Enabling / Disabling Checks / Warnings
 
-To enable `white_space`, `console_log` and `debugger` checks:
+### 0.12.0 and lower
 
-    # From your git repo
-    $ git config "pre-commit.checks" "white_space, console_log, debugger"
+    git config pre-commit.checks "whitespace, jshint, debugger"
 
-Note: If no checks are configured, a default set of checks is run:
+To disable, simply leave one off the list
 
-    white_space, console_log, debugger, pry, tabs, jshint, migrations, merge_conflict, local
+    git config pre-commit.checks "whitespace, jshint"
 
-You may also enable checks that will produce warnings if detected but NOT stop the commit:
+### 0.13.0 and higher
 
-    # From your git repo
-    $ git config "pre-commit.warnings" "jshint, ruby_symbol_hashrockets"
+```ssh
+pre-commit <enable|disbale> <git|yaml> <checks|warnings> check1 [check2...]
+```
 
+The `git` provider can be used for local machine configuration, the `yaml` can be used for shared
+project configuration.
 
-For the rubocop check, you can tell it what config file to use by setting a path relative to the repo:
+Example move `jshint` from `checks` to `warnings` in `yaml` provider and save configuration to git:
+```bash
+pre-commit disbale yaml checks   jshint
+pre-commit enable  yaml warnings jshint
+git add config/pre-commit.yml
+git commit -m "pre-commit: move jshint from checks to warnings"
+```
 
-    # From your git repo
-    $ git config "pre-commit.rubocop.config" "config/rubocop.yml"
+Example `config/pre_commit.yml`:
+```yaml
+---
+:warnings_remove: []
+:warnings_add:
+- :jshint
+- :tabs
+```
+
+## Configuration providers
+
+`pre-commit` comes with 3 configuration providers:
+
+- `default` - basic settings, read only
+- `git` - reads configuration from `git config pre-commit.*`, allow local update
+- `yaml` - reads configuration from `/etc/pre-commit.yml`, `$HOME/.pre-commit.yml` and `config/pre-commit.yml`, allows `config/pre-commit.yml` updates
+
+## [Contributing](CONTRIBUTING.md)

data/bin/pre-commit

@@ -2,19 +2,8 @@
 
 require 'pre-commit/cli'
 
-if ARGV[0] != "install"
-  abort "Usage: pre-commit install"
-end
-
 if !File.exists?(".git")
   abort "No .git directory found."
 end
 
-begin
-  PreCommit::Cli.new.install(ARGV[1])
-rescue PreCommit::TemplateNotFound => e
-  abort e.message
-end
-
-puts "Installed hook: #{PreCommit::Cli::PRE_COMMIT_HOOK_PATH}"
-puts
+PreCommit::Cli.new(*ARGV).execute or exit 1

data/lib/plugins/pluginator/extensions/find_check.rb

@@ -0,0 +1,26 @@
+require "plugins/pluginator/extensions/conversions"
+
+module Pluginator::Extensions
+  # Extension to find class or first plugin that answers the question with true or to print warning
+  module FindCheck
+    include Conversions
+
+    def find_check(name)
+      klass = string2class(name)
+      @plugins["checks"].detect do |plugin|
+        class2name(plugin) == klass ||
+        plugin.respond_to?(:aliases) && plugin.public_send(:aliases).include?(name.to_sym)
+      end ||
+      begin
+        $stderr.puts "Could not find plugin supporting #{name} / #{klass},
+available plugins: #{available_plugins}"
+        nil
+      end
+    end
+
+    def available_plugins
+      @plugins["checks"].map{|plugin| class2name(plugin) }.join(", ")
+    end
+
+  end
+end

data/lib/plugins/pre_commit/checks/before_all.rb

@@ -1,13 +1,29 @@
+require 'pre-commit/checks/grep'
+
 module PreCommit
   module Checks
-    class BeforeAll
-      def self.call(staged_files)
-        staged_files.reject! { |f| File.extname(f) != ".rb" }
-        return if staged_files.empty?
-        errors = `#{PreCommit::Utils.grep} -e "before.*:all" #{staged_files.join(" ")} | grep -v \/\/`.strip
-        return unless $?.success?
-        "before(:all) found:\n#{errors}"
+    class BeforeAll < Grep
+
+      def files_filter(staged_files)
+        staged_files.grep(/\.rb$/)
       end
+
+      def extra_grep
+        " | grep -v \/\/"
+      end
+
+      def message
+        "before(:all) found:\n"
+      end
+
+      def pattern
+        '-e "before.*:all"'
+      end
+
+      def self.description
+        "Find ruby files with 'before :all' pattern"
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/ci.rb

@@ -1,12 +1,19 @@
+require 'pre-commit/checks/plugin'
+
 module PreCommit
   module Checks
-    class Ci
+    class Ci < Plugin
       CI_TASK_NAME = 'pre_commit:ci'
 
-      def self.call(_)
-        return if system("rake #{CI_TASK_NAME} --silent")
+      def call(_)
+        return if system("rake #{Ci::CI_TASK_NAME} --silent")
         "your test suite has failed, for the full output run `#{CI_TASK_NAME}`"
       end
+
+      def self.description
+        "Runs 'rake #{CI_TASK_NAME} --silent'"
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/closure.rb

@@ -1,19 +1,27 @@
+require 'pre-commit/checks/plugin'
+
 module PreCommit
   module Checks
-    class Closure
+    class Closure < Plugin
       #TODO: add pluginator assets support
       CLOSURE_PATH = File.expand_path("../../../../pre-commit/support/closure/compiler.jar", __FILE__)
 
-      def self.supports(name)
-        name == :closure_syntax_check
+      def self.aliases
+        [:closure_syntax_check]
       end
-      def self.call(staged_files)
+
+      def call(staged_files)
         return if staged_files.empty?
         js_args = staged_files.map {|arg| "--js #{arg}"}.join(' ')
         errors = `java -jar #{CLOSURE_PATH} #{js_args} --js_output_file /tmp/jammit.js 2>&1`.strip
         return if errors.empty?
         errors
       end
+
+      def self.description
+        "Runs closure compiler to detect errors"
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/coffeelint.rb

@@ -1,11 +1,11 @@
-require 'pre-commit/utils'
-require 'stringio'
 require 'open3'
+require 'pre-commit/checks/plugin'
 
 module PreCommit
   module Checks
-    class Coffeelint
-      def self.call(staged_files)
+    class Coffeelint < Plugin
+
+      def call(staged_files)
         staged_files = staged_files.grep(/\.coffee$/)
         return if staged_files.empty?
 
@@ -14,6 +14,11 @@ module PreCommit
         stdout, stderr, result = Open3.capture3("coffeelint #{args}")
         stdout + stderr unless result.success?
       end
+
+      def self.description
+        "Runs coffeelint to detect errors"
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/common.rb

@@ -0,0 +1,17 @@
+require 'pre-commit/checks/plugin'
+
+module PreCommit
+  module Checks
+    class Common < Plugin
+
+      def self.includes
+        [:tabs, :nb_space, :whitespace, :merge_conflict, :debugger]
+      end
+
+      def self.description
+        "Plugins common for all languages."
+      end
+
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/console_log.rb

@@ -1,13 +1,29 @@
+require 'pre-commit/checks/grep'
+
 module PreCommit
   module Checks
-    class ConsoleLog
-      def self.call(staged_files)
-        staged_files.reject! { |f| File.extname(f) != ".js" }
-        return if staged_files.empty?
-        errors = `#{PreCommit::Utils.grep} -e "console\\.log" #{staged_files.join(" ")} | grep -v \/\/`.strip
-        return unless $?.success?
-        "console.log found:\n#{errors}"
+    class ConsoleLog < Grep
+
+      def files_filter(staged_files)
+        staged_files.grep(/\.js$/)
       end
+
+      def extra_grep
+        " | grep -v \/\/"
+      end
+
+      def message
+        "console.log found:\n"
+      end
+
+      def pattern
+        '-e "console\\.log"'
+      end
+
+      def self.description
+        "Finds javascript files with 'console.log'."
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/csslint.rb

@@ -0,0 +1,32 @@
+require 'pre-commit/checks/js'
+
+module PreCommit
+  module Checks
+    class Csslint < Js
+
+      SOURCE = "https://github.com/stubbornella/csslint/blob/v0.10.0/release/csslint.js"
+
+      def run_check(file)
+        context = ExecJS.compile(File.read(linter_src))
+        context.call("CSSLint.verify", File.read(file))["messages"]
+      end
+
+      def linter_src
+        File.expand_path("../../../../pre-commit/support/csslint/csslint.js", __FILE__)
+      end
+
+      def error_selector
+        'message'
+      end
+
+      def files_filter(staged_files)
+        staged_files.grep(/\.css$/)
+      end
+
+      def self.description
+        "Checks CSS files with CSSLint."
+      end
+
+    end
+  end
+end

data/lib/plugins/pre_commit/checks/debugger.rb

@@ -1,21 +1,25 @@
-require 'pre-commit/utils'
+require 'pre-commit/checks/grep'
 
 module PreCommit
   module Checks
-    class Debugger
-      def self.call(staged_files)
-        files = files_to_check(staged_files)
-        return if files.empty?
+    class Debugger < Grep
 
-        errors = `#{PreCommit::Utils.grep} debugger #{files.join(" ")}`.strip
-        return unless $?.success?
+      def files_filter(staged_files)
+        staged_files.reject { |file| File.basename(file) =~ /^Gemfile/ }
+      end
+
+      def message
+        "debugger statement(s) found:\n"
+      end
 
-        "debugger statement(s) found:\n#{errors}"
+      def pattern
+        'debugger'
       end
 
-      def self.files_to_check(files)
-        files.reject { |file| File.basename(file) =~ /^Gemfile/ }
+      def self.description
+        "Finds files with 'debuger'."
       end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/gemfile_path.rb

@@ -1,14 +1,25 @@
-require 'pre-commit/utils'
+require 'pre-commit/checks/grep'
 
 module PreCommit
   module Checks
-    class GemfilePath
-      def self.call(staged_files)
-        return unless staged_files.include?("Gemfile")
-        errors = `#{PreCommit::Utils.grep} 'path:|:path\\s*=>' Gemfile`.strip
-        return unless $?.success?
-        "local path found in Gemfile:\n#{errors}"
+    class GemfilePath < Grep
+
+      def files_filter(staged_files)
+        staged_files.grep(/^Gemfile$/)
+      end
+
+      def message
+        "local path found in Gemfile:\n"
+      end
+
+      def pattern
+        "'path:|:path\\s*=>'"
+      end
+
+      def self.description
+        "Checks 'Gemfile' for local paths."
       end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/jshint.rb

@@ -1,9 +1,10 @@
-require 'plugins/pre_commit/checks/js'
+require 'pre-commit/checks/js'
 
 module PreCommit
   module Checks
     class Jshint < Js
-      def self.config
+
+      def config
         if config_file = [ENV['JSHINT_CONFIG'], ".jshintrc"].compact.detect { |f| File.exist?(f) }
           ExecJS.exec("return (#{File.read(config_file)});")
         else
@@ -11,14 +12,19 @@ module PreCommit
         end
       end
 
-      def self.run_check(file)
+      def run_check(file)
         context = ExecJS.compile(File.read(linter_src))
         context.call("JSHINT", File.read(file), config, config["globals"])
       end
 
-      def self.linter_src
+      def linter_src
         File.expand_path("../../../../pre-commit/support/jshint/jshint.js", __FILE__)
       end
+
+      def self.description
+        "Checks javascript files with JSHint."
+      end
+
     end
   end
 end