Class: Overcommit::Hook::PreCommit::JavaCheckstyle

Inherits:
Base
  • Object
show all
Defined in:
lib/overcommit/hook/pre_commit/java_checkstyle.rb

Overview

Runs ‘checkstyle` against any modified Java files.

See Also:

Constant Summary collapse

MESSAGE_REGEX = 
/^(\[(?<type>[^\]]+)\]\s+)?(?<file>(?:\w:)?[^:]+):(?<line>\d+)/.freeze
MESSAGE_TYPE_CATEGORIZER = 
lambda do |type|
  %w[WARN INFO].include?(type.to_s) ? :warning : :error
end

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #excluded?, #execute, #execute_in_background, #flags, #in_path?, #included_files, #initialize, #name, #parallelize?, #processors, #quiet?, #required?, #required_executable, #required_libraries, #run?, #run_and_transform, #skip?

Constructor Details

This class inherits a constructor from Overcommit::Hook::Base

Instance Method Details

#run ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/overcommit/hook/pre_commit/java_checkstyle.rb', line 14

def run
  result = execute(command, args: applicable_files)
  output = result.stdout.chomp

  # example message:
  #   path/to/file.java:3:5: Error message
  extract_messages(
    output.split("\n").grep(MESSAGE_REGEX),
    MESSAGE_REGEX,
    MESSAGE_TYPE_CATEGORIZER
  )
end