Class: Overcommit::Hook::PreCommit::PhpStan

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

Overview

Runs `phpstan` against any modified PHP files. For running `phpstan` with Laravel, it requires setup with `ide_helper`.

References: github.com/phpstan/phpstan/issues/239 gist.github.com/edmondscommerce/89695c9cd2584fefdf540fb1c528d2c2

Constant Summary collapse

MESSAGE_REGEX =
/^(?<file>.+)\:(?<line>\d+)\:(?<message>.+)/

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


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

def run
  messages = []

  result = execute(command, args: applicable_files)

  unless result.success?
    messages += result.stdout.lstrip.split("\n")
  end

  return :pass if messages.empty?

  extract_messages(
    messages,
    MESSAGE_REGEX
  )
end