overcommit 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be12e52142407d34b856e8cf7c3b9e1743f9318b
-  data.tar.gz: cbbf986c4d3e2a45d26b281e9716de2ef15cd2c2
+  metadata.gz: cc7753466602537df2c08569c1758136eec9f90b
+  data.tar.gz: 67ed7c78239ba382a78e9f6f976ec113dc4bff67
 SHA512:
-  metadata.gz: 9ccfb37216d910e8c14b7d935c42a74b2ab372016bfe2b3e8eee4f63195028db62d34dbedec808d9b704d49f75991951eeabcdc3a857bbddccd8ebd55c4f00ee
-  data.tar.gz: 2fe6b8c2563e6f709e7d844f4055386fd8a60f4239e82dedf9792b8efeb59d46ecf761c4f2c28998d1628cab1452c35cb125226090c29e35359776ebf83bbfe0
+  metadata.gz: 28bba28fd0dae45783ff7c43a7d0b847547b2680e7b900569d5d4b8ba8ef0c831ae3db30391154e7e04b100fcd2818e7b66ca7ed2ef247a035a0ffccf54b85cd
+  data.tar.gz: d7fb90d9cb74df2e57deea38fabadba464328ac8f1b445847c6c51ad7fa8a7f542c338f92d0ae1d7d115a21fdea0f9f191d94d6d3efa222d96f2567edb7e1b69

data/config/default.yml

@@ -14,16 +14,36 @@ plugin_directory: '.git-hooks'
 # See https://github.com/causes/overcommit#security for more information.
 verify_plugin_signatures: true
 
-# Hooks that run after HEAD changes or a file is explicitly checked out. Useful
-# for updating source tags (e.g. via ctags) or warning about new migrations,
-# etc.
-PostCheckout:
+# Hooks that are run against every commit message after a user has written it.
+# These hooks are useful for enforcing policies on commit messages written for a
+# project.
+CommitMsg:
   ALL:
-    required: false
+    requires_files: false
     quiet: false
-  IndexTags:
+
+  GerritChangeId:
     enabled: false
-    description: 'Generating tags file from source'
+    description: 'Ensuring Gerrit Change-Id is present'
+    required: true
+
+  HardTabs:
+    description: 'Checking for hard tabs'
+
+  RussianNovel:
+    description: 'Checking length of commit message'
+    quiet: true
+
+  SingleLineSubject:
+    description: 'Checking subject line'
+
+  TextWidth:
+    description: 'Checking text width'
+    max_subject_width: 60
+    max_body_width: 72
+
+  TrailingPeriod:
+    description: 'Checking for trailing periods in subject'
 
 # Hooks that are run after `git commit` is executed, before the commit message
 # editor is displayed. These hooks are ideal for syntax checkers, linters, and
@@ -105,6 +125,13 @@ PreCommit:
     install_command: 'npm install -g csslint'
     include: '**/*.css'
 
+  EsLint:
+    description: 'Analyzing with ESLint'
+    required_executable: 'eslint'
+    flags: ['--format=compact']
+    install_command: 'npm install -g eslint'
+    include: '**/*.js'
+
   GoLint:
     description: 'Analyzing with golint'
     required_executable: 'golint'
@@ -127,6 +154,13 @@ PreCommit:
       - '**/Makefile'
       - '.gitmodules'
 
+  HtmlTidy:
+    enabled: false
+    description: 'Analyzing HTML with tidy'
+    required_executable: 'tidy'
+    flags: ['-errors', '-quiet', '-utf8']
+    include: '**/*.html'
+
   ImageOptim:
     description: 'Checking for optimizable images'
     include:
@@ -135,6 +169,12 @@ PreCommit:
       - '**/*.jpeg'
       - '**/*.png'
 
+  JavaCheckstyle:
+    description: 'Analyzing with checkstyle'
+    required_executable: 'checkstyle'
+    flags: ['-c', '/sun_checks.xml']
+    include: '**/*.java'
+
   Jscs:
     description: 'Analyzing with JSCS'
     required_executable: 'jscs'
@@ -142,16 +182,10 @@ PreCommit:
     install_command: 'npm install -g jscs'
     include: '**/*.js'
 
-  Jsxcs:
-    description: 'Analyzing with JSXCS'
-    required_executable: 'jsxcs'
-    flags: ['--reporter=inline']
-    install_command: 'npm install -g jsxcs'
-    include: '**/*.jsx'
-
   JsHint:
     description: 'Analyzing with JSHint'
     required_executable: 'jshint'
+    flags: ['--verbose']
     install_command: 'npm install -g jshint'
     include: '**/*.js'
 
@@ -159,12 +193,6 @@ PreCommit:
     description: 'Validating JSON syntax'
     include: '**/*.json'
 
-  JsxHint:
-    description: 'Analyzing with JSXHint'
-    required_executable: 'jsxhint'
-    install_command: 'npm install -g jsxhint'
-    include: '**/*.jsx'
-
   LocalPathsInGemfile:
     description: 'Checking for local paths in Gemfile'
     required_executable: 'grep'
@@ -177,6 +205,19 @@ PreCommit:
     required_executable: 'grep'
     flags: ['-IHn', '^<<<<<<<\s']
 
+  Pep257:
+    description: 'Analyzing docstrings with pep257'
+    required_executable: 'pep257'
+    install_command: 'pip install pep257'
+    include: '**/*.py'
+
+  Pep8:
+    enabled: false
+    description: 'Analyzing with pep8'
+    required_executable: 'pep8'
+    install_command: 'pip install pep8'
+    include: '**/*.py'
+
   PryBinding:
     description: 'Checking for instances of binding.pry'
     quiet: true
@@ -184,6 +225,23 @@ PreCommit:
       - '**/*.rb'
       - '**/*.rake'
 
+  Pyflakes:
+    enabled: false
+    description: 'Analyzing with pyflakes'
+    required_executable: 'pyflakes'
+    install_command: 'pip install pyflakes'
+    include: '**/*.py'
+
+  Pylint:
+    description: 'Analyzing with Pylint'
+    required_executable: 'pylint'
+    install_command: 'pip install pylint'
+    flags:
+      - '--msg-template="{path}:{line}:{C}: {msg} ({symbol})"'
+      - '--reports=n'
+      - '--persistent=n'
+    include: '**/*.py'
+
   PythonFlake8:
     description: 'Analyzing with flake8'
     required_executable: 'flake8'
@@ -222,18 +280,39 @@ PreCommit:
       - '**/Gemfile'
       - '**/Rakefile'
 
+  Scalastyle:
+    description: 'Analyzing with Scalastyle'
+    required_executable: 'scalastyle'
+    include: '**/*.scala'
+
   ScssLint:
     description: 'Analyzing with scss-lint'
     required_executable: 'scss-lint'
     install_command: 'gem install scss-lint'
     include: '**/*.scss'
 
+  SemiStandard:
+    enabled: false
+    description: 'Analyzing with semistandard'
+    required_executable: 'semistandard'
+    flags: ['--verbose']
+    install_command: 'npm install -g semistandard'
+    include: '**/*.js'
+
   ShellCheck:
     description: 'Analyzing with ShellCheck'
     required_executable: 'shellcheck'
     flags: ['--format=gcc']
     include: '**/*.sh'
 
+  Standard:
+    enabled: false
+    description: 'Analyzing with standard'
+    required_executable: 'standard'
+    flags: ['--verbose']
+    install_command: 'npm install -g standard'
+    include: '**/*.js'
+
   TrailingWhitespace:
     description: 'Checking for trailing whitespace'
     required_executable: 'grep'
@@ -248,37 +327,86 @@ PreCommit:
     install_command: 'gem install travis'
     include: '.travis.yml'
 
+  W3cCss:
+    enabled: false
+    description: 'Analyzing with W3C CSS validation service'
+    validator_uri: 'http://jigsaw.w3.org/css-validator/validator'
+    language: 'en'
+    profile: 'css3'
+    warn_level: 2
+    include:
+      - '**/*.css'
+
+  W3cHtml:
+    enabled: false
+    description: 'Analyzing with W3C HTML validation service'
+    validator_uri: 'http://validator.w3.org/check'
+    charset: 'utf-8'
+    doctype: 'HTML5'
+    include:
+      - '**/*.html'
+
+  XmlLint:
+    description: 'Analyzing with xmllint'
+    required_executable: 'xmllint'
+    flags: ['--noout']
+    include: '**/*.xml'
+
   YamlSyntax:
     description: 'Checking YAML syntax'
-    include: '**/*.yml'
+    include:
+      - '**/*.yaml'
+      - '**/*.yml'
 
-# Hooks that are run against every commit message after a user has written it.
-# These hooks are useful for enforcing policies on commit messages written for a
-# project.
-CommitMsg:
+# Hooks that run after HEAD changes or a file is explicitly checked out.
+PostCheckout:
+  ALL:
+    required: false
+    quiet: false
+
+  IndexTags:
+    enabled: false
+    description: 'Generating tags file from source'
+    required_executable: 'ctags'
+
+# Hooks that run after a commit is created.
+PostCommit:
   ALL:
     requires_files: false
+    required: false
     quiet: false
 
-  GerritChangeId:
+  GitGuilt:
     enabled: false
-    description: 'Ensuring Gerrit Change-Id is present'
-    required: true
+    description: 'Calculating changes in blame since last commit'
+    requires_files: true
+    required_executable: 'git-guilt'
+    flags: ['HEAD~', 'HEAD']
+    install_command: 'npm install -g git-guilt'
 
-  HardTabs:
-    description: 'Checking for hard tabs'
+  IndexTags:
+    enabled: false
+    description: 'Generating tags file from source'
+    required_executable: 'ctags'
 
-  RussianNovel:
-    description: 'Checking length of commit message'
-    quiet: true
+# Hooks that run after `git merge` executes successfully (no merge conflicts).
+PostMerge:
+  ALL:
+    requires_files: false
+    quiet: false
 
-  SingleLineSubject:
-    description: 'Checking subject line'
+  IndexTags:
+    enabled: false
+    description: 'Generating tags file from source'
+    required_executable: 'ctags'
 
-  TextWidth:
-    description: 'Checking text width'
-    max_subject_width: 60
-    max_body_width: 72
+# Hooks that run after a commit is modified by an amend or rebase.
+PostRewrite:
+  ALL:
+    requires_files: false
+    quiet: false
 
-  TrailingPeriod:
-    description: 'Checking for trailing periods in subject'
+  IndexTags:
+    enabled: false
+    description: 'Generating tags file from source'
+    required_executable: 'ctags'

data/lib/overcommit/configuration.rb

@@ -170,8 +170,6 @@ module Overcommit
     def smart_merge(parent, child)
       parent.merge(child) do |_key, old, new|
         case old
-        when Array
-          old + Array(new)
         when Hash
           smart_merge(old, new)
         else

data/lib/overcommit/git_repo.rb

@@ -20,8 +20,10 @@ module Overcommit
       lines = Set.new
 
       flags = '--cached' if options[:staged]
+      refs = options[:refs]
+      subcmd = options[:subcmd] || 'diff'
 
-      `git diff --no-ext-diff -U0 #{flags} -- #{file_path}`.
+      `git #{subcmd} --no-ext-diff -U0 #{flags} #{refs} -- '#{file_path}'`.
         scan(DIFF_HUNK_REGEX) do |start_line, lines_added|
         lines_added = (lines_added || 1).to_i # When blank, one line was added
         cur_line = start_line.to_i
@@ -42,9 +44,13 @@ module Overcommit
     # @return [Array<String>] list of absolute file paths
     def modified_files(options)
       flags = '--cached' if options[:staged]
+      refs = options[:refs]
+      subcmd = options[:subcmd] || 'diff'
 
-      `git diff --name-only -z --diff-filter=ACM --ignore-submodules=all #{flags}`.
+      `git #{subcmd} --name-only -z --diff-filter=ACM --ignore-submodules=all #{flags} #{refs}`.
         split("\0").
+        map(&:strip).
+        reject(&:empty?).
         map { |relative_file| File.expand_path(relative_file) }
     end
 
@@ -54,7 +60,8 @@ module Overcommit
     def all_files
       `git ls-files`.
         split(/\n/).
-        map { |relative_file| File.expand_path(relative_file) }
+        map { |relative_file| File.expand_path(relative_file) }.
+        reject { |file| File.directory?(file) } # Exclude submodule directories
     end
 
     # Returns whether the current git branch is empty (has no commits).

data/lib/overcommit/hook/base.rb

@@ -111,6 +111,10 @@ module Overcommit::Hook
       Overcommit::Utils.execute(cmd)
     end
 
+    def execute_in_background(cmd)
+      Overcommit::Utils.execute_in_background(cmd)
+    end
+
     def required_executable
       @config['required_executable']
     end

data/lib/overcommit/hook/post_checkout/index_tags.rb

@@ -1,26 +1,9 @@
 module Overcommit::Hook::PostCheckout
-  # Scans source code each time HEAD changes to generate an up-to-date index of
-  # all function/variable definitions, etc.
+  # Updates ctags index for all source code in the repository.
   class IndexTags < Base
     def run
-      unless in_path?('ctags')
-        return :pass # Silently ignore
-      end
-
-      index_tags_in_background
-
+      execute_in_background([Overcommit::Utils.script_path('index-tags')])
       :pass
     end
-
-    private
-
-    SCRIPT_LOCATION = Overcommit::Utils.script_path('index-tags')
-
-    def index_tags_in_background
-      ctags_args = config['ctags_arguments']
-
-      # TODO: come up with Ruby 1.8-friendly way to do this
-      Process.detach(Process.spawn("#{SCRIPT_LOCATION} #{ctags_args}"))
-    end
   end
 end

data/lib/overcommit/hook/post_commit/base.rb

@@ -0,0 +1,10 @@
+require 'forwardable'
+
+module Overcommit::Hook::PostCommit
+  # Functionality common to all post-commit hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context, :modified_lines_in_file, :initial_commit?
+  end
+end

data/lib/overcommit/hook/post_commit/git_guilt.rb

@@ -0,0 +1,39 @@
+module Overcommit::Hook::PostCommit
+  # Calculates the change in blame since the last revision.
+  class GitGuilt < Base
+    PLUS_MINUS_REGEX = /^(.*?)(?:(\++)|(-+))$/
+    GREEN = 32
+    RED = 31
+
+    def run
+      return :pass if initial_commit?
+      result = execute(command)
+      return :fail, result.stderr unless result.success?
+
+      return :pass if result.stdout.strip.empty?
+
+      output = []
+      result.stdout.scan(PLUS_MINUS_REGEX) do |user, plus, minus|
+        plus = color(GREEN, plus)
+        minus = color(RED, minus)
+        output << "#{user}#{plus}#{minus}"
+      end
+
+      [:warn, output.join("\n")]
+    end
+
+    private
+
+    # Returns text wrapped in ANSI escape code necessary to produce a given
+    # color/text display.
+    #
+    # Taken from Overcommit::Logger as a temporary workaround.
+    # TODO: expose logger instance to hooks for colorized output
+    #
+    # @param code [String] ANSI escape code, e.g. '1;33' for "bold yellow"
+    # @param str [String] string to wrap
+    def color(code, str)
+      STDOUT.tty? ? "\033[#{code}m#{str}\033[0m" : str
+    end
+  end
+end

data/lib/overcommit/hook/post_commit/index_tags.rb

@@ -0,0 +1,9 @@
+module Overcommit::Hook::PostCommit
+  # Updates ctags index for all source code in the repository.
+  class IndexTags < Base
+    def run
+      execute_in_background([Overcommit::Utils.script_path('index-tags')])
+      :pass
+    end
+  end
+end

data/lib/overcommit/hook/post_merge/base.rb

@@ -0,0 +1,10 @@
+require 'forwardable'
+
+module Overcommit::Hook::PostMerge
+  # Functionality common to all post-merge hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context, :modified_lines_in_file, :squash?, :merge_commit?
+  end
+end

data/lib/overcommit/hook/post_merge/index_tags.rb

@@ -0,0 +1,9 @@
+module Overcommit::Hook::PostMerge
+  # Updates ctags index for all source code in the repository.
+  class IndexTags < Base
+    def run
+      execute_in_background([Overcommit::Utils.script_path('index-tags')])
+      :pass
+    end
+  end
+end

data/lib/overcommit/hook/post_rewrite/base.rb

@@ -0,0 +1,10 @@
+require 'forwardable'
+
+module Overcommit::Hook::PostRewrite
+  # Functionality common to all post-rewrite hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context, :amend?, :rebase?
+  end
+end

data/lib/overcommit/hook/post_rewrite/index_tags.rb

@@ -0,0 +1,12 @@
+module Overcommit::Hook::PostRewrite
+  # Updates ctags index for all source code in the repository.
+  class IndexTags < Base
+    def run
+      # Ignore unless this is a rebase (amends are covered by post-commit hook)
+      return :pass unless rebase?
+
+      execute_in_background([Overcommit::Utils.script_path('index-tags')])
+      :pass
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/css_lint.rb

@@ -1,11 +1,29 @@
 module Overcommit::Hook::PreCommit
   # Runs `csslint` against any modified CSS files.
   class CssLint < Base
+    MESSAGE_REGEX = /
+      ^(?<file>[^:]+):\s
+      (?:line\s(?<line>\d+)[^EW]+)?
+      (?<type>Error|Warning)
+    /x
+
     def run
       result = execute(command + applicable_files)
-      return :pass if result.stdout !~ /Error - (?!Unknown @ rule)/
+      output = result.stdout.chomp
+      return :pass if result.success? && output.empty?
+
+      extract_messages(
+        output.split("\n").collect(&method(:add_line_number)),
+        MESSAGE_REGEX,
+        lambda { |type| type.downcase.to_sym }
+      )
+    end
+
+    private
 
-      [:fail, result.stdout]
+    # Hack to include messages that apply to the entire file
+    def add_line_number(message)
+      message.sub(/(?<!\d,\s)(Error|Warning)/, 'line 0, \1')
     end
   end
 end

data/lib/overcommit/hook/pre_commit/es_lint.rb

@@ -0,0 +1,18 @@
+module Overcommit::Hook::PreCommit
+  # Runs `eslint` against any modified JavaScript files.
+  class EsLint < Base
+    def run
+      result = execute(command + applicable_files)
+      output = result.stdout.chomp
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.js: line 1, col 0, Error - Error message (ruleName)
+      extract_messages(
+        output.split("\n").grep(/Warning|Error/),
+        /^(?<file>[^:]+):[^\d]+(?<line>\d+).*?(?<type>Error|Warning)/,
+        lambda { |type| type.downcase.to_sym }
+      )
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/html_tidy.rb

@@ -0,0 +1,35 @@
+module Overcommit::Hook::PreCommit
+  # Runs `tidy` against any modified HTML files.
+  class HtmlTidy < Base
+    MESSAGE_REGEX = /
+      ^(?<file>[^:]+):\s
+      line\s(?<line>\d+)\s
+      column\s(?<col>\d+)\s-\s
+      (?<type>Error|Warning):\s(?<message>.+)$
+    /x
+
+    def run
+      # example message:
+      #   line 4 column 24 - Warning: <html> proprietary attribute "class"
+      messages = collect_messages
+
+      return :pass if messages.empty?
+
+      messages
+    end
+
+    private
+
+    def collect_messages
+      applicable_files.collect do |file|
+        result = execute(command + [file])
+        output = result.stderr.chomp
+        extract_messages(
+          output.split("\n").collect { |msg| "#{file}: #{msg}" },
+          MESSAGE_REGEX,
+          lambda { |type| type.downcase.to_sym }
+        )
+      end.flatten
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/image_optim.rb

@@ -5,7 +5,7 @@ module Overcommit::Hook::PreCommit
       begin
         require 'image_optim'
       rescue LoadError
-        return :warn, 'image_optim not installed -- run `gem install image_optim`'
+        return :fail, 'image_optim not installed -- run `gem install image_optim`'
       end
 
       optimized_images =

data/lib/overcommit/hook/pre_commit/java_checkstyle.rb

@@ -0,0 +1,19 @@
+module Overcommit::Hook::PreCommit
+  # Runs `checkstyle` against any modified Java files.
+  class JavaCheckstyle < Base
+    MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+)/
+
+    def run
+      result = execute(command + applicable_files)
+      output = result.stdout.chomp
+      return :pass if result.success?
+
+      # example message:
+      #   path/to/file.java:3:5: Error message
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/js_hint.rb

@@ -3,11 +3,17 @@ module Overcommit::Hook::PreCommit
   class JsHint < Base
     def run
       result = execute(command + applicable_files)
-      output = result.stdout
+      output = result.stdout.chomp
 
-      return :pass if output.empty?
+      return :pass if result.success? && output.empty?
 
-      [:fail, output]
+      # example message:
+      #   path/to/file.js: line 1, col 0, Error message (E001)
+      extract_messages(
+        output.split("\n").grep(/E|W/),
+        /^(?<file>[^:]+):[^\d]+(?<line>\d+).+\((?<type>E|W)\d+\)/,
+        lambda { |type| type.include?('W') ? :warning : :error }
+      )
     end
   end
 end

data/lib/overcommit/hook/pre_commit/pep257.rb

@@ -0,0 +1,19 @@
+module Overcommit::Hook::PreCommit
+  # Runs `pep257` against any modified Python files.
+  class Pep257 < Base
+    def run
+      result = execute(command + applicable_files)
+      return :pass if result.success?
+
+      output = result.stderr.chomp
+
+      # example message:
+      #   path/to/file.py:1 in public method `foo`:
+      #           D102: Docstring missing
+      extract_messages(
+        output.gsub(/:\s+/, ': ').split("\n"),
+        /^(?<file>[^:]+):(?<line>\d+)/
+      )
+    end
+  end
+end