Class: Overcommit::Hook::PreCommit::RubySyntax

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

Overview

Runs `ruby -c` against all Ruby files.

Constant Summary collapse

MESSAGE_TYPE_CATEGORIZER =
lambda do |type|
  type.match?(/^(syntax)?\s*error/) ? :error : :warning
end

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #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

#runObject


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

def run
  result = execute(command, args: applicable_files)

  result_lines = result.stderr.split("\n")

  return :pass if result_lines.length.zero?

  # Example message:
  #   path/to/file.rb:1: syntax error, unexpected '^'
  extract_messages(
    result_lines,
    /^(?<file>[^:]+):(?<line>\d+):\s*(?<type>[^,]+),\s*(?<message>.+)/,
    MESSAGE_TYPE_CATEGORIZER
  )
end